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 |
… | |
… | |
361 | invocation, and callback invocation will be synchronous. Synchronous means |
385 | invocation, and callback invocation will be synchronous. Synchronous means |
362 | that it might take a while until the signal gets handled by the process, |
386 | that it might take a while until the signal gets handled by the process, |
363 | but it is guaranteed not to interrupt any other callbacks. |
387 | but it is guaranteed not to interrupt any other callbacks. |
364 | |
388 | |
365 | The main advantage of using these watchers is that you can share a signal |
389 | The main advantage of using these watchers is that you can share a signal |
366 | between multiple watchers. |
390 | between multiple watchers, and AnyEvent will ensure that signals will not |
|
|
391 | interrupt your program at bad times. |
367 | |
392 | |
368 | This watcher might use C<%SIG>, so programs overwriting those signals |
393 | This watcher might use C<%SIG> (depending on the event loop used), |
369 | directly will likely not work correctly. |
394 | so programs overwriting those signals directly will likely not work |
|
|
395 | correctly. |
370 | |
396 | |
371 | Example: exit on SIGINT |
397 | Example: exit on SIGINT |
372 | |
398 | |
373 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
399 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
374 | |
400 | |
|
|
401 | =head3 Signal Races, Delays and Workarounds |
|
|
402 | |
|
|
403 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
|
|
404 | callbacks to signals in a generic way, which is a pity, as you cannot do |
|
|
405 | race-free signal handling in perl. AnyEvent will try to do it's best, but |
|
|
406 | in some cases, signals will be delayed. The maximum time a signal might |
|
|
407 | be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 |
|
|
408 | seconds). This variable can be changed only before the first signal |
|
|
409 | watcher is created, and should be left alone otherwise. Higher values |
|
|
410 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
411 | saving. All these problems can be avoided by installing the optional |
|
|
412 | L<Async::Interrupt> module. This will not work with inherently broken |
|
|
413 | event loops such as L<Event> or L<Event::Lib> (and not with L<POE> |
|
|
414 | currently, as POE does it's own workaround with one-second latency). With |
|
|
415 | those, you just have to suffer the delays. |
|
|
416 | |
375 | =head2 CHILD PROCESS WATCHERS |
417 | =head2 CHILD PROCESS WATCHERS |
376 | |
418 | |
|
|
419 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
|
|
420 | |
377 | 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. |
378 | |
422 | |
379 | 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, |
380 | 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 |
381 | 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 |
382 | any trace events (stopped/continued). |
426 | finished and an exit status is available, not on any trace events |
|
|
427 | (stopped/continued). |
383 | |
428 | |
384 | 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 |
385 | 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 |
386 | callback arguments. |
431 | callback arguments. |
387 | |
432 | |
… | |
… | |
403 | |
448 | |
404 | This means you cannot create a child watcher as the very first |
449 | This means you cannot create a child watcher as the very first |
405 | thing in an AnyEvent program, you I<have> to create at least one |
450 | thing in an AnyEvent program, you I<have> to create at least one |
406 | watcher before you C<fork> the child (alternatively, you can call |
451 | watcher before you C<fork> the child (alternatively, you can call |
407 | C<AnyEvent::detect>). |
452 | C<AnyEvent::detect>). |
|
|
453 | |
|
|
454 | As most event loops do not support waiting for child events, they will be |
|
|
455 | emulated by AnyEvent in most cases, in which the latency and race problems |
|
|
456 | mentioned in the description of signal watchers apply. |
408 | |
457 | |
409 | Example: fork a process and wait for it |
458 | Example: fork a process and wait for it |
410 | |
459 | |
411 | my $done = AnyEvent->condvar; |
460 | my $done = AnyEvent->condvar; |
412 | |
461 | |
… | |
… | |
424 | # do something else, then wait for process exit |
473 | # do something else, then wait for process exit |
425 | $done->recv; |
474 | $done->recv; |
426 | |
475 | |
427 | =head2 IDLE WATCHERS |
476 | =head2 IDLE WATCHERS |
428 | |
477 | |
|
|
478 | $w = AnyEvent->idle (cb => <callback>); |
|
|
479 | |
429 | 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 |
430 | 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 |
431 | "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 |
432 | attention by the event loop". |
483 | attention by the event loop". |
433 | |
484 | |
… | |
… | |
459 | }); |
510 | }); |
460 | }); |
511 | }); |
461 | |
512 | |
462 | =head2 CONDITION VARIABLES |
513 | =head2 CONDITION VARIABLES |
463 | |
514 | |
|
|
515 | $cv = AnyEvent->condvar; |
|
|
516 | |
|
|
517 | $cv->send (<list>); |
|
|
518 | my @res = $cv->recv; |
|
|
519 | |
464 | 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 |
465 | 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 |
466 | will actively watch for new events and call your callbacks. |
522 | will actively watch for new events and call your callbacks. |
467 | |
523 | |
468 | AnyEvent is different, it expects somebody else to run the event loop and |
524 | AnyEvent is slightly different: it expects somebody else to run the event |
469 | will only block when necessary (usually when told by the user). |
525 | loop and will only block when necessary (usually when told by the user). |
470 | |
526 | |
471 | The instrument to do that is called a "condition variable", so called |
527 | The instrument to do that is called a "condition variable", so called |
472 | because they represent a condition that must become true. |
528 | because they represent a condition that must become true. |
473 | |
529 | |
|
|
530 | Now is probably a good time to look at the examples further below. |
|
|
531 | |
474 | Condition variables can be created by calling the C<< AnyEvent->condvar |
532 | Condition variables can be created by calling the C<< AnyEvent->condvar |
475 | >> method, usually without arguments. The only argument pair allowed is |
533 | >> method, usually without arguments. The only argument pair allowed is |
476 | |
|
|
477 | C<cb>, which specifies a callback to be called when the condition variable |
534 | C<cb>, which specifies a callback to be called when the condition variable |
478 | becomes true, with the condition variable as the first argument (but not |
535 | becomes true, with the condition variable as the first argument (but not |
479 | the results). |
536 | the results). |
480 | |
537 | |
481 | After creation, the condition variable is "false" until it becomes "true" |
538 | After creation, the condition variable is "false" until it becomes "true" |
… | |
… | |
486 | Condition variables are similar to callbacks, except that you can |
543 | Condition variables are similar to callbacks, except that you can |
487 | optionally wait for them. They can also be called merge points - points |
544 | optionally wait for them. They can also be called merge points - points |
488 | in time where multiple outstanding events have been processed. And yet |
545 | in time where multiple outstanding events have been processed. And yet |
489 | another way to call them is transactions - each condition variable can be |
546 | another way to call them is transactions - each condition variable can be |
490 | used to represent a transaction, which finishes at some point and delivers |
547 | used to represent a transaction, which finishes at some point and delivers |
491 | a result. |
548 | a result. And yet some people know them as "futures" - a promise to |
|
|
549 | compute/deliver something that you can wait for. |
492 | |
550 | |
493 | Condition variables are very useful to signal that something has finished, |
551 | Condition variables are very useful to signal that something has finished, |
494 | for example, if you write a module that does asynchronous http requests, |
552 | for example, if you write a module that does asynchronous http requests, |
495 | then a condition variable would be the ideal candidate to signal the |
553 | then a condition variable would be the ideal candidate to signal the |
496 | availability of results. The user can either act when the callback is |
554 | availability of results. The user can either act when the callback is |
… | |
… | |
530 | after => 1, |
588 | after => 1, |
531 | cb => sub { $result_ready->send }, |
589 | cb => sub { $result_ready->send }, |
532 | ); |
590 | ); |
533 | |
591 | |
534 | # this "blocks" (while handling events) till the callback |
592 | # this "blocks" (while handling events) till the callback |
535 | # calls send |
593 | # calls -<send |
536 | $result_ready->recv; |
594 | $result_ready->recv; |
537 | |
595 | |
538 | Example: wait for a timer, but take advantage of the fact that |
596 | Example: wait for a timer, but take advantage of the fact that condition |
539 | condition variables are also code references. |
597 | variables are also callable directly. |
540 | |
598 | |
541 | my $done = AnyEvent->condvar; |
599 | my $done = AnyEvent->condvar; |
542 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
600 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
543 | $done->recv; |
601 | $done->recv; |
544 | |
602 | |
… | |
… | |
550 | |
608 | |
551 | ... |
609 | ... |
552 | |
610 | |
553 | my @info = $couchdb->info->recv; |
611 | my @info = $couchdb->info->recv; |
554 | |
612 | |
555 | And this is how you would just ste a callback to be called whenever the |
613 | And this is how you would just set a callback to be called whenever the |
556 | results are available: |
614 | results are available: |
557 | |
615 | |
558 | $couchdb->info->cb (sub { |
616 | $couchdb->info->cb (sub { |
559 | my @info = $_[0]->recv; |
617 | my @info = $_[0]->recv; |
560 | }); |
618 | }); |
… | |
… | |
578 | immediately from within send. |
636 | immediately from within send. |
579 | |
637 | |
580 | Any arguments passed to the C<send> call will be returned by all |
638 | Any arguments passed to the C<send> call will be returned by all |
581 | future C<< ->recv >> calls. |
639 | future C<< ->recv >> calls. |
582 | |
640 | |
583 | Condition variables are overloaded so one can call them directly |
641 | Condition variables are overloaded so one can call them directly (as if |
584 | (as a code reference). Calling them directly is the same as calling |
642 | they were a code reference). Calling them directly is the same as calling |
585 | C<send>. Note, however, that many C-based event loops do not handle |
643 | C<send>. |
586 | overloading, so as tempting as it may be, passing a condition variable |
|
|
587 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
588 | support overloading, however, as well as all functions that use perl to |
|
|
589 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
590 | example). |
|
|
591 | |
644 | |
592 | =item $cv->croak ($error) |
645 | =item $cv->croak ($error) |
593 | |
646 | |
594 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
647 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
595 | C<Carp::croak> with the given error message/object/scalar. |
648 | C<Carp::croak> with the given error message/object/scalar. |
596 | |
649 | |
597 | This can be used to signal any errors to the condition variable |
650 | This can be used to signal any errors to the condition variable |
598 | user/consumer. |
651 | user/consumer. Doing it this way instead of calling C<croak> directly |
|
|
652 | delays the error detetcion, but has the overwhelmign advantage that it |
|
|
653 | diagnoses the error at the place where the result is expected, and not |
|
|
654 | deep in some event clalback without connection to the actual code causing |
|
|
655 | the problem. |
599 | |
656 | |
600 | =item $cv->begin ([group callback]) |
657 | =item $cv->begin ([group callback]) |
601 | |
658 | |
602 | =item $cv->end |
659 | =item $cv->end |
603 | |
660 | |
… | |
… | |
699 | function will call C<croak>. |
756 | function will call C<croak>. |
700 | |
757 | |
701 | In list context, all parameters passed to C<send> will be returned, |
758 | In list context, all parameters passed to C<send> will be returned, |
702 | in scalar context only the first one will be returned. |
759 | in scalar context only the first one will be returned. |
703 | |
760 | |
|
|
761 | Note that doing a blocking wait in a callback is not supported by any |
|
|
762 | event loop, that is, recursive invocation of a blocking C<< ->recv |
|
|
763 | >> is not allowed, and the C<recv> call will C<croak> if such a |
|
|
764 | condition is detected. This condition can be slightly loosened by using |
|
|
765 | L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from |
|
|
766 | any thread that doesn't run the event loop itself. |
|
|
767 | |
704 | Not all event models support a blocking wait - some die in that case |
768 | Not all event models support a blocking wait - some die in that case |
705 | (programs might want to do that to stay interactive), so I<if you are |
769 | (programs might want to do that to stay interactive), so I<if you are |
706 | using this from a module, never require a blocking wait>, but let the |
770 | using this from a module, never require a blocking wait>. Instead, let the |
707 | caller decide whether the call will block or not (for example, by coupling |
771 | caller decide whether the call will block or not (for example, by coupling |
708 | condition variables with some kind of request results and supporting |
772 | condition variables with some kind of request results and supporting |
709 | callbacks so the caller knows that getting the result will not block, |
773 | callbacks so the caller knows that getting the result will not block, |
710 | while still supporting blocking waits if the caller so desires). |
774 | while still supporting blocking waits if the caller so desires). |
711 | |
|
|
712 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
|
|
713 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
|
|
714 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
|
|
715 | can supply. |
|
|
716 | |
|
|
717 | The L<Coro> module, however, I<can> and I<does> supply coroutines and, in |
|
|
718 | fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe |
|
|
719 | versions and also integrates coroutines into AnyEvent, making blocking |
|
|
720 | C<< ->recv >> calls perfectly safe as long as they are done from another |
|
|
721 | coroutine (one that doesn't run the event loop). |
|
|
722 | |
775 | |
723 | You can ensure that C<< -recv >> never blocks by setting a callback and |
776 | You can ensure that C<< -recv >> never blocks by setting a callback and |
724 | only calling C<< ->recv >> from within that callback (or at a later |
777 | only calling C<< ->recv >> from within that callback (or at a later |
725 | time). This will work even when the event loop does not support blocking |
778 | time). This will work even when the event loop does not support blocking |
726 | waits otherwise. |
779 | waits otherwise. |
… | |
… | |
769 | |
822 | |
770 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
823 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
771 | AnyEvent::Impl::Tk based on Tk, very broken. |
824 | AnyEvent::Impl::Tk based on Tk, very broken. |
772 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
825 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
773 | 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. |
774 | |
828 | |
775 | =item Backends with special needs. |
829 | =item Backends with special needs. |
776 | |
830 | |
777 | Qt requires the Qt::Application to be instantiated first, but will |
831 | Qt requires the Qt::Application to be instantiated first, but will |
778 | otherwise be picked up automatically. As long as the main program |
832 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
852 | event module detection too early, for example, L<AnyEvent::AIO> creates |
906 | event module detection too early, for example, L<AnyEvent::AIO> creates |
853 | 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 |
854 | avoid autodetecting the event module at load time. |
908 | avoid autodetecting the event module at load time. |
855 | |
909 | |
856 | 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 |
857 | 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 |
858 | 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; |
859 | |
930 | |
860 | =item @AnyEvent::post_detect |
931 | =item @AnyEvent::post_detect |
861 | |
932 | |
862 | 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 |
863 | before or after loading AnyEvent), then they will called directly after |
934 | before or after loading AnyEvent), then they will called directly after |
… | |
… | |
1028 | |
1099 | |
1029 | =cut |
1100 | =cut |
1030 | |
1101 | |
1031 | package AnyEvent; |
1102 | package AnyEvent; |
1032 | |
1103 | |
|
|
1104 | # basically a tuned-down version of common::sense |
|
|
1105 | sub common_sense { |
1033 | no warnings; |
1106 | # no warnings |
|
|
1107 | ${^WARNING_BITS} ^= ${^WARNING_BITS}; |
1034 | use strict qw(vars subs); |
1108 | # use strict vars subs |
|
|
1109 | $^H |= 0x00000600; |
|
|
1110 | } |
1035 | |
1111 | |
|
|
1112 | BEGIN { AnyEvent::common_sense } |
|
|
1113 | |
1036 | use Carp; |
1114 | use Carp (); |
1037 | |
1115 | |
1038 | our $VERSION = 4.801; |
1116 | our $VERSION = 4.881; |
1039 | our $MODEL; |
1117 | our $MODEL; |
1040 | |
1118 | |
1041 | our $AUTOLOAD; |
1119 | our $AUTOLOAD; |
1042 | our @ISA; |
1120 | our @ISA; |
1043 | |
1121 | |
1044 | our @REGISTRY; |
1122 | our @REGISTRY; |
1045 | |
1123 | |
1046 | our $WIN32; |
1124 | our $WIN32; |
|
|
1125 | |
|
|
1126 | our $VERBOSE; |
1047 | |
1127 | |
1048 | BEGIN { |
1128 | BEGIN { |
1049 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1129 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1050 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1130 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1051 | |
1131 | |
1052 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1132 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1053 | if ${^TAINT}; |
1133 | if ${^TAINT}; |
1054 | } |
|
|
1055 | |
1134 | |
1056 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1135 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
|
|
1136 | |
|
|
1137 | } |
|
|
1138 | |
|
|
1139 | our $MAX_SIGNAL_LATENCY = 10; |
1057 | |
1140 | |
1058 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1141 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1059 | |
1142 | |
1060 | { |
1143 | { |
1061 | my $idx; |
1144 | my $idx; |
… | |
… | |
1063 | for reverse split /\s*,\s*/, |
1146 | for reverse split /\s*,\s*/, |
1064 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1147 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1065 | } |
1148 | } |
1066 | |
1149 | |
1067 | my @models = ( |
1150 | my @models = ( |
1068 | [EV:: => AnyEvent::Impl::EV::], |
1151 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1069 | [Event:: => AnyEvent::Impl::Event::], |
1152 | [Event:: => AnyEvent::Impl::Event::, 1], |
1070 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1153 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1071 | # everything below here will not be autoprobed |
1154 | # everything below here will not (normally) be autoprobed |
1072 | # as the pureperl backend should work everywhere |
1155 | # as the pureperl backend should work everywhere |
1073 | # and is usually faster |
1156 | # and is usually faster |
1074 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1157 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1075 | [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 |
1076 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1160 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
1161 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1077 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1162 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1078 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
|
|
1079 | [Wx:: => AnyEvent::Impl::POE::], |
1163 | [Wx:: => AnyEvent::Impl::POE::], |
1080 | [Prima:: => AnyEvent::Impl::POE::], |
1164 | [Prima:: => AnyEvent::Impl::POE::], |
1081 | # 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 |
1082 | # byzantine signal and broken child handling, among others. |
1166 | # byzantine signal and broken child handling, among others. |
1083 | # 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 |
1084 | # obvious default class. |
1168 | # obvious default class. |
1085 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1169 | # [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1086 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1170 | # [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1087 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1171 | # [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1088 | ); |
1172 | ); |
1089 | |
1173 | |
1090 | our %method = map +($_ => 1), |
1174 | our %method = map +($_ => 1), |
1091 | 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); |
1092 | |
1176 | |
… | |
… | |
1096 | my ($cb) = @_; |
1180 | my ($cb) = @_; |
1097 | |
1181 | |
1098 | if ($MODEL) { |
1182 | if ($MODEL) { |
1099 | $cb->(); |
1183 | $cb->(); |
1100 | |
1184 | |
1101 | 1 |
1185 | undef |
1102 | } else { |
1186 | } else { |
1103 | push @post_detect, $cb; |
1187 | push @post_detect, $cb; |
1104 | |
1188 | |
1105 | defined wantarray |
1189 | defined wantarray |
1106 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1190 | ? bless \$cb, "AnyEvent::Util::postdetect" |
… | |
… | |
1112 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1196 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1113 | } |
1197 | } |
1114 | |
1198 | |
1115 | sub detect() { |
1199 | sub detect() { |
1116 | unless ($MODEL) { |
1200 | unless ($MODEL) { |
1117 | no strict 'refs'; |
|
|
1118 | local $SIG{__DIE__}; |
1201 | local $SIG{__DIE__}; |
1119 | |
1202 | |
1120 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1203 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1121 | my $model = "AnyEvent::Impl::$1"; |
1204 | my $model = "AnyEvent::Impl::$1"; |
1122 | if (eval "require $model") { |
1205 | if (eval "require $model") { |
1123 | $MODEL = $model; |
1206 | $MODEL = $model; |
1124 | warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; |
1207 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
1125 | } else { |
1208 | } else { |
1126 | warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; |
1209 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1127 | } |
1210 | } |
1128 | } |
1211 | } |
1129 | |
1212 | |
1130 | # check for already loaded models |
1213 | # check for already loaded models |
1131 | unless ($MODEL) { |
1214 | unless ($MODEL) { |
1132 | for (@REGISTRY, @models) { |
1215 | for (@REGISTRY, @models) { |
1133 | my ($package, $model) = @$_; |
1216 | my ($package, $model) = @$_; |
1134 | if (${"$package\::VERSION"} > 0) { |
1217 | if (${"$package\::VERSION"} > 0) { |
1135 | if (eval "require $model") { |
1218 | if (eval "require $model") { |
1136 | $MODEL = $model; |
1219 | $MODEL = $model; |
1137 | warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; |
1220 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1138 | last; |
1221 | last; |
1139 | } |
1222 | } |
1140 | } |
1223 | } |
1141 | } |
1224 | } |
1142 | |
1225 | |
1143 | unless ($MODEL) { |
1226 | unless ($MODEL) { |
1144 | # try to load a model |
1227 | # try to autoload a model |
1145 | |
|
|
1146 | for (@REGISTRY, @models) { |
1228 | for (@REGISTRY, @models) { |
1147 | my ($package, $model) = @$_; |
1229 | my ($package, $model, $autoload) = @$_; |
|
|
1230 | if ( |
|
|
1231 | $autoload |
1148 | if (eval "require $package" |
1232 | and eval "require $package" |
1149 | and ${"$package\::VERSION"} > 0 |
1233 | and ${"$package\::VERSION"} > 0 |
1150 | and eval "require $model") { |
1234 | and eval "require $model" |
|
|
1235 | ) { |
1151 | $MODEL = $model; |
1236 | $MODEL = $model; |
1152 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; |
1237 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1153 | last; |
1238 | last; |
1154 | } |
1239 | } |
1155 | } |
1240 | } |
1156 | |
1241 | |
1157 | $MODEL |
1242 | $MODEL |
… | |
… | |
1173 | |
1258 | |
1174 | sub AUTOLOAD { |
1259 | sub AUTOLOAD { |
1175 | (my $func = $AUTOLOAD) =~ s/.*://; |
1260 | (my $func = $AUTOLOAD) =~ s/.*://; |
1176 | |
1261 | |
1177 | $method{$func} |
1262 | $method{$func} |
1178 | or croak "$func: not a valid method for AnyEvent objects"; |
1263 | or Carp::croak "$func: not a valid method for AnyEvent objects"; |
1179 | |
1264 | |
1180 | detect unless $MODEL; |
1265 | detect unless $MODEL; |
1181 | |
1266 | |
1182 | my $class = shift; |
1267 | my $class = shift; |
1183 | $class->$func (@_); |
1268 | $class->$func (@_); |
… | |
… | |
1188 | # allow only one watcher per fd, so we dup it to get a different one). |
1273 | # allow only one watcher per fd, so we dup it to get a different one). |
1189 | sub _dupfh($$;$$) { |
1274 | sub _dupfh($$;$$) { |
1190 | my ($poll, $fh, $r, $w) = @_; |
1275 | my ($poll, $fh, $r, $w) = @_; |
1191 | |
1276 | |
1192 | # cygwin requires the fh mode to be matching, unix doesn't |
1277 | # cygwin requires the fh mode to be matching, unix doesn't |
1193 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">"); |
1278 | my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&"); |
1194 | |
1279 | |
1195 | open my $fh2, "$mode&", $fh |
1280 | open my $fh2, $mode, $fh |
1196 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
1281 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
1197 | |
1282 | |
1198 | # we assume CLOEXEC is already set by perl in all important cases |
1283 | # we assume CLOEXEC is already set by perl in all important cases |
1199 | |
1284 | |
1200 | ($fh2, $rw) |
1285 | ($fh2, $rw) |
… | |
… | |
1202 | |
1287 | |
1203 | package AnyEvent::Base; |
1288 | package AnyEvent::Base; |
1204 | |
1289 | |
1205 | # default implementations for many methods |
1290 | # default implementations for many methods |
1206 | |
1291 | |
1207 | BEGIN { |
1292 | sub _time { |
|
|
1293 | # probe for availability of Time::HiRes |
1208 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1294 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
|
|
1295 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1209 | *_time = \&Time::HiRes::time; |
1296 | *_time = \&Time::HiRes::time; |
1210 | # if (eval "use POSIX (); (POSIX::times())... |
1297 | # if (eval "use POSIX (); (POSIX::times())... |
1211 | } else { |
1298 | } else { |
|
|
1299 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1212 | *_time = sub { time }; # epic fail |
1300 | *_time = sub { time }; # epic fail |
1213 | } |
1301 | } |
|
|
1302 | |
|
|
1303 | &_time |
1214 | } |
1304 | } |
1215 | |
1305 | |
1216 | sub time { _time } |
1306 | sub time { _time } |
1217 | sub now { _time } |
1307 | sub now { _time } |
1218 | sub now_update { } |
1308 | sub now_update { } |
… | |
… | |
1223 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1313 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1224 | } |
1314 | } |
1225 | |
1315 | |
1226 | # default implementation for ->signal |
1316 | # default implementation for ->signal |
1227 | |
1317 | |
|
|
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 | |
1228 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1328 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
|
|
1329 | our (%SIG_ASY, %SIG_ASY_W); |
|
|
1330 | our ($SIG_COUNT, $SIG_TW); |
1229 | |
1331 | |
1230 | sub _signal_exec { |
1332 | sub _signal_exec { |
|
|
1333 | $HAVE_ASYNC_INTERRUPT |
|
|
1334 | ? $SIGPIPE_R->drain |
1231 | sysread $SIGPIPE_R, my $dummy, 4; |
1335 | : sysread $SIGPIPE_R, my $dummy, 9; |
1232 | |
1336 | |
1233 | while (%SIG_EV) { |
1337 | while (%SIG_EV) { |
1234 | for (keys %SIG_EV) { |
1338 | for (keys %SIG_EV) { |
1235 | delete $SIG_EV{$_}; |
1339 | delete $SIG_EV{$_}; |
1236 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1340 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1237 | } |
1341 | } |
1238 | } |
1342 | } |
1239 | } |
1343 | } |
1240 | |
1344 | |
|
|
1345 | # install a dummy wakeup watcher to reduce signal catching latency |
|
|
1346 | sub _sig_add() { |
|
|
1347 | unless ($SIG_COUNT++) { |
|
|
1348 | # try to align timer on a full-second boundary, if possible |
|
|
1349 | my $NOW = AnyEvent->now; |
|
|
1350 | |
|
|
1351 | $SIG_TW = AnyEvent->timer ( |
|
|
1352 | after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
|
|
1353 | interval => $MAX_SIGNAL_LATENCY, |
|
|
1354 | cb => sub { }, # just for the PERL_ASYNC_CHECK |
|
|
1355 | ); |
|
|
1356 | } |
|
|
1357 | } |
|
|
1358 | |
|
|
1359 | sub _sig_del { |
|
|
1360 | undef $SIG_TW |
|
|
1361 | unless --$SIG_COUNT; |
|
|
1362 | } |
|
|
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 | |
1241 | sub signal { |
1395 | sub signal { |
1242 | my (undef, %arg) = @_; |
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; |
1243 | |
1400 | |
1244 | unless ($SIGPIPE_R) { |
1401 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1245 | require Fcntl; |
1402 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
1246 | |
1403 | |
1247 | if (AnyEvent::WIN32) { |
|
|
1248 | require AnyEvent::Util; |
|
|
1249 | |
|
|
1250 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1251 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1252 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1253 | } else { |
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 { |
1254 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1416 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1255 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1417 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1256 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
1418 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
1257 | |
1419 | |
1258 | # not strictly required, as $^F is normally 2, but let's make sure... |
1420 | # not strictly required, as $^F is normally 2, but let's make sure... |
1259 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
1421 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
1260 | fcntl $SIGPIPE_W, &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); |
1261 | } |
1429 | } |
1262 | |
1430 | |
1263 | $SIGPIPE_R |
1431 | *signal = sub { |
1264 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1432 | my (undef, %arg) = @_; |
1265 | |
1433 | |
1266 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1267 | } |
|
|
1268 | |
|
|
1269 | my $signal = uc $arg{signal} |
1434 | my $signal = uc $arg{signal} |
1270 | or Carp::croak "required option 'signal' is missing"; |
1435 | or Carp::croak "required option 'signal' is missing"; |
1271 | |
1436 | |
|
|
1437 | if ($HAVE_ASYNC_INTERRUPT) { |
|
|
1438 | # async::interrupt |
|
|
1439 | |
|
|
1440 | $signal = sig2num $signal; |
1272 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1441 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1442 | |
|
|
1443 | $SIG_ASY{$signal} ||= new Async::Interrupt |
|
|
1444 | cb => sub { undef $SIG_EV{$signal} }, |
|
|
1445 | signal => $signal, |
|
|
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 | |
1273 | $SIG{$signal} ||= sub { |
1457 | $SIG{$signal} ||= sub { |
1274 | local $!; |
1458 | local $!; |
1275 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1459 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1276 | undef $SIG_EV{$signal}; |
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; |
|
|
1466 | } |
|
|
1467 | |
|
|
1468 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1469 | }; |
|
|
1470 | |
|
|
1471 | *AnyEvent::Base::signal::DESTROY = sub { |
|
|
1472 | my ($signal, $cb) = @{$_[0]}; |
|
|
1473 | |
|
|
1474 | _sig_del; |
|
|
1475 | |
|
|
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. |
|
|
1483 | undef $SIG{$signal} |
|
|
1484 | unless keys %{ $SIG_CB{$signal} }; |
|
|
1485 | }; |
1277 | }; |
1486 | }; |
1278 | |
1487 | die if $@; |
1279 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1488 | &signal |
1280 | } |
|
|
1281 | |
|
|
1282 | sub AnyEvent::Base::signal::DESTROY { |
|
|
1283 | my ($signal, $cb) = @{$_[0]}; |
|
|
1284 | |
|
|
1285 | delete $SIG_CB{$signal}{$cb}; |
|
|
1286 | |
|
|
1287 | # delete doesn't work with older perls - they then |
|
|
1288 | # print weird messages, or just unconditionally exit |
|
|
1289 | # instead of getting the default action. |
|
|
1290 | undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
|
|
1291 | } |
1489 | } |
1292 | |
1490 | |
1293 | # default implementation for ->child |
1491 | # default implementation for ->child |
1294 | |
1492 | |
1295 | our %PID_CB; |
1493 | our %PID_CB; |
1296 | our $CHLD_W; |
1494 | our $CHLD_W; |
1297 | our $CHLD_DELAY_W; |
1495 | our $CHLD_DELAY_W; |
1298 | our $WNOHANG; |
1496 | our $WNOHANG; |
1299 | |
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 | |
1300 | sub _sigchld { |
1506 | sub _sigchld { |
|
|
1507 | my $pid; |
|
|
1508 | |
|
|
1509 | AnyEvent->_emit_childstatus ($pid, $?) |
1301 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1510 | while ($pid = waitpid -1, $WNOHANG) > 0; |
1302 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
|
|
1303 | (values %{ $PID_CB{0} || {} }); |
|
|
1304 | } |
|
|
1305 | } |
1511 | } |
1306 | |
1512 | |
1307 | sub child { |
1513 | sub child { |
1308 | my (undef, %arg) = @_; |
1514 | my (undef, %arg) = @_; |
1309 | |
1515 | |
1310 | defined (my $pid = $arg{pid} + 0) |
1516 | defined (my $pid = $arg{pid} + 0) |
1311 | or Carp::croak "required option 'pid' is missing"; |
1517 | or Carp::croak "required option 'pid' is missing"; |
1312 | |
1518 | |
1313 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1519 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1314 | |
1520 | |
|
|
1521 | # WNOHANG is almost cetrainly 1 everywhere |
|
|
1522 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
|
|
1523 | ? 1 |
1315 | $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1524 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1316 | |
1525 | |
1317 | unless ($CHLD_W) { |
1526 | unless ($CHLD_W) { |
1318 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1527 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1319 | # child could be a zombie already, so make at least one round |
1528 | # child could be a zombie already, so make at least one round |
1320 | &_sigchld; |
1529 | &_sigchld; |
… | |
… | |
1372 | |
1581 | |
1373 | our @ISA = AnyEvent::CondVar::Base::; |
1582 | our @ISA = AnyEvent::CondVar::Base::; |
1374 | |
1583 | |
1375 | package AnyEvent::CondVar::Base; |
1584 | package AnyEvent::CondVar::Base; |
1376 | |
1585 | |
1377 | use overload |
1586 | #use overload |
1378 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1587 | # '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1379 | fallback => 1; |
1588 | # fallback => 1; |
|
|
1589 | |
|
|
1590 | # save 300+ kilobytes by dirtily hardcoding overloading |
|
|
1591 | ${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching. |
|
|
1592 | *{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod." |
|
|
1593 | *{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{} |
|
|
1594 | ${'AnyEvent::CondVar::Base::()'} = 1; # fallback |
|
|
1595 | |
|
|
1596 | our $WAITING; |
1380 | |
1597 | |
1381 | sub _send { |
1598 | sub _send { |
1382 | # nop |
1599 | # nop |
1383 | } |
1600 | } |
1384 | |
1601 | |
… | |
… | |
1397 | sub ready { |
1614 | sub ready { |
1398 | $_[0]{_ae_sent} |
1615 | $_[0]{_ae_sent} |
1399 | } |
1616 | } |
1400 | |
1617 | |
1401 | sub _wait { |
1618 | sub _wait { |
|
|
1619 | $WAITING |
|
|
1620 | and !$_[0]{_ae_sent} |
|
|
1621 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; |
|
|
1622 | |
|
|
1623 | local $WAITING = 1; |
1402 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
1624 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
1403 | } |
1625 | } |
1404 | |
1626 | |
1405 | sub recv { |
1627 | sub recv { |
1406 | $_[0]->_wait; |
1628 | $_[0]->_wait; |
… | |
… | |
1425 | } |
1647 | } |
1426 | |
1648 | |
1427 | # undocumented/compatibility with pre-3.4 |
1649 | # undocumented/compatibility with pre-3.4 |
1428 | *broadcast = \&send; |
1650 | *broadcast = \&send; |
1429 | *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 | } |
1430 | |
1694 | |
1431 | =head1 ERROR AND EXCEPTION HANDLING |
1695 | =head1 ERROR AND EXCEPTION HANDLING |
1432 | |
1696 | |
1433 | 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 |
1434 | 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 |
… | |
… | |
1468 | C<PERL_ANYEVENT_MODEL>. |
1732 | C<PERL_ANYEVENT_MODEL>. |
1469 | |
1733 | |
1470 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1734 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1471 | model it chooses. |
1735 | model it chooses. |
1472 | |
1736 | |
|
|
1737 | When set to C<8> or higher, then AnyEvent will report extra information on |
|
|
1738 | which optional modules it loads and how it implements certain features. |
|
|
1739 | |
1473 | =item C<PERL_ANYEVENT_STRICT> |
1740 | =item C<PERL_ANYEVENT_STRICT> |
1474 | |
1741 | |
1475 | AnyEvent does not do much argument checking by default, as thorough |
1742 | AnyEvent does not do much argument checking by default, as thorough |
1476 | argument checking is very costly. Setting this variable to a true value |
1743 | argument checking is very costly. Setting this variable to a true value |
1477 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1744 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1478 | check the arguments passed to most method calls. If it finds any problems, |
1745 | check the arguments passed to most method calls. If it finds any problems, |
1479 | it will croak. |
1746 | it will croak. |
1480 | |
1747 | |
1481 | In other words, enables "strict" mode. |
1748 | In other words, enables "strict" mode. |
1482 | |
1749 | |
1483 | Unlike C<use strict>, it is definitely recommended to keep it off in |
1750 | Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> |
1484 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1751 | >>, it is definitely recommended to keep it off in production. Keeping |
1485 | developing programs can be very useful, however. |
1752 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
|
|
1753 | can be very useful, however. |
1486 | |
1754 | |
1487 | =item C<PERL_ANYEVENT_MODEL> |
1755 | =item C<PERL_ANYEVENT_MODEL> |
1488 | |
1756 | |
1489 | This can be used to specify the event model to be used by AnyEvent, before |
1757 | This can be used to specify the event model to be used by AnyEvent, before |
1490 | auto detection and -probing kicks in. It must be a string consisting |
1758 | auto detection and -probing kicks in. It must be a string consisting |
… | |
… | |
1552 | |
1820 | |
1553 | When neither C<ca_file> nor C<ca_path> was specified during |
1821 | When neither C<ca_file> nor C<ca_path> was specified during |
1554 | L<AnyEvent::TLS> context creation, and either of these environment |
1822 | L<AnyEvent::TLS> context creation, and either of these environment |
1555 | variables exist, they will be used to specify CA certificate locations |
1823 | variables exist, they will be used to specify CA certificate locations |
1556 | instead of a system-dependent default. |
1824 | instead of a system-dependent default. |
|
|
1825 | |
|
|
1826 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
|
|
1827 | |
|
|
1828 | When these are set to C<1>, then the respective modules are not |
|
|
1829 | loaded. Mostly good for testing AnyEvent itself. |
1557 | |
1830 | |
1558 | =back |
1831 | =back |
1559 | |
1832 | |
1560 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1833 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1561 | |
1834 | |
… | |
… | |
2100 | |
2373 | |
2101 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2374 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2102 | emulation for event loops that do not support them natively. Also, some |
2375 | emulation for event loops that do not support them natively. Also, some |
2103 | event loops install a similar handler. |
2376 | event loops install a similar handler. |
2104 | |
2377 | |
2105 | If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will |
2378 | Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then |
2106 | reset it to default, to avoid losing child exit statuses. |
2379 | AnyEvent will reset it to default, to avoid losing child exit statuses. |
2107 | |
2380 | |
2108 | =item SIGPIPE |
2381 | =item SIGPIPE |
2109 | |
2382 | |
2110 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2383 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2111 | when AnyEvent gets loaded. |
2384 | when AnyEvent gets loaded. |
… | |
… | |
2129 | if $SIG{CHLD} eq 'IGNORE'; |
2402 | if $SIG{CHLD} eq 'IGNORE'; |
2130 | |
2403 | |
2131 | $SIG{PIPE} = sub { } |
2404 | $SIG{PIPE} = sub { } |
2132 | unless defined $SIG{PIPE}; |
2405 | unless defined $SIG{PIPE}; |
2133 | |
2406 | |
|
|
2407 | =head1 RECOMMENDED/OPTIONAL MODULES |
|
|
2408 | |
|
|
2409 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
|
|
2410 | it's built-in modules) are required to use it. |
|
|
2411 | |
|
|
2412 | That does not mean that AnyEvent won't take advantage of some additional |
|
|
2413 | modules if they are installed. |
|
|
2414 | |
|
|
2415 | This section epxlains which additional modules will be used, and how they |
|
|
2416 | affect AnyEvent's operetion. |
|
|
2417 | |
|
|
2418 | =over 4 |
|
|
2419 | |
|
|
2420 | =item L<Async::Interrupt> |
|
|
2421 | |
|
|
2422 | This slightly arcane module is used to implement fast signal handling: To |
|
|
2423 | my knowledge, there is no way to do completely race-free and quick |
|
|
2424 | signal handling in pure perl. To ensure that signals still get |
|
|
2425 | delivered, AnyEvent will start an interval timer to wake up perl (and |
|
|
2426 | catch the signals) with some delay (default is 10 seconds, look for |
|
|
2427 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
|
|
2428 | |
|
|
2429 | If this module is available, then it will be used to implement signal |
|
|
2430 | catching, which means that signals will not be delayed, and the event loop |
|
|
2431 | will not be interrupted regularly, which is more efficient (And good for |
|
|
2432 | battery life on laptops). |
|
|
2433 | |
|
|
2434 | This affects not just the pure-perl event loop, but also other event loops |
|
|
2435 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
|
|
2436 | |
|
|
2437 | Some event loops (POE, Event, Event::Lib) offer signal watchers natively, |
|
|
2438 | and either employ their own workarounds (POE) or use AnyEvent's workaround |
|
|
2439 | (using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt> |
|
|
2440 | does nothing for those backends. |
|
|
2441 | |
|
|
2442 | =item L<EV> |
|
|
2443 | |
|
|
2444 | This module isn't really "optional", as it is simply one of the backend |
|
|
2445 | event loops that AnyEvent can use. However, it is simply the best event |
|
|
2446 | loop available in terms of features, speed and stability: It supports |
|
|
2447 | the AnyEvent API optimally, implements all the watcher types in XS, does |
|
|
2448 | automatic timer adjustments even when no monotonic clock is available, |
|
|
2449 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
|
|
2450 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
|
|
2451 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
|
|
2452 | |
|
|
2453 | =item L<Guard> |
|
|
2454 | |
|
|
2455 | The guard module, when used, will be used to implement |
|
|
2456 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
|
|
2457 | lot less memory), but otherwise doesn't affect guard operation much. It is |
|
|
2458 | purely used for performance. |
|
|
2459 | |
|
|
2460 | =item L<JSON> and L<JSON::XS> |
|
|
2461 | |
|
|
2462 | This module is required when you want to read or write JSON data via |
|
|
2463 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
|
|
2464 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
|
|
2465 | |
|
|
2466 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
|
|
2467 | installed. |
|
|
2468 | |
|
|
2469 | =item L<Net::SSLeay> |
|
|
2470 | |
|
|
2471 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
|
|
2472 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
|
|
2473 | the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. |
|
|
2474 | |
|
|
2475 | =item L<Time::HiRes> |
|
|
2476 | |
|
|
2477 | This module is part of perl since release 5.008. It will be used when the |
|
|
2478 | chosen event library does not come with a timing source on it's own. The |
|
|
2479 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
|
|
2480 | try to use a monotonic clock for timing stability. |
|
|
2481 | |
|
|
2482 | =back |
|
|
2483 | |
|
|
2484 | |
2134 | =head1 FORK |
2485 | =head1 FORK |
2135 | |
2486 | |
2136 | Most event libraries are not fork-safe. The ones who are usually are |
2487 | Most event libraries are not fork-safe. The ones who are usually are |
2137 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2488 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2138 | calls. Only L<EV> is fully fork-aware. |
2489 | calls. Only L<EV> is fully fork-aware. |
2139 | |
2490 | |
2140 | If you have to fork, you must either do so I<before> creating your first |
2491 | If you have to fork, you must either do so I<before> creating your first |
2141 | watcher OR you must not use AnyEvent at all in the child. |
2492 | watcher OR you must not use AnyEvent at all in the child OR you must do |
|
|
2493 | something completely out of the scope of AnyEvent. |
2142 | |
2494 | |
2143 | |
2495 | |
2144 | =head1 SECURITY CONSIDERATIONS |
2496 | =head1 SECURITY CONSIDERATIONS |
2145 | |
2497 | |
2146 | AnyEvent can be forced to load any event model via |
2498 | AnyEvent can be forced to load any event model via |
… | |
… | |
2184 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2536 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2185 | |
2537 | |
2186 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2538 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2187 | 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>, |
2188 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2540 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2189 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
2541 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2190 | |
2542 | |
2191 | Non-blocking file handles, sockets, TCP clients and |
2543 | Non-blocking file handles, sockets, TCP clients and |
2192 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2544 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2193 | |
2545 | |
2194 | Asynchronous DNS: L<AnyEvent::DNS>. |
2546 | Asynchronous DNS: L<AnyEvent::DNS>. |