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> (I<not> 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 |
183 | handle). Note that only file handles pointing to things for which |
197 | handle). Note that only file handles pointing to things for which |
184 | non-blocking operation makes sense are allowed. This includes sockets, |
198 | non-blocking operation makes sense are allowed. This includes sockets, |
185 | most character devices, pipes, fifos and so on, but not for example files |
199 | most character devices, pipes, fifos and so on, but not for example files |
186 | or block devices. |
200 | or block devices. |
… | |
… | |
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 |
|
|
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, |
|
|
407 | signals will be delayed. The maximum time a signal might be delayed is |
|
|
408 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
|
|
409 | variable can be changed only before the first signal watcher is created, |
|
|
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 |
|
|
412 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
413 | saving. |
|
|
414 | |
|
|
415 | All these problems can be avoided by installing the optional |
|
|
416 | L<Async::Interrupt> module, which works with most event loops. It will not |
|
|
417 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
|
|
418 | (and not with L<POE> currently, as POE does it's own workaround with |
|
|
419 | one-second latency). For those, you just have to suffer the delays. |
|
|
420 | |
375 | =head2 CHILD PROCESS WATCHERS |
421 | =head2 CHILD PROCESS WATCHERS |
376 | |
422 | |
|
|
423 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
|
|
424 | |
377 | 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. |
378 | |
426 | |
379 | 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, |
380 | 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 |
381 | 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 |
382 | any trace events (stopped/continued). |
430 | finished and an exit status is available, not on any trace events |
|
|
431 | (stopped/continued). |
383 | |
432 | |
384 | 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 |
385 | 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 |
386 | callback arguments. |
435 | callback arguments. |
387 | |
436 | |
… | |
… | |
403 | |
452 | |
404 | This means you cannot create a child watcher as the very first |
453 | 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 |
454 | 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 |
455 | watcher before you C<fork> the child (alternatively, you can call |
407 | C<AnyEvent::detect>). |
456 | C<AnyEvent::detect>). |
|
|
457 | |
|
|
458 | As most event loops do not support waiting for child events, they will be |
|
|
459 | emulated by AnyEvent in most cases, in which the latency and race problems |
|
|
460 | mentioned in the description of signal watchers apply. |
408 | |
461 | |
409 | Example: fork a process and wait for it |
462 | Example: fork a process and wait for it |
410 | |
463 | |
411 | my $done = AnyEvent->condvar; |
464 | my $done = AnyEvent->condvar; |
412 | |
465 | |
… | |
… | |
424 | # do something else, then wait for process exit |
477 | # do something else, then wait for process exit |
425 | $done->recv; |
478 | $done->recv; |
426 | |
479 | |
427 | =head2 IDLE WATCHERS |
480 | =head2 IDLE WATCHERS |
428 | |
481 | |
|
|
482 | $w = AnyEvent->idle (cb => <callback>); |
|
|
483 | |
429 | 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 |
430 | 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 |
431 | "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 |
432 | attention by the event loop". |
487 | attention by the event loop". |
433 | |
488 | |
… | |
… | |
459 | }); |
514 | }); |
460 | }); |
515 | }); |
461 | |
516 | |
462 | =head2 CONDITION VARIABLES |
517 | =head2 CONDITION VARIABLES |
463 | |
518 | |
|
|
519 | $cv = AnyEvent->condvar; |
|
|
520 | |
|
|
521 | $cv->send (<list>); |
|
|
522 | my @res = $cv->recv; |
|
|
523 | |
464 | 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 |
465 | 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 |
466 | will actively watch for new events and call your callbacks. |
526 | will actively watch for new events and call your callbacks. |
467 | |
527 | |
468 | AnyEvent is different, it expects somebody else to run the event loop and |
528 | AnyEvent is slightly different: it expects somebody else to run the event |
469 | will only block when necessary (usually when told by the user). |
529 | loop and will only block when necessary (usually when told by the user). |
470 | |
530 | |
471 | The instrument to do that is called a "condition variable", so called |
531 | The instrument to do that is called a "condition variable", so called |
472 | because they represent a condition that must become true. |
532 | because they represent a condition that must become true. |
473 | |
533 | |
|
|
534 | Now is probably a good time to look at the examples further below. |
|
|
535 | |
474 | Condition variables can be created by calling the C<< AnyEvent->condvar |
536 | Condition variables can be created by calling the C<< AnyEvent->condvar |
475 | >> method, usually without arguments. The only argument pair allowed is |
537 | >> 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 |
538 | 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 |
539 | becomes true, with the condition variable as the first argument (but not |
479 | the results). |
540 | the results). |
480 | |
541 | |
481 | After creation, the condition variable is "false" until it becomes "true" |
542 | After creation, the condition variable is "false" until it becomes "true" |
… | |
… | |
486 | Condition variables are similar to callbacks, except that you can |
547 | Condition variables are similar to callbacks, except that you can |
487 | 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 |
488 | in time where multiple outstanding events have been processed. And yet |
549 | in time where multiple outstanding events have been processed. And yet |
489 | 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 |
490 | 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 |
491 | 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. |
492 | |
554 | |
493 | Condition variables are very useful to signal that something has finished, |
555 | Condition variables are very useful to signal that something has finished, |
494 | 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, |
495 | 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 |
496 | 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 |
… | |
… | |
530 | after => 1, |
592 | after => 1, |
531 | cb => sub { $result_ready->send }, |
593 | cb => sub { $result_ready->send }, |
532 | ); |
594 | ); |
533 | |
595 | |
534 | # this "blocks" (while handling events) till the callback |
596 | # this "blocks" (while handling events) till the callback |
535 | # calls send |
597 | # calls -<send |
536 | $result_ready->recv; |
598 | $result_ready->recv; |
537 | |
599 | |
538 | Example: wait for a timer, but take advantage of the fact that |
600 | Example: wait for a timer, but take advantage of the fact that condition |
539 | condition variables are also code references. |
601 | variables are also callable directly. |
540 | |
602 | |
541 | my $done = AnyEvent->condvar; |
603 | my $done = AnyEvent->condvar; |
542 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
604 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
543 | $done->recv; |
605 | $done->recv; |
544 | |
606 | |
… | |
… | |
550 | |
612 | |
551 | ... |
613 | ... |
552 | |
614 | |
553 | my @info = $couchdb->info->recv; |
615 | my @info = $couchdb->info->recv; |
554 | |
616 | |
555 | And this is how you would just ste a callback to be called whenever the |
617 | And this is how you would just set a callback to be called whenever the |
556 | results are available: |
618 | results are available: |
557 | |
619 | |
558 | $couchdb->info->cb (sub { |
620 | $couchdb->info->cb (sub { |
559 | my @info = $_[0]->recv; |
621 | my @info = $_[0]->recv; |
560 | }); |
622 | }); |
… | |
… | |
578 | immediately from within send. |
640 | immediately from within send. |
579 | |
641 | |
580 | Any arguments passed to the C<send> call will be returned by all |
642 | Any arguments passed to the C<send> call will be returned by all |
581 | future C<< ->recv >> calls. |
643 | future C<< ->recv >> calls. |
582 | |
644 | |
583 | Condition variables are overloaded so one can call them directly |
645 | 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 |
646 | 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 |
647 | 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 | |
648 | |
592 | =item $cv->croak ($error) |
649 | =item $cv->croak ($error) |
593 | |
650 | |
594 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
651 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
595 | C<Carp::croak> with the given error message/object/scalar. |
652 | C<Carp::croak> with the given error message/object/scalar. |
596 | |
653 | |
597 | This can be used to signal any errors to the condition variable |
654 | This can be used to signal any errors to the condition variable |
598 | user/consumer. |
655 | user/consumer. Doing it this way instead of calling C<croak> directly |
|
|
656 | delays the error detetcion, but has the overwhelmign advantage that it |
|
|
657 | diagnoses the error at the place where the result is expected, and not |
|
|
658 | deep in some event clalback without connection to the actual code causing |
|
|
659 | the problem. |
599 | |
660 | |
600 | =item $cv->begin ([group callback]) |
661 | =item $cv->begin ([group callback]) |
601 | |
662 | |
602 | =item $cv->end |
663 | =item $cv->end |
603 | |
664 | |
… | |
… | |
699 | function will call C<croak>. |
760 | function will call C<croak>. |
700 | |
761 | |
701 | In list context, all parameters passed to C<send> will be returned, |
762 | In list context, all parameters passed to C<send> will be returned, |
702 | in scalar context only the first one will be returned. |
763 | in scalar context only the first one will be returned. |
703 | |
764 | |
|
|
765 | Note that doing a blocking wait in a callback is not supported by any |
|
|
766 | event loop, that is, recursive invocation of a blocking C<< ->recv |
|
|
767 | >> is not allowed, and the C<recv> call will C<croak> if such a |
|
|
768 | condition is detected. This condition can be slightly loosened by using |
|
|
769 | L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from |
|
|
770 | any thread that doesn't run the event loop itself. |
|
|
771 | |
704 | Not all event models support a blocking wait - some die in that case |
772 | 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 |
773 | (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 |
774 | 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 |
775 | caller decide whether the call will block or not (for example, by coupling |
708 | condition variables with some kind of request results and supporting |
776 | condition variables with some kind of request results and supporting |
709 | callbacks so the caller knows that getting the result will not block, |
777 | callbacks so the caller knows that getting the result will not block, |
710 | while still supporting blocking waits if the caller so desires). |
778 | while still supporting blocking waits if the caller so desires). |
711 | |
779 | |
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 | |
|
|
723 | You can ensure that C<< -recv >> never blocks by setting a callback and |
780 | 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 |
781 | 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 |
782 | time). This will work even when the event loop does not support blocking |
726 | waits otherwise. |
783 | waits otherwise. |
727 | |
784 | |
… | |
… | |
740 | variable itself. Calling C<recv> inside the callback or at any later time |
797 | variable itself. Calling C<recv> inside the callback or at any later time |
741 | is guaranteed not to block. |
798 | is guaranteed not to block. |
742 | |
799 | |
743 | =back |
800 | =back |
744 | |
801 | |
|
|
802 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
|
|
803 | |
|
|
804 | The available backend classes are (every class has its own manpage): |
|
|
805 | |
|
|
806 | =over 4 |
|
|
807 | |
|
|
808 | =item Backends that are autoprobed when no other event loop can be found. |
|
|
809 | |
|
|
810 | EV is the preferred backend when no other event loop seems to be in |
|
|
811 | use. If EV is not installed, then AnyEvent will try Event, and, failing |
|
|
812 | that, will fall back to its own pure-perl implementation, which is |
|
|
813 | available everywhere as it comes with AnyEvent itself. |
|
|
814 | |
|
|
815 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
|
|
816 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
817 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
818 | |
|
|
819 | =item Backends that are transparently being picked up when they are used. |
|
|
820 | |
|
|
821 | These will be used when they are currently loaded when the first watcher |
|
|
822 | is created, in which case it is assumed that the application is using |
|
|
823 | them. This means that AnyEvent will automatically pick the right backend |
|
|
824 | when the main program loads an event module before anything starts to |
|
|
825 | create watchers. Nothing special needs to be done by the main program. |
|
|
826 | |
|
|
827 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
|
|
828 | AnyEvent::Impl::Tk based on Tk, very broken. |
|
|
829 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
830 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
831 | AnyEvent::Impl::Irssi used when running within irssi. |
|
|
832 | |
|
|
833 | =item Backends with special needs. |
|
|
834 | |
|
|
835 | Qt requires the Qt::Application to be instantiated first, but will |
|
|
836 | otherwise be picked up automatically. As long as the main program |
|
|
837 | instantiates the application before any AnyEvent watchers are created, |
|
|
838 | everything should just work. |
|
|
839 | |
|
|
840 | AnyEvent::Impl::Qt based on Qt. |
|
|
841 | |
|
|
842 | Support for IO::Async can only be partial, as it is too broken and |
|
|
843 | architecturally limited to even support the AnyEvent API. It also |
|
|
844 | is the only event loop that needs the loop to be set explicitly, so |
|
|
845 | it can only be used by a main program knowing about AnyEvent. See |
|
|
846 | L<AnyEvent::Impl::Async> for the gory details. |
|
|
847 | |
|
|
848 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
|
|
849 | |
|
|
850 | =item Event loops that are indirectly supported via other backends. |
|
|
851 | |
|
|
852 | Some event loops can be supported via other modules: |
|
|
853 | |
|
|
854 | There is no direct support for WxWidgets (L<Wx>) or L<Prima>. |
|
|
855 | |
|
|
856 | B<WxWidgets> has no support for watching file handles. However, you can |
|
|
857 | use WxWidgets through the POE adaptor, as POE has a Wx backend that simply |
|
|
858 | polls 20 times per second, which was considered to be too horrible to even |
|
|
859 | consider for AnyEvent. |
|
|
860 | |
|
|
861 | B<Prima> is not supported as nobody seems to be using it, but it has a POE |
|
|
862 | backend, so it can be supported through POE. |
|
|
863 | |
|
|
864 | AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to |
|
|
865 | load L<POE> when detecting them, in the hope that POE will pick them up, |
|
|
866 | in which case everything will be automatic. |
|
|
867 | |
|
|
868 | =back |
|
|
869 | |
745 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
870 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
746 | |
871 | |
|
|
872 | These are not normally required to use AnyEvent, but can be useful to |
|
|
873 | write AnyEvent extension modules. |
|
|
874 | |
747 | =over 4 |
875 | =over 4 |
748 | |
876 | |
749 | =item $AnyEvent::MODEL |
877 | =item $AnyEvent::MODEL |
750 | |
878 | |
751 | Contains C<undef> until the first watcher is being created. Then it |
879 | Contains C<undef> until the first watcher is being created, before the |
|
|
880 | backend has been autodetected. |
|
|
881 | |
752 | contains the event model that is being used, which is the name of the |
882 | Afterwards it contains the event model that is being used, which is the |
753 | Perl class implementing the model. This class is usually one of the |
883 | name of the Perl class implementing the model. This class is usually one |
754 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
884 | of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the |
755 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
885 | case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it |
756 | |
886 | will be C<urxvt::anyevent>). |
757 | The known classes so far are: |
|
|
758 | |
|
|
759 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
|
|
760 | AnyEvent::Impl::Event based on Event, second best choice. |
|
|
761 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
762 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
|
|
763 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
|
|
764 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
|
|
765 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
766 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
|
|
767 | |
|
|
768 | # warning, support for IO::Async is only partial, as it is too broken |
|
|
769 | # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async. |
|
|
770 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs). |
|
|
771 | |
|
|
772 | There is no support for WxWidgets, as WxWidgets has no support for |
|
|
773 | watching file handles. However, you can use WxWidgets through the |
|
|
774 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
|
|
775 | second, which was considered to be too horrible to even consider for |
|
|
776 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
|
|
777 | it's adaptor. |
|
|
778 | |
|
|
779 | AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when |
|
|
780 | autodetecting them. |
|
|
781 | |
887 | |
782 | =item AnyEvent::detect |
888 | =item AnyEvent::detect |
783 | |
889 | |
784 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
890 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
785 | if necessary. You should only call this function right before you would |
891 | if necessary. You should only call this function right before you would |
786 | have created an AnyEvent watcher anyway, that is, as late as possible at |
892 | have created an AnyEvent watcher anyway, that is, as late as possible at |
787 | runtime. |
893 | runtime, and not e.g. while initialising of your module. |
|
|
894 | |
|
|
895 | If you need to do some initialisation before AnyEvent watchers are |
|
|
896 | created, use C<post_detect>. |
788 | |
897 | |
789 | =item $guard = AnyEvent::post_detect { BLOCK } |
898 | =item $guard = AnyEvent::post_detect { BLOCK } |
790 | |
899 | |
791 | Arranges for the code block to be executed as soon as the event model is |
900 | Arranges for the code block to be executed as soon as the event model is |
792 | autodetected (or immediately if this has already happened). |
901 | autodetected (or immediately if this has already happened). |
793 | |
902 | |
|
|
903 | The block will be executed I<after> the actual backend has been detected |
|
|
904 | (C<$AnyEvent::MODEL> is set), but I<before> any watchers have been |
|
|
905 | created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do |
|
|
906 | other initialisations - see the sources of L<AnyEvent::Strict> or |
|
|
907 | L<AnyEvent::AIO> to see how this is used. |
|
|
908 | |
|
|
909 | The most common usage is to create some global watchers, without forcing |
|
|
910 | event module detection too early, for example, L<AnyEvent::AIO> creates |
|
|
911 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
|
|
912 | avoid autodetecting the event module at load time. |
|
|
913 | |
794 | 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 |
795 | 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 |
796 | 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; |
797 | |
934 | |
798 | =item @AnyEvent::post_detect |
935 | =item @AnyEvent::post_detect |
799 | |
936 | |
800 | 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 |
801 | before or after loading AnyEvent), then they will called directly after |
938 | before or after loading AnyEvent), then they will called directly after |
802 | the event loop has been chosen. |
939 | the event loop has been chosen. |
803 | |
940 | |
804 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
941 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
805 | if it contains a true value then the event loop has already been detected, |
942 | if it is defined then the event loop has already been detected, and the |
806 | and the array will be ignored. |
943 | array will be ignored. |
807 | |
944 | |
808 | Best use C<AnyEvent::post_detect { BLOCK }> instead. |
945 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
|
|
946 | it,as it takes care of these details. |
|
|
947 | |
|
|
948 | This variable is mainly useful for modules that can do something useful |
|
|
949 | when AnyEvent is used and thus want to know when it is initialised, but do |
|
|
950 | not need to even load it by default. This array provides the means to hook |
|
|
951 | into AnyEvent passively, without loading it. |
809 | |
952 | |
810 | =back |
953 | =back |
811 | |
954 | |
812 | =head1 WHAT TO DO IN A MODULE |
955 | =head1 WHAT TO DO IN A MODULE |
813 | |
956 | |
… | |
… | |
868 | |
1011 | |
869 | |
1012 | |
870 | =head1 OTHER MODULES |
1013 | =head1 OTHER MODULES |
871 | |
1014 | |
872 | The following is a non-exhaustive list of additional modules that use |
1015 | The following is a non-exhaustive list of additional modules that use |
873 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
1016 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
874 | in the same program. Some of the modules come with AnyEvent, some are |
1017 | modules and other event loops in the same program. Some of the modules |
875 | available via CPAN. |
1018 | come with AnyEvent, most are available via CPAN. |
876 | |
1019 | |
877 | =over 4 |
1020 | =over 4 |
878 | |
1021 | |
879 | =item L<AnyEvent::Util> |
1022 | =item L<AnyEvent::Util> |
880 | |
1023 | |
… | |
… | |
889 | |
1032 | |
890 | =item L<AnyEvent::Handle> |
1033 | =item L<AnyEvent::Handle> |
891 | |
1034 | |
892 | Provide read and write buffers, manages watchers for reads and writes, |
1035 | Provide read and write buffers, manages watchers for reads and writes, |
893 | supports raw and formatted I/O, I/O queued and fully transparent and |
1036 | supports raw and formatted I/O, I/O queued and fully transparent and |
894 | non-blocking SSL/TLS. |
1037 | non-blocking SSL/TLS (via L<AnyEvent::TLS>. |
895 | |
1038 | |
896 | =item L<AnyEvent::DNS> |
1039 | =item L<AnyEvent::DNS> |
897 | |
1040 | |
898 | Provides rich asynchronous DNS resolver capabilities. |
1041 | Provides rich asynchronous DNS resolver capabilities. |
899 | |
1042 | |
… | |
… | |
927 | |
1070 | |
928 | =item L<AnyEvent::GPSD> |
1071 | =item L<AnyEvent::GPSD> |
929 | |
1072 | |
930 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
1073 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
931 | |
1074 | |
|
|
1075 | =item L<AnyEvent::IRC> |
|
|
1076 | |
|
|
1077 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
1078 | |
|
|
1079 | =item L<AnyEvent::XMPP> |
|
|
1080 | |
|
|
1081 | AnyEvent based XMPP (Jabber protocol) module family (replacing the older |
|
|
1082 | Net::XMPP2>. |
|
|
1083 | |
932 | =item L<AnyEvent::IGS> |
1084 | =item L<AnyEvent::IGS> |
933 | |
1085 | |
934 | A non-blocking interface to the Internet Go Server protocol (used by |
1086 | A non-blocking interface to the Internet Go Server protocol (used by |
935 | L<App::IGS>). |
1087 | L<App::IGS>). |
936 | |
1088 | |
937 | =item L<AnyEvent::IRC> |
|
|
938 | |
|
|
939 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
940 | |
|
|
941 | =item L<Net::XMPP2> |
|
|
942 | |
|
|
943 | AnyEvent based XMPP (Jabber protocol) module family. |
|
|
944 | |
|
|
945 | =item L<Net::FCP> |
1089 | =item L<Net::FCP> |
946 | |
1090 | |
947 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
1091 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
948 | of AnyEvent. |
1092 | of AnyEvent. |
949 | |
1093 | |
… | |
… | |
953 | |
1097 | |
954 | =item L<Coro> |
1098 | =item L<Coro> |
955 | |
1099 | |
956 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1100 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
957 | |
1101 | |
958 | =item L<IO::Lambda> |
|
|
959 | |
|
|
960 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
|
|
961 | |
|
|
962 | =back |
1102 | =back |
963 | |
1103 | |
964 | =cut |
1104 | =cut |
965 | |
1105 | |
966 | package AnyEvent; |
1106 | package AnyEvent; |
967 | |
1107 | |
|
|
1108 | # basically a tuned-down version of common::sense |
|
|
1109 | sub common_sense { |
968 | no warnings; |
1110 | # no warnings |
|
|
1111 | ${^WARNING_BITS} ^= ${^WARNING_BITS}; |
969 | use strict qw(vars subs); |
1112 | # use strict vars subs |
|
|
1113 | $^H |= 0x00000600; |
|
|
1114 | } |
970 | |
1115 | |
|
|
1116 | BEGIN { AnyEvent::common_sense } |
|
|
1117 | |
971 | use Carp; |
1118 | use Carp (); |
972 | |
1119 | |
973 | our $VERSION = 4.452; |
1120 | our $VERSION = 4.9; |
974 | our $MODEL; |
1121 | our $MODEL; |
975 | |
1122 | |
976 | our $AUTOLOAD; |
1123 | our $AUTOLOAD; |
977 | our @ISA; |
1124 | our @ISA; |
978 | |
1125 | |
979 | our @REGISTRY; |
1126 | our @REGISTRY; |
980 | |
1127 | |
981 | our $WIN32; |
1128 | our $WIN32; |
|
|
1129 | |
|
|
1130 | our $VERBOSE; |
982 | |
1131 | |
983 | BEGIN { |
1132 | BEGIN { |
984 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1133 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
985 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1134 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
986 | |
1135 | |
987 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1136 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
988 | if ${^TAINT}; |
1137 | if ${^TAINT}; |
989 | } |
|
|
990 | |
1138 | |
991 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1139 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
|
|
1140 | |
|
|
1141 | } |
|
|
1142 | |
|
|
1143 | our $MAX_SIGNAL_LATENCY = 10; |
992 | |
1144 | |
993 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1145 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
994 | |
1146 | |
995 | { |
1147 | { |
996 | my $idx; |
1148 | my $idx; |
… | |
… | |
998 | for reverse split /\s*,\s*/, |
1150 | for reverse split /\s*,\s*/, |
999 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1151 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1000 | } |
1152 | } |
1001 | |
1153 | |
1002 | my @models = ( |
1154 | my @models = ( |
1003 | [EV:: => AnyEvent::Impl::EV::], |
1155 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1004 | [Event:: => AnyEvent::Impl::Event::], |
1156 | [Event:: => AnyEvent::Impl::Event::, 1], |
1005 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1157 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1006 | # everything below here will not be autoprobed |
1158 | # everything below here will not (normally) be autoprobed |
1007 | # as the pureperl backend should work everywhere |
1159 | # as the pureperl backend should work everywhere |
1008 | # and is usually faster |
1160 | # and is usually faster |
|
|
1161 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
|
|
1162 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1163 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1009 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1164 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1010 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
|
|
1011 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1012 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1165 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1013 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1166 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1014 | [Wx:: => AnyEvent::Impl::POE::], |
1167 | [Wx:: => AnyEvent::Impl::POE::], |
1015 | [Prima:: => AnyEvent::Impl::POE::], |
1168 | [Prima:: => AnyEvent::Impl::POE::], |
1016 | # IO::Async is just too broken - we would need workaorunds for its |
1169 | # IO::Async is just too broken - we would need workarounds for its |
1017 | # byzantine signal and broken child handling, among others. |
1170 | # byzantine signal and broken child handling, among others. |
1018 | # 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 |
1019 | # obvious default class. |
1172 | # obvious default class. |
1020 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1173 | # [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1021 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1174 | # [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1022 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1175 | # [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1023 | ); |
1176 | ); |
1024 | |
1177 | |
1025 | our %method = map +($_ => 1), |
1178 | our %method = map +($_ => 1), |
1026 | 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); |
1027 | |
1180 | |
… | |
… | |
1031 | my ($cb) = @_; |
1184 | my ($cb) = @_; |
1032 | |
1185 | |
1033 | if ($MODEL) { |
1186 | if ($MODEL) { |
1034 | $cb->(); |
1187 | $cb->(); |
1035 | |
1188 | |
1036 | 1 |
1189 | undef |
1037 | } else { |
1190 | } else { |
1038 | push @post_detect, $cb; |
1191 | push @post_detect, $cb; |
1039 | |
1192 | |
1040 | defined wantarray |
1193 | defined wantarray |
1041 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1194 | ? bless \$cb, "AnyEvent::Util::postdetect" |
… | |
… | |
1047 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1200 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1048 | } |
1201 | } |
1049 | |
1202 | |
1050 | sub detect() { |
1203 | sub detect() { |
1051 | unless ($MODEL) { |
1204 | unless ($MODEL) { |
1052 | no strict 'refs'; |
|
|
1053 | local $SIG{__DIE__}; |
1205 | local $SIG{__DIE__}; |
1054 | |
1206 | |
1055 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1207 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1056 | my $model = "AnyEvent::Impl::$1"; |
1208 | my $model = "AnyEvent::Impl::$1"; |
1057 | if (eval "require $model") { |
1209 | if (eval "require $model") { |
1058 | $MODEL = $model; |
1210 | $MODEL = $model; |
1059 | warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; |
1211 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
1060 | } else { |
1212 | } else { |
1061 | warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; |
1213 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1062 | } |
1214 | } |
1063 | } |
1215 | } |
1064 | |
1216 | |
1065 | # check for already loaded models |
1217 | # check for already loaded models |
1066 | unless ($MODEL) { |
1218 | unless ($MODEL) { |
1067 | for (@REGISTRY, @models) { |
1219 | for (@REGISTRY, @models) { |
1068 | my ($package, $model) = @$_; |
1220 | my ($package, $model) = @$_; |
1069 | if (${"$package\::VERSION"} > 0) { |
1221 | if (${"$package\::VERSION"} > 0) { |
1070 | if (eval "require $model") { |
1222 | if (eval "require $model") { |
1071 | $MODEL = $model; |
1223 | $MODEL = $model; |
1072 | warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; |
1224 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1073 | last; |
1225 | last; |
1074 | } |
1226 | } |
1075 | } |
1227 | } |
1076 | } |
1228 | } |
1077 | |
1229 | |
1078 | unless ($MODEL) { |
1230 | unless ($MODEL) { |
1079 | # try to load a model |
1231 | # try to autoload a model |
1080 | |
|
|
1081 | for (@REGISTRY, @models) { |
1232 | for (@REGISTRY, @models) { |
1082 | my ($package, $model) = @$_; |
1233 | my ($package, $model, $autoload) = @$_; |
|
|
1234 | if ( |
|
|
1235 | $autoload |
1083 | if (eval "require $package" |
1236 | and eval "require $package" |
1084 | and ${"$package\::VERSION"} > 0 |
1237 | and ${"$package\::VERSION"} > 0 |
1085 | and eval "require $model") { |
1238 | and eval "require $model" |
|
|
1239 | ) { |
1086 | $MODEL = $model; |
1240 | $MODEL = $model; |
1087 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; |
1241 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1088 | last; |
1242 | last; |
1089 | } |
1243 | } |
1090 | } |
1244 | } |
1091 | |
1245 | |
1092 | $MODEL |
1246 | $MODEL |
… | |
… | |
1108 | |
1262 | |
1109 | sub AUTOLOAD { |
1263 | sub AUTOLOAD { |
1110 | (my $func = $AUTOLOAD) =~ s/.*://; |
1264 | (my $func = $AUTOLOAD) =~ s/.*://; |
1111 | |
1265 | |
1112 | $method{$func} |
1266 | $method{$func} |
1113 | or croak "$func: not a valid method for AnyEvent objects"; |
1267 | or Carp::croak "$func: not a valid method for AnyEvent objects"; |
1114 | |
1268 | |
1115 | detect unless $MODEL; |
1269 | detect unless $MODEL; |
1116 | |
1270 | |
1117 | my $class = shift; |
1271 | my $class = shift; |
1118 | $class->$func (@_); |
1272 | $class->$func (@_); |
… | |
… | |
1123 | # allow only one watcher per fd, so we dup it to get a different one). |
1277 | # allow only one watcher per fd, so we dup it to get a different one). |
1124 | sub _dupfh($$;$$) { |
1278 | sub _dupfh($$;$$) { |
1125 | my ($poll, $fh, $r, $w) = @_; |
1279 | my ($poll, $fh, $r, $w) = @_; |
1126 | |
1280 | |
1127 | # cygwin requires the fh mode to be matching, unix doesn't |
1281 | # cygwin requires the fh mode to be matching, unix doesn't |
1128 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1282 | my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&"); |
1129 | : $poll eq "w" ? ($w, ">") |
|
|
1130 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
|
|
1131 | |
1283 | |
1132 | open my $fh2, "$mode&" . fileno $fh |
1284 | open my $fh2, $mode, $fh |
1133 | or die "cannot dup() filehandle: $!,"; |
1285 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
1134 | |
1286 | |
1135 | # we assume CLOEXEC is already set by perl in all important cases |
1287 | # we assume CLOEXEC is already set by perl in all important cases |
1136 | |
1288 | |
1137 | ($fh2, $rw) |
1289 | ($fh2, $rw) |
1138 | } |
1290 | } |
1139 | |
1291 | |
1140 | package AnyEvent::Base; |
1292 | package AnyEvent::Base; |
1141 | |
1293 | |
1142 | # default implementations for many methods |
1294 | # default implementations for many methods |
1143 | |
1295 | |
1144 | BEGIN { |
1296 | sub _time { |
|
|
1297 | # probe for availability of Time::HiRes |
1145 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1298 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
|
|
1299 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1146 | *_time = \&Time::HiRes::time; |
1300 | *_time = \&Time::HiRes::time; |
1147 | # if (eval "use POSIX (); (POSIX::times())... |
1301 | # if (eval "use POSIX (); (POSIX::times())... |
1148 | } else { |
1302 | } else { |
|
|
1303 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1149 | *_time = sub { time }; # epic fail |
1304 | *_time = sub { time }; # epic fail |
1150 | } |
1305 | } |
|
|
1306 | |
|
|
1307 | &_time |
1151 | } |
1308 | } |
1152 | |
1309 | |
1153 | sub time { _time } |
1310 | sub time { _time } |
1154 | sub now { _time } |
1311 | sub now { _time } |
1155 | sub now_update { } |
1312 | sub now_update { } |
… | |
… | |
1160 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1317 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1161 | } |
1318 | } |
1162 | |
1319 | |
1163 | # default implementation for ->signal |
1320 | # default implementation for ->signal |
1164 | |
1321 | |
|
|
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 | |
1165 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1332 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
|
|
1333 | our (%SIG_ASY, %SIG_ASY_W); |
|
|
1334 | our ($SIG_COUNT, $SIG_TW); |
1166 | |
1335 | |
1167 | sub _signal_exec { |
1336 | sub _signal_exec { |
|
|
1337 | $HAVE_ASYNC_INTERRUPT |
|
|
1338 | ? $SIGPIPE_R->drain |
1168 | sysread $SIGPIPE_R, my $dummy, 4; |
1339 | : sysread $SIGPIPE_R, my $dummy, 9; |
1169 | |
1340 | |
1170 | while (%SIG_EV) { |
1341 | while (%SIG_EV) { |
1171 | for (keys %SIG_EV) { |
1342 | for (keys %SIG_EV) { |
1172 | delete $SIG_EV{$_}; |
1343 | delete $SIG_EV{$_}; |
1173 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1344 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1174 | } |
1345 | } |
1175 | } |
1346 | } |
1176 | } |
1347 | } |
1177 | |
1348 | |
|
|
1349 | # install a dummy wakeup watcher to reduce signal catching latency |
|
|
1350 | sub _sig_add() { |
|
|
1351 | unless ($SIG_COUNT++) { |
|
|
1352 | # try to align timer on a full-second boundary, if possible |
|
|
1353 | my $NOW = AnyEvent->now; |
|
|
1354 | |
|
|
1355 | $SIG_TW = AnyEvent->timer ( |
|
|
1356 | after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
|
|
1357 | interval => $MAX_SIGNAL_LATENCY, |
|
|
1358 | cb => sub { }, # just for the PERL_ASYNC_CHECK |
|
|
1359 | ); |
|
|
1360 | } |
|
|
1361 | } |
|
|
1362 | |
|
|
1363 | sub _sig_del { |
|
|
1364 | undef $SIG_TW |
|
|
1365 | unless --$SIG_COUNT; |
|
|
1366 | } |
|
|
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 | |
1178 | sub signal { |
1399 | sub signal { |
1179 | my (undef, %arg) = @_; |
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; |
1180 | |
1404 | |
1181 | unless ($SIGPIPE_R) { |
1405 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1182 | require Fcntl; |
1406 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
1183 | |
1407 | |
1184 | if (AnyEvent::WIN32) { |
|
|
1185 | require AnyEvent::Util; |
|
|
1186 | |
|
|
1187 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1188 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1189 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1190 | } else { |
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 { |
1191 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1420 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1192 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1421 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1193 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
1422 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
1194 | |
1423 | |
1195 | # not strictly required, as $^F is normally 2, but let's make sure... |
1424 | # not strictly required, as $^F is normally 2, but let's make sure... |
1196 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
1425 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
1197 | fcntl $SIGPIPE_W, &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); |
1198 | } |
1433 | } |
1199 | |
1434 | |
1200 | $SIGPIPE_R |
1435 | *signal = sub { |
1201 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1436 | my (undef, %arg) = @_; |
1202 | |
1437 | |
1203 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1204 | } |
|
|
1205 | |
|
|
1206 | my $signal = uc $arg{signal} |
1438 | my $signal = uc $arg{signal} |
1207 | or Carp::croak "required option 'signal' is missing"; |
1439 | or Carp::croak "required option 'signal' is missing"; |
1208 | |
1440 | |
|
|
1441 | if ($HAVE_ASYNC_INTERRUPT) { |
|
|
1442 | # async::interrupt |
|
|
1443 | |
|
|
1444 | $signal = sig2num $signal; |
1209 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1445 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1446 | |
|
|
1447 | $SIG_ASY{$signal} ||= new Async::Interrupt |
|
|
1448 | cb => sub { undef $SIG_EV{$signal} }, |
|
|
1449 | signal => $signal, |
|
|
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 | |
1210 | $SIG{$signal} ||= sub { |
1461 | $SIG{$signal} ||= sub { |
1211 | local $!; |
1462 | local $!; |
1212 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1463 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1213 | undef $SIG_EV{$signal}; |
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; |
|
|
1470 | } |
|
|
1471 | |
|
|
1472 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1473 | }; |
|
|
1474 | |
|
|
1475 | *AnyEvent::Base::signal::DESTROY = sub { |
|
|
1476 | my ($signal, $cb) = @{$_[0]}; |
|
|
1477 | |
|
|
1478 | _sig_del; |
|
|
1479 | |
|
|
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. |
|
|
1487 | undef $SIG{$signal} |
|
|
1488 | unless keys %{ $SIG_CB{$signal} }; |
|
|
1489 | }; |
1214 | }; |
1490 | }; |
1215 | |
1491 | die if $@; |
1216 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1492 | &signal |
1217 | } |
|
|
1218 | |
|
|
1219 | sub AnyEvent::Base::signal::DESTROY { |
|
|
1220 | my ($signal, $cb) = @{$_[0]}; |
|
|
1221 | |
|
|
1222 | delete $SIG_CB{$signal}{$cb}; |
|
|
1223 | |
|
|
1224 | # delete doesn't work with older perls - they then |
|
|
1225 | # print weird messages, or just unconditionally exit |
|
|
1226 | # instead of getting the default action. |
|
|
1227 | undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
|
|
1228 | } |
1493 | } |
1229 | |
1494 | |
1230 | # default implementation for ->child |
1495 | # default implementation for ->child |
1231 | |
1496 | |
1232 | our %PID_CB; |
1497 | our %PID_CB; |
1233 | our $CHLD_W; |
1498 | our $CHLD_W; |
1234 | our $CHLD_DELAY_W; |
1499 | our $CHLD_DELAY_W; |
1235 | our $WNOHANG; |
1500 | our $WNOHANG; |
1236 | |
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 | |
1237 | sub _sigchld { |
1510 | sub _sigchld { |
|
|
1511 | my $pid; |
|
|
1512 | |
|
|
1513 | AnyEvent->_emit_childstatus ($pid, $?) |
1238 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1514 | while ($pid = waitpid -1, $WNOHANG) > 0; |
1239 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
|
|
1240 | (values %{ $PID_CB{0} || {} }); |
|
|
1241 | } |
|
|
1242 | } |
1515 | } |
1243 | |
1516 | |
1244 | sub child { |
1517 | sub child { |
1245 | my (undef, %arg) = @_; |
1518 | my (undef, %arg) = @_; |
1246 | |
1519 | |
1247 | defined (my $pid = $arg{pid} + 0) |
1520 | defined (my $pid = $arg{pid} + 0) |
1248 | or Carp::croak "required option 'pid' is missing"; |
1521 | or Carp::croak "required option 'pid' is missing"; |
1249 | |
1522 | |
1250 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1523 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1251 | |
1524 | |
|
|
1525 | # WNOHANG is almost cetrainly 1 everywhere |
|
|
1526 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
|
|
1527 | ? 1 |
1252 | $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1528 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1253 | |
1529 | |
1254 | unless ($CHLD_W) { |
1530 | unless ($CHLD_W) { |
1255 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1531 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1256 | # child could be a zombie already, so make at least one round |
1532 | # child could be a zombie already, so make at least one round |
1257 | &_sigchld; |
1533 | &_sigchld; |
… | |
… | |
1309 | |
1585 | |
1310 | our @ISA = AnyEvent::CondVar::Base::; |
1586 | our @ISA = AnyEvent::CondVar::Base::; |
1311 | |
1587 | |
1312 | package AnyEvent::CondVar::Base; |
1588 | package AnyEvent::CondVar::Base; |
1313 | |
1589 | |
1314 | use overload |
1590 | #use overload |
1315 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1591 | # '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1316 | fallback => 1; |
1592 | # fallback => 1; |
|
|
1593 | |
|
|
1594 | # save 300+ kilobytes by dirtily hardcoding overloading |
|
|
1595 | ${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching. |
|
|
1596 | *{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod." |
|
|
1597 | *{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{} |
|
|
1598 | ${'AnyEvent::CondVar::Base::()'} = 1; # fallback |
|
|
1599 | |
|
|
1600 | our $WAITING; |
1317 | |
1601 | |
1318 | sub _send { |
1602 | sub _send { |
1319 | # nop |
1603 | # nop |
1320 | } |
1604 | } |
1321 | |
1605 | |
… | |
… | |
1334 | sub ready { |
1618 | sub ready { |
1335 | $_[0]{_ae_sent} |
1619 | $_[0]{_ae_sent} |
1336 | } |
1620 | } |
1337 | |
1621 | |
1338 | sub _wait { |
1622 | sub _wait { |
|
|
1623 | $WAITING |
|
|
1624 | and !$_[0]{_ae_sent} |
|
|
1625 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; |
|
|
1626 | |
|
|
1627 | local $WAITING = 1; |
1339 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
1628 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
1340 | } |
1629 | } |
1341 | |
1630 | |
1342 | sub recv { |
1631 | sub recv { |
1343 | $_[0]->_wait; |
1632 | $_[0]->_wait; |
… | |
… | |
1362 | } |
1651 | } |
1363 | |
1652 | |
1364 | # undocumented/compatibility with pre-3.4 |
1653 | # undocumented/compatibility with pre-3.4 |
1365 | *broadcast = \&send; |
1654 | *broadcast = \&send; |
1366 | *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 | } |
1367 | |
1698 | |
1368 | =head1 ERROR AND EXCEPTION HANDLING |
1699 | =head1 ERROR AND EXCEPTION HANDLING |
1369 | |
1700 | |
1370 | 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 |
1371 | 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 |
… | |
… | |
1405 | C<PERL_ANYEVENT_MODEL>. |
1736 | C<PERL_ANYEVENT_MODEL>. |
1406 | |
1737 | |
1407 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1738 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1408 | model it chooses. |
1739 | model it chooses. |
1409 | |
1740 | |
|
|
1741 | When set to C<8> or higher, then AnyEvent will report extra information on |
|
|
1742 | which optional modules it loads and how it implements certain features. |
|
|
1743 | |
1410 | =item C<PERL_ANYEVENT_STRICT> |
1744 | =item C<PERL_ANYEVENT_STRICT> |
1411 | |
1745 | |
1412 | AnyEvent does not do much argument checking by default, as thorough |
1746 | AnyEvent does not do much argument checking by default, as thorough |
1413 | argument checking is very costly. Setting this variable to a true value |
1747 | argument checking is very costly. Setting this variable to a true value |
1414 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1748 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1415 | check the arguments passed to most method calls. If it finds any problems, |
1749 | check the arguments passed to most method calls. If it finds any problems, |
1416 | it will croak. |
1750 | it will croak. |
1417 | |
1751 | |
1418 | In other words, enables "strict" mode. |
1752 | In other words, enables "strict" mode. |
1419 | |
1753 | |
1420 | Unlike C<use strict>, it is definitely recommended to keep it off in |
1754 | Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> |
1421 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1755 | >>, it is definitely recommended to keep it off in production. Keeping |
1422 | developing programs can be very useful, however. |
1756 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
|
|
1757 | can be very useful, however. |
1423 | |
1758 | |
1424 | =item C<PERL_ANYEVENT_MODEL> |
1759 | =item C<PERL_ANYEVENT_MODEL> |
1425 | |
1760 | |
1426 | This can be used to specify the event model to be used by AnyEvent, before |
1761 | This can be used to specify the event model to be used by AnyEvent, before |
1427 | auto detection and -probing kicks in. It must be a string consisting |
1762 | auto detection and -probing kicks in. It must be a string consisting |
… | |
… | |
1470 | |
1805 | |
1471 | =item C<PERL_ANYEVENT_MAX_FORKS> |
1806 | =item C<PERL_ANYEVENT_MAX_FORKS> |
1472 | |
1807 | |
1473 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
1808 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
1474 | will create in parallel. |
1809 | will create in parallel. |
|
|
1810 | |
|
|
1811 | =item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS> |
|
|
1812 | |
|
|
1813 | The default value for the C<max_outstanding> parameter for the default DNS |
|
|
1814 | resolver - this is the maximum number of parallel DNS requests that are |
|
|
1815 | sent to the DNS server. |
|
|
1816 | |
|
|
1817 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
|
|
1818 | |
|
|
1819 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
|
|
1820 | configuration) in the default resolver. When set to the empty string, no |
|
|
1821 | default config will be used. |
|
|
1822 | |
|
|
1823 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
|
|
1824 | |
|
|
1825 | When neither C<ca_file> nor C<ca_path> was specified during |
|
|
1826 | L<AnyEvent::TLS> context creation, and either of these environment |
|
|
1827 | variables exist, they will be used to specify CA certificate locations |
|
|
1828 | instead of a system-dependent default. |
|
|
1829 | |
|
|
1830 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
|
|
1831 | |
|
|
1832 | When these are set to C<1>, then the respective modules are not |
|
|
1833 | loaded. Mostly good for testing AnyEvent itself. |
1475 | |
1834 | |
1476 | =back |
1835 | =back |
1477 | |
1836 | |
1478 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1837 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1479 | |
1838 | |
… | |
… | |
2018 | |
2377 | |
2019 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2378 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2020 | emulation for event loops that do not support them natively. Also, some |
2379 | emulation for event loops that do not support them natively. Also, some |
2021 | event loops install a similar handler. |
2380 | event loops install a similar handler. |
2022 | |
2381 | |
2023 | If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will |
2382 | Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then |
2024 | reset it to default, to avoid losing child exit statuses. |
2383 | AnyEvent will reset it to default, to avoid losing child exit statuses. |
2025 | |
2384 | |
2026 | =item SIGPIPE |
2385 | =item SIGPIPE |
2027 | |
2386 | |
2028 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2387 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2029 | when AnyEvent gets loaded. |
2388 | when AnyEvent gets loaded. |
… | |
… | |
2047 | if $SIG{CHLD} eq 'IGNORE'; |
2406 | if $SIG{CHLD} eq 'IGNORE'; |
2048 | |
2407 | |
2049 | $SIG{PIPE} = sub { } |
2408 | $SIG{PIPE} = sub { } |
2050 | unless defined $SIG{PIPE}; |
2409 | unless defined $SIG{PIPE}; |
2051 | |
2410 | |
|
|
2411 | =head1 RECOMMENDED/OPTIONAL MODULES |
|
|
2412 | |
|
|
2413 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
|
|
2414 | it's built-in modules) are required to use it. |
|
|
2415 | |
|
|
2416 | That does not mean that AnyEvent won't take advantage of some additional |
|
|
2417 | modules if they are installed. |
|
|
2418 | |
|
|
2419 | This section epxlains which additional modules will be used, and how they |
|
|
2420 | affect AnyEvent's operetion. |
|
|
2421 | |
|
|
2422 | =over 4 |
|
|
2423 | |
|
|
2424 | =item L<Async::Interrupt> |
|
|
2425 | |
|
|
2426 | This slightly arcane module is used to implement fast signal handling: To |
|
|
2427 | my knowledge, there is no way to do completely race-free and quick |
|
|
2428 | signal handling in pure perl. To ensure that signals still get |
|
|
2429 | delivered, AnyEvent will start an interval timer to wake up perl (and |
|
|
2430 | catch the signals) with some delay (default is 10 seconds, look for |
|
|
2431 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
|
|
2432 | |
|
|
2433 | If this module is available, then it will be used to implement signal |
|
|
2434 | catching, which means that signals will not be delayed, and the event loop |
|
|
2435 | will not be interrupted regularly, which is more efficient (And good for |
|
|
2436 | battery life on laptops). |
|
|
2437 | |
|
|
2438 | This affects not just the pure-perl event loop, but also other event loops |
|
|
2439 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
|
|
2440 | |
|
|
2441 | Some event loops (POE, Event, Event::Lib) offer signal watchers natively, |
|
|
2442 | and either employ their own workarounds (POE) or use AnyEvent's workaround |
|
|
2443 | (using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt> |
|
|
2444 | does nothing for those backends. |
|
|
2445 | |
|
|
2446 | =item L<EV> |
|
|
2447 | |
|
|
2448 | This module isn't really "optional", as it is simply one of the backend |
|
|
2449 | event loops that AnyEvent can use. However, it is simply the best event |
|
|
2450 | loop available in terms of features, speed and stability: It supports |
|
|
2451 | the AnyEvent API optimally, implements all the watcher types in XS, does |
|
|
2452 | automatic timer adjustments even when no monotonic clock is available, |
|
|
2453 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
|
|
2454 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
|
|
2455 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
|
|
2456 | |
|
|
2457 | =item L<Guard> |
|
|
2458 | |
|
|
2459 | The guard module, when used, will be used to implement |
|
|
2460 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
|
|
2461 | lot less memory), but otherwise doesn't affect guard operation much. It is |
|
|
2462 | purely used for performance. |
|
|
2463 | |
|
|
2464 | =item L<JSON> and L<JSON::XS> |
|
|
2465 | |
|
|
2466 | This module is required when you want to read or write JSON data via |
|
|
2467 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
|
|
2468 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
|
|
2469 | |
|
|
2470 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
|
|
2471 | installed. |
|
|
2472 | |
|
|
2473 | =item L<Net::SSLeay> |
|
|
2474 | |
|
|
2475 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
|
|
2476 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
|
|
2477 | the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. |
|
|
2478 | |
|
|
2479 | =item L<Time::HiRes> |
|
|
2480 | |
|
|
2481 | This module is part of perl since release 5.008. It will be used when the |
|
|
2482 | chosen event library does not come with a timing source on it's own. The |
|
|
2483 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
|
|
2484 | try to use a monotonic clock for timing stability. |
|
|
2485 | |
|
|
2486 | =back |
|
|
2487 | |
|
|
2488 | |
2052 | =head1 FORK |
2489 | =head1 FORK |
2053 | |
2490 | |
2054 | Most event libraries are not fork-safe. The ones who are usually are |
2491 | Most event libraries are not fork-safe. The ones who are usually are |
2055 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2492 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2056 | calls. Only L<EV> is fully fork-aware. |
2493 | calls. Only L<EV> is fully fork-aware. |
2057 | |
2494 | |
2058 | If you have to fork, you must either do so I<before> creating your first |
2495 | If you have to fork, you must either do so I<before> creating your first |
2059 | watcher OR you must not use AnyEvent at all in the child. |
2496 | watcher OR you must not use AnyEvent at all in the child OR you must do |
|
|
2497 | something completely out of the scope of AnyEvent. |
2060 | |
2498 | |
2061 | |
2499 | |
2062 | =head1 SECURITY CONSIDERATIONS |
2500 | =head1 SECURITY CONSIDERATIONS |
2063 | |
2501 | |
2064 | AnyEvent can be forced to load any event model via |
2502 | AnyEvent can be forced to load any event model via |
… | |
… | |
2102 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2540 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2103 | |
2541 | |
2104 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2542 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2105 | 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>, |
2106 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2544 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2107 | L<AnyEvent::Impl::POE>. |
2545 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2108 | |
2546 | |
2109 | Non-blocking file handles, sockets, TCP clients and |
2547 | Non-blocking file handles, sockets, TCP clients and |
2110 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. |
2548 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2111 | |
2549 | |
2112 | Asynchronous DNS: L<AnyEvent::DNS>. |
2550 | Asynchronous DNS: L<AnyEvent::DNS>. |
2113 | |
2551 | |
2114 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
2552 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, |
|
|
2553 | L<Coro::Event>, |
2115 | |
2554 | |
2116 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
2555 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, |
|
|
2556 | L<AnyEvent::HTTP>. |
2117 | |
2557 | |
2118 | |
2558 | |
2119 | =head1 AUTHOR |
2559 | =head1 AUTHOR |
2120 | |
2560 | |
2121 | Marc Lehmann <schmorp@schmorp.de> |
2561 | Marc Lehmann <schmorp@schmorp.de> |