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.253 by root, Tue Jul 21 06:00:47 2009 UTC vs.
Revision 1.262 by root, Tue Jul 28 13:08:17 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - events independent of event loop implementation 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6event loops. 6and POE are various supported event loops/environments.
7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
… …
47 47
48There is a mailinglist for discussing all things AnyEvent, and an IRC 48There is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too. 49channel, too.
50 50
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software 51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Respository>, at L<http://anyevent.schmorp.de>, for more info. 52Repository>, at L<http://anyevent.schmorp.de>, for more info.
53 53
54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
55 55
56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
57nowadays. So what is different about AnyEvent? 57nowadays. So what is different about AnyEvent?
… …
400 400
401=head2 CHILD PROCESS WATCHERS 401=head2 CHILD PROCESS WATCHERS
402 402
403You can also watch on a child process exit and catch its exit status. 403You can also watch on a child process exit and catch its exit status.
404 404
405The child process is specified by the C<pid> argument (if set to C<0>, it 405The child process is specified by the C<pid> argument (one some backends,
406watches for any child process exit). The watcher will triggered only when 406using C<0> watches for any child process exit, on others this will
407the child process has finished and an exit status is available, not on 407croak). The watcher will be triggered only when the child process has
408any trace events (stopped/continued). 408finished and an exit status is available, not on any trace events
409(stopped/continued).
409 410
410The callback will be called with the pid and exit status (as returned by 411The callback will be called with the pid and exit status (as returned by
411waitpid), so unlike other watcher types, you I<can> rely on child watcher 412waitpid), so unlike other watcher types, you I<can> rely on child watcher
412callback arguments. 413callback arguments.
413 414
… …
796 797
797 AnyEvent::Impl::Glib based on Glib, slow but very stable. 798 AnyEvent::Impl::Glib based on Glib, slow but very stable.
798 AnyEvent::Impl::Tk based on Tk, very broken. 799 AnyEvent::Impl::Tk based on Tk, very broken.
799 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 800 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
800 AnyEvent::Impl::POE based on POE, very slow, some limitations. 801 AnyEvent::Impl::POE based on POE, very slow, some limitations.
802 AnyEvent::Impl::Irssi used when running within irssi.
801 803
802=item Backends with special needs. 804=item Backends with special needs.
803 805
804Qt requires the Qt::Application to be instantiated first, but will 806Qt requires the Qt::Application to be instantiated first, but will
805otherwise be picked up automatically. As long as the main program 807otherwise be picked up automatically. As long as the main program
… …
1084 1086
1085BEGIN { AnyEvent::common_sense } 1087BEGIN { AnyEvent::common_sense }
1086 1088
1087use Carp (); 1089use Carp ();
1088 1090
1089our $VERSION = 4.86; 1091our $VERSION = 4.881;
1090our $MODEL; 1092our $MODEL;
1091 1093
1092our $AUTOLOAD; 1094our $AUTOLOAD;
1093our @ISA; 1095our @ISA;
1094 1096
… …
1119 for reverse split /\s*,\s*/, 1121 for reverse split /\s*,\s*/,
1120 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1122 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1121} 1123}
1122 1124
1123my @models = ( 1125my @models = (
1124 [EV:: => AnyEvent::Impl::EV::], 1126 [EV:: => AnyEvent::Impl::EV:: , 1],
1125 [Event:: => AnyEvent::Impl::Event::], 1127 [Event:: => AnyEvent::Impl::Event::, 1],
1126 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1128 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1127 # everything below here will not be autoprobed 1129 # everything below here will not (normally) be autoprobed
1128 # as the pureperl backend should work everywhere 1130 # as the pureperl backend should work everywhere
1129 # and is usually faster 1131 # and is usually faster
1130 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1132 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1131 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1133 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1132 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1135 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1133 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1136 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1134 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1137 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1135 [Wx:: => AnyEvent::Impl::POE::], 1138 [Wx:: => AnyEvent::Impl::POE::],
1136 [Prima:: => AnyEvent::Impl::POE::], 1139 [Prima:: => AnyEvent::Impl::POE::],
1137 # IO::Async is just too broken - we would need workarounds for its 1140 # IO::Async is just too broken - we would need workarounds for its
1138 # byzantine signal and broken child handling, among others. 1141 # byzantine signal and broken child handling, among others.
1139 # IO::Async is rather hard to detect, as it doesn't have any 1142 # IO::Async is rather hard to detect, as it doesn't have any
1140 # obvious default class. 1143 # obvious default class.
1141# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1144# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1142# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1145# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1143# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1146# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1144); 1147);
1145 1148
1146our %method = map +($_ => 1), 1149our %method = map +($_ => 1),
1147 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1150 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1148 1151
… …
1194 } 1197 }
1195 } 1198 }
1196 } 1199 }
1197 1200
1198 unless ($MODEL) { 1201 unless ($MODEL) {
1199 # try to load a model 1202 # try to autoload a model
1200
1201 for (@REGISTRY, @models) { 1203 for (@REGISTRY, @models) {
1202 my ($package, $model) = @$_; 1204 my ($package, $model, $autoload) = @$_;
1205 if (
1206 $autoload
1203 if (eval "require $package" 1207 and eval "require $package"
1204 and ${"$package\::VERSION"} > 0 1208 and ${"$package\::VERSION"} > 0
1205 and eval "require $model") { 1209 and eval "require $model"
1210 ) {
1206 $MODEL = $model; 1211 $MODEL = $model;
1207 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; 1212 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1208 last; 1213 last;
1209 } 1214 }
1210 } 1215 }
1211 1216
1212 $MODEL 1217 $MODEL
… …
1301 $_->() for values %{ $SIG_CB{$_} || {} }; 1306 $_->() for values %{ $SIG_CB{$_} || {} };
1302 } 1307 }
1303 } 1308 }
1304} 1309}
1305 1310
1306# install a dumym wakeupw atcher to reduce signal catching latency 1311# install a dummy wakeup watcher to reduce signal catching latency
1307sub _sig_add() { 1312sub _sig_add() {
1308 unless ($SIG_COUNT++) { 1313 unless ($SIG_COUNT++) {
1309 # try to align timer on a full-second boundary, if possible 1314 # try to align timer on a full-second boundary, if possible
1310 my $NOW = AnyEvent->now; 1315 my $NOW = AnyEvent->now;
1311 1316
… …
1326 my (undef, %arg) = @_; 1331 my (undef, %arg) = @_;
1327 1332
1328 my $signal = uc $arg{signal} 1333 my $signal = uc $arg{signal}
1329 or Carp::croak "required option 'signal' is missing"; 1334 or Carp::croak "required option 'signal' is missing";
1330 1335
1331 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1332
1333 if ($HAVE_ASYNC_INTERRUPT) { 1336 if ($HAVE_ASYNC_INTERRUPT) {
1334 # async::interrupt 1337 # async::interrupt
1335 1338
1336 $SIG_ASY{$signal} ||= do { 1339 $signal = Async::Interrupt::sig2num ($signal);
1337 my $asy = new Async::Interrupt 1340 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1341
1342 $SIG_ASY{$signal} ||= new Async::Interrupt
1338 cb => sub { undef $SIG_EV{$signal} }, 1343 cb => sub { undef $SIG_EV{$signal} },
1339 signal => $signal, 1344 signal => $signal,
1340 pipe => [$SIGPIPE_R->filenos], 1345 pipe => [$SIGPIPE_R->filenos],
1341 ;
1342 $asy->pipe_autodrain (0); 1346 pipe_autodrain => 0,
1343
1344 $asy
1345 }; 1347 ;
1346 1348
1347 } else { 1349 } else {
1348 # pure perl 1350 # pure perl
1351
1352 # AE::Util has been loaded in signal
1353 $signal = AnyEvent::Util::sig2name ($signal);
1354 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1349 1355
1350 $SIG{$signal} ||= sub { 1356 $SIG{$signal} ||= sub {
1351 local $!; 1357 local $!;
1352 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1358 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1353 undef $SIG_EV{$signal}; 1359 undef $SIG_EV{$signal};
… …
1361 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1367 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1362} 1368}
1363 1369
1364sub signal { 1370sub signal {
1365 # probe for availability of Async::Interrupt 1371 # probe for availability of Async::Interrupt
1366 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { 1372 if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 1.0 (); 1") {
1367 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1373 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1368 1374
1369 $HAVE_ASYNC_INTERRUPT = 1; 1375 $HAVE_ASYNC_INTERRUPT = 1;
1370 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1376 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1371 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1377 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
… …
1422our %PID_CB; 1428our %PID_CB;
1423our $CHLD_W; 1429our $CHLD_W;
1424our $CHLD_DELAY_W; 1430our $CHLD_DELAY_W;
1425our $WNOHANG; 1431our $WNOHANG;
1426 1432
1433sub _emit_childstatus($$) {
1434 my (undef, $rpid, $rstatus) = @_;
1435
1436 $_->($rpid, $rstatus)
1437 for values %{ $PID_CB{$rpid} || {} },
1438 values %{ $PID_CB{0} || {} };
1439}
1440
1427sub _sigchld { 1441sub _sigchld {
1442 my $pid;
1443
1444 AnyEvent->_emit_childstatus ($pid, $?)
1428 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1445 while ($pid = waitpid -1, $WNOHANG) > 0;
1429 $_->($pid, $?)
1430 for values %{ $PID_CB{$pid} || {} },
1431 values %{ $PID_CB{0} || {} };
1432 }
1433} 1446}
1434 1447
1435sub child { 1448sub child {
1436 my (undef, %arg) = @_; 1449 my (undef, %arg) = @_;
1437 1450
… …
2416L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2429L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2417 2430
2418Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2431Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2419L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2432L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2420L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2433L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2421L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2434L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2422 2435
2423Non-blocking file handles, sockets, TCP clients and 2436Non-blocking file handles, sockets, TCP clients and
2424servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2437servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2425 2438
2426Asynchronous DNS: L<AnyEvent::DNS>. 2439Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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