1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
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 | |
… | |
… | |
40 | =head1 INTRODUCTION/TUTORIAL |
40 | =head1 INTRODUCTION/TUTORIAL |
41 | |
41 | |
42 | This manpage is mainly a reference manual. If you are interested |
42 | This manpage is mainly a reference manual. If you are interested |
43 | in a tutorial or some gentle introduction, have a look at the |
43 | in a tutorial or some gentle introduction, have a look at the |
44 | L<AnyEvent::Intro> manpage. |
44 | L<AnyEvent::Intro> manpage. |
|
|
45 | |
|
|
46 | =head1 SUPPORT |
|
|
47 | |
|
|
48 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
|
|
49 | channel, too. |
|
|
50 | |
|
|
51 | See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software |
|
|
52 | Repository>, at L<http://anyevent.schmorp.de>, for more info. |
45 | |
53 | |
46 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
54 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
47 | |
55 | |
48 | 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 |
49 | nowadays. So what is different about AnyEvent? |
57 | nowadays. So what is different about AnyEvent? |
… | |
… | |
173 | 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 |
174 | declared. |
182 | declared. |
175 | |
183 | |
176 | =head2 I/O WATCHERS |
184 | =head2 I/O WATCHERS |
177 | |
185 | |
|
|
186 | $w = AnyEvent->io ( |
|
|
187 | fh => <filehandle_or_fileno>, |
|
|
188 | poll => <"r" or "w">, |
|
|
189 | cb => <callback>, |
|
|
190 | ); |
|
|
191 | |
178 | 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 |
179 | with the following mandatory key-value pairs as arguments: |
193 | with the following mandatory key-value pairs as arguments: |
180 | |
194 | |
181 | 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 |
182 | 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 |
… | |
… | |
211 | undef $w; |
225 | undef $w; |
212 | }); |
226 | }); |
213 | |
227 | |
214 | =head2 TIME WATCHERS |
228 | =head2 TIME WATCHERS |
215 | |
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 | |
216 | 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 >> |
217 | method with the following mandatory arguments: |
239 | method with the following mandatory arguments: |
218 | |
240 | |
219 | C<after> specifies after how many seconds (fractional values are |
241 | C<after> specifies after how many seconds (fractional values are |
220 | 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 |
… | |
… | |
347 | |
369 | |
348 | =back |
370 | =back |
349 | |
371 | |
350 | =head2 SIGNAL WATCHERS |
372 | =head2 SIGNAL WATCHERS |
351 | |
373 | |
|
|
374 | $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>); |
|
|
375 | |
352 | 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 |
353 | 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 |
354 | callback to be invoked whenever a signal occurs. |
378 | callback to be invoked whenever a signal occurs. |
355 | |
379 | |
356 | Although the callback might get passed parameters, their value and |
380 | Although the callback might get passed parameters, their value and |
… | |
… | |
375 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
399 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
376 | |
400 | |
377 | =head3 Signal Races, Delays and Workarounds |
401 | =head3 Signal Races, Delays and Workarounds |
378 | |
402 | |
379 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
403 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
380 | callbacks to signals in a generic way, which is a pity, as you cannot do |
404 | callbacks to signals in a generic way, which is a pity, as you cannot |
381 | race-free signal handling in perl. AnyEvent will try to do it's best, but |
405 | do race-free signal handling in perl, requiring C libraries for |
|
|
406 | this. AnyEvent will try to do it's best, which means in some cases, |
382 | in some cases, signals will be delayed. The maximum time a signal might |
407 | signals will be delayed. The maximum time a signal might be delayed is |
383 | be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 |
408 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
384 | seconds). This variable can be changed only before the first signal |
409 | variable can be changed only before the first signal watcher is created, |
385 | watcher is created, and should be left alone otherwise. Higher values |
410 | and should be left alone otherwise. This variable determines how often |
|
|
411 | AnyEvent polls for signals (in case a wake-up was missed). Higher values |
386 | will cause fewer spurious wake-ups, which is better for power and CPU |
412 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
413 | saving. |
|
|
414 | |
387 | saving. All these problems can be avoided by installing the optional |
415 | All these problems can be avoided by installing the optional |
388 | L<Async::Interrupt> module. This will not work with inherently broken |
416 | L<Async::Interrupt> module, which works with most event loops. It will not |
389 | event loops such as L<Event> or L<Event::Lib> (and not with L<POE> |
417 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
390 | currently, as POE does it's own workaround with one-second latency). With |
418 | (and not with L<POE> currently, as POE does it's own workaround with |
391 | those, you just have to suffer the delays. |
419 | one-second latency). For those, you just have to suffer the delays. |
392 | |
420 | |
393 | =head2 CHILD PROCESS WATCHERS |
421 | =head2 CHILD PROCESS WATCHERS |
394 | |
422 | |
|
|
423 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
|
|
424 | |
395 | You can also watch on a child process exit and catch its exit status. |
425 | You can also watch on a child process exit and catch its exit status. |
396 | |
426 | |
397 | The child process is specified by the C<pid> argument (if set to C<0>, it |
427 | The child process is specified by the C<pid> argument (one some backends, |
398 | watches for any child process exit). The watcher will triggered only when |
428 | using C<0> watches for any child process exit, on others this will |
399 | the child process has finished and an exit status is available, not on |
429 | croak). The watcher will be triggered only when the child process has |
400 | any trace events (stopped/continued). |
430 | finished and an exit status is available, not on any trace events |
|
|
431 | (stopped/continued). |
401 | |
432 | |
402 | The callback will be called with the pid and exit status (as returned by |
433 | The callback will be called with the pid and exit status (as returned by |
403 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
434 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
404 | callback arguments. |
435 | callback arguments. |
405 | |
436 | |
… | |
… | |
446 | # do something else, then wait for process exit |
477 | # do something else, then wait for process exit |
447 | $done->recv; |
478 | $done->recv; |
448 | |
479 | |
449 | =head2 IDLE WATCHERS |
480 | =head2 IDLE WATCHERS |
450 | |
481 | |
|
|
482 | $w = AnyEvent->idle (cb => <callback>); |
|
|
483 | |
451 | Sometimes there is a need to do something, but it is not so important |
484 | Sometimes there is a need to do something, but it is not so important |
452 | to do it instantly, but only when there is nothing better to do. This |
485 | to do it instantly, but only when there is nothing better to do. This |
453 | "nothing better to do" is usually defined to be "no other events need |
486 | "nothing better to do" is usually defined to be "no other events need |
454 | attention by the event loop". |
487 | attention by the event loop". |
455 | |
488 | |
… | |
… | |
481 | }); |
514 | }); |
482 | }); |
515 | }); |
483 | |
516 | |
484 | =head2 CONDITION VARIABLES |
517 | =head2 CONDITION VARIABLES |
485 | |
518 | |
|
|
519 | $cv = AnyEvent->condvar; |
|
|
520 | |
|
|
521 | $cv->send (<list>); |
|
|
522 | my @res = $cv->recv; |
|
|
523 | |
486 | If you are familiar with some event loops you will know that all of them |
524 | If you are familiar with some event loops you will know that all of them |
487 | require you to run some blocking "loop", "run" or similar function that |
525 | require you to run some blocking "loop", "run" or similar function that |
488 | will actively watch for new events and call your callbacks. |
526 | will actively watch for new events and call your callbacks. |
489 | |
527 | |
490 | AnyEvent is slightly different: it expects somebody else to run the event |
528 | AnyEvent is slightly different: it expects somebody else to run the event |
… | |
… | |
509 | Condition variables are similar to callbacks, except that you can |
547 | Condition variables are similar to callbacks, except that you can |
510 | optionally wait for them. They can also be called merge points - points |
548 | optionally wait for them. They can also be called merge points - points |
511 | in time where multiple outstanding events have been processed. And yet |
549 | in time where multiple outstanding events have been processed. And yet |
512 | another way to call them is transactions - each condition variable can be |
550 | another way to call them is transactions - each condition variable can be |
513 | used to represent a transaction, which finishes at some point and delivers |
551 | used to represent a transaction, which finishes at some point and delivers |
514 | a result. |
552 | a result. And yet some people know them as "futures" - a promise to |
|
|
553 | compute/deliver something that you can wait for. |
515 | |
554 | |
516 | Condition variables are very useful to signal that something has finished, |
555 | Condition variables are very useful to signal that something has finished, |
517 | for example, if you write a module that does asynchronous http requests, |
556 | for example, if you write a module that does asynchronous http requests, |
518 | then a condition variable would be the ideal candidate to signal the |
557 | then a condition variable would be the ideal candidate to signal the |
519 | availability of results. The user can either act when the callback is |
558 | availability of results. The user can either act when the callback is |
… | |
… | |
787 | |
826 | |
788 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
827 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
789 | AnyEvent::Impl::Tk based on Tk, very broken. |
828 | AnyEvent::Impl::Tk based on Tk, very broken. |
790 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
829 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
791 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
830 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
831 | AnyEvent::Impl::Irssi used when running within irssi. |
792 | |
832 | |
793 | =item Backends with special needs. |
833 | =item Backends with special needs. |
794 | |
834 | |
795 | Qt requires the Qt::Application to be instantiated first, but will |
835 | Qt requires the Qt::Application to be instantiated first, but will |
796 | otherwise be picked up automatically. As long as the main program |
836 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
870 | event module detection too early, for example, L<AnyEvent::AIO> creates |
910 | event module detection too early, for example, L<AnyEvent::AIO> creates |
871 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
911 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
872 | avoid autodetecting the event module at load time. |
912 | avoid autodetecting the event module at load time. |
873 | |
913 | |
874 | If called in scalar or list context, then it creates and returns an object |
914 | If called in scalar or list context, then it creates and returns an object |
875 | that automatically removes the callback again when it is destroyed. See |
915 | that automatically removes the callback again when it is destroyed (or |
|
|
916 | C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for |
876 | L<Coro::BDB> for a case where this is useful. |
917 | a case where this is useful. |
|
|
918 | |
|
|
919 | Example: Create a watcher for the IO::AIO module and store it in |
|
|
920 | C<$WATCHER>. Only do so after the event loop is initialised, though. |
|
|
921 | |
|
|
922 | our WATCHER; |
|
|
923 | |
|
|
924 | my $guard = AnyEvent::post_detect { |
|
|
925 | $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); |
|
|
926 | }; |
|
|
927 | |
|
|
928 | # the ||= is important in case post_detect immediately runs the block, |
|
|
929 | # as to not clobber the newly-created watcher. assigning both watcher and |
|
|
930 | # post_detect guard to the same variable has the advantage of users being |
|
|
931 | # able to just C<undef $WATCHER> if the watcher causes them grief. |
|
|
932 | |
|
|
933 | $WATCHER ||= $guard; |
877 | |
934 | |
878 | =item @AnyEvent::post_detect |
935 | =item @AnyEvent::post_detect |
879 | |
936 | |
880 | If there are any code references in this array (you can C<push> to it |
937 | If there are any code references in this array (you can C<push> to it |
881 | before or after loading AnyEvent), then they will called directly after |
938 | before or after loading AnyEvent), then they will called directly after |
… | |
… | |
1058 | |
1115 | |
1059 | BEGIN { AnyEvent::common_sense } |
1116 | BEGIN { AnyEvent::common_sense } |
1060 | |
1117 | |
1061 | use Carp (); |
1118 | use Carp (); |
1062 | |
1119 | |
1063 | our $VERSION = 4.85; |
1120 | our $VERSION = 4.9; |
1064 | our $MODEL; |
1121 | our $MODEL; |
1065 | |
1122 | |
1066 | our $AUTOLOAD; |
1123 | our $AUTOLOAD; |
1067 | our @ISA; |
1124 | our @ISA; |
1068 | |
1125 | |
… | |
… | |
1093 | for reverse split /\s*,\s*/, |
1150 | for reverse split /\s*,\s*/, |
1094 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1151 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1095 | } |
1152 | } |
1096 | |
1153 | |
1097 | my @models = ( |
1154 | my @models = ( |
1098 | [EV:: => AnyEvent::Impl::EV::], |
1155 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1099 | [Event:: => AnyEvent::Impl::Event::], |
1156 | [Event:: => AnyEvent::Impl::Event::, 1], |
1100 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1157 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1101 | # everything below here will not be autoprobed |
1158 | # everything below here will not (normally) be autoprobed |
1102 | # as the pureperl backend should work everywhere |
1159 | # as the pureperl backend should work everywhere |
1103 | # and is usually faster |
1160 | # and is usually faster |
1104 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1161 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1105 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1162 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1163 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1106 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1164 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1107 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1165 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1108 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1166 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1109 | [Wx:: => AnyEvent::Impl::POE::], |
1167 | [Wx:: => AnyEvent::Impl::POE::], |
1110 | [Prima:: => AnyEvent::Impl::POE::], |
1168 | [Prima:: => AnyEvent::Impl::POE::], |
1111 | # IO::Async is just too broken - we would need workarounds for its |
1169 | # IO::Async is just too broken - we would need workarounds for its |
1112 | # byzantine signal and broken child handling, among others. |
1170 | # byzantine signal and broken child handling, among others. |
1113 | # IO::Async is rather hard to detect, as it doesn't have any |
1171 | # IO::Async is rather hard to detect, as it doesn't have any |
1114 | # obvious default class. |
1172 | # obvious default class. |
1115 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1173 | # [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1116 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1174 | # [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1117 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1175 | # [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1118 | ); |
1176 | ); |
1119 | |
1177 | |
1120 | our %method = map +($_ => 1), |
1178 | our %method = map +($_ => 1), |
1121 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1179 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1122 | |
1180 | |
… | |
… | |
1126 | my ($cb) = @_; |
1184 | my ($cb) = @_; |
1127 | |
1185 | |
1128 | if ($MODEL) { |
1186 | if ($MODEL) { |
1129 | $cb->(); |
1187 | $cb->(); |
1130 | |
1188 | |
1131 | 1 |
1189 | undef |
1132 | } else { |
1190 | } else { |
1133 | push @post_detect, $cb; |
1191 | push @post_detect, $cb; |
1134 | |
1192 | |
1135 | defined wantarray |
1193 | defined wantarray |
1136 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1194 | ? bless \$cb, "AnyEvent::Util::postdetect" |
… | |
… | |
1168 | } |
1226 | } |
1169 | } |
1227 | } |
1170 | } |
1228 | } |
1171 | |
1229 | |
1172 | unless ($MODEL) { |
1230 | unless ($MODEL) { |
1173 | # try to load a model |
1231 | # try to autoload a model |
1174 | |
|
|
1175 | for (@REGISTRY, @models) { |
1232 | for (@REGISTRY, @models) { |
1176 | my ($package, $model) = @$_; |
1233 | my ($package, $model, $autoload) = @$_; |
|
|
1234 | if ( |
|
|
1235 | $autoload |
1177 | if (eval "require $package" |
1236 | and eval "require $package" |
1178 | and ${"$package\::VERSION"} > 0 |
1237 | and ${"$package\::VERSION"} > 0 |
1179 | and eval "require $model") { |
1238 | and eval "require $model" |
|
|
1239 | ) { |
1180 | $MODEL = $model; |
1240 | $MODEL = $model; |
1181 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; |
1241 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1182 | last; |
1242 | last; |
1183 | } |
1243 | } |
1184 | } |
1244 | } |
1185 | |
1245 | |
1186 | $MODEL |
1246 | $MODEL |
… | |
… | |
1258 | } |
1318 | } |
1259 | |
1319 | |
1260 | # default implementation for ->signal |
1320 | # default implementation for ->signal |
1261 | |
1321 | |
1262 | our $HAVE_ASYNC_INTERRUPT; |
1322 | our $HAVE_ASYNC_INTERRUPT; |
|
|
1323 | |
|
|
1324 | sub _have_async_interrupt() { |
|
|
1325 | $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} |
|
|
1326 | && eval "use Async::Interrupt 1.0 (); 1") |
|
|
1327 | unless defined $HAVE_ASYNC_INTERRUPT; |
|
|
1328 | |
|
|
1329 | $HAVE_ASYNC_INTERRUPT |
|
|
1330 | } |
|
|
1331 | |
1263 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1332 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1264 | our (%SIG_ASY, %SIG_ASY_W); |
1333 | our (%SIG_ASY, %SIG_ASY_W); |
1265 | our ($SIG_COUNT, $SIG_TW); |
1334 | our ($SIG_COUNT, $SIG_TW); |
1266 | |
1335 | |
1267 | sub _signal_exec { |
1336 | sub _signal_exec { |
… | |
… | |
1275 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1344 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1276 | } |
1345 | } |
1277 | } |
1346 | } |
1278 | } |
1347 | } |
1279 | |
1348 | |
1280 | # install a dumym wakeupw atcher to reduce signal catching latency |
1349 | # install a dummy wakeup watcher to reduce signal catching latency |
1281 | sub _sig_add() { |
1350 | sub _sig_add() { |
1282 | unless ($SIG_COUNT++) { |
1351 | unless ($SIG_COUNT++) { |
1283 | # try to align timer on a full-second boundary, if possible |
1352 | # try to align timer on a full-second boundary, if possible |
1284 | my $NOW = AnyEvent->now; |
1353 | my $NOW = AnyEvent->now; |
1285 | |
1354 | |
… | |
… | |
1294 | sub _sig_del { |
1363 | sub _sig_del { |
1295 | undef $SIG_TW |
1364 | undef $SIG_TW |
1296 | unless --$SIG_COUNT; |
1365 | unless --$SIG_COUNT; |
1297 | } |
1366 | } |
1298 | |
1367 | |
|
|
1368 | our $_sig_name_init; $_sig_name_init = sub { |
|
|
1369 | eval q{ # poor man's autoloading |
|
|
1370 | undef $_sig_name_init; |
|
|
1371 | |
|
|
1372 | if (_have_async_interrupt) { |
|
|
1373 | *sig2num = \&Async::Interrupt::sig2num; |
|
|
1374 | *sig2name = \&Async::Interrupt::sig2name; |
|
|
1375 | } else { |
|
|
1376 | require Config; |
|
|
1377 | |
|
|
1378 | my %signame2num; |
|
|
1379 | @signame2num{ split ' ', $Config::Config{sig_name} } |
|
|
1380 | = split ' ', $Config::Config{sig_num}; |
|
|
1381 | |
|
|
1382 | my @signum2name; |
|
|
1383 | @signum2name[values %signame2num] = keys %signame2num; |
|
|
1384 | |
|
|
1385 | *sig2num = sub($) { |
|
|
1386 | $_[0] > 0 ? shift : $signame2num{+shift} |
|
|
1387 | }; |
|
|
1388 | *sig2name = sub ($) { |
|
|
1389 | $_[0] > 0 ? $signum2name[+shift] : shift |
|
|
1390 | }; |
|
|
1391 | } |
|
|
1392 | }; |
|
|
1393 | die if $@; |
|
|
1394 | }; |
|
|
1395 | |
|
|
1396 | sub sig2num ($) { &$_sig_name_init; &sig2num } |
|
|
1397 | sub sig2name($) { &$_sig_name_init; &sig2name } |
|
|
1398 | |
1299 | sub _signal { |
1399 | sub signal { |
|
|
1400 | eval q{ # poor man's autoloading {} |
|
|
1401 | # probe for availability of Async::Interrupt |
|
|
1402 | if (_have_async_interrupt) { |
|
|
1403 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
|
|
1404 | |
|
|
1405 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1406 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
|
|
1407 | |
|
|
1408 | } else { |
|
|
1409 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1410 | |
|
|
1411 | require Fcntl; |
|
|
1412 | |
|
|
1413 | if (AnyEvent::WIN32) { |
|
|
1414 | require AnyEvent::Util; |
|
|
1415 | |
|
|
1416 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1417 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; |
|
|
1418 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case |
|
|
1419 | } else { |
|
|
1420 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1421 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1422 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1423 | |
|
|
1424 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1425 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1426 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1427 | } |
|
|
1428 | |
|
|
1429 | $SIGPIPE_R |
|
|
1430 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1431 | |
|
|
1432 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1433 | } |
|
|
1434 | |
|
|
1435 | *signal = sub { |
1300 | my (undef, %arg) = @_; |
1436 | my (undef, %arg) = @_; |
1301 | |
1437 | |
1302 | my $signal = uc $arg{signal} |
1438 | my $signal = uc $arg{signal} |
1303 | or Carp::croak "required option 'signal' is missing"; |
1439 | or Carp::croak "required option 'signal' is missing"; |
1304 | |
1440 | |
1305 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1306 | |
|
|
1307 | if ($HAVE_ASYNC_INTERRUPT) { |
1441 | if ($HAVE_ASYNC_INTERRUPT) { |
1308 | # async::interrupt |
1442 | # async::interrupt |
1309 | |
1443 | |
1310 | $SIG_ASY{$signal} ||= do { |
1444 | $signal = sig2num $signal; |
1311 | my $asy = new Async::Interrupt |
1445 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1446 | |
|
|
1447 | $SIG_ASY{$signal} ||= new Async::Interrupt |
1312 | cb => sub { undef $SIG_EV{$signal} }, |
1448 | cb => sub { undef $SIG_EV{$signal} }, |
1313 | signal => $signal, |
1449 | signal => $signal, |
1314 | pipe => [$SIGPIPE_R->filenos], |
1450 | pipe => [$SIGPIPE_R->filenos], |
|
|
1451 | pipe_autodrain => 0, |
|
|
1452 | ; |
|
|
1453 | |
|
|
1454 | } else { |
|
|
1455 | # pure perl |
|
|
1456 | |
|
|
1457 | # AE::Util has been loaded in signal |
|
|
1458 | $signal = sig2name $signal; |
|
|
1459 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1460 | |
|
|
1461 | $SIG{$signal} ||= sub { |
|
|
1462 | local $!; |
|
|
1463 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1464 | undef $SIG_EV{$signal}; |
|
|
1465 | }; |
|
|
1466 | |
|
|
1467 | # can't do signal processing without introducing races in pure perl, |
|
|
1468 | # so limit the signal latency. |
|
|
1469 | _sig_add; |
1315 | ; |
1470 | } |
1316 | $asy->pipe_autodrain (0); |
|
|
1317 | |
1471 | |
1318 | $asy |
1472 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1319 | }; |
1473 | }; |
1320 | |
1474 | |
1321 | } else { |
1475 | *AnyEvent::Base::signal::DESTROY = sub { |
1322 | # pure perl |
1476 | my ($signal, $cb) = @{$_[0]}; |
1323 | |
1477 | |
1324 | $SIG{$signal} ||= sub { |
1478 | _sig_del; |
1325 | local $!; |
1479 | |
1326 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1480 | delete $SIG_CB{$signal}{$cb}; |
|
|
1481 | |
|
|
1482 | $HAVE_ASYNC_INTERRUPT |
|
|
1483 | ? delete $SIG_ASY{$signal} |
|
|
1484 | : # delete doesn't work with older perls - they then |
|
|
1485 | # print weird messages, or just unconditionally exit |
|
|
1486 | # instead of getting the default action. |
1327 | undef $SIG_EV{$signal}; |
1487 | undef $SIG{$signal} |
|
|
1488 | unless keys %{ $SIG_CB{$signal} }; |
1328 | }; |
1489 | }; |
1329 | |
|
|
1330 | # can't do signal processing without introducing races in pure perl, |
|
|
1331 | # so limit the signal latency. |
|
|
1332 | _sig_add; |
|
|
1333 | } |
1490 | }; |
1334 | |
1491 | die if $@; |
1335 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1336 | } |
|
|
1337 | |
|
|
1338 | sub signal { |
|
|
1339 | # probe for availability of Async::Interrupt |
|
|
1340 | if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { |
|
|
1341 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
|
|
1342 | |
|
|
1343 | $HAVE_ASYNC_INTERRUPT = 1; |
|
|
1344 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1345 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
|
|
1346 | |
|
|
1347 | } else { |
|
|
1348 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1349 | |
|
|
1350 | require Fcntl; |
|
|
1351 | |
|
|
1352 | if (AnyEvent::WIN32) { |
|
|
1353 | require AnyEvent::Util; |
|
|
1354 | |
|
|
1355 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1356 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1357 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1358 | } else { |
|
|
1359 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1360 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1361 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1362 | |
|
|
1363 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1364 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1365 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1366 | } |
|
|
1367 | |
|
|
1368 | $SIGPIPE_R |
|
|
1369 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1370 | |
|
|
1371 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1372 | } |
|
|
1373 | |
|
|
1374 | *signal = \&_signal; |
|
|
1375 | &signal |
1492 | &signal |
1376 | } |
|
|
1377 | |
|
|
1378 | sub AnyEvent::Base::signal::DESTROY { |
|
|
1379 | my ($signal, $cb) = @{$_[0]}; |
|
|
1380 | |
|
|
1381 | _sig_del; |
|
|
1382 | |
|
|
1383 | delete $SIG_CB{$signal}{$cb}; |
|
|
1384 | |
|
|
1385 | $HAVE_ASYNC_INTERRUPT |
|
|
1386 | ? delete $SIG_ASY{$signal} |
|
|
1387 | : # delete doesn't work with older perls - they then |
|
|
1388 | # print weird messages, or just unconditionally exit |
|
|
1389 | # instead of getting the default action. |
|
|
1390 | undef $SIG{$signal} |
|
|
1391 | unless keys %{ $SIG_CB{$signal} }; |
|
|
1392 | } |
1493 | } |
1393 | |
1494 | |
1394 | # default implementation for ->child |
1495 | # default implementation for ->child |
1395 | |
1496 | |
1396 | our %PID_CB; |
1497 | our %PID_CB; |
1397 | our $CHLD_W; |
1498 | our $CHLD_W; |
1398 | our $CHLD_DELAY_W; |
1499 | our $CHLD_DELAY_W; |
1399 | our $WNOHANG; |
1500 | our $WNOHANG; |
1400 | |
1501 | |
|
|
1502 | sub _emit_childstatus($$) { |
|
|
1503 | my (undef, $rpid, $rstatus) = @_; |
|
|
1504 | |
|
|
1505 | $_->($rpid, $rstatus) |
|
|
1506 | for values %{ $PID_CB{$rpid} || {} }, |
|
|
1507 | values %{ $PID_CB{0} || {} }; |
|
|
1508 | } |
|
|
1509 | |
1401 | sub _sigchld { |
1510 | sub _sigchld { |
|
|
1511 | my $pid; |
|
|
1512 | |
|
|
1513 | AnyEvent->_emit_childstatus ($pid, $?) |
1402 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1514 | while ($pid = waitpid -1, $WNOHANG) > 0; |
1403 | $_->($pid, $?) |
|
|
1404 | for values %{ $PID_CB{$pid} || {} }, |
|
|
1405 | values %{ $PID_CB{0} || {} }; |
|
|
1406 | } |
|
|
1407 | } |
1515 | } |
1408 | |
1516 | |
1409 | sub child { |
1517 | sub child { |
1410 | my (undef, %arg) = @_; |
1518 | my (undef, %arg) = @_; |
1411 | |
1519 | |
… | |
… | |
1543 | } |
1651 | } |
1544 | |
1652 | |
1545 | # undocumented/compatibility with pre-3.4 |
1653 | # undocumented/compatibility with pre-3.4 |
1546 | *broadcast = \&send; |
1654 | *broadcast = \&send; |
1547 | *wait = \&_wait; |
1655 | *wait = \&_wait; |
|
|
1656 | |
|
|
1657 | ############################################################################# |
|
|
1658 | # "new" API, currently only emulation of it |
|
|
1659 | ############################################################################# |
|
|
1660 | |
|
|
1661 | package AE; |
|
|
1662 | |
|
|
1663 | sub io($$$) { |
|
|
1664 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
|
|
1665 | } |
|
|
1666 | |
|
|
1667 | sub timer($$$) { |
|
|
1668 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]); |
|
|
1669 | } |
|
|
1670 | |
|
|
1671 | sub signal($$) { |
|
|
1672 | AnyEvent->signal (signal => $_[0], cb => $_[1]); |
|
|
1673 | } |
|
|
1674 | |
|
|
1675 | sub child($$) { |
|
|
1676 | AnyEvent->child (pid => $_[0], cb => $_[1]); |
|
|
1677 | } |
|
|
1678 | |
|
|
1679 | sub idle($) { |
|
|
1680 | AnyEvent->idle (cb => $_[0]); |
|
|
1681 | } |
|
|
1682 | |
|
|
1683 | sub cv() { |
|
|
1684 | AnyEvent->condvar |
|
|
1685 | } |
|
|
1686 | |
|
|
1687 | sub now() { |
|
|
1688 | AnyEvent->now |
|
|
1689 | } |
|
|
1690 | |
|
|
1691 | sub now_update() { |
|
|
1692 | AnyEvent->now_update |
|
|
1693 | } |
|
|
1694 | |
|
|
1695 | sub time() { |
|
|
1696 | AnyEvent->time |
|
|
1697 | } |
1548 | |
1698 | |
1549 | =head1 ERROR AND EXCEPTION HANDLING |
1699 | =head1 ERROR AND EXCEPTION HANDLING |
1550 | |
1700 | |
1551 | In general, AnyEvent does not do any error handling - it relies on the |
1701 | In general, AnyEvent does not do any error handling - it relies on the |
1552 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
1702 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
… | |
… | |
2313 | |
2463 | |
2314 | =item L<JSON> and L<JSON::XS> |
2464 | =item L<JSON> and L<JSON::XS> |
2315 | |
2465 | |
2316 | This module is required when you want to read or write JSON data via |
2466 | This module is required when you want to read or write JSON data via |
2317 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
2467 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
2318 | advantage of the ulta-high-speed L<JSON::XS> module when it is installed. |
2468 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
2319 | |
2469 | |
2320 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
2470 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
2321 | installed. |
2471 | installed. |
2322 | |
2472 | |
2323 | =item L<Net::SSLeay> |
2473 | =item L<Net::SSLeay> |
… | |
… | |
2390 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2540 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2391 | |
2541 | |
2392 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2542 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2393 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2543 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2394 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2544 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2395 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
2545 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2396 | |
2546 | |
2397 | Non-blocking file handles, sockets, TCP clients and |
2547 | Non-blocking file handles, sockets, TCP clients and |
2398 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2548 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2399 | |
2549 | |
2400 | Asynchronous DNS: L<AnyEvent::DNS>. |
2550 | Asynchronous DNS: L<AnyEvent::DNS>. |