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.332 by root, Tue Aug 31 23:32:40 2010 UTC vs.
Revision 1.363 by root, Sun Aug 14 13:56:52 2011 UTC

46in a tutorial or some gentle introduction, have a look at the 46in a tutorial or some gentle introduction, have a look at the
47L<AnyEvent::Intro> manpage. 47L<AnyEvent::Intro> manpage.
48 48
49=head1 SUPPORT 49=head1 SUPPORT
50 50
51An FAQ document is available as L<AnyEvent::FAQ>.
52
51There is a mailinglist for discussing all things AnyEvent, and an IRC 53There also is a mailinglist for discussing all things AnyEvent, and an IRC
52channel, too. 54channel, too.
53 55
54See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software 56See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
55Repository>, at L<http://anyevent.schmorp.de>, for more info. 57Repository>, at L<http://anyevent.schmorp.de>, for more info.
56 58
83that 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
84module 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.
85 87
86AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 88AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
87fine. 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
88with 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
89your 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
90too. But if your module uses AnyEvent, it works transparently with all 92your module uses AnyEvent, it works transparently with all event models it
91event 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
92use 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,
93to AnyEvent, too, so it is future-proof). 95so it is future-proof).
94 96
95In 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
96model>, 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
97modules, 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
98follow. 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
119The 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>
120module. 122module.
121 123
122During the first call of any watcher-creation method, the module tries 124During the first call of any watcher-creation method, the module tries
123to 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
124following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>, 126following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
125L<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
126found 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
127four 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
128available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so 130available, the pure-perl L<AnyEvent::Loop> should always work, so
129the other two are not normally tried. 131the other two are not normally tried.
130 132
131Because AnyEvent first checks for modules that are already loaded, loading 133Because AnyEvent first checks for modules that are already loaded, loading
132an event model explicitly before first using AnyEvent will likely make 134an event model explicitly before first using AnyEvent will likely make
133that model the default. For example: 135that model the default. For example:
140The 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
141starts 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,
142as very few modules hardcode event loops without announcing this very 144as very few modules hardcode event loops without announcing this very
143loudly. 145loudly.
144 146
145The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
146C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148other event modules you can load it explicitly and enjoy the high
147explicitly and enjoy the high availability of that event loop :) 149availability of that event loop :)
148 150
149=head1 WATCHERS 151=head1 WATCHERS
150 152
151AnyEvent 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
152stores 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
354difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
355account. 357account.
356 358
357=item AnyEvent->now_update 359=item AnyEvent->now_update
358 360
359Some 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
360the current time for each loop iteration (see the discussion of L<< 362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
361AnyEvent->now >>, above). 363above).
362 364
363When 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
364this "current" time will differ substantially from the real time, which 366this "current" time will differ substantially from the real time, which
365might affect timers and time-outs. 367might affect timers and time-outs.
366 368
480thing 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
481watcher before you C<fork> the child (alternatively, you can call 483watcher before you C<fork> the child (alternatively, you can call
482C<AnyEvent::detect>). 484C<AnyEvent::detect>).
483 485
484As 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
485emulated 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
486mentioned in the description of signal watchers apply. 488problems mentioned in the description of signal watchers apply.
487 489
488Example: fork a process and wait for it 490Example: fork a process and wait for it
489 491
490 my $done = AnyEvent->condvar; 492 my $done = AnyEvent->condvar;
491 493
858use. 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
859pure-perl implementation, which is available everywhere as it comes with 861pure-perl implementation, which is available everywhere as it comes with
860AnyEvent itself. 862AnyEvent itself.
861 863
862 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 864 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
863 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 865 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
864 866
865=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.
866 868
867These 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
868is 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
874 AnyEvent::Impl::Glib based on Glib, slow but very stable. 876 AnyEvent::Impl::Glib based on Glib, slow but very stable.
875 AnyEvent::Impl::Tk based on Tk, very broken. 877 AnyEvent::Impl::Tk based on Tk, very broken.
876 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
877 AnyEvent::Impl::POE based on POE, very slow, some limitations. 879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
878 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).
879 884
880=item Backends with special needs. 885=item Backends with special needs.
881 886
882Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
883otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
884instantiates the application before any AnyEvent watchers are created, 889instantiates the application before any AnyEvent watchers are created,
885everything should just work. 890everything should just work.
886 891
887 AnyEvent::Impl::Qt based on Qt. 892 AnyEvent::Impl::Qt based on Qt.
888
889Support for IO::Async can only be partial, as it is too broken and
890architecturally limited to even support the AnyEvent API. It also
891is the only event loop that needs the loop to be set explicitly, so
892it can only be used by a main program knowing about AnyEvent. See
893L<AnyEvent::Impl::IOAsync> for the gory details.
894
895 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
896 893
897=item Event loops that are indirectly supported via other backends. 894=item Event loops that are indirectly supported via other backends.
898 895
899Some event loops can be supported via other modules: 896Some event loops can be supported via other modules:
900 897
936 933
937Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
938if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
939have created an AnyEvent watcher anyway, that is, as late as possible at 936have created an AnyEvent watcher anyway, that is, as late as possible at
940runtime, and not e.g. during initialisation of your module. 937runtime, and not e.g. during initialisation of your module.
938
939The effect of calling this function is as if a watcher had been created
940(specifically, actions that happen "when the first watcher is created"
941happen when calling detetc as well).
941 942
942If you need to do some initialisation before AnyEvent watchers are 943If you need to do some initialisation before AnyEvent watchers are
943created, use C<post_detect>. 944created, use C<post_detect>.
944 945
945=item $guard = AnyEvent::post_detect { BLOCK } 946=item $guard = AnyEvent::post_detect { BLOCK }
1008 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1009 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1009 # as soon as it is 1010 # as soon as it is
1010 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1011 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1011 } 1012 }
1012 1013
1014=item AnyEvent::postpone { BLOCK }
1015
1016Arranges for the block to be executed as soon as possible, but not before
1017the call itself returns. In practise, the block will be executed just
1018before the event loop polls for new events, or shortly afterwards.
1019
1020This function never returns anything (to make the C<return postpone { ...
1021}> idiom more useful.
1022
1023To understand the usefulness of this function, consider a function that
1024asynchronously does something for you and returns some transaction
1025object or guard to let you cancel the operation. For example,
1026C<AnyEvent::Socket::tcp_connect>:
1027
1028 # start a conenction attempt unless one is active
1029 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1030 delete $self->{connect_guard};
1031 ...
1032 };
1033
1034Imagine that this function could instantly call the callback, for
1035example, because it detects an obvious error such as a negative port
1036number. Invoking the callback before the function returns causes problems
1037however: the callback will be called and will try to delete the guard
1038object. But since the function hasn't returned yet, there is nothing to
1039delete. When the function eventually returns it will assign the guard
1040object to C<< $self->{connect_guard} >>, where it will likely never be
1041deleted, so the program thinks it is still trying to connect.
1042
1043This is where C<AnyEvent::postpone> should be used. Instead of calling the
1044callback directly on error:
1045
1046 $cb->(undef), return # signal error to callback, BAD!
1047 if $some_error_condition;
1048
1049It should use C<postpone>:
1050
1051 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1052 if $some_error_condition;
1053
1013=back 1054=back
1014 1055
1015=head1 WHAT TO DO IN A MODULE 1056=head1 WHAT TO DO IN A MODULE
1016 1057
1017As a module author, you should C<use AnyEvent> and call AnyEvent methods 1058As a module author, you should C<use AnyEvent> and call AnyEvent methods
1050modules might create watchers when they are loaded, and AnyEvent will 1091modules might create watchers when they are loaded, and AnyEvent will
1051decide on the event model to use as soon as it creates watchers, and it 1092decide on the event model to use as soon as it creates watchers, and it
1052might choose the wrong one unless you load the correct one yourself. 1093might choose the wrong one unless you load the correct one yourself.
1053 1094
1054You can chose to use a pure-perl implementation by loading the 1095You can chose to use a pure-perl implementation by loading the
1055C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1096C<AnyEvent::Loop> module, which gives you similar behaviour
1056everywhere, but letting AnyEvent chose the model is generally better. 1097everywhere, but letting AnyEvent chose the model is generally better.
1057 1098
1058=head2 MAINLOOP EMULATION 1099=head2 MAINLOOP EMULATION
1059 1100
1060Sometimes (often for short test scripts, or even standalone programs who 1101Sometimes (often for short test scripts, or even standalone programs who
1155 1196
1156package AnyEvent; 1197package AnyEvent;
1157 1198
1158# basically a tuned-down version of common::sense 1199# basically a tuned-down version of common::sense
1159sub common_sense { 1200sub common_sense {
1160 # from common:.sense 3.3 1201 # from common:.sense 3.4
1161 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; 1202 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1162 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) 1203 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1163 $^H |= 0x00000600; 1204 $^H |= 0x00000600;
1164} 1205}
1165 1206
1166BEGIN { AnyEvent::common_sense } 1207BEGIN { AnyEvent::common_sense }
1167 1208
1168use Carp (); 1209use Carp ();
1169 1210
1170our $VERSION = '5.271'; 1211our $VERSION = '6.01';
1171our $MODEL; 1212our $MODEL;
1172 1213
1173our $AUTOLOAD;
1174our @ISA; 1214our @ISA;
1175 1215
1176our @REGISTRY; 1216our @REGISTRY;
1177 1217
1178our $VERBOSE; 1218our $VERBOSE;
1198 $PROTOCOL{$_} = ++$idx 1238 $PROTOCOL{$_} = ++$idx
1199 for reverse split /\s*,\s*/, 1239 for reverse split /\s*,\s*/,
1200 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1240 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1201} 1241}
1202 1242
1243our @post_detect;
1244
1245sub post_detect(&) {
1246 my ($cb) = @_;
1247
1248 push @post_detect, $cb;
1249
1250 defined wantarray
1251 ? bless \$cb, "AnyEvent::Util::postdetect"
1252 : ()
1253}
1254
1255sub AnyEvent::Util::postdetect::DESTROY {
1256 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1257}
1258
1259our $POSTPONE_W;
1260our @POSTPONE;
1261
1262sub _postpone_exec {
1263 undef $POSTPONE_W;
1264
1265 &{ shift @POSTPONE }
1266 while @POSTPONE;
1267}
1268
1269sub postpone(&) {
1270 push @POSTPONE, shift;
1271
1272 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1273
1274 ()
1275}
1276
1203my @models = ( 1277our @models = (
1204 [EV:: => AnyEvent::Impl::EV:: , 1], 1278 [EV:: => AnyEvent::Impl::EV:: , 1],
1205 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1279 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1206 # everything below here will not (normally) be autoprobed 1280 # everything below here will not (normally) be autoprobed
1207 # as the pureperl backend should work everywhere 1281 # as the pure perl backend should work everywhere
1208 # and is usually faster 1282 # and is usually faster
1209 [Event:: => AnyEvent::Impl::Event::, 1], 1283 [Event:: => AnyEvent::Impl::Event::, 1],
1210 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1284 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1211 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1285 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1212 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1286 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1213 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1287 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1214 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1288 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1215 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1289 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1216 [Wx:: => AnyEvent::Impl::POE::], 1290 [Wx:: => AnyEvent::Impl::POE::],
1217 [Prima:: => AnyEvent::Impl::POE::], 1291 [Prima:: => AnyEvent::Impl::POE::],
1218 # IO::Async is just too broken - we would need workarounds for its 1292 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1219 # byzantine signal and broken child handling, among others. 1293 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1220 # IO::Async is rather hard to detect, as it doesn't have any 1294 [FLTK:: => AnyEvent::Impl::FLTK2::],
1221 # obvious default class.
1222 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1223 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1224 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1225 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1226); 1295);
1227 1296
1228our %method = map +($_ => 1), 1297our @isa_hook;
1298
1299sub _isa_set {
1300 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1301
1302 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1303 for 1 .. $#pkg;
1304
1305 grep $_ && $_->[1], @isa_hook
1306 and AE::_reset ();
1307}
1308
1309# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1310sub _isa_hook($$;$) {
1311 my ($i, $pkg, $reset_ae) = @_;
1312
1313 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1314
1315 _isa_set;
1316}
1317
1318# all autoloaded methods reserve the complete glob, not just the method slot.
1319# due to bugs in perls method cache implementation.
1229 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1320our @methods = qw(io timer time now now_update signal child idle condvar);
1230
1231our @post_detect;
1232
1233sub post_detect(&) {
1234 my ($cb) = @_;
1235
1236 push @post_detect, $cb;
1237
1238 defined wantarray
1239 ? bless \$cb, "AnyEvent::Util::postdetect"
1240 : ()
1241}
1242
1243sub AnyEvent::Util::postdetect::DESTROY {
1244 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1245}
1246 1321
1247sub detect() { 1322sub detect() {
1323 return $MODEL if $MODEL; # some programs keep references to detect
1324
1325 local $!; # for good measure
1326 local $SIG{__DIE__}; # we use eval
1327
1248 # free some memory 1328 # free some memory
1249 *detect = sub () { $MODEL }; 1329 *detect = sub () { $MODEL };
1330 # undef &func doesn't correctly update the method cache. grmbl.
1331 # so we delete the whole glob. grmbl.
1332 # otoh, perl doesn't let me undef an active usb, but it lets me free
1333 # a glob with an active sub. hrm. i hope it works, but perl is
1334 # usually buggy in this department. sigh.
1335 delete @{"AnyEvent::"}{@methods};
1336 undef @methods;
1250 1337
1251 local $!; # for good measure
1252 local $SIG{__DIE__};
1253
1254 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1338 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1255 my $model = "AnyEvent::Impl::$1"; 1339 my $model = $1;
1340 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1256 if (eval "require $model") { 1341 if (eval "require $model") {
1257 $MODEL = $model; 1342 $MODEL = $model;
1258 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1343 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1259 } else { 1344 } else {
1260 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1345 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1289 last; 1374 last;
1290 } 1375 }
1291 } 1376 }
1292 1377
1293 $MODEL 1378 $MODEL
1294 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1379 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1295 } 1380 }
1296 } 1381 }
1297 1382
1298 @models = (); # free probe data 1383 # free memory only needed for probing
1384 undef @models;
1385 undef @REGISTRY;
1299 1386
1300 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1387 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1301 unshift @ISA, $MODEL;
1302 1388
1303 # now nuke some methods that are overriden by the backend. 1389 # now nuke some methods that are overridden by the backend.
1304 # SUPER is not allowed. 1390 # SUPER usage is not allowed in these.
1305 for (qw(time signal child idle)) { 1391 for (qw(time signal child idle)) {
1306 undef &{"AnyEvent::Base::$_"} 1392 undef &{"AnyEvent::Base::$_"}
1307 if defined &{"$MODEL\::$_"}; 1393 if defined &{"$MODEL\::$_"};
1308 } 1394 }
1309 1395
1310 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; 1396 _isa_set;
1397
1398 if ($ENV{PERL_ANYEVENT_STRICT}) {
1399 require AnyEvent::Strict;
1400 }
1401
1402 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1403 require AnyEvent::Debug;
1404 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1405 }
1406
1407 if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1408 require AnyEvent::Socket;
1409 require AnyEvent::Debug;
1410
1411 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1412 $shell =~ s/\$\$/$$/g;
1413
1414 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1415 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1416 }
1311 1417
1312 (shift @post_detect)->() while @post_detect; 1418 (shift @post_detect)->() while @post_detect;
1419 undef @post_detect;
1313 1420
1314 *post_detect = sub(&) { 1421 *post_detect = sub(&) {
1315 shift->(); 1422 shift->();
1316 1423
1317 undef 1424 undef
1318 }; 1425 };
1319 1426
1320 $MODEL 1427 $MODEL
1321} 1428}
1322 1429
1323sub AUTOLOAD { 1430for my $name (@methods) {
1324 (my $func = $AUTOLOAD) =~ s/.*://; 1431 *$name = sub {
1325
1326 $method{$func}
1327 or Carp::croak "$func: not a valid AnyEvent class method";
1328
1329 detect; 1432 detect;
1330 1433 # we use goto because
1331 my $class = shift; 1434 # a) it makes the thunk more transparent
1332 $class->$func (@_); 1435 # b) it allows us to delete the thunk later
1436 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1437 };
1333} 1438}
1334 1439
1335# utility function to dup a filehandle. this is used by many backends 1440# utility function to dup a filehandle. this is used by many backends
1336# to support binding more than one watcher per filehandle (they usually 1441# to support binding more than one watcher per filehandle (they usually
1337# allow only one watcher per fd, so we dup it to get a different one). 1442# allow only one watcher per fd, so we dup it to get a different one).
1361 1466
1362package AE; 1467package AE;
1363 1468
1364our $VERSION = $AnyEvent::VERSION; 1469our $VERSION = $AnyEvent::VERSION;
1365 1470
1471sub _reset() {
1472 eval q{
1366# fall back to the main API by default - backends and AnyEvent::Base 1473 # fall back to the main API by default - backends and AnyEvent::Base
1367# implementations can overwrite these. 1474 # implementations can overwrite these.
1368 1475
1369sub io($$$) { 1476 sub io($$$) {
1370 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1477 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1371} 1478 }
1372 1479
1373sub timer($$$) { 1480 sub timer($$$) {
1374 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1481 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1375} 1482 }
1376 1483
1377sub signal($$) { 1484 sub signal($$) {
1378 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1485 AnyEvent->signal (signal => $_[0], cb => $_[1])
1379} 1486 }
1380 1487
1381sub child($$) { 1488 sub child($$) {
1382 AnyEvent->child (pid => $_[0], cb => $_[1]) 1489 AnyEvent->child (pid => $_[0], cb => $_[1])
1383} 1490 }
1384 1491
1385sub idle($) { 1492 sub idle($) {
1386 AnyEvent->idle (cb => $_[0]) 1493 AnyEvent->idle (cb => $_[0]);
1387} 1494 }
1388 1495
1389sub cv(;&) { 1496 sub cv(;&) {
1390 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1497 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1391} 1498 }
1392 1499
1393sub now() { 1500 sub now() {
1394 AnyEvent->now 1501 AnyEvent->now
1395} 1502 }
1396 1503
1397sub now_update() { 1504 sub now_update() {
1398 AnyEvent->now_update 1505 AnyEvent->now_update
1399} 1506 }
1400 1507
1401sub time() { 1508 sub time() {
1402 AnyEvent->time 1509 AnyEvent->time
1510 }
1511
1512 *postpone = \&AnyEvent::postpone;
1513 };
1514 die if $@;
1403} 1515}
1516
1517BEGIN { _reset }
1404 1518
1405package AnyEvent::Base; 1519package AnyEvent::Base;
1406 1520
1407# default implementations for many methods 1521# default implementations for many methods
1408 1522
1409sub time { 1523sub time {
1410 eval q{ # poor man's autoloading {} 1524 eval q{ # poor man's autoloading {}
1411 # probe for availability of Time::HiRes 1525 # probe for availability of Time::HiRes
1412 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1526 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1413 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1527 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1528 *time = sub { Time::HiRes::time () };
1414 *AE::time = \&Time::HiRes::time; 1529 *AE::time = \& Time::HiRes::time ;
1415 # if (eval "use POSIX (); (POSIX::times())... 1530 # if (eval "use POSIX (); (POSIX::times())...
1416 } else { 1531 } else {
1417 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1532 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1533 *time = sub { CORE::time };
1418 *AE::time = sub (){ time }; # epic fail 1534 *AE::time = sub (){ CORE::time };
1419 } 1535 }
1420 1536
1421 *time = sub { AE::time }; # different prototypes 1537 *now = \&time;
1422 }; 1538 };
1423 die if $@; 1539 die if $@;
1424 1540
1425 &time 1541 &time
1426} 1542}
1427 1543
1428*now = \&time; 1544*now = \&time;
1429
1430sub now_update { } 1545sub now_update { }
1431 1546
1547sub _poll {
1548 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1549}
1550
1432# default implementation for ->condvar 1551# default implementation for ->condvar
1552# in fact, the default should not be overwritten
1433 1553
1434sub condvar { 1554sub condvar {
1435 eval q{ # poor man's autoloading {} 1555 eval q{ # poor man's autoloading {}
1436 *condvar = sub { 1556 *condvar = sub {
1437 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1557 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1607 : sysread $SIGPIPE_R, (my $dummy), 9; 1727 : sysread $SIGPIPE_R, (my $dummy), 9;
1608 1728
1609 while (%SIG_EV) { 1729 while (%SIG_EV) {
1610 for (keys %SIG_EV) { 1730 for (keys %SIG_EV) {
1611 delete $SIG_EV{$_}; 1731 delete $SIG_EV{$_};
1612 $_->() for values %{ $SIG_CB{$_} || {} }; 1732 &$_ for values %{ $SIG_CB{$_} || {} };
1613 } 1733 }
1614 } 1734 }
1615 }; 1735 };
1616 }; 1736 };
1617 die if $@; 1737 die if $@;
1622# default implementation for ->child 1742# default implementation for ->child
1623 1743
1624our %PID_CB; 1744our %PID_CB;
1625our $CHLD_W; 1745our $CHLD_W;
1626our $CHLD_DELAY_W; 1746our $CHLD_DELAY_W;
1627our $WNOHANG;
1628 1747
1629# used by many Impl's 1748# used by many Impl's
1630sub _emit_childstatus($$) { 1749sub _emit_childstatus($$) {
1631 my (undef, $rpid, $rstatus) = @_; 1750 my (undef, $rpid, $rstatus) = @_;
1632 1751
1639 eval q{ # poor man's autoloading {} 1758 eval q{ # poor man's autoloading {}
1640 *_sigchld = sub { 1759 *_sigchld = sub {
1641 my $pid; 1760 my $pid;
1642 1761
1643 AnyEvent->_emit_childstatus ($pid, $?) 1762 AnyEvent->_emit_childstatus ($pid, $?)
1644 while ($pid = waitpid -1, $WNOHANG) > 0; 1763 while ($pid = waitpid -1, WNOHANG) > 0;
1645 }; 1764 };
1646 1765
1647 *child = sub { 1766 *child = sub {
1648 my (undef, %arg) = @_; 1767 my (undef, %arg) = @_;
1649 1768
1650 defined (my $pid = $arg{pid} + 0) 1769 my $pid = $arg{pid};
1651 or Carp::croak "required option 'pid' is missing"; 1770 my $cb = $arg{cb};
1652 1771
1653 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1772 $PID_CB{$pid}{$cb+0} = $cb;
1654
1655 # WNOHANG is almost cetrainly 1 everywhere
1656 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1657 ? 1
1658 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1659 1773
1660 unless ($CHLD_W) { 1774 unless ($CHLD_W) {
1661 $CHLD_W = AE::signal CHLD => \&_sigchld; 1775 $CHLD_W = AE::signal CHLD => \&_sigchld;
1662 # child could be a zombie already, so make at least one round 1776 # child could be a zombie already, so make at least one round
1663 &_sigchld; 1777 &_sigchld;
1664 } 1778 }
1665 1779
1666 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1780 bless [$pid, $cb+0], "AnyEvent::Base::child"
1667 }; 1781 };
1668 1782
1669 *AnyEvent::Base::child::DESTROY = sub { 1783 *AnyEvent::Base::child::DESTROY = sub {
1670 my ($pid, $cb) = @{$_[0]}; 1784 my ($pid, $icb) = @{$_[0]};
1671 1785
1672 delete $PID_CB{$pid}{$cb}; 1786 delete $PID_CB{$pid}{$icb};
1673 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1787 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1674 1788
1675 undef $CHLD_W unless keys %PID_CB; 1789 undef $CHLD_W unless keys %PID_CB;
1676 }; 1790 };
1677 }; 1791 };
1690 1804
1691 my ($cb, $w, $rcb) = $arg{cb}; 1805 my ($cb, $w, $rcb) = $arg{cb};
1692 1806
1693 $rcb = sub { 1807 $rcb = sub {
1694 if ($cb) { 1808 if ($cb) {
1695 $w = _time; 1809 $w = AE::time;
1696 &$cb; 1810 &$cb;
1697 $w = _time - $w; 1811 $w = AE::time - $w;
1698 1812
1699 # never use more then 50% of the time for the idle watcher, 1813 # never use more then 50% of the time for the idle watcher,
1700 # within some limits 1814 # within some limits
1701 $w = 0.0001 if $w < 0.0001; 1815 $w = 0.0001 if $w < 0.0001;
1702 $w = 5 if $w > 5; 1816 $w = 5 if $w > 5;
1725 1839
1726package AnyEvent::CondVar; 1840package AnyEvent::CondVar;
1727 1841
1728our @ISA = AnyEvent::CondVar::Base::; 1842our @ISA = AnyEvent::CondVar::Base::;
1729 1843
1844# only to be used for subclassing
1845sub new {
1846 my $class = shift;
1847 bless AnyEvent->condvar (@_), $class
1848}
1849
1730package AnyEvent::CondVar::Base; 1850package AnyEvent::CondVar::Base;
1731 1851
1732#use overload 1852#use overload
1733# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1853# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1734# fallback => 1; 1854# fallback => 1;
1743 1863
1744sub _send { 1864sub _send {
1745 # nop 1865 # nop
1746} 1866}
1747 1867
1868sub _wait {
1869 AnyEvent->_poll until $_[0]{_ae_sent};
1870}
1871
1748sub send { 1872sub send {
1749 my $cv = shift; 1873 my $cv = shift;
1750 $cv->{_ae_sent} = [@_]; 1874 $cv->{_ae_sent} = [@_];
1751 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1875 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1752 $cv->_send; 1876 $cv->_send;
1759 1883
1760sub ready { 1884sub ready {
1761 $_[0]{_ae_sent} 1885 $_[0]{_ae_sent}
1762} 1886}
1763 1887
1764sub _wait {
1765 $WAITING
1766 and !$_[0]{_ae_sent}
1767 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1768
1769 local $WAITING = 1;
1770 AnyEvent->one_event while !$_[0]{_ae_sent};
1771}
1772
1773sub recv { 1888sub recv {
1889 unless ($_[0]{_ae_sent}) {
1890 $WAITING
1891 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1892
1893 local $WAITING = 1;
1774 $_[0]->_wait; 1894 $_[0]->_wait;
1895 }
1775 1896
1776 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1897 $_[0]{_ae_croak}
1777 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1898 and Carp::croak $_[0]{_ae_croak};
1899
1900 wantarray
1901 ? @{ $_[0]{_ae_sent} }
1902 : $_[0]{_ae_sent}[0]
1778} 1903}
1779 1904
1780sub cb { 1905sub cb {
1781 my $cv = shift; 1906 my $cv = shift;
1782 1907
1798 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1923 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1799} 1924}
1800 1925
1801# undocumented/compatibility with pre-3.4 1926# undocumented/compatibility with pre-3.4
1802*broadcast = \&send; 1927*broadcast = \&send;
1803*wait = \&_wait; 1928*wait = \&recv;
1804 1929
1805=head1 ERROR AND EXCEPTION HANDLING 1930=head1 ERROR AND EXCEPTION HANDLING
1806 1931
1807In general, AnyEvent does not do any error handling - it relies on the 1932In general, AnyEvent does not do any error handling - it relies on the
1808caller to do that if required. The L<AnyEvent::Strict> module (see also 1933caller to do that if required. The L<AnyEvent::Strict> module (see also
1860Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 1985Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1861>>, it is definitely recommended to keep it off in production. Keeping 1986>>, it is definitely recommended to keep it off in production. Keeping
1862C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 1987C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1863can be very useful, however. 1988can be very useful, however.
1864 1989
1990=item C<PERL_ANYEVENT_DEBUG_SHELL>
1991
1992If this env variable is set, then its contents will be interpreted by
1993C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
1994C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
1995that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
1996
1997This takes place when the first watcher is created.
1998
1999For example, to bind a debug shell on a unix domain socket in
2000F<< /tmp/debug<pid>.sock >>, you could use this:
2001
2002 PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug\$\$.sock perlprog
2003
2004Note that creating sockets in F</tmp> is very unsafe on multiuser
2005systems.
2006
2007=item C<PERL_ANYEVENT_DEBUG_WRAP>
2008
2009Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2010debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2011
1865=item C<PERL_ANYEVENT_MODEL> 2012=item C<PERL_ANYEVENT_MODEL>
1866 2013
1867This can be used to specify the event model to be used by AnyEvent, before 2014This can be used to specify the event model to be used by AnyEvent, before
1868auto detection and -probing kicks in. It must be a string consisting 2015auto detection and -probing kicks in.
1869entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2016
2017It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2018or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1870and the resulting module name is loaded and if the load was successful, 2019resulting module name is loaded and - if the load was successful - used as
1871used as event model. If it fails to load AnyEvent will proceed with 2020event model backend. If it fails to load then AnyEvent will proceed with
1872auto detection and -probing. 2021auto detection and -probing.
1873 2022
1874This functionality might change in future versions. 2023If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2024nothing gets prepended and the module name is used as-is (hint: C<::> at
2025the end of a string designates a module name and quotes it appropriately).
1875 2026
1876For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2027For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1877could start your program like this: 2028could start your program like this:
1878 2029
1879 PERL_ANYEVENT_MODEL=Perl perl ... 2030 PERL_ANYEVENT_MODEL=Perl perl ...
1880 2031
1881=item C<PERL_ANYEVENT_PROTOCOLS> 2032=item C<PERL_ANYEVENT_PROTOCOLS>
2271(even when used without AnyEvent), but most event loops have acceptable 2422(even when used without AnyEvent), but most event loops have acceptable
2272performance with or without AnyEvent. 2423performance with or without AnyEvent.
2273 2424
2274=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2425=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2275the actual event loop, only with extremely fast event loops such as EV 2426the actual event loop, only with extremely fast event loops such as EV
2276adds AnyEvent significant overhead. 2427does AnyEvent add significant overhead.
2277 2428
2278=item * You should avoid POE like the plague if you want performance or 2429=item * You should avoid POE like the plague if you want performance or
2279reasonable memory usage. 2430reasonable memory usage.
2280 2431
2281=back 2432=back
2580 2731
2581=item L<Time::HiRes> 2732=item L<Time::HiRes>
2582 2733
2583This module is part of perl since release 5.008. It will be used when the 2734This module is part of perl since release 5.008. It will be used when the
2584chosen event library does not come with a timing source of its own. The 2735chosen event library does not come with a timing source of its own. The
2585pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2736pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2586try to use a monotonic clock for timing stability. 2737try to use a monotonic clock for timing stability.
2587 2738
2588=back 2739=back
2589 2740
2590 2741
2652pronounced). 2803pronounced).
2653 2804
2654 2805
2655=head1 SEE ALSO 2806=head1 SEE ALSO
2656 2807
2808Tutorial/Introduction: L<AnyEvent::Intro>.
2809
2810FAQ: L<AnyEvent::FAQ>.
2811
2657Utility functions: L<AnyEvent::Util>. 2812Utility functions: L<AnyEvent::Util>.
2658 2813
2659Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2814Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2660L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2815L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2661 2816
2662Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2817Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2663L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2818L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2664L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2819L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2665L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2820L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2667Non-blocking file handles, sockets, TCP clients and 2822Non-blocking file handles, sockets, TCP clients and
2668servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2823servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2669 2824
2670Asynchronous DNS: L<AnyEvent::DNS>. 2825Asynchronous DNS: L<AnyEvent::DNS>.
2671 2826
2672Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 2827Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2673L<Coro::Event>,
2674 2828
2675Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 2829Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2676L<AnyEvent::HTTP>. 2830L<AnyEvent::HTTP>.
2677 2831
2678 2832
2679=head1 AUTHOR 2833=head1 AUTHOR
2680 2834

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines