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.330 by root, Tue Aug 31 00:59:55 2010 UTC vs.
Revision 1.354 by root, Thu Aug 11 21:26:39 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>, 126following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
125L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, 127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
126L<POE>. The first one found is used. If none are found, the module tries 128found is used. If none are detected, the module tries to load the first
127to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl 129four modules in the order given; but note that if L<EV> is not
128adaptor should always succeed) in the order given. The first one that can 130available, the pure-perl L<AnyEvent::Loop> should always work, so
129be successfully loaded will be used. If, after this, still none could be 131the other two are not normally tried.
130found, AnyEvent will fall back to a pure-perl event loop, which is not
131very efficient, but should work everywhere.
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:
136 136
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::FLTK based on FLTK.
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 1.0 1197 # from common:.sense 3.4
1163 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\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; 1210our $AUTOLOAD;
1176our @ISA; 1211our @ISA;
1177 1212
1202 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1237 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1203} 1238}
1204 1239
1205my @models = ( 1240my @models = (
1206 [EV:: => AnyEvent::Impl::EV:: , 1], 1241 [EV:: => AnyEvent::Impl::EV:: , 1],
1207 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1242 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1208 # everything below here will not (normally) be autoprobed 1243 # everything below here will not (normally) be autoprobed
1209 # as the pureperl backend should work everywhere 1244 # as the pure perl backend should work everywhere
1210 # and is usually faster 1245 # and is usually faster
1211 [Event:: => AnyEvent::Impl::Event::, 1], 1246 [Event:: => AnyEvent::Impl::Event::, 1],
1212 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1247 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1213 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1248 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1214 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1249 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1215 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1250 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1216 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1251 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1217 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1252 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1218 [Wx:: => AnyEvent::Impl::POE::], 1253 [Wx:: => AnyEvent::Impl::POE::],
1219 [Prima:: => AnyEvent::Impl::POE::], 1254 [Prima:: => AnyEvent::Impl::POE::],
1220 # IO::Async is just too broken - we would need workarounds for its
1221 # byzantine signal and broken child handling, among others.
1222 # IO::Async is rather hard to detect, as it doesn't have any
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 1255 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],
1226 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1256 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1227 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program 1257 [FLTK:: => AnyEvent::Impl::FLTK::],
1228); 1258);
1229 1259
1230our %method = map +($_ => 1), 1260our %method = map +($_ => 1),
1231 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1261 qw(io timer time now now_update signal child idle condvar DESTROY);
1232 1262
1233our @post_detect; 1263our @post_detect;
1234 1264
1235sub post_detect(&) { 1265sub post_detect(&) {
1236 my ($cb) = @_; 1266 my ($cb) = @_;
1291 last; 1321 last;
1292 } 1322 }
1293 } 1323 }
1294 1324
1295 $MODEL 1325 $MODEL
1296 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1326 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1297 } 1327 }
1298 } 1328 }
1299 1329
1300 @models = (); # free probe data 1330 @models = (); # free probe data
1301 1331
1302 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1332 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1303 unshift @ISA, $MODEL; 1333 unshift @ISA, $MODEL;
1304 1334
1305 # now nuke some methods that are overriden by the backend. 1335 # now nuke some methods that are overridden by the backend.
1306 # SUPER is not allowed. 1336 # SUPER is not allowed.
1307 for (qw(time signal child idle)) { 1337 for (qw(time signal child idle)) {
1308 undef &{"AnyEvent::Base::$_"} 1338 undef &{"AnyEvent::Base::$_"}
1309 if defined &{"$MODEL\::$_"}; 1339 if defined &{"$MODEL\::$_"};
1310 } 1340 }
1311 1341
1312 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; 1342 if ($ENV{PERL_ANYEVENT_STRICT}) {
1343 eval { require AnyEvent::Strict };
1344 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1345 if $@ && $VERBOSE;
1346 }
1313 1347
1314 (shift @post_detect)->() while @post_detect; 1348 (shift @post_detect)->() while @post_detect;
1315 1349
1316 *post_detect = sub(&) { 1350 *post_detect = sub(&) {
1317 shift->(); 1351 shift->();
1330 1364
1331 detect; 1365 detect;
1332 1366
1333 my $class = shift; 1367 my $class = shift;
1334 $class->$func (@_); 1368 $class->$func (@_);
1369}
1370
1371our $POSTPONE_W;
1372our @POSTPONE;
1373
1374sub _postpone_exec {
1375 undef $POSTPONE_W;
1376 (pop @POSTPONE)->()
1377 while @POSTPONE;
1378}
1379
1380sub postpone(&) {
1381 push @POSTPONE, shift;
1382
1383 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1384
1385 ()
1335} 1386}
1336 1387
1337# utility function to dup a filehandle. this is used by many backends 1388# utility function to dup a filehandle. this is used by many backends
1338# to support binding more than one watcher per filehandle (they usually 1389# 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). 1390# allow only one watcher per fd, so we dup it to get a different one).
1401} 1452}
1402 1453
1403sub time() { 1454sub time() {
1404 AnyEvent->time 1455 AnyEvent->time
1405} 1456}
1457
1458*postpone = \&AnyEvent::postpone;
1406 1459
1407package AnyEvent::Base; 1460package AnyEvent::Base;
1408 1461
1409# default implementations for many methods 1462# default implementations for many methods
1410 1463
1429 1482
1430*now = \&time; 1483*now = \&time;
1431 1484
1432sub now_update { } 1485sub now_update { }
1433 1486
1487sub _poll {
1488 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1489}
1490
1434# default implementation for ->condvar 1491# default implementation for ->condvar
1492# in fact, the default should not be overwritten
1435 1493
1436sub condvar { 1494sub condvar {
1437 eval q{ # poor man's autoloading {} 1495 eval q{ # poor man's autoloading {}
1438 *condvar = sub { 1496 *condvar = sub {
1439 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1497 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1624# default implementation for ->child 1682# default implementation for ->child
1625 1683
1626our %PID_CB; 1684our %PID_CB;
1627our $CHLD_W; 1685our $CHLD_W;
1628our $CHLD_DELAY_W; 1686our $CHLD_DELAY_W;
1629our $WNOHANG;
1630 1687
1631# used by many Impl's 1688# used by many Impl's
1632sub _emit_childstatus($$) { 1689sub _emit_childstatus($$) {
1633 my (undef, $rpid, $rstatus) = @_; 1690 my (undef, $rpid, $rstatus) = @_;
1634 1691
1641 eval q{ # poor man's autoloading {} 1698 eval q{ # poor man's autoloading {}
1642 *_sigchld = sub { 1699 *_sigchld = sub {
1643 my $pid; 1700 my $pid;
1644 1701
1645 AnyEvent->_emit_childstatus ($pid, $?) 1702 AnyEvent->_emit_childstatus ($pid, $?)
1646 while ($pid = waitpid -1, $WNOHANG) > 0; 1703 while ($pid = waitpid -1, WNOHANG) > 0;
1647 }; 1704 };
1648 1705
1649 *child = sub { 1706 *child = sub {
1650 my (undef, %arg) = @_; 1707 my (undef, %arg) = @_;
1651 1708
1652 defined (my $pid = $arg{pid} + 0) 1709 my $pid = $arg{pid};
1653 or Carp::croak "required option 'pid' is missing"; 1710 my $cb = $arg{cb};
1654 1711
1655 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1712 $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 1713
1662 unless ($CHLD_W) { 1714 unless ($CHLD_W) {
1663 $CHLD_W = AE::signal CHLD => \&_sigchld; 1715 $CHLD_W = AE::signal CHLD => \&_sigchld;
1664 # child could be a zombie already, so make at least one round 1716 # child could be a zombie already, so make at least one round
1665 &_sigchld; 1717 &_sigchld;
1666 } 1718 }
1667 1719
1668 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1720 bless [$pid, $cb+0], "AnyEvent::Base::child"
1669 }; 1721 };
1670 1722
1671 *AnyEvent::Base::child::DESTROY = sub { 1723 *AnyEvent::Base::child::DESTROY = sub {
1672 my ($pid, $cb) = @{$_[0]}; 1724 my ($pid, $icb) = @{$_[0]};
1673 1725
1674 delete $PID_CB{$pid}{$cb}; 1726 delete $PID_CB{$pid}{$icb};
1675 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1727 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1676 1728
1677 undef $CHLD_W unless keys %PID_CB; 1729 undef $CHLD_W unless keys %PID_CB;
1678 }; 1730 };
1679 }; 1731 };
1727 1779
1728package AnyEvent::CondVar; 1780package AnyEvent::CondVar;
1729 1781
1730our @ISA = AnyEvent::CondVar::Base::; 1782our @ISA = AnyEvent::CondVar::Base::;
1731 1783
1784# only to be used for subclassing
1785sub new {
1786 my $class = shift;
1787 bless AnyEvent->condvar (@_), $class
1788}
1789
1732package AnyEvent::CondVar::Base; 1790package AnyEvent::CondVar::Base;
1733 1791
1734#use overload 1792#use overload
1735# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1793# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1736# fallback => 1; 1794# fallback => 1;
1745 1803
1746sub _send { 1804sub _send {
1747 # nop 1805 # nop
1748} 1806}
1749 1807
1808sub _wait {
1809 AnyEvent->_poll until $_[0]{_ae_sent};
1810}
1811
1750sub send { 1812sub send {
1751 my $cv = shift; 1813 my $cv = shift;
1752 $cv->{_ae_sent} = [@_]; 1814 $cv->{_ae_sent} = [@_];
1753 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1815 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1754 $cv->_send; 1816 $cv->_send;
1761 1823
1762sub ready { 1824sub ready {
1763 $_[0]{_ae_sent} 1825 $_[0]{_ae_sent}
1764} 1826}
1765 1827
1766sub _wait {
1767 $WAITING
1768 and !$_[0]{_ae_sent}
1769 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1770
1771 local $WAITING = 1;
1772 AnyEvent->one_event while !$_[0]{_ae_sent};
1773}
1774
1775sub recv { 1828sub recv {
1829 unless ($_[0]{_ae_sent}) {
1830 $WAITING
1831 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1832
1833 local $WAITING = 1;
1776 $_[0]->_wait; 1834 $_[0]->_wait;
1835 }
1777 1836
1778 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1837 $_[0]{_ae_croak}
1779 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1838 and Carp::croak $_[0]{_ae_croak};
1839
1840 wantarray
1841 ? @{ $_[0]{_ae_sent} }
1842 : $_[0]{_ae_sent}[0]
1780} 1843}
1781 1844
1782sub cb { 1845sub cb {
1783 my $cv = shift; 1846 my $cv = shift;
1784 1847
1800 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1863 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1801} 1864}
1802 1865
1803# undocumented/compatibility with pre-3.4 1866# undocumented/compatibility with pre-3.4
1804*broadcast = \&send; 1867*broadcast = \&send;
1805*wait = \&_wait; 1868*wait = \&recv;
1806 1869
1807=head1 ERROR AND EXCEPTION HANDLING 1870=head1 ERROR AND EXCEPTION HANDLING
1808 1871
1809In general, AnyEvent does not do any error handling - it relies on the 1872In general, AnyEvent does not do any error handling - it relies on the
1810caller to do that if required. The L<AnyEvent::Strict> module (see also 1873caller to do that if required. The L<AnyEvent::Strict> module (see also
1873used as event model. If it fails to load AnyEvent will proceed with 1936used as event model. If it fails to load AnyEvent will proceed with
1874auto detection and -probing. 1937auto detection and -probing.
1875 1938
1876This functionality might change in future versions. 1939This functionality might change in future versions.
1877 1940
1878For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1941For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1879could start your program like this: 1942could start your program like this:
1880 1943
1881 PERL_ANYEVENT_MODEL=Perl perl ... 1944 PERL_ANYEVENT_MODEL=Perl perl ...
1882 1945
1883=item C<PERL_ANYEVENT_PROTOCOLS> 1946=item C<PERL_ANYEVENT_PROTOCOLS>
2582 2645
2583=item L<Time::HiRes> 2646=item L<Time::HiRes>
2584 2647
2585This module is part of perl since release 5.008. It will be used when the 2648This module is part of perl since release 5.008. It will be used when the
2586chosen event library does not come with a timing source of its own. The 2649chosen event library does not come with a timing source of its own. The
2587pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2650pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2588try to use a monotonic clock for timing stability. 2651try to use a monotonic clock for timing stability.
2589 2652
2590=back 2653=back
2591 2654
2592 2655
2654pronounced). 2717pronounced).
2655 2718
2656 2719
2657=head1 SEE ALSO 2720=head1 SEE ALSO
2658 2721
2722Tutorial/Introduction: L<AnyEvent::Intro>.
2723
2724FAQ: L<AnyEvent::FAQ>.
2725
2659Utility functions: L<AnyEvent::Util>. 2726Utility functions: L<AnyEvent::Util>.
2660 2727
2661Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2728Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
2662L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2729L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2663 2730
2664Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2731Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2665L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2732L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2666L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2733L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2667L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2734L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2669Non-blocking file handles, sockets, TCP clients and 2736Non-blocking file handles, sockets, TCP clients and
2670servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2737servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2671 2738
2672Asynchronous DNS: L<AnyEvent::DNS>. 2739Asynchronous DNS: L<AnyEvent::DNS>.
2673 2740
2674Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 2741Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2675L<Coro::Event>,
2676 2742
2677Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 2743Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2678L<AnyEvent::HTTP>. 2744L<AnyEvent::HTTP>.
2679 2745
2680 2746
2681=head1 AUTHOR 2747=head1 AUTHOR
2682 2748

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines