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.348 by root, Thu Feb 24 12:04:20 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
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.
879 883
880=item Backends with special needs. 884=item Backends with special needs.
881 885
882Qt requires the Qt::Application to be instantiated first, but will 886Qt requires the Qt::Application to be instantiated first, but will
883otherwise be picked up automatically. As long as the main program 887otherwise be picked up automatically. As long as the main program
884instantiates the application before any AnyEvent watchers are created, 888instantiates the application before any AnyEvent watchers are created,
885everything should just work. 889everything should just work.
886 890
887 AnyEvent::Impl::Qt based on Qt. 891 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 892
897=item Event loops that are indirectly supported via other backends. 893=item Event loops that are indirectly supported via other backends.
898 894
899Some event loops can be supported via other modules: 895Some event loops can be supported via other modules:
900 896
1155 1151
1156package AnyEvent; 1152package AnyEvent;
1157 1153
1158# basically a tuned-down version of common::sense 1154# basically a tuned-down version of common::sense
1159sub common_sense { 1155sub common_sense {
1160 # from common:.sense 3.3 1156 # from common:.sense 3.4
1161 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; 1157 ${^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) 1158 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1163 $^H |= 0x00000600; 1159 $^H |= 0x00000600;
1164} 1160}
1165 1161
1166BEGIN { AnyEvent::common_sense } 1162BEGIN { AnyEvent::common_sense }
1167 1163
1168use Carp (); 1164use Carp ();
1169 1165
1170our $VERSION = '5.271'; 1166our $VERSION = '5.33';
1171our $MODEL; 1167our $MODEL;
1172 1168
1173our $AUTOLOAD; 1169our $AUTOLOAD;
1174our @ISA; 1170our @ISA;
1175 1171
1213 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1209 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1214 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1210 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1215 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1211 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1216 [Wx:: => AnyEvent::Impl::POE::], 1212 [Wx:: => AnyEvent::Impl::POE::],
1217 [Prima:: => AnyEvent::Impl::POE::], 1213 [Prima:: => AnyEvent::Impl::POE::],
1218 # IO::Async is just too broken - we would need workarounds for its
1219 # byzantine signal and broken child handling, among others.
1220 # IO::Async is rather hard to detect, as it doesn't have any
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 1214 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],
1224 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1215 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1225 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1226); 1216);
1227 1217
1228our %method = map +($_ => 1), 1218our %method = map +($_ => 1),
1229 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1219 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1230 1220
1289 last; 1279 last;
1290 } 1280 }
1291 } 1281 }
1292 1282
1293 $MODEL 1283 $MODEL
1294 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1284 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1295 } 1285 }
1296 } 1286 }
1297 1287
1298 @models = (); # free probe data 1288 @models = (); # free probe data
1299 1289
1300 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1290 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1301 unshift @ISA, $MODEL; 1291 unshift @ISA, $MODEL;
1302 1292
1303 # now nuke some methods that are overriden by the backend. 1293 # now nuke some methods that are overridden by the backend.
1304 # SUPER is not allowed. 1294 # SUPER is not allowed.
1305 for (qw(time signal child idle)) { 1295 for (qw(time signal child idle)) {
1306 undef &{"AnyEvent::Base::$_"} 1296 undef &{"AnyEvent::Base::$_"}
1307 if defined &{"$MODEL\::$_"}; 1297 if defined &{"$MODEL\::$_"};
1308 } 1298 }
1309 1299
1310 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; 1300 if ($ENV{PERL_ANYEVENT_STRICT}) {
1301 eval { require AnyEvent::Strict };
1302 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1303 if $@ && $VERBOSE;
1304 }
1311 1305
1312 (shift @post_detect)->() while @post_detect; 1306 (shift @post_detect)->() while @post_detect;
1313 1307
1314 *post_detect = sub(&) { 1308 *post_detect = sub(&) {
1315 shift->(); 1309 shift->();
1622# default implementation for ->child 1616# default implementation for ->child
1623 1617
1624our %PID_CB; 1618our %PID_CB;
1625our $CHLD_W; 1619our $CHLD_W;
1626our $CHLD_DELAY_W; 1620our $CHLD_DELAY_W;
1627our $WNOHANG;
1628 1621
1629# used by many Impl's 1622# used by many Impl's
1630sub _emit_childstatus($$) { 1623sub _emit_childstatus($$) {
1631 my (undef, $rpid, $rstatus) = @_; 1624 my (undef, $rpid, $rstatus) = @_;
1632 1625
1639 eval q{ # poor man's autoloading {} 1632 eval q{ # poor man's autoloading {}
1640 *_sigchld = sub { 1633 *_sigchld = sub {
1641 my $pid; 1634 my $pid;
1642 1635
1643 AnyEvent->_emit_childstatus ($pid, $?) 1636 AnyEvent->_emit_childstatus ($pid, $?)
1644 while ($pid = waitpid -1, $WNOHANG) > 0; 1637 while ($pid = waitpid -1, WNOHANG) > 0;
1645 }; 1638 };
1646 1639
1647 *child = sub { 1640 *child = sub {
1648 my (undef, %arg) = @_; 1641 my (undef, %arg) = @_;
1649 1642
1650 defined (my $pid = $arg{pid} + 0) 1643 defined (my $pid = $arg{pid} + 0)
1651 or Carp::croak "required option 'pid' is missing"; 1644 or Carp::croak "required option 'pid' is missing";
1652 1645
1653 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1646 $PID_CB{$pid}{$arg{cb}} = $arg{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 1647
1660 unless ($CHLD_W) { 1648 unless ($CHLD_W) {
1661 $CHLD_W = AE::signal CHLD => \&_sigchld; 1649 $CHLD_W = AE::signal CHLD => \&_sigchld;
1662 # child could be a zombie already, so make at least one round 1650 # child could be a zombie already, so make at least one round
1663 &_sigchld; 1651 &_sigchld;
1724} 1712}
1725 1713
1726package AnyEvent::CondVar; 1714package AnyEvent::CondVar;
1727 1715
1728our @ISA = AnyEvent::CondVar::Base::; 1716our @ISA = AnyEvent::CondVar::Base::;
1717
1718# only to be used for subclassing
1719sub new {
1720 my $class = shift;
1721 bless AnyEvent->condvar (@_), $class
1722}
1729 1723
1730package AnyEvent::CondVar::Base; 1724package AnyEvent::CondVar::Base;
1731 1725
1732#use overload 1726#use overload
1733# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1727# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
2652pronounced). 2646pronounced).
2653 2647
2654 2648
2655=head1 SEE ALSO 2649=head1 SEE ALSO
2656 2650
2651Tutorial/Introduction: L<AnyEvent::Intro>.
2652
2653FAQ: L<AnyEvent::FAQ>.
2654
2657Utility functions: L<AnyEvent::Util>. 2655Utility functions: L<AnyEvent::Util>.
2658 2656
2659Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2657Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
2660L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2658L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2661 2659
2667Non-blocking file handles, sockets, TCP clients and 2665Non-blocking file handles, sockets, TCP clients and
2668servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2666servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2669 2667
2670Asynchronous DNS: L<AnyEvent::DNS>. 2668Asynchronous DNS: L<AnyEvent::DNS>.
2671 2669
2672Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 2670Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2673L<Coro::Event>,
2674 2671
2675Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 2672Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2676L<AnyEvent::HTTP>. 2673L<AnyEvent::HTTP>.
2677 2674
2678 2675
2679=head1 AUTHOR 2676=head1 AUTHOR
2680 2677

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines