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? |
… | |
… | |
181 | my variables are only visible after the statement in which they are |
181 | my variables are only visible after the statement in which they are |
182 | declared. |
182 | declared. |
183 | |
183 | |
184 | =head2 I/O WATCHERS |
184 | =head2 I/O WATCHERS |
185 | |
185 | |
|
|
186 | $w = AnyEvent->io ( |
|
|
187 | fh => <filehandle_or_fileno>, |
|
|
188 | poll => <"r" or "w">, |
|
|
189 | cb => <callback>, |
|
|
190 | ); |
|
|
191 | |
186 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
192 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
187 | with the following mandatory key-value pairs as arguments: |
193 | with the following mandatory key-value pairs as arguments: |
188 | |
194 | |
189 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
195 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
190 | for events (AnyEvent might or might not keep a reference to this file |
196 | for events (AnyEvent might or might not keep a reference to this file |
… | |
… | |
219 | undef $w; |
225 | undef $w; |
220 | }); |
226 | }); |
221 | |
227 | |
222 | =head2 TIME WATCHERS |
228 | =head2 TIME WATCHERS |
223 | |
229 | |
|
|
230 | $w = AnyEvent->timer (after => <seconds>, cb => <callback>); |
|
|
231 | |
|
|
232 | $w = AnyEvent->timer ( |
|
|
233 | after => <fractional_seconds>, |
|
|
234 | interval => <fractional_seconds>, |
|
|
235 | cb => <callback>, |
|
|
236 | ); |
|
|
237 | |
224 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
238 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
225 | method with the following mandatory arguments: |
239 | method with the following mandatory arguments: |
226 | |
240 | |
227 | C<after> specifies after how many seconds (fractional values are |
241 | C<after> specifies after how many seconds (fractional values are |
228 | supported) the callback should be invoked. C<cb> is the callback to invoke |
242 | supported) the callback should be invoked. C<cb> is the callback to invoke |
… | |
… | |
354 | Note that updating the time I<might> cause some events to be handled. |
368 | Note that updating the time I<might> cause some events to be handled. |
355 | |
369 | |
356 | =back |
370 | =back |
357 | |
371 | |
358 | =head2 SIGNAL WATCHERS |
372 | =head2 SIGNAL WATCHERS |
|
|
373 | |
|
|
374 | $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>); |
359 | |
375 | |
360 | You can watch for signals using a signal watcher, C<signal> is the signal |
376 | You can watch for signals using a signal watcher, C<signal> is the signal |
361 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
377 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
362 | callback to be invoked whenever a signal occurs. |
378 | callback to be invoked whenever a signal occurs. |
363 | |
379 | |
… | |
… | |
398 | currently, as POE does it's own workaround with one-second latency). With |
414 | currently, as POE does it's own workaround with one-second latency). With |
399 | those, you just have to suffer the delays. |
415 | those, you just have to suffer the delays. |
400 | |
416 | |
401 | =head2 CHILD PROCESS WATCHERS |
417 | =head2 CHILD PROCESS WATCHERS |
402 | |
418 | |
|
|
419 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
|
|
420 | |
403 | You can also watch on a child process exit and catch its exit status. |
421 | You can also watch on a child process exit and catch its exit status. |
404 | |
422 | |
405 | The child process is specified by the C<pid> argument (if set to C<0>, it |
423 | 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 |
424 | 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 |
425 | croak). The watcher will be triggered only when the child process has |
408 | any trace events (stopped/continued). |
426 | finished and an exit status is available, not on any trace events |
|
|
427 | (stopped/continued). |
409 | |
428 | |
410 | The callback will be called with the pid and exit status (as returned by |
429 | 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 |
430 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
412 | callback arguments. |
431 | callback arguments. |
413 | |
432 | |
… | |
… | |
454 | # do something else, then wait for process exit |
473 | # do something else, then wait for process exit |
455 | $done->recv; |
474 | $done->recv; |
456 | |
475 | |
457 | =head2 IDLE WATCHERS |
476 | =head2 IDLE WATCHERS |
458 | |
477 | |
|
|
478 | $w = AnyEvent->idle (cb => <callback>); |
|
|
479 | |
459 | Sometimes there is a need to do something, but it is not so important |
480 | Sometimes there is a need to do something, but it is not so important |
460 | to do it instantly, but only when there is nothing better to do. This |
481 | to do it instantly, but only when there is nothing better to do. This |
461 | "nothing better to do" is usually defined to be "no other events need |
482 | "nothing better to do" is usually defined to be "no other events need |
462 | attention by the event loop". |
483 | attention by the event loop". |
463 | |
484 | |
… | |
… | |
489 | }); |
510 | }); |
490 | }); |
511 | }); |
491 | |
512 | |
492 | =head2 CONDITION VARIABLES |
513 | =head2 CONDITION VARIABLES |
493 | |
514 | |
|
|
515 | $cv = AnyEvent->condvar; |
|
|
516 | |
|
|
517 | $cv->send (<list>); |
|
|
518 | my @res = $cv->recv; |
|
|
519 | |
494 | If you are familiar with some event loops you will know that all of them |
520 | If you are familiar with some event loops you will know that all of them |
495 | require you to run some blocking "loop", "run" or similar function that |
521 | require you to run some blocking "loop", "run" or similar function that |
496 | will actively watch for new events and call your callbacks. |
522 | will actively watch for new events and call your callbacks. |
497 | |
523 | |
498 | AnyEvent is slightly different: it expects somebody else to run the event |
524 | AnyEvent is slightly different: it expects somebody else to run the event |
… | |
… | |
796 | |
822 | |
797 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
823 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
798 | AnyEvent::Impl::Tk based on Tk, very broken. |
824 | AnyEvent::Impl::Tk based on Tk, very broken. |
799 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
825 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
800 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
826 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
827 | AnyEvent::Impl::Irssi used when running within irssi. |
801 | |
828 | |
802 | =item Backends with special needs. |
829 | =item Backends with special needs. |
803 | |
830 | |
804 | Qt requires the Qt::Application to be instantiated first, but will |
831 | Qt requires the Qt::Application to be instantiated first, but will |
805 | otherwise be picked up automatically. As long as the main program |
832 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
879 | event module detection too early, for example, L<AnyEvent::AIO> creates |
906 | 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 |
907 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
881 | avoid autodetecting the event module at load time. |
908 | avoid autodetecting the event module at load time. |
882 | |
909 | |
883 | If called in scalar or list context, then it creates and returns an object |
910 | 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 |
911 | that automatically removes the callback again when it is destroyed (or |
|
|
912 | C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for |
885 | L<Coro::BDB> for a case where this is useful. |
913 | a case where this is useful. |
|
|
914 | |
|
|
915 | Example: Create a watcher for the IO::AIO module and store it in |
|
|
916 | C<$WATCHER>. Only do so after the event loop is initialised, though. |
|
|
917 | |
|
|
918 | our WATCHER; |
|
|
919 | |
|
|
920 | my $guard = AnyEvent::post_detect { |
|
|
921 | $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); |
|
|
922 | }; |
|
|
923 | |
|
|
924 | # the ||= is important in case post_detect immediately runs the block, |
|
|
925 | # as to not clobber the newly-created watcher. assigning both watcher and |
|
|
926 | # post_detect guard to the same variable has the advantage of users being |
|
|
927 | # able to just C<undef $WATCHER> if the watcher causes them grief. |
|
|
928 | |
|
|
929 | $WATCHER ||= $guard; |
886 | |
930 | |
887 | =item @AnyEvent::post_detect |
931 | =item @AnyEvent::post_detect |
888 | |
932 | |
889 | If there are any code references in this array (you can C<push> to it |
933 | 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 |
934 | before or after loading AnyEvent), then they will called directly after |
… | |
… | |
1067 | |
1111 | |
1068 | BEGIN { AnyEvent::common_sense } |
1112 | BEGIN { AnyEvent::common_sense } |
1069 | |
1113 | |
1070 | use Carp (); |
1114 | use Carp (); |
1071 | |
1115 | |
1072 | our $VERSION = 4.86; |
1116 | our $VERSION = 4.881; |
1073 | our $MODEL; |
1117 | our $MODEL; |
1074 | |
1118 | |
1075 | our $AUTOLOAD; |
1119 | our $AUTOLOAD; |
1076 | our @ISA; |
1120 | our @ISA; |
1077 | |
1121 | |
… | |
… | |
1102 | for reverse split /\s*,\s*/, |
1146 | for reverse split /\s*,\s*/, |
1103 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1147 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1104 | } |
1148 | } |
1105 | |
1149 | |
1106 | my @models = ( |
1150 | my @models = ( |
1107 | [EV:: => AnyEvent::Impl::EV::], |
1151 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1108 | [Event:: => AnyEvent::Impl::Event::], |
1152 | [Event:: => AnyEvent::Impl::Event::, 1], |
1109 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1153 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1110 | # everything below here will not be autoprobed |
1154 | # everything below here will not (normally) be autoprobed |
1111 | # as the pureperl backend should work everywhere |
1155 | # as the pureperl backend should work everywhere |
1112 | # and is usually faster |
1156 | # and is usually faster |
1113 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1157 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1114 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1158 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1159 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1115 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1160 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1116 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1161 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1117 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1162 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1118 | [Wx:: => AnyEvent::Impl::POE::], |
1163 | [Wx:: => AnyEvent::Impl::POE::], |
1119 | [Prima:: => AnyEvent::Impl::POE::], |
1164 | [Prima:: => AnyEvent::Impl::POE::], |
1120 | # IO::Async is just too broken - we would need workarounds for its |
1165 | # IO::Async is just too broken - we would need workarounds for its |
1121 | # byzantine signal and broken child handling, among others. |
1166 | # byzantine signal and broken child handling, among others. |
1122 | # IO::Async is rather hard to detect, as it doesn't have any |
1167 | # IO::Async is rather hard to detect, as it doesn't have any |
1123 | # obvious default class. |
1168 | # obvious default class. |
1124 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1169 | # [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1125 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1170 | # [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1126 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1171 | # [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1127 | ); |
1172 | ); |
1128 | |
1173 | |
1129 | our %method = map +($_ => 1), |
1174 | our %method = map +($_ => 1), |
1130 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1175 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1131 | |
1176 | |
… | |
… | |
1135 | my ($cb) = @_; |
1180 | my ($cb) = @_; |
1136 | |
1181 | |
1137 | if ($MODEL) { |
1182 | if ($MODEL) { |
1138 | $cb->(); |
1183 | $cb->(); |
1139 | |
1184 | |
1140 | 1 |
1185 | undef |
1141 | } else { |
1186 | } else { |
1142 | push @post_detect, $cb; |
1187 | push @post_detect, $cb; |
1143 | |
1188 | |
1144 | defined wantarray |
1189 | defined wantarray |
1145 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1190 | ? bless \$cb, "AnyEvent::Util::postdetect" |
… | |
… | |
1177 | } |
1222 | } |
1178 | } |
1223 | } |
1179 | } |
1224 | } |
1180 | |
1225 | |
1181 | unless ($MODEL) { |
1226 | unless ($MODEL) { |
1182 | # try to load a model |
1227 | # try to autoload a model |
1183 | |
|
|
1184 | for (@REGISTRY, @models) { |
1228 | for (@REGISTRY, @models) { |
1185 | my ($package, $model) = @$_; |
1229 | my ($package, $model, $autoload) = @$_; |
|
|
1230 | if ( |
|
|
1231 | $autoload |
1186 | if (eval "require $package" |
1232 | and eval "require $package" |
1187 | and ${"$package\::VERSION"} > 0 |
1233 | and ${"$package\::VERSION"} > 0 |
1188 | and eval "require $model") { |
1234 | and eval "require $model" |
|
|
1235 | ) { |
1189 | $MODEL = $model; |
1236 | $MODEL = $model; |
1190 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; |
1237 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1191 | last; |
1238 | last; |
1192 | } |
1239 | } |
1193 | } |
1240 | } |
1194 | |
1241 | |
1195 | $MODEL |
1242 | $MODEL |
… | |
… | |
1267 | } |
1314 | } |
1268 | |
1315 | |
1269 | # default implementation for ->signal |
1316 | # default implementation for ->signal |
1270 | |
1317 | |
1271 | our $HAVE_ASYNC_INTERRUPT; |
1318 | our $HAVE_ASYNC_INTERRUPT; |
|
|
1319 | |
|
|
1320 | sub _have_async_interrupt() { |
|
|
1321 | $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} |
|
|
1322 | && eval "use Async::Interrupt 1.0 (); 1") |
|
|
1323 | unless defined $HAVE_ASYNC_INTERRUPT; |
|
|
1324 | |
|
|
1325 | $HAVE_ASYNC_INTERRUPT |
|
|
1326 | } |
|
|
1327 | |
1272 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1328 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1273 | our (%SIG_ASY, %SIG_ASY_W); |
1329 | our (%SIG_ASY, %SIG_ASY_W); |
1274 | our ($SIG_COUNT, $SIG_TW); |
1330 | our ($SIG_COUNT, $SIG_TW); |
1275 | |
1331 | |
1276 | sub _signal_exec { |
1332 | sub _signal_exec { |
… | |
… | |
1284 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1340 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1285 | } |
1341 | } |
1286 | } |
1342 | } |
1287 | } |
1343 | } |
1288 | |
1344 | |
1289 | # install a dumym wakeupw atcher to reduce signal catching latency |
1345 | # install a dummy wakeup watcher to reduce signal catching latency |
1290 | sub _sig_add() { |
1346 | sub _sig_add() { |
1291 | unless ($SIG_COUNT++) { |
1347 | unless ($SIG_COUNT++) { |
1292 | # try to align timer on a full-second boundary, if possible |
1348 | # try to align timer on a full-second boundary, if possible |
1293 | my $NOW = AnyEvent->now; |
1349 | my $NOW = AnyEvent->now; |
1294 | |
1350 | |
… | |
… | |
1303 | sub _sig_del { |
1359 | sub _sig_del { |
1304 | undef $SIG_TW |
1360 | undef $SIG_TW |
1305 | unless --$SIG_COUNT; |
1361 | unless --$SIG_COUNT; |
1306 | } |
1362 | } |
1307 | |
1363 | |
|
|
1364 | our $_sig_name_init; $_sig_name_init = sub { |
|
|
1365 | eval q{ # poor man's autoloading |
|
|
1366 | undef $_sig_name_init; |
|
|
1367 | |
|
|
1368 | if (_have_async_interrupt) { |
|
|
1369 | *sig2num = \&Async::Interrupt::sig2num; |
|
|
1370 | *sig2name = \&Async::Interrupt::sig2name; |
|
|
1371 | } else { |
|
|
1372 | require Config; |
|
|
1373 | |
|
|
1374 | my %signame2num; |
|
|
1375 | @signame2num{ split ' ', $Config::Config{sig_name} } |
|
|
1376 | = split ' ', $Config::Config{sig_num}; |
|
|
1377 | |
|
|
1378 | my @signum2name; |
|
|
1379 | @signum2name[values %signame2num] = keys %signame2num; |
|
|
1380 | |
|
|
1381 | *sig2num = sub($) { |
|
|
1382 | $_[0] > 0 ? shift : $signame2num{+shift} |
|
|
1383 | }; |
|
|
1384 | *sig2name = sub ($) { |
|
|
1385 | $_[0] > 0 ? $signum2name[+shift] : shift |
|
|
1386 | }; |
|
|
1387 | } |
|
|
1388 | }; |
|
|
1389 | die if $@; |
|
|
1390 | }; |
|
|
1391 | |
|
|
1392 | sub sig2num ($) { &$_sig_name_init; &sig2num } |
|
|
1393 | sub sig2name($) { &$_sig_name_init; &sig2name } |
|
|
1394 | |
1308 | sub _signal { |
1395 | sub signal { |
|
|
1396 | eval q{ # poor man's autoloading {} |
|
|
1397 | # probe for availability of Async::Interrupt |
|
|
1398 | if (_have_async_interrupt) { |
|
|
1399 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
|
|
1400 | |
|
|
1401 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1402 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
|
|
1403 | |
|
|
1404 | } else { |
|
|
1405 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1406 | |
|
|
1407 | require Fcntl; |
|
|
1408 | |
|
|
1409 | if (AnyEvent::WIN32) { |
|
|
1410 | require AnyEvent::Util; |
|
|
1411 | |
|
|
1412 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1413 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; |
|
|
1414 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case |
|
|
1415 | } else { |
|
|
1416 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1417 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1418 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1419 | |
|
|
1420 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1421 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1422 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1423 | } |
|
|
1424 | |
|
|
1425 | $SIGPIPE_R |
|
|
1426 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1427 | |
|
|
1428 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1429 | } |
|
|
1430 | |
|
|
1431 | *signal = sub { |
1309 | my (undef, %arg) = @_; |
1432 | my (undef, %arg) = @_; |
1310 | |
1433 | |
1311 | my $signal = uc $arg{signal} |
1434 | my $signal = uc $arg{signal} |
1312 | or Carp::croak "required option 'signal' is missing"; |
1435 | or Carp::croak "required option 'signal' is missing"; |
1313 | |
1436 | |
1314 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1315 | |
|
|
1316 | if ($HAVE_ASYNC_INTERRUPT) { |
1437 | if ($HAVE_ASYNC_INTERRUPT) { |
1317 | # async::interrupt |
1438 | # async::interrupt |
1318 | |
1439 | |
1319 | $SIG_ASY{$signal} ||= do { |
1440 | $signal = sig2num $signal; |
1320 | my $asy = new Async::Interrupt |
1441 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1442 | |
|
|
1443 | $SIG_ASY{$signal} ||= new Async::Interrupt |
1321 | cb => sub { undef $SIG_EV{$signal} }, |
1444 | cb => sub { undef $SIG_EV{$signal} }, |
1322 | signal => $signal, |
1445 | signal => $signal, |
1323 | pipe => [$SIGPIPE_R->filenos], |
1446 | pipe => [$SIGPIPE_R->filenos], |
|
|
1447 | pipe_autodrain => 0, |
|
|
1448 | ; |
|
|
1449 | |
|
|
1450 | } else { |
|
|
1451 | # pure perl |
|
|
1452 | |
|
|
1453 | # AE::Util has been loaded in signal |
|
|
1454 | $signal = sig2name $signal; |
|
|
1455 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1456 | |
|
|
1457 | $SIG{$signal} ||= sub { |
|
|
1458 | local $!; |
|
|
1459 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1460 | undef $SIG_EV{$signal}; |
|
|
1461 | }; |
|
|
1462 | |
|
|
1463 | # can't do signal processing without introducing races in pure perl, |
|
|
1464 | # so limit the signal latency. |
|
|
1465 | _sig_add; |
1324 | ; |
1466 | } |
1325 | $asy->pipe_autodrain (0); |
|
|
1326 | |
1467 | |
1327 | $asy |
1468 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1328 | }; |
1469 | }; |
1329 | |
1470 | |
1330 | } else { |
1471 | *AnyEvent::Base::signal::DESTROY = sub { |
1331 | # pure perl |
1472 | my ($signal, $cb) = @{$_[0]}; |
1332 | |
1473 | |
1333 | $SIG{$signal} ||= sub { |
1474 | _sig_del; |
1334 | local $!; |
1475 | |
1335 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1476 | delete $SIG_CB{$signal}{$cb}; |
|
|
1477 | |
|
|
1478 | $HAVE_ASYNC_INTERRUPT |
|
|
1479 | ? delete $SIG_ASY{$signal} |
|
|
1480 | : # delete doesn't work with older perls - they then |
|
|
1481 | # print weird messages, or just unconditionally exit |
|
|
1482 | # instead of getting the default action. |
1336 | undef $SIG_EV{$signal}; |
1483 | undef $SIG{$signal} |
|
|
1484 | unless keys %{ $SIG_CB{$signal} }; |
1337 | }; |
1485 | }; |
1338 | |
|
|
1339 | # can't do signal processing without introducing races in pure perl, |
|
|
1340 | # so limit the signal latency. |
|
|
1341 | _sig_add; |
|
|
1342 | } |
1486 | }; |
1343 | |
1487 | die if $@; |
1344 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1345 | } |
|
|
1346 | |
|
|
1347 | sub signal { |
|
|
1348 | # probe for availability of Async::Interrupt |
|
|
1349 | if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { |
|
|
1350 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
|
|
1351 | |
|
|
1352 | $HAVE_ASYNC_INTERRUPT = 1; |
|
|
1353 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1354 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
|
|
1355 | |
|
|
1356 | } else { |
|
|
1357 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1358 | |
|
|
1359 | require Fcntl; |
|
|
1360 | |
|
|
1361 | if (AnyEvent::WIN32) { |
|
|
1362 | require AnyEvent::Util; |
|
|
1363 | |
|
|
1364 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1365 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1366 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1367 | } else { |
|
|
1368 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1369 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1370 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1371 | |
|
|
1372 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1373 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1374 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1375 | } |
|
|
1376 | |
|
|
1377 | $SIGPIPE_R |
|
|
1378 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1379 | |
|
|
1380 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1381 | } |
|
|
1382 | |
|
|
1383 | *signal = \&_signal; |
|
|
1384 | &signal |
1488 | &signal |
1385 | } |
|
|
1386 | |
|
|
1387 | sub AnyEvent::Base::signal::DESTROY { |
|
|
1388 | my ($signal, $cb) = @{$_[0]}; |
|
|
1389 | |
|
|
1390 | _sig_del; |
|
|
1391 | |
|
|
1392 | delete $SIG_CB{$signal}{$cb}; |
|
|
1393 | |
|
|
1394 | $HAVE_ASYNC_INTERRUPT |
|
|
1395 | ? delete $SIG_ASY{$signal} |
|
|
1396 | : # delete doesn't work with older perls - they then |
|
|
1397 | # print weird messages, or just unconditionally exit |
|
|
1398 | # instead of getting the default action. |
|
|
1399 | undef $SIG{$signal} |
|
|
1400 | unless keys %{ $SIG_CB{$signal} }; |
|
|
1401 | } |
1489 | } |
1402 | |
1490 | |
1403 | # default implementation for ->child |
1491 | # default implementation for ->child |
1404 | |
1492 | |
1405 | our %PID_CB; |
1493 | our %PID_CB; |
1406 | our $CHLD_W; |
1494 | our $CHLD_W; |
1407 | our $CHLD_DELAY_W; |
1495 | our $CHLD_DELAY_W; |
1408 | our $WNOHANG; |
1496 | our $WNOHANG; |
1409 | |
1497 | |
|
|
1498 | sub _emit_childstatus($$) { |
|
|
1499 | my (undef, $rpid, $rstatus) = @_; |
|
|
1500 | |
|
|
1501 | $_->($rpid, $rstatus) |
|
|
1502 | for values %{ $PID_CB{$rpid} || {} }, |
|
|
1503 | values %{ $PID_CB{0} || {} }; |
|
|
1504 | } |
|
|
1505 | |
1410 | sub _sigchld { |
1506 | sub _sigchld { |
|
|
1507 | my $pid; |
|
|
1508 | |
|
|
1509 | AnyEvent->_emit_childstatus ($pid, $?) |
1411 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1510 | while ($pid = waitpid -1, $WNOHANG) > 0; |
1412 | $_->($pid, $?) |
|
|
1413 | for values %{ $PID_CB{$pid} || {} }, |
|
|
1414 | values %{ $PID_CB{0} || {} }; |
|
|
1415 | } |
|
|
1416 | } |
1511 | } |
1417 | |
1512 | |
1418 | sub child { |
1513 | sub child { |
1419 | my (undef, %arg) = @_; |
1514 | my (undef, %arg) = @_; |
1420 | |
1515 | |
… | |
… | |
1552 | } |
1647 | } |
1553 | |
1648 | |
1554 | # undocumented/compatibility with pre-3.4 |
1649 | # undocumented/compatibility with pre-3.4 |
1555 | *broadcast = \&send; |
1650 | *broadcast = \&send; |
1556 | *wait = \&_wait; |
1651 | *wait = \&_wait; |
|
|
1652 | |
|
|
1653 | ############################################################################# |
|
|
1654 | # "new" API, currently only emulation of it |
|
|
1655 | ############################################################################# |
|
|
1656 | |
|
|
1657 | package AE; |
|
|
1658 | |
|
|
1659 | sub io($$$) { |
|
|
1660 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
|
|
1661 | } |
|
|
1662 | |
|
|
1663 | sub timer($$$) { |
|
|
1664 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]); |
|
|
1665 | } |
|
|
1666 | |
|
|
1667 | sub signal($$) { |
|
|
1668 | AnyEvent->signal (signal => $_[0], cb => $_[1]); |
|
|
1669 | } |
|
|
1670 | |
|
|
1671 | sub child($$) { |
|
|
1672 | AnyEvent->child (pid => $_[0], cb => $_[1]); |
|
|
1673 | } |
|
|
1674 | |
|
|
1675 | sub idle($) { |
|
|
1676 | AnyEvent->idle (cb => $_[0]); |
|
|
1677 | } |
|
|
1678 | |
|
|
1679 | sub cv() { |
|
|
1680 | AnyEvent->condvar |
|
|
1681 | } |
|
|
1682 | |
|
|
1683 | sub now() { |
|
|
1684 | AnyEvent->now |
|
|
1685 | } |
|
|
1686 | |
|
|
1687 | sub now_update() { |
|
|
1688 | AnyEvent->now_update |
|
|
1689 | } |
|
|
1690 | |
|
|
1691 | sub time() { |
|
|
1692 | AnyEvent->time |
|
|
1693 | } |
1557 | |
1694 | |
1558 | =head1 ERROR AND EXCEPTION HANDLING |
1695 | =head1 ERROR AND EXCEPTION HANDLING |
1559 | |
1696 | |
1560 | In general, AnyEvent does not do any error handling - it relies on the |
1697 | In general, AnyEvent does not do any error handling - it relies on the |
1561 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
1698 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
… | |
… | |
2399 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2536 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2400 | |
2537 | |
2401 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2538 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2402 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2539 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2403 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2540 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2404 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
2541 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2405 | |
2542 | |
2406 | Non-blocking file handles, sockets, TCP clients and |
2543 | Non-blocking file handles, sockets, TCP clients and |
2407 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2544 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2408 | |
2545 | |
2409 | Asynchronous DNS: L<AnyEvent::DNS>. |
2546 | Asynchronous DNS: L<AnyEvent::DNS>. |