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.348 by root, Thu Feb 24 12:04:20 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::FLTK2 based on FLTK (fltk 2 binding).
883 884
884=item Backends with special needs. 885=item Backends with special needs.
885 886
886Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
887otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
1004 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1005 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1005 # as soon as it is 1006 # as soon as it is
1006 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1007 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1007 } 1008 }
1008 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
1009=back 1050=back
1010 1051
1011=head1 WHAT TO DO IN A MODULE 1052=head1 WHAT TO DO IN A MODULE
1012 1053
1013As 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
1046modules might create watchers when they are loaded, and AnyEvent will 1087modules might create watchers when they are loaded, and AnyEvent will
1047decide on the event model to use as soon as it creates watchers, and it 1088decide on the event model to use as soon as it creates watchers, and it
1048might choose the wrong one unless you load the correct one yourself. 1089might choose the wrong one unless you load the correct one yourself.
1049 1090
1050You can chose to use a pure-perl implementation by loading the 1091You can chose to use a pure-perl implementation by loading the
1051C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1092C<AnyEvent::Loop> module, which gives you similar behaviour
1052everywhere, but letting AnyEvent chose the model is generally better. 1093everywhere, but letting AnyEvent chose the model is generally better.
1053 1094
1054=head2 MAINLOOP EMULATION 1095=head2 MAINLOOP EMULATION
1055 1096
1056Sometimes (often for short test scripts, or even standalone programs who 1097Sometimes (often for short test scripts, or even standalone programs who
1161 1202
1162BEGIN { AnyEvent::common_sense } 1203BEGIN { AnyEvent::common_sense }
1163 1204
1164use Carp (); 1205use Carp ();
1165 1206
1166our $VERSION = '5.33'; 1207our $VERSION = '5.34';
1167our $MODEL; 1208our $MODEL;
1168 1209
1169our $AUTOLOAD;
1170our @ISA; 1210our @ISA;
1171 1211
1172our @REGISTRY; 1212our @REGISTRY;
1173 1213
1174our $VERBOSE; 1214our $VERBOSE;
1194 $PROTOCOL{$_} = ++$idx 1234 $PROTOCOL{$_} = ++$idx
1195 for reverse split /\s*,\s*/, 1235 for reverse split /\s*,\s*/,
1196 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1236 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1197} 1237}
1198 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
1199my @models = ( 1273our @models = (
1200 [EV:: => AnyEvent::Impl::EV:: , 1], 1274 [EV:: => AnyEvent::Impl::EV:: , 1],
1201 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1275 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1202 # everything below here will not (normally) be autoprobed 1276 # everything below here will not (normally) be autoprobed
1203 # as the pureperl backend should work everywhere 1277 # as the pure perl backend should work everywhere
1204 # and is usually faster 1278 # and is usually faster
1205 [Event:: => AnyEvent::Impl::Event::, 1], 1279 [Event:: => AnyEvent::Impl::Event::, 1],
1206 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1280 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1207 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1281 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1208 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1282 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1209 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1283 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1210 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1284 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1211 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1285 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1212 [Wx:: => AnyEvent::Impl::POE::], 1286 [Wx:: => AnyEvent::Impl::POE::],
1213 [Prima:: => AnyEvent::Impl::POE::], 1287 [Prima:: => AnyEvent::Impl::POE::],
1214 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1288 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1215 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1289 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1290 [FLTK:: => AnyEvent::Impl::FLTK2::],
1216); 1291);
1217 1292
1218our %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.
1219 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);
1220
1221our @post_detect;
1222
1223sub post_detect(&) {
1224 my ($cb) = @_;
1225
1226 push @post_detect, $cb;
1227
1228 defined wantarray
1229 ? bless \$cb, "AnyEvent::Util::postdetect"
1230 : ()
1231}
1232
1233sub AnyEvent::Util::postdetect::DESTROY {
1234 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1235}
1236 1296
1237sub detect() { 1297sub detect() {
1298 local $!; # for good measure
1299 local $SIG{__DIE__}; # we use eval
1300
1238 # free some memory 1301 # free some memory
1239 *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;
1240 1310
1241 local $!; # for good measure
1242 local $SIG{__DIE__};
1243
1244 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1311 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1245 my $model = "AnyEvent::Impl::$1"; 1312 my $model = $1;
1313 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1246 if (eval "require $model") { 1314 if (eval "require $model") {
1247 $MODEL = $model; 1315 $MODEL = $model;
1248 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;
1249 } else { 1317 } else {
1250 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;
1283 $MODEL 1351 $MODEL
1284 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";
1285 } 1353 }
1286 } 1354 }
1287 1355
1288 @models = (); # free probe data 1356 # free memory only needed for probing
1357 undef @models;
1358 undef @REGISTRY;
1289 1359
1290 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1360 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1291 unshift @ISA, $MODEL; 1361 unshift @ISA, $MODEL;
1292 1362
1293 # now nuke some methods that are overridden by the backend. 1363 # now nuke some methods that are overridden by the backend.
1294 # SUPER is not allowed. 1364 # SUPER usage is not allowed in these.
1295 for (qw(time signal child idle)) { 1365 for (qw(time signal child idle)) {
1296 undef &{"AnyEvent::Base::$_"} 1366 undef &{"AnyEvent::Base::$_"}
1297 if defined &{"$MODEL\::$_"}; 1367 if defined &{"$MODEL\::$_"};
1298 } 1368 }
1299 1369
1300 if ($ENV{PERL_ANYEVENT_STRICT}) { 1370 if ($ENV{PERL_ANYEVENT_STRICT}) {
1301 eval { require AnyEvent::Strict }; 1371 require AnyEvent::Strict;
1302 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1303 if $@ && $VERBOSE;
1304 } 1372 }
1305 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
1306 (shift @post_detect)->() while @post_detect; 1387 (shift @post_detect)->() while @post_detect;
1388 undef @post_detect;
1307 1389
1308 *post_detect = sub(&) { 1390 *post_detect = sub(&) {
1309 shift->(); 1391 shift->();
1310 1392
1311 undef 1393 undef
1312 }; 1394 };
1313 1395
1314 $MODEL 1396 $MODEL
1315} 1397}
1316 1398
1317sub AUTOLOAD { 1399for my $name (@methods) {
1318 (my $func = $AUTOLOAD) =~ s/.*://; 1400 *$name = sub {
1319
1320 $method{$func}
1321 or Carp::croak "$func: not a valid AnyEvent class method";
1322
1323 detect; 1401 detect;
1324 1402 # we use goto because
1325 my $class = shift; 1403 # a) it makes the thunk more transparent
1326 $class->$func (@_); 1404 # b) it allows us to delete the thunk later
1405 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1406 };
1327} 1407}
1328 1408
1329# 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
1330# to support binding more than one watcher per filehandle (they usually 1410# to support binding more than one watcher per filehandle (they usually
1331# allow only one watcher per fd, so we dup it to get a different one). 1411# allow only one watcher per fd, so we dup it to get a different one).
1355 1435
1356package AE; 1436package AE;
1357 1437
1358our $VERSION = $AnyEvent::VERSION; 1438our $VERSION = $AnyEvent::VERSION;
1359 1439
1440sub _reset() {
1441 eval q{
1360# 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
1361# implementations can overwrite these. 1443 # implementations can overwrite these.
1362 1444
1363sub io($$$) { 1445 sub io($$$) {
1364 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1446 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365} 1447 }
1366 1448
1367sub timer($$$) { 1449 sub timer($$$) {
1368 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1450 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369} 1451 }
1370 1452
1371sub signal($$) { 1453 sub signal($$) {
1372 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1454 AnyEvent->signal (signal => $_[0], cb => $_[1])
1373} 1455 }
1374 1456
1375sub child($$) { 1457 sub child($$) {
1376 AnyEvent->child (pid => $_[0], cb => $_[1]) 1458 AnyEvent->child (pid => $_[0], cb => $_[1])
1377} 1459 }
1378 1460
1379sub idle($) { 1461 sub idle($) {
1380 AnyEvent->idle (cb => $_[0]) 1462 AnyEvent->idle (cb => $_[0]);
1381} 1463 }
1382 1464
1383sub cv(;&) { 1465 sub cv(;&) {
1384 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1466 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385} 1467 }
1386 1468
1387sub now() { 1469 sub now() {
1388 AnyEvent->now 1470 AnyEvent->now
1389} 1471 }
1390 1472
1391sub now_update() { 1473 sub now_update() {
1392 AnyEvent->now_update 1474 AnyEvent->now_update
1393} 1475 }
1394 1476
1395sub time() { 1477 sub time() {
1396 AnyEvent->time 1478 AnyEvent->time
1479 }
1480
1481 *postpone = \&AnyEvent::postpone;
1482 };
1483 die if $@;
1397} 1484}
1485
1486BEGIN { _reset }
1398 1487
1399package AnyEvent::Base; 1488package AnyEvent::Base;
1400 1489
1401# default implementations for many methods 1490# default implementations for many methods
1402 1491
1421 1510
1422*now = \&time; 1511*now = \&time;
1423 1512
1424sub now_update { } 1513sub now_update { }
1425 1514
1515sub _poll {
1516 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1517}
1518
1426# default implementation for ->condvar 1519# default implementation for ->condvar
1520# in fact, the default should not be overwritten
1427 1521
1428sub condvar { 1522sub condvar {
1429 eval q{ # poor man's autoloading {} 1523 eval q{ # poor man's autoloading {}
1430 *condvar = sub { 1524 *condvar = sub {
1431 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1525 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1601 : sysread $SIGPIPE_R, (my $dummy), 9; 1695 : sysread $SIGPIPE_R, (my $dummy), 9;
1602 1696
1603 while (%SIG_EV) { 1697 while (%SIG_EV) {
1604 for (keys %SIG_EV) { 1698 for (keys %SIG_EV) {
1605 delete $SIG_EV{$_}; 1699 delete $SIG_EV{$_};
1606 $_->() for values %{ $SIG_CB{$_} || {} }; 1700 &$_ for values %{ $SIG_CB{$_} || {} };
1607 } 1701 }
1608 } 1702 }
1609 }; 1703 };
1610 }; 1704 };
1611 die if $@; 1705 die if $@;
1638 }; 1732 };
1639 1733
1640 *child = sub { 1734 *child = sub {
1641 my (undef, %arg) = @_; 1735 my (undef, %arg) = @_;
1642 1736
1643 defined (my $pid = $arg{pid} + 0) 1737 my $pid = $arg{pid};
1644 or Carp::croak "required option 'pid' is missing"; 1738 my $cb = $arg{cb};
1645 1739
1646 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1740 $PID_CB{$pid}{$cb+0} = $cb;
1647 1741
1648 unless ($CHLD_W) { 1742 unless ($CHLD_W) {
1649 $CHLD_W = AE::signal CHLD => \&_sigchld; 1743 $CHLD_W = AE::signal CHLD => \&_sigchld;
1650 # 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
1651 &_sigchld; 1745 &_sigchld;
1652 } 1746 }
1653 1747
1654 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1748 bless [$pid, $cb+0], "AnyEvent::Base::child"
1655 }; 1749 };
1656 1750
1657 *AnyEvent::Base::child::DESTROY = sub { 1751 *AnyEvent::Base::child::DESTROY = sub {
1658 my ($pid, $cb) = @{$_[0]}; 1752 my ($pid, $icb) = @{$_[0]};
1659 1753
1660 delete $PID_CB{$pid}{$cb}; 1754 delete $PID_CB{$pid}{$icb};
1661 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1755 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1662 1756
1663 undef $CHLD_W unless keys %PID_CB; 1757 undef $CHLD_W unless keys %PID_CB;
1664 }; 1758 };
1665 }; 1759 };
1678 1772
1679 my ($cb, $w, $rcb) = $arg{cb}; 1773 my ($cb, $w, $rcb) = $arg{cb};
1680 1774
1681 $rcb = sub { 1775 $rcb = sub {
1682 if ($cb) { 1776 if ($cb) {
1683 $w = _time; 1777 $w = AE::time;
1684 &$cb; 1778 &$cb;
1685 $w = _time - $w; 1779 $w = AE::time - $w;
1686 1780
1687 # 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,
1688 # within some limits 1782 # within some limits
1689 $w = 0.0001 if $w < 0.0001; 1783 $w = 0.0001 if $w < 0.0001;
1690 $w = 5 if $w > 5; 1784 $w = 5 if $w > 5;
1737 1831
1738sub _send { 1832sub _send {
1739 # nop 1833 # nop
1740} 1834}
1741 1835
1836sub _wait {
1837 AnyEvent->_poll until $_[0]{_ae_sent};
1838}
1839
1742sub send { 1840sub send {
1743 my $cv = shift; 1841 my $cv = shift;
1744 $cv->{_ae_sent} = [@_]; 1842 $cv->{_ae_sent} = [@_];
1745 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1843 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1746 $cv->_send; 1844 $cv->_send;
1753 1851
1754sub ready { 1852sub ready {
1755 $_[0]{_ae_sent} 1853 $_[0]{_ae_sent}
1756} 1854}
1757 1855
1758sub _wait {
1759 $WAITING
1760 and !$_[0]{_ae_sent}
1761 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1762
1763 local $WAITING = 1;
1764 AnyEvent->one_event while !$_[0]{_ae_sent};
1765}
1766
1767sub recv { 1856sub recv {
1857 unless ($_[0]{_ae_sent}) {
1858 $WAITING
1859 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1860
1861 local $WAITING = 1;
1768 $_[0]->_wait; 1862 $_[0]->_wait;
1863 }
1769 1864
1770 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1865 $_[0]{_ae_croak}
1771 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]
1772} 1871}
1773 1872
1774sub cb { 1873sub cb {
1775 my $cv = shift; 1874 my $cv = shift;
1776 1875
1792 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1891 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1793} 1892}
1794 1893
1795# undocumented/compatibility with pre-3.4 1894# undocumented/compatibility with pre-3.4
1796*broadcast = \&send; 1895*broadcast = \&send;
1797*wait = \&_wait; 1896*wait = \&recv;
1798 1897
1799=head1 ERROR AND EXCEPTION HANDLING 1898=head1 ERROR AND EXCEPTION HANDLING
1800 1899
1801In 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
1802caller 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
1854Unlike 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>
1855>>, it is definitely recommended to keep it off in production. Keeping 1954>>, it is definitely recommended to keep it off in production. Keeping
1856C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 1955C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1857can be very useful, however. 1956can be very useful, however.
1858 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
1859=item C<PERL_ANYEVENT_MODEL> 1975=item C<PERL_ANYEVENT_MODEL>
1860 1976
1861This 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
1862auto detection and -probing kicks in. It must be a string consisting 1978auto detection and -probing kicks in.
1863entirely 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
1864and 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
1865used 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
1866auto detection and -probing. 1984auto detection and -probing.
1867 1985
1868This 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).
1869 1989
1870For 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
1871could start your program like this: 1991could start your program like this:
1872 1992
1873 PERL_ANYEVENT_MODEL=Perl perl ... 1993 PERL_ANYEVENT_MODEL=Perl perl ...
1874 1994
1875=item C<PERL_ANYEVENT_PROTOCOLS> 1995=item C<PERL_ANYEVENT_PROTOCOLS>
2574 2694
2575=item L<Time::HiRes> 2695=item L<Time::HiRes>
2576 2696
2577This 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
2578chosen 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
2579pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2699pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2580try to use a monotonic clock for timing stability. 2700try to use a monotonic clock for timing stability.
2581 2701
2582=back 2702=back
2583 2703
2584 2704
2652 2772
2653FAQ: L<AnyEvent::FAQ>. 2773FAQ: L<AnyEvent::FAQ>.
2654 2774
2655Utility functions: L<AnyEvent::Util>. 2775Utility functions: L<AnyEvent::Util>.
2656 2776
2657Event 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>,
2658L<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>.
2659 2779
2660Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2780Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2781L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2782L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663L<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