1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - events independent of event loop implementation |
3 | AnyEvent - the DBI of event loop programming |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt |
6 | event loops. |
6 | and 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 | |
48 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
48 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
49 | channel, too. |
49 | channel, too. |
50 | |
50 | |
51 | See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software |
51 | See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software |
52 | Respository>, at L<http://anyevent.schmorp.de>, for more info. |
52 | Repository>, 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 | |
56 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
56 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
57 | nowadays. So what is different about AnyEvent? |
57 | nowadays. So what is different about AnyEvent? |
… | |
… | |
400 | |
400 | |
401 | =head2 CHILD PROCESS WATCHERS |
401 | =head2 CHILD PROCESS WATCHERS |
402 | |
402 | |
403 | You can also watch on a child process exit and catch its exit status. |
403 | You can also watch on a child process exit and catch its exit status. |
404 | |
404 | |
405 | The child process is specified by the C<pid> argument (if set to C<0>, it |
405 | The child process is specified by the C<pid> argument (one some backends, |
406 | watches for any child process exit). The watcher will triggered only when |
406 | using C<0> watches for any child process exit, on others this will |
407 | the child process has finished and an exit status is available, not on |
407 | croak). The watcher will be triggered only when the child process has |
408 | any trace events (stopped/continued). |
408 | finished and an exit status is available, not on any trace events |
|
|
409 | (stopped/continued). |
409 | |
410 | |
410 | The callback will be called with the pid and exit status (as returned by |
411 | The callback will be called with the pid and exit status (as returned by |
411 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
412 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
412 | callback arguments. |
413 | callback 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 | |
804 | Qt requires the Qt::Application to be instantiated first, but will |
806 | Qt requires the Qt::Application to be instantiated first, but will |
805 | otherwise be picked up automatically. As long as the main program |
807 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
879 | event module detection too early, for example, L<AnyEvent::AIO> creates |
881 | event module detection too early, for example, L<AnyEvent::AIO> creates |
880 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
882 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
881 | avoid autodetecting the event module at load time. |
883 | avoid autodetecting the event module at load time. |
882 | |
884 | |
883 | If called in scalar or list context, then it creates and returns an object |
885 | If called in scalar or list context, then it creates and returns an object |
884 | that automatically removes the callback again when it is destroyed. See |
886 | that automatically removes the callback again when it is destroyed (or |
|
|
887 | C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for |
885 | L<Coro::BDB> for a case where this is useful. |
888 | a case where this is useful. |
|
|
889 | |
|
|
890 | Example: Create a watcher for the IO::AIO module and store it in |
|
|
891 | C<$WATCHER>. Only do so after the event loop is initialised, though. |
|
|
892 | |
|
|
893 | our WATCHER; |
|
|
894 | |
|
|
895 | my $guard = AnyEvent::post_detect { |
|
|
896 | $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); |
|
|
897 | }; |
|
|
898 | |
|
|
899 | # the ||= is important in case post_detect immediately runs the block, |
|
|
900 | # as to not clobber the newly-created watcher. assigning both watcher and |
|
|
901 | # post_detect guard to the same variable has the advantage of users being |
|
|
902 | # able to just C<undef $WATCHER> if the watcher causes them grief. |
|
|
903 | |
|
|
904 | $WATCHER ||= $guard; |
886 | |
905 | |
887 | =item @AnyEvent::post_detect |
906 | =item @AnyEvent::post_detect |
888 | |
907 | |
889 | If there are any code references in this array (you can C<push> to it |
908 | If there are any code references in this array (you can C<push> to it |
890 | before or after loading AnyEvent), then they will called directly after |
909 | before or after loading AnyEvent), then they will called directly after |
… | |
… | |
1067 | |
1086 | |
1068 | BEGIN { AnyEvent::common_sense } |
1087 | BEGIN { AnyEvent::common_sense } |
1069 | |
1088 | |
1070 | use Carp (); |
1089 | use Carp (); |
1071 | |
1090 | |
1072 | our $VERSION = 4.86; |
1091 | our $VERSION = 4.881; |
1073 | our $MODEL; |
1092 | our $MODEL; |
1074 | |
1093 | |
1075 | our $AUTOLOAD; |
1094 | our $AUTOLOAD; |
1076 | our @ISA; |
1095 | our @ISA; |
1077 | |
1096 | |
… | |
… | |
1102 | for reverse split /\s*,\s*/, |
1121 | for reverse split /\s*,\s*/, |
1103 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1122 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1104 | } |
1123 | } |
1105 | |
1124 | |
1106 | my @models = ( |
1125 | my @models = ( |
1107 | [EV:: => AnyEvent::Impl::EV::], |
1126 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1108 | [Event:: => AnyEvent::Impl::Event::], |
1127 | [Event:: => AnyEvent::Impl::Event::, 1], |
1109 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1128 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1110 | # everything below here will not be autoprobed |
1129 | # everything below here will not (normally) be autoprobed |
1111 | # as the pureperl backend should work everywhere |
1130 | # as the pureperl backend should work everywhere |
1112 | # and is usually faster |
1131 | # and is usually faster |
1113 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1132 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1114 | [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 |
1115 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1135 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1116 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1136 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1117 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1137 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1118 | [Wx:: => AnyEvent::Impl::POE::], |
1138 | [Wx:: => AnyEvent::Impl::POE::], |
1119 | [Prima:: => AnyEvent::Impl::POE::], |
1139 | [Prima:: => AnyEvent::Impl::POE::], |
1120 | # 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 |
1121 | # byzantine signal and broken child handling, among others. |
1141 | # byzantine signal and broken child handling, among others. |
1122 | # 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 |
1123 | # obvious default class. |
1143 | # obvious default class. |
1124 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1144 | # [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1125 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1145 | # [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1126 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1146 | # [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1127 | ); |
1147 | ); |
1128 | |
1148 | |
1129 | our %method = map +($_ => 1), |
1149 | our %method = map +($_ => 1), |
1130 | 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); |
1131 | |
1151 | |
… | |
… | |
1135 | my ($cb) = @_; |
1155 | my ($cb) = @_; |
1136 | |
1156 | |
1137 | if ($MODEL) { |
1157 | if ($MODEL) { |
1138 | $cb->(); |
1158 | $cb->(); |
1139 | |
1159 | |
1140 | 1 |
1160 | undef |
1141 | } else { |
1161 | } else { |
1142 | push @post_detect, $cb; |
1162 | push @post_detect, $cb; |
1143 | |
1163 | |
1144 | defined wantarray |
1164 | defined wantarray |
1145 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1165 | ? bless \$cb, "AnyEvent::Util::postdetect" |
… | |
… | |
1177 | } |
1197 | } |
1178 | } |
1198 | } |
1179 | } |
1199 | } |
1180 | |
1200 | |
1181 | unless ($MODEL) { |
1201 | unless ($MODEL) { |
1182 | # try to load a model |
1202 | # try to autoload a model |
1183 | |
|
|
1184 | for (@REGISTRY, @models) { |
1203 | for (@REGISTRY, @models) { |
1185 | my ($package, $model) = @$_; |
1204 | my ($package, $model, $autoload) = @$_; |
|
|
1205 | if ( |
|
|
1206 | $autoload |
1186 | if (eval "require $package" |
1207 | and eval "require $package" |
1187 | and ${"$package\::VERSION"} > 0 |
1208 | and ${"$package\::VERSION"} > 0 |
1188 | and eval "require $model") { |
1209 | and eval "require $model" |
|
|
1210 | ) { |
1189 | $MODEL = $model; |
1211 | $MODEL = $model; |
1190 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; |
1212 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1191 | last; |
1213 | last; |
1192 | } |
1214 | } |
1193 | } |
1215 | } |
1194 | |
1216 | |
1195 | $MODEL |
1217 | $MODEL |
… | |
… | |
1267 | } |
1289 | } |
1268 | |
1290 | |
1269 | # default implementation for ->signal |
1291 | # default implementation for ->signal |
1270 | |
1292 | |
1271 | our $HAVE_ASYNC_INTERRUPT; |
1293 | our $HAVE_ASYNC_INTERRUPT; |
|
|
1294 | |
|
|
1295 | sub _have_async_interrupt() { |
|
|
1296 | $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} |
|
|
1297 | && eval "use Async::Interrupt 1.0 (); 1") |
|
|
1298 | unless defined $HAVE_ASYNC_INTERRUPT; |
|
|
1299 | |
|
|
1300 | $HAVE_ASYNC_INTERRUPT |
|
|
1301 | } |
|
|
1302 | |
1272 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1303 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1273 | our (%SIG_ASY, %SIG_ASY_W); |
1304 | our (%SIG_ASY, %SIG_ASY_W); |
1274 | our ($SIG_COUNT, $SIG_TW); |
1305 | our ($SIG_COUNT, $SIG_TW); |
1275 | |
1306 | |
1276 | sub _signal_exec { |
1307 | sub _signal_exec { |
… | |
… | |
1284 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1315 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1285 | } |
1316 | } |
1286 | } |
1317 | } |
1287 | } |
1318 | } |
1288 | |
1319 | |
1289 | # install a dumym wakeupw atcher to reduce signal catching latency |
1320 | # install a dummy wakeup watcher to reduce signal catching latency |
1290 | sub _sig_add() { |
1321 | sub _sig_add() { |
1291 | unless ($SIG_COUNT++) { |
1322 | unless ($SIG_COUNT++) { |
1292 | # try to align timer on a full-second boundary, if possible |
1323 | # try to align timer on a full-second boundary, if possible |
1293 | my $NOW = AnyEvent->now; |
1324 | my $NOW = AnyEvent->now; |
1294 | |
1325 | |
… | |
… | |
1303 | sub _sig_del { |
1334 | sub _sig_del { |
1304 | undef $SIG_TW |
1335 | undef $SIG_TW |
1305 | unless --$SIG_COUNT; |
1336 | unless --$SIG_COUNT; |
1306 | } |
1337 | } |
1307 | |
1338 | |
|
|
1339 | our %SIGNAME2NUM; |
|
|
1340 | our @SIGNUM2NAME; |
|
|
1341 | our $_sig_name_init; $_sig_name_init = sub { |
|
|
1342 | undef $_sig_name_init; |
|
|
1343 | |
|
|
1344 | if (_have_async_interrupt) { |
|
|
1345 | *sig2num = \&Async::Interrupt::sig2num; |
|
|
1346 | *sig2name = \&Async::Interrupt::sig2name; |
|
|
1347 | } else { |
|
|
1348 | require Config; |
|
|
1349 | |
|
|
1350 | @SIGNAME2NUM{ split ' ', $Config::Config{sig_name} } |
|
|
1351 | = split ' ', $Config::Config{sig_num}; |
|
|
1352 | @SIGNUM2NAME[values %SIGNAME2NUM] = keys %SIGNAME2NUM; |
|
|
1353 | |
|
|
1354 | *sig2num = sub($) { |
|
|
1355 | $_[0] > 0 ? shift : $SIGNAME2NUM{+shift} |
|
|
1356 | }; |
|
|
1357 | *sig2name = sub ($) { |
|
|
1358 | $_[0] > 0 ? $SIGNUM2NAME[+shift] : shift |
|
|
1359 | }; |
|
|
1360 | } |
|
|
1361 | }; |
|
|
1362 | |
|
|
1363 | sub sig2num ($) { &$_sig_name_init; &sig2num } |
|
|
1364 | sub sig2name($) { &$_sig_name_init; &sig2name } |
|
|
1365 | |
1308 | sub _signal { |
1366 | sub _signal { |
1309 | my (undef, %arg) = @_; |
1367 | my (undef, %arg) = @_; |
1310 | |
1368 | |
1311 | my $signal = uc $arg{signal} |
1369 | my $signal = uc $arg{signal} |
1312 | or Carp::croak "required option 'signal' is missing"; |
1370 | or Carp::croak "required option 'signal' is missing"; |
1313 | |
1371 | |
1314 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1315 | |
|
|
1316 | if ($HAVE_ASYNC_INTERRUPT) { |
1372 | if ($HAVE_ASYNC_INTERRUPT) { |
1317 | # async::interrupt |
1373 | # async::interrupt |
1318 | |
1374 | |
1319 | $SIG_ASY{$signal} ||= do { |
1375 | $signal = sig2num $signal; |
1320 | my $asy = new Async::Interrupt |
1376 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1377 | |
|
|
1378 | $SIG_ASY{$signal} ||= new Async::Interrupt |
1321 | cb => sub { undef $SIG_EV{$signal} }, |
1379 | cb => sub { undef $SIG_EV{$signal} }, |
1322 | signal => $signal, |
1380 | signal => $signal, |
1323 | pipe => [$SIGPIPE_R->filenos], |
1381 | pipe => [$SIGPIPE_R->filenos], |
1324 | ; |
|
|
1325 | $asy->pipe_autodrain (0); |
1382 | pipe_autodrain => 0, |
1326 | |
|
|
1327 | $asy |
|
|
1328 | }; |
1383 | ; |
1329 | |
1384 | |
1330 | } else { |
1385 | } else { |
1331 | # pure perl |
1386 | # pure perl |
|
|
1387 | |
|
|
1388 | # AE::Util has been loaded in signal |
|
|
1389 | $signal = sig2name $signal; |
|
|
1390 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1332 | |
1391 | |
1333 | $SIG{$signal} ||= sub { |
1392 | $SIG{$signal} ||= sub { |
1334 | local $!; |
1393 | local $!; |
1335 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1394 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1336 | undef $SIG_EV{$signal}; |
1395 | undef $SIG_EV{$signal}; |
… | |
… | |
1344 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1403 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1345 | } |
1404 | } |
1346 | |
1405 | |
1347 | sub signal { |
1406 | sub signal { |
1348 | # probe for availability of Async::Interrupt |
1407 | # probe for availability of Async::Interrupt |
1349 | if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { |
1408 | if (_have_async_interrupt) { |
1350 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1409 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1351 | |
1410 | |
1352 | $HAVE_ASYNC_INTERRUPT = 1; |
|
|
1353 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1411 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1354 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
1412 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
1355 | |
1413 | |
1356 | } else { |
1414 | } else { |
1357 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1415 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
… | |
… | |
1405 | our %PID_CB; |
1463 | our %PID_CB; |
1406 | our $CHLD_W; |
1464 | our $CHLD_W; |
1407 | our $CHLD_DELAY_W; |
1465 | our $CHLD_DELAY_W; |
1408 | our $WNOHANG; |
1466 | our $WNOHANG; |
1409 | |
1467 | |
|
|
1468 | sub _emit_childstatus($$) { |
|
|
1469 | my (undef, $rpid, $rstatus) = @_; |
|
|
1470 | |
|
|
1471 | $_->($rpid, $rstatus) |
|
|
1472 | for values %{ $PID_CB{$rpid} || {} }, |
|
|
1473 | values %{ $PID_CB{0} || {} }; |
|
|
1474 | } |
|
|
1475 | |
1410 | sub _sigchld { |
1476 | sub _sigchld { |
|
|
1477 | my $pid; |
|
|
1478 | |
|
|
1479 | AnyEvent->_emit_childstatus ($pid, $?) |
1411 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1480 | while ($pid = waitpid -1, $WNOHANG) > 0; |
1412 | $_->($pid, $?) |
|
|
1413 | for values %{ $PID_CB{$pid} || {} }, |
|
|
1414 | values %{ $PID_CB{0} || {} }; |
|
|
1415 | } |
|
|
1416 | } |
1481 | } |
1417 | |
1482 | |
1418 | sub child { |
1483 | sub child { |
1419 | my (undef, %arg) = @_; |
1484 | my (undef, %arg) = @_; |
1420 | |
1485 | |
… | |
… | |
2399 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2464 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2400 | |
2465 | |
2401 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2466 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2402 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2467 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2403 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2468 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2404 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
2469 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2405 | |
2470 | |
2406 | Non-blocking file handles, sockets, TCP clients and |
2471 | Non-blocking file handles, sockets, TCP clients and |
2407 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2472 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2408 | |
2473 | |
2409 | Asynchronous DNS: L<AnyEvent::DNS>. |
2474 | Asynchronous DNS: L<AnyEvent::DNS>. |