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.335 by root, Wed Oct 13 01:17:02 2010 UTC vs.
Revision 1.357 by root, Sat Aug 13 02:20:29 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
… …
876 AnyEvent::Impl::Glib based on Glib, slow but very stable. 876 AnyEvent::Impl::Glib based on Glib, slow but very stable.
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.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
881 884
882=item Backends with special needs. 885=item Backends with special needs.
883 886
884Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
885otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
886instantiates the application before any AnyEvent watchers are created, 889instantiates the application before any AnyEvent watchers are created,
887everything should just work. 890everything should just work.
888 891
889 AnyEvent::Impl::Qt based on Qt. 892 AnyEvent::Impl::Qt based on Qt.
890
891Support for IO::Async can only be partial, as it is too broken and
892architecturally limited to even support the AnyEvent API. It also
893is the only event loop that needs the loop to be set explicitly, so
894it can only be used by a main program knowing about AnyEvent. See
895L<AnyEvent::Impl::IOAsync> for the gory details.
896
897 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
898 893
899=item Event loops that are indirectly supported via other backends. 894=item Event loops that are indirectly supported via other backends.
900 895
901Some event loops can be supported via other modules: 896Some event loops can be supported via other modules:
902 897
… …
1010 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1005 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1011 # as soon as it is 1006 # as soon as it is
1012 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1007 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1013 } 1008 }
1014 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
1015=back 1050=back
1016 1051
1017=head1 WHAT TO DO IN A MODULE 1052=head1 WHAT TO DO IN A MODULE
1018 1053
1019As 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
… …
1052modules might create watchers when they are loaded, and AnyEvent will 1087modules might create watchers when they are loaded, and AnyEvent will
1053decide 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
1054might choose the wrong one unless you load the correct one yourself. 1089might choose the wrong one unless you load the correct one yourself.
1055 1090
1056You can chose to use a pure-perl implementation by loading the 1091You can chose to use a pure-perl implementation by loading the
1057C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1092C<AnyEvent::Loop> module, which gives you similar behaviour
1058everywhere, but letting AnyEvent chose the model is generally better. 1093everywhere, but letting AnyEvent chose the model is generally better.
1059 1094
1060=head2 MAINLOOP EMULATION 1095=head2 MAINLOOP EMULATION
1061 1096
1062Sometimes (often for short test scripts, or even standalone programs who 1097Sometimes (often for short test scripts, or even standalone programs who
… …
1157 1192
1158package AnyEvent; 1193package AnyEvent;
1159 1194
1160# basically a tuned-down version of common::sense 1195# basically a tuned-down version of common::sense
1161sub common_sense { 1196sub common_sense {
1162 # from common:.sense 3.3 1197 # from common:.sense 3.4
1163 ${^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";
1164 # 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)
1165 $^H |= 0x00000600; 1200 $^H |= 0x00000600;
1166} 1201}
1167 1202
1168BEGIN { AnyEvent::common_sense } 1203BEGIN { AnyEvent::common_sense }
1169 1204
1170use Carp (); 1205use Carp ();
1171 1206
1172our $VERSION = '5.271'; 1207our $VERSION = '5.34';
1173our $MODEL; 1208our $MODEL;
1174 1209
1175our $AUTOLOAD;
1176our @ISA; 1210our @ISA;
1177 1211
1178our @REGISTRY; 1212our @REGISTRY;
1179 1213
1180our $VERBOSE; 1214our $VERBOSE;
… …
1200 $PROTOCOL{$_} = ++$idx 1234 $PROTOCOL{$_} = ++$idx
1201 for reverse split /\s*,\s*/, 1235 for reverse split /\s*,\s*/,
1202 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1236 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1203} 1237}
1204 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
1205my @models = ( 1273our @models = (
1206 [EV:: => AnyEvent::Impl::EV:: , 1], 1274 [EV:: => AnyEvent::Impl::EV:: , 1],
1207 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1275 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1208 # everything below here will not (normally) be autoprobed 1276 # everything below here will not (normally) be autoprobed
1209 # as the pureperl backend should work everywhere 1277 # as the pure perl backend should work everywhere
1210 # and is usually faster 1278 # and is usually faster
1211 [Event:: => AnyEvent::Impl::Event::, 1], 1279 [Event:: => AnyEvent::Impl::Event::, 1],
1212 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1280 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1213 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1281 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1214 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1282 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1215 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1283 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1216 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1284 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1217 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1285 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1218 [Wx:: => AnyEvent::Impl::POE::], 1286 [Wx:: => AnyEvent::Impl::POE::],
1219 [Prima:: => AnyEvent::Impl::POE::], 1287 [Prima:: => AnyEvent::Impl::POE::],
1220 # IO::Async is just too broken - we would need workarounds for its 1288 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1221 # byzantine signal and broken child handling, among others. 1289 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1222 # IO::Async is rather hard to detect, as it doesn't have any 1290 [FLTK:: => AnyEvent::Impl::FLTK2::],
1223 # obvious default class.
1224 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1225 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1226 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1227 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1228); 1291);
1229 1292
1230our %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.
1231 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);
1232
1233our @post_detect;
1234
1235sub post_detect(&) {
1236 my ($cb) = @_;
1237
1238 push @post_detect, $cb;
1239
1240 defined wantarray
1241 ? bless \$cb, "AnyEvent::Util::postdetect"
1242 : ()
1243}
1244
1245sub AnyEvent::Util::postdetect::DESTROY {
1246 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1247}
1248 1296
1249sub detect() { 1297sub detect() {
1298 local $!; # for good measure
1299 local $SIG{__DIE__}; # we use eval
1300
1250 # free some memory 1301 # free some memory
1251 *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;
1252 1310
1253 local $!; # for good measure
1254 local $SIG{__DIE__};
1255
1256 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1311 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1257 my $model = "AnyEvent::Impl::$1"; 1312 my $model = $1;
1313 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1258 if (eval "require $model") { 1314 if (eval "require $model") {
1259 $MODEL = $model; 1315 $MODEL = $model;
1260 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;
1261 } else { 1317 } else {
1262 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;
… …
1291 last; 1347 last;
1292 } 1348 }
1293 } 1349 }
1294 1350
1295 $MODEL 1351 $MODEL
1296 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1352 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1297 } 1353 }
1298 } 1354 }
1299 1355
1300 @models = (); # free probe data 1356 # free memory only needed for probing
1357 undef @models;
1358 undef @REGISTRY;
1301 1359
1302 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1360 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1303 unshift @ISA, $MODEL; 1361 unshift @ISA, $MODEL;
1304 1362
1305 # now nuke some methods that are overriden by the backend. 1363 # now nuke some methods that are overridden by the backend.
1306 # SUPER is not allowed. 1364 # SUPER usage is not allowed in these.
1307 for (qw(time signal child idle)) { 1365 for (qw(time signal child idle)) {
1308 undef &{"AnyEvent::Base::$_"} 1366 undef &{"AnyEvent::Base::$_"}
1309 if defined &{"$MODEL\::$_"}; 1367 if defined &{"$MODEL\::$_"};
1310 } 1368 }
1311 1369
1312 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; 1370 if ($ENV{PERL_ANYEVENT_STRICT}) {
1371 require AnyEvent::Strict;
1372 }
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::Debug;
1381 #d#
1382 }
1313 1383
1314 (shift @post_detect)->() while @post_detect; 1384 (shift @post_detect)->() while @post_detect;
1385 undef @post_detect;
1315 1386
1316 *post_detect = sub(&) { 1387 *post_detect = sub(&) {
1317 shift->(); 1388 shift->();
1318 1389
1319 undef 1390 undef
1320 }; 1391 };
1321 1392
1322 $MODEL 1393 $MODEL
1323} 1394}
1324 1395
1325sub AUTOLOAD { 1396for my $name (@methods) {
1326 (my $func = $AUTOLOAD) =~ s/.*://; 1397 *$name = sub {
1327
1328 $method{$func}
1329 or Carp::croak "$func: not a valid AnyEvent class method";
1330
1331 detect; 1398 detect;
1332 1399 # we use goto because
1333 my $class = shift; 1400 # a) it makes the thunk more transparent
1334 $class->$func (@_); 1401 # b) it allows us to delete the thunk later
1402 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1403 };
1335} 1404}
1336 1405
1337# utility function to dup a filehandle. this is used by many backends 1406# utility function to dup a filehandle. this is used by many backends
1338# to support binding more than one watcher per filehandle (they usually 1407# to support binding more than one watcher per filehandle (they usually
1339# allow only one watcher per fd, so we dup it to get a different one). 1408# allow only one watcher per fd, so we dup it to get a different one).
… …
1363 1432
1364package AE; 1433package AE;
1365 1434
1366our $VERSION = $AnyEvent::VERSION; 1435our $VERSION = $AnyEvent::VERSION;
1367 1436
1437sub _reset() {
1438 eval q{
1368# fall back to the main API by default - backends and AnyEvent::Base 1439 # fall back to the main API by default - backends and AnyEvent::Base
1369# implementations can overwrite these. 1440 # implementations can overwrite these.
1370 1441
1371sub io($$$) { 1442 sub io($$$) {
1372 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1443 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1373} 1444 }
1374 1445
1375sub timer($$$) { 1446 sub timer($$$) {
1376 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1447 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1377} 1448 }
1378 1449
1379sub signal($$) { 1450 sub signal($$) {
1380 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1451 AnyEvent->signal (signal => $_[0], cb => $_[1])
1381} 1452 }
1382 1453
1383sub child($$) { 1454 sub child($$) {
1384 AnyEvent->child (pid => $_[0], cb => $_[1]) 1455 AnyEvent->child (pid => $_[0], cb => $_[1])
1385} 1456 }
1386 1457
1387sub idle($) { 1458 sub idle($) {
1388 AnyEvent->idle (cb => $_[0]) 1459 AnyEvent->idle (cb => $_[0]);
1389} 1460 }
1390 1461
1391sub cv(;&) { 1462 sub cv(;&) {
1392 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1463 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1393} 1464 }
1394 1465
1395sub now() { 1466 sub now() {
1396 AnyEvent->now 1467 AnyEvent->now
1397} 1468 }
1398 1469
1399sub now_update() { 1470 sub now_update() {
1400 AnyEvent->now_update 1471 AnyEvent->now_update
1401} 1472 }
1402 1473
1403sub time() { 1474 sub time() {
1404 AnyEvent->time 1475 AnyEvent->time
1476 }
1477
1478 *postpone = \&AnyEvent::postpone;
1479 };
1480 die if $@;
1405} 1481}
1482
1483BEGIN { _reset }
1406 1484
1407package AnyEvent::Base; 1485package AnyEvent::Base;
1408 1486
1409# default implementations for many methods 1487# default implementations for many methods
1410 1488
… …
1429 1507
1430*now = \&time; 1508*now = \&time;
1431 1509
1432sub now_update { } 1510sub now_update { }
1433 1511
1512sub _poll {
1513 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1514}
1515
1434# default implementation for ->condvar 1516# default implementation for ->condvar
1517# in fact, the default should not be overwritten
1435 1518
1436sub condvar { 1519sub condvar {
1437 eval q{ # poor man's autoloading {} 1520 eval q{ # poor man's autoloading {}
1438 *condvar = sub { 1521 *condvar = sub {
1439 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1522 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
… …
1609 : sysread $SIGPIPE_R, (my $dummy), 9; 1692 : sysread $SIGPIPE_R, (my $dummy), 9;
1610 1693
1611 while (%SIG_EV) { 1694 while (%SIG_EV) {
1612 for (keys %SIG_EV) { 1695 for (keys %SIG_EV) {
1613 delete $SIG_EV{$_}; 1696 delete $SIG_EV{$_};
1614 $_->() for values %{ $SIG_CB{$_} || {} }; 1697 &$_ for values %{ $SIG_CB{$_} || {} };
1615 } 1698 }
1616 } 1699 }
1617 }; 1700 };
1618 }; 1701 };
1619 die if $@; 1702 die if $@;
… …
1624# default implementation for ->child 1707# default implementation for ->child
1625 1708
1626our %PID_CB; 1709our %PID_CB;
1627our $CHLD_W; 1710our $CHLD_W;
1628our $CHLD_DELAY_W; 1711our $CHLD_DELAY_W;
1629our $WNOHANG;
1630 1712
1631# used by many Impl's 1713# used by many Impl's
1632sub _emit_childstatus($$) { 1714sub _emit_childstatus($$) {
1633 my (undef, $rpid, $rstatus) = @_; 1715 my (undef, $rpid, $rstatus) = @_;
1634 1716
… …
1641 eval q{ # poor man's autoloading {} 1723 eval q{ # poor man's autoloading {}
1642 *_sigchld = sub { 1724 *_sigchld = sub {
1643 my $pid; 1725 my $pid;
1644 1726
1645 AnyEvent->_emit_childstatus ($pid, $?) 1727 AnyEvent->_emit_childstatus ($pid, $?)
1646 while ($pid = waitpid -1, $WNOHANG) > 0; 1728 while ($pid = waitpid -1, WNOHANG) > 0;
1647 }; 1729 };
1648 1730
1649 *child = sub { 1731 *child = sub {
1650 my (undef, %arg) = @_; 1732 my (undef, %arg) = @_;
1651 1733
1652 defined (my $pid = $arg{pid} + 0) 1734 my $pid = $arg{pid};
1653 or Carp::croak "required option 'pid' is missing"; 1735 my $cb = $arg{cb};
1654 1736
1655 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1737 $PID_CB{$pid}{$cb+0} = $cb;
1656
1657 # WNOHANG is almost cetrainly 1 everywhere
1658 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1659 ? 1
1660 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1661 1738
1662 unless ($CHLD_W) { 1739 unless ($CHLD_W) {
1663 $CHLD_W = AE::signal CHLD => \&_sigchld; 1740 $CHLD_W = AE::signal CHLD => \&_sigchld;
1664 # child could be a zombie already, so make at least one round 1741 # child could be a zombie already, so make at least one round
1665 &_sigchld; 1742 &_sigchld;
1666 } 1743 }
1667 1744
1668 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1745 bless [$pid, $cb+0], "AnyEvent::Base::child"
1669 }; 1746 };
1670 1747
1671 *AnyEvent::Base::child::DESTROY = sub { 1748 *AnyEvent::Base::child::DESTROY = sub {
1672 my ($pid, $cb) = @{$_[0]}; 1749 my ($pid, $icb) = @{$_[0]};
1673 1750
1674 delete $PID_CB{$pid}{$cb}; 1751 delete $PID_CB{$pid}{$icb};
1675 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1752 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1676 1753
1677 undef $CHLD_W unless keys %PID_CB; 1754 undef $CHLD_W unless keys %PID_CB;
1678 }; 1755 };
1679 }; 1756 };
… …
1692 1769
1693 my ($cb, $w, $rcb) = $arg{cb}; 1770 my ($cb, $w, $rcb) = $arg{cb};
1694 1771
1695 $rcb = sub { 1772 $rcb = sub {
1696 if ($cb) { 1773 if ($cb) {
1697 $w = _time; 1774 $w = AE::time;
1698 &$cb; 1775 &$cb;
1699 $w = _time - $w; 1776 $w = AE::time - $w;
1700 1777
1701 # never use more then 50% of the time for the idle watcher, 1778 # never use more then 50% of the time for the idle watcher,
1702 # within some limits 1779 # within some limits
1703 $w = 0.0001 if $w < 0.0001; 1780 $w = 0.0001 if $w < 0.0001;
1704 $w = 5 if $w > 5; 1781 $w = 5 if $w > 5;
… …
1751 1828
1752sub _send { 1829sub _send {
1753 # nop 1830 # nop
1754} 1831}
1755 1832
1833sub _wait {
1834 AnyEvent->_poll until $_[0]{_ae_sent};
1835}
1836
1756sub send { 1837sub send {
1757 my $cv = shift; 1838 my $cv = shift;
1758 $cv->{_ae_sent} = [@_]; 1839 $cv->{_ae_sent} = [@_];
1759 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1840 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1760 $cv->_send; 1841 $cv->_send;
… …
1767 1848
1768sub ready { 1849sub ready {
1769 $_[0]{_ae_sent} 1850 $_[0]{_ae_sent}
1770} 1851}
1771 1852
1772sub _wait {
1773 $WAITING
1774 and !$_[0]{_ae_sent}
1775 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1776
1777 local $WAITING = 1;
1778 AnyEvent->one_event while !$_[0]{_ae_sent};
1779}
1780
1781sub recv { 1853sub recv {
1854 unless ($_[0]{_ae_sent}) {
1855 $WAITING
1856 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1857
1858 local $WAITING = 1;
1782 $_[0]->_wait; 1859 $_[0]->_wait;
1860 }
1783 1861
1784 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1862 $_[0]{_ae_croak}
1785 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1863 and Carp::croak $_[0]{_ae_croak};
1864
1865 wantarray
1866 ? @{ $_[0]{_ae_sent} }
1867 : $_[0]{_ae_sent}[0]
1786} 1868}
1787 1869
1788sub cb { 1870sub cb {
1789 my $cv = shift; 1871 my $cv = shift;
1790 1872
… …
1806 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1888 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1807} 1889}
1808 1890
1809# undocumented/compatibility with pre-3.4 1891# undocumented/compatibility with pre-3.4
1810*broadcast = \&send; 1892*broadcast = \&send;
1811*wait = \&_wait; 1893*wait = \&recv;
1812 1894
1813=head1 ERROR AND EXCEPTION HANDLING 1895=head1 ERROR AND EXCEPTION HANDLING
1814 1896
1815In general, AnyEvent does not do any error handling - it relies on the 1897In general, AnyEvent does not do any error handling - it relies on the
1816caller to do that if required. The L<AnyEvent::Strict> module (see also 1898caller to do that if required. The L<AnyEvent::Strict> module (see also
… …
1871can be very useful, however. 1953can be very useful, however.
1872 1954
1873=item C<PERL_ANYEVENT_MODEL> 1955=item C<PERL_ANYEVENT_MODEL>
1874 1956
1875This can be used to specify the event model to be used by AnyEvent, before 1957This can be used to specify the event model to be used by AnyEvent, before
1876auto detection and -probing kicks in. It must be a string consisting 1958auto detection and -probing kicks in.
1877entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 1959
1960It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
1961or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1878and the resulting module name is loaded and if the load was successful, 1962resulting module name is loaded and - if the load was successful - used as
1879used as event model. If it fails to load AnyEvent will proceed with 1963event model backend. If it fails to load then AnyEvent will proceed with
1880auto detection and -probing. 1964auto detection and -probing.
1881 1965
1882This functionality might change in future versions. 1966If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
1967nothing gets prepended and the module name is used as-is (hint: C<::> at
1968the end of a string designates a module name and quotes it appropriately).
1883 1969
1884For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1970For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1885could start your program like this: 1971could start your program like this:
1886 1972
1887 PERL_ANYEVENT_MODEL=Perl perl ... 1973 PERL_ANYEVENT_MODEL=Perl perl ...
1888 1974
1889=item C<PERL_ANYEVENT_PROTOCOLS> 1975=item C<PERL_ANYEVENT_PROTOCOLS>
… …
2588 2674
2589=item L<Time::HiRes> 2675=item L<Time::HiRes>
2590 2676
2591This module is part of perl since release 5.008. It will be used when the 2677This module is part of perl since release 5.008. It will be used when the
2592chosen event library does not come with a timing source of its own. The 2678chosen event library does not come with a timing source of its own. The
2593pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2679pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2594try to use a monotonic clock for timing stability. 2680try to use a monotonic clock for timing stability.
2595 2681
2596=back 2682=back
2597 2683
2598 2684
… …
2666 2752
2667FAQ: L<AnyEvent::FAQ>. 2753FAQ: L<AnyEvent::FAQ>.
2668 2754
2669Utility functions: L<AnyEvent::Util>. 2755Utility functions: L<AnyEvent::Util>.
2670 2756
2671Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2757Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2672L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2758L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2673 2759
2674Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2760Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2675L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2761L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2676L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2762L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2677L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2763L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.

Diff Legend

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