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.342 by root, Wed Dec 29 04:16:33 2010 UTC vs.
Revision 1.358 by root, Sat Aug 13 02:35:32 2011 UTC

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