1 | =head1 NAME |
1 | =head1 => NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - provide framework for multiple event loops |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
6 | |
6 | |
… | |
… | |
48 | isn't itself. What's worse, all the potential users of your module are |
48 | isn't itself. What's worse, all the potential users of your module are |
49 | I<also> forced to use the same event loop you use. |
49 | I<also> forced to use the same event loop you use. |
50 | |
50 | |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
53 | with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if |
53 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
54 | your module uses one of those, every user of your module has to use it, |
54 | your module uses one of those, every user of your module has to use it, |
55 | too. But if your module uses AnyEvent, it works transparently with all |
55 | too. But if your module uses AnyEvent, it works transparently with all |
56 | event models it supports (including stuff like POE and IO::Async, as long |
56 | event models it supports (including stuff like POE and IO::Async, as long |
57 | as those use one of the supported event loops. It is trivial to add new |
57 | as those use one of the supported event loops. It is trivial to add new |
58 | event loops to AnyEvent, too, so it is future-proof). |
58 | event loops to AnyEvent, too, so it is future-proof). |
59 | |
59 | |
60 | In addition to being free of having to use I<the one and only true event |
60 | In addition to being free of having to use I<the one and only true event |
61 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
61 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
62 | modules, you get an enourmous amount of code and strict rules you have to |
62 | modules, you get an enormous amount of code and strict rules you have to |
63 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
63 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
64 | offering the functionality that is necessary, in as thin as a wrapper as |
64 | offering the functionality that is necessary, in as thin as a wrapper as |
65 | technically possible. |
65 | technically possible. |
66 | |
66 | |
|
|
67 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
|
|
68 | of useful functionality, such as an asynchronous DNS resolver, 100% |
|
|
69 | non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms |
|
|
70 | such as Windows) and lots of real-world knowledge and workarounds for |
|
|
71 | platform bugs and differences. |
|
|
72 | |
67 | Of course, if you want lots of policy (this can arguably be somewhat |
73 | Now, if you I<do want> lots of policy (this can arguably be somewhat |
68 | useful) and you want to force your users to use the one and only event |
74 | useful) and you want to force your users to use the one and only event |
69 | model, you should I<not> use this module. |
75 | model, you should I<not> use this module. |
70 | |
76 | |
71 | =head1 DESCRIPTION |
77 | =head1 DESCRIPTION |
72 | |
78 | |
… | |
… | |
102 | starts using it, all bets are off. Maybe you should tell their authors to |
108 | starts using it, all bets are off. Maybe you should tell their authors to |
103 | use AnyEvent so their modules work together with others seamlessly... |
109 | use AnyEvent so their modules work together with others seamlessly... |
104 | |
110 | |
105 | The pure-perl implementation of AnyEvent is called |
111 | The pure-perl implementation of AnyEvent is called |
106 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
112 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
107 | explicitly. |
113 | explicitly and enjoy the high availability of that event loop :) |
108 | |
114 | |
109 | =head1 WATCHERS |
115 | =head1 WATCHERS |
110 | |
116 | |
111 | AnyEvent has the central concept of a I<watcher>, which is an object that |
117 | AnyEvent has the central concept of a I<watcher>, which is an object that |
112 | stores relevant data for each kind of event you are waiting for, such as |
118 | stores relevant data for each kind of event you are waiting for, such as |
113 | the callback to call, the filehandle to watch, etc. |
119 | the callback to call, the file handle to watch, etc. |
114 | |
120 | |
115 | These watchers are normal Perl objects with normal Perl lifetime. After |
121 | These watchers are normal Perl objects with normal Perl lifetime. After |
116 | creating a watcher it will immediately "watch" for events and invoke the |
122 | creating a watcher it will immediately "watch" for events and invoke the |
117 | callback when the event occurs (of course, only when the event model |
123 | callback when the event occurs (of course, only when the event model |
118 | is in control). |
124 | is in control). |
… | |
… | |
237 | |
243 | |
238 | Although the callback might get passed parameters, their value and |
244 | Although the callback might get passed parameters, their value and |
239 | presence is undefined and you cannot rely on them. Portable AnyEvent |
245 | presence is undefined and you cannot rely on them. Portable AnyEvent |
240 | callbacks cannot use arguments passed to signal watcher callbacks. |
246 | callbacks cannot use arguments passed to signal watcher callbacks. |
241 | |
247 | |
242 | Multiple signal occurances can be clumped together into one callback |
248 | Multiple signal occurrences can be clumped together into one callback |
243 | invocation, and callback invocation will be synchronous. synchronous means |
249 | invocation, and callback invocation will be synchronous. Synchronous means |
244 | that it might take a while until the signal gets handled by the process, |
250 | that it might take a while until the signal gets handled by the process, |
245 | but it is guarenteed not to interrupt any other callbacks. |
251 | but it is guaranteed not to interrupt any other callbacks. |
246 | |
252 | |
247 | The main advantage of using these watchers is that you can share a signal |
253 | The main advantage of using these watchers is that you can share a signal |
248 | between multiple watchers. |
254 | between multiple watchers. |
249 | |
255 | |
250 | This watcher might use C<%SIG>, so programs overwriting those signals |
256 | This watcher might use C<%SIG>, so programs overwriting those signals |
… | |
… | |
310 | Condition variables can be created by calling the C<< AnyEvent->condvar |
316 | Condition variables can be created by calling the C<< AnyEvent->condvar |
311 | >> method, usually without arguments. The only argument pair allowed is |
317 | >> method, usually without arguments. The only argument pair allowed is |
312 | C<cb>, which specifies a callback to be called when the condition variable |
318 | C<cb>, which specifies a callback to be called when the condition variable |
313 | becomes true. |
319 | becomes true. |
314 | |
320 | |
315 | After creation, the conditon variable is "false" until it becomes "true" |
321 | After creation, the condition variable is "false" until it becomes "true" |
316 | by calling the C<send> method. |
322 | by calling the C<send> method (or calling the condition variable as if it |
|
|
323 | were a callback, read about the caveats in the description for the C<< |
|
|
324 | ->send >> method). |
317 | |
325 | |
318 | Condition variables are similar to callbacks, except that you can |
326 | Condition variables are similar to callbacks, except that you can |
319 | optionally wait for them. They can also be called merge points - points |
327 | optionally wait for them. They can also be called merge points - points |
320 | in time where multiple outstandign events have been processed. And yet |
328 | in time where multiple outstanding events have been processed. And yet |
321 | another way to call them is transations - each condition variable can be |
329 | another way to call them is transactions - each condition variable can be |
322 | used to represent a transaction, which finishes at some point and delivers |
330 | used to represent a transaction, which finishes at some point and delivers |
323 | a result. |
331 | a result. |
324 | |
332 | |
325 | Condition variables are very useful to signal that something has finished, |
333 | Condition variables are very useful to signal that something has finished, |
326 | for example, if you write a module that does asynchronous http requests, |
334 | for example, if you write a module that does asynchronous http requests, |
… | |
… | |
332 | you can block your main program until an event occurs - for example, you |
340 | you can block your main program until an event occurs - for example, you |
333 | could C<< ->recv >> in your main program until the user clicks the Quit |
341 | could C<< ->recv >> in your main program until the user clicks the Quit |
334 | button of your app, which would C<< ->send >> the "quit" event. |
342 | button of your app, which would C<< ->send >> the "quit" event. |
335 | |
343 | |
336 | Note that condition variables recurse into the event loop - if you have |
344 | Note that condition variables recurse into the event loop - if you have |
337 | two pieces of code that call C<< ->recv >> in a round-robbin fashion, you |
345 | two pieces of code that call C<< ->recv >> in a round-robin fashion, you |
338 | lose. Therefore, condition variables are good to export to your caller, but |
346 | lose. Therefore, condition variables are good to export to your caller, but |
339 | you should avoid making a blocking wait yourself, at least in callbacks, |
347 | you should avoid making a blocking wait yourself, at least in callbacks, |
340 | as this asks for trouble. |
348 | as this asks for trouble. |
341 | |
349 | |
342 | Condition variables are represented by hash refs in perl, and the keys |
350 | Condition variables are represented by hash refs in perl, and the keys |
… | |
… | |
347 | |
355 | |
348 | There are two "sides" to a condition variable - the "producer side" which |
356 | There are two "sides" to a condition variable - the "producer side" which |
349 | eventually calls C<< -> send >>, and the "consumer side", which waits |
357 | eventually calls C<< -> send >>, and the "consumer side", which waits |
350 | for the send to occur. |
358 | for the send to occur. |
351 | |
359 | |
352 | Example: |
360 | Example: wait for a timer. |
353 | |
361 | |
354 | # wait till the result is ready |
362 | # wait till the result is ready |
355 | my $result_ready = AnyEvent->condvar; |
363 | my $result_ready = AnyEvent->condvar; |
356 | |
364 | |
357 | # do something such as adding a timer |
365 | # do something such as adding a timer |
… | |
… | |
365 | |
373 | |
366 | # this "blocks" (while handling events) till the callback |
374 | # this "blocks" (while handling events) till the callback |
367 | # calls send |
375 | # calls send |
368 | $result_ready->recv; |
376 | $result_ready->recv; |
369 | |
377 | |
|
|
378 | Example: wait for a timer, but take advantage of the fact that |
|
|
379 | condition variables are also code references. |
|
|
380 | |
|
|
381 | my $done = AnyEvent->condvar; |
|
|
382 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
|
|
383 | $done->recv; |
|
|
384 | |
370 | =head3 METHODS FOR PRODUCERS |
385 | =head3 METHODS FOR PRODUCERS |
371 | |
386 | |
372 | These methods should only be used by the producing side, i.e. the |
387 | These methods should only be used by the producing side, i.e. the |
373 | code/module that eventually sends the signal. Note that it is also |
388 | code/module that eventually sends the signal. Note that it is also |
374 | the producer side which creates the condvar in most cases, but it isn't |
389 | the producer side which creates the condvar in most cases, but it isn't |
… | |
… | |
385 | If a callback has been set on the condition variable, it is called |
400 | If a callback has been set on the condition variable, it is called |
386 | immediately from within send. |
401 | immediately from within send. |
387 | |
402 | |
388 | Any arguments passed to the C<send> call will be returned by all |
403 | Any arguments passed to the C<send> call will be returned by all |
389 | future C<< ->recv >> calls. |
404 | future C<< ->recv >> calls. |
|
|
405 | |
|
|
406 | Condition variables are overloaded so one can call them directly |
|
|
407 | (as a code reference). Calling them directly is the same as calling |
|
|
408 | C<send>. Note, however, that many C-based event loops do not handle |
|
|
409 | overloading, so as tempting as it may be, passing a condition variable |
|
|
410 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
411 | support overloading, however, as well as all functions that use perl to |
|
|
412 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
413 | example). |
390 | |
414 | |
391 | =item $cv->croak ($error) |
415 | =item $cv->croak ($error) |
392 | |
416 | |
393 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
417 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
394 | C<Carp::croak> with the given error message/object/scalar. |
418 | C<Carp::croak> with the given error message/object/scalar. |
… | |
… | |
443 | doesn't execute once). |
467 | doesn't execute once). |
444 | |
468 | |
445 | This is the general pattern when you "fan out" into multiple subrequests: |
469 | This is the general pattern when you "fan out" into multiple subrequests: |
446 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
470 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
447 | is called at least once, and then, for each subrequest you start, call |
471 | is called at least once, and then, for each subrequest you start, call |
448 | C<begin> and for eahc subrequest you finish, call C<end>. |
472 | C<begin> and for each subrequest you finish, call C<end>. |
449 | |
473 | |
450 | =back |
474 | =back |
451 | |
475 | |
452 | =head3 METHODS FOR CONSUMERS |
476 | =head3 METHODS FOR CONSUMERS |
453 | |
477 | |
… | |
… | |
475 | (programs might want to do that to stay interactive), so I<if you are |
499 | (programs might want to do that to stay interactive), so I<if you are |
476 | using this from a module, never require a blocking wait>, but let the |
500 | using this from a module, never require a blocking wait>, but let the |
477 | caller decide whether the call will block or not (for example, by coupling |
501 | caller decide whether the call will block or not (for example, by coupling |
478 | condition variables with some kind of request results and supporting |
502 | condition variables with some kind of request results and supporting |
479 | callbacks so the caller knows that getting the result will not block, |
503 | callbacks so the caller knows that getting the result will not block, |
480 | while still suppporting blocking waits if the caller so desires). |
504 | while still supporting blocking waits if the caller so desires). |
481 | |
505 | |
482 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
506 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
483 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
507 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
484 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
508 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
485 | can supply. |
509 | can supply. |
… | |
… | |
601 | |
625 | |
602 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
626 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
603 | do anything special (it does not need to be event-based) and let AnyEvent |
627 | do anything special (it does not need to be event-based) and let AnyEvent |
604 | decide which implementation to chose if some module relies on it. |
628 | decide which implementation to chose if some module relies on it. |
605 | |
629 | |
606 | If the main program relies on a specific event model. For example, in |
630 | If the main program relies on a specific event model - for example, in |
607 | Gtk2 programs you have to rely on the Glib module. You should load the |
631 | Gtk2 programs you have to rely on the Glib module - you should load the |
608 | event module before loading AnyEvent or any module that uses it: generally |
632 | event module before loading AnyEvent or any module that uses it: generally |
609 | speaking, you should load it as early as possible. The reason is that |
633 | speaking, you should load it as early as possible. The reason is that |
610 | modules might create watchers when they are loaded, and AnyEvent will |
634 | modules might create watchers when they are loaded, and AnyEvent will |
611 | decide on the event model to use as soon as it creates watchers, and it |
635 | decide on the event model to use as soon as it creates watchers, and it |
612 | might chose the wrong one unless you load the correct one yourself. |
636 | might chose the wrong one unless you load the correct one yourself. |
613 | |
637 | |
614 | You can chose to use a rather inefficient pure-perl implementation by |
638 | You can chose to use a pure-perl implementation by loading the |
615 | loading the C<AnyEvent::Impl::Perl> module, which gives you similar |
639 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
616 | behaviour everywhere, but letting AnyEvent chose is generally better. |
640 | everywhere, but letting AnyEvent chose the model is generally better. |
|
|
641 | |
|
|
642 | =head2 MAINLOOP EMULATION |
|
|
643 | |
|
|
644 | Sometimes (often for short test scripts, or even standalone programs who |
|
|
645 | only want to use AnyEvent), you do not want to run a specific event loop. |
|
|
646 | |
|
|
647 | In that case, you can use a condition variable like this: |
|
|
648 | |
|
|
649 | AnyEvent->condvar->recv; |
|
|
650 | |
|
|
651 | This has the effect of entering the event loop and looping forever. |
|
|
652 | |
|
|
653 | Note that usually your program has some exit condition, in which case |
|
|
654 | it is better to use the "traditional" approach of storing a condition |
|
|
655 | variable somewhere, waiting for it, and sending it when the program should |
|
|
656 | exit cleanly. |
|
|
657 | |
617 | |
658 | |
618 | =head1 OTHER MODULES |
659 | =head1 OTHER MODULES |
619 | |
660 | |
620 | The following is a non-exhaustive list of additional modules that use |
661 | The following is a non-exhaustive list of additional modules that use |
621 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
662 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
… | |
… | |
631 | |
672 | |
632 | =item L<AnyEvent::Handle> |
673 | =item L<AnyEvent::Handle> |
633 | |
674 | |
634 | Provide read and write buffers and manages watchers for reads and writes. |
675 | Provide read and write buffers and manages watchers for reads and writes. |
635 | |
676 | |
|
|
677 | =item L<AnyEvent::Socket> |
|
|
678 | |
|
|
679 | Provides various utility functions for (internet protocol) sockets, |
|
|
680 | addresses and name resolution. Also functions to create non-blocking tcp |
|
|
681 | connections or tcp servers, with IPv6 and SRV record support and more. |
|
|
682 | |
|
|
683 | =item L<AnyEvent::DNS> |
|
|
684 | |
|
|
685 | Provides rich asynchronous DNS resolver capabilities. |
|
|
686 | |
636 | =item L<AnyEvent::HTTPD> |
687 | =item L<AnyEvent::HTTPD> |
637 | |
688 | |
638 | Provides a simple web application server framework. |
689 | Provides a simple web application server framework. |
639 | |
|
|
640 | =item L<AnyEvent::DNS> |
|
|
641 | |
|
|
642 | Provides asynchronous DNS resolver capabilities, beyond what |
|
|
643 | L<AnyEvent::Util> offers. |
|
|
644 | |
690 | |
645 | =item L<AnyEvent::FastPing> |
691 | =item L<AnyEvent::FastPing> |
646 | |
692 | |
647 | The fastest ping in the west. |
693 | The fastest ping in the west. |
648 | |
694 | |
… | |
… | |
691 | no warnings; |
737 | no warnings; |
692 | use strict; |
738 | use strict; |
693 | |
739 | |
694 | use Carp; |
740 | use Carp; |
695 | |
741 | |
696 | our $VERSION = '3.4'; |
742 | our $VERSION = '4.05'; |
697 | our $MODEL; |
743 | our $MODEL; |
698 | |
744 | |
699 | our $AUTOLOAD; |
745 | our $AUTOLOAD; |
700 | our @ISA; |
746 | our @ISA; |
701 | |
747 | |
|
|
748 | our @REGISTRY; |
|
|
749 | |
|
|
750 | our $WIN32; |
|
|
751 | |
|
|
752 | BEGIN { |
|
|
753 | my $win32 = ! ! ($^O =~ /mswin32/i); |
|
|
754 | eval "sub WIN32(){ $win32 }"; |
|
|
755 | } |
|
|
756 | |
702 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
757 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
703 | |
758 | |
704 | our @REGISTRY; |
759 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
|
|
760 | |
|
|
761 | { |
|
|
762 | my $idx; |
|
|
763 | $PROTOCOL{$_} = ++$idx |
|
|
764 | for reverse split /\s*,\s*/, |
|
|
765 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
|
|
766 | } |
705 | |
767 | |
706 | my @models = ( |
768 | my @models = ( |
707 | [EV:: => AnyEvent::Impl::EV::], |
769 | [EV:: => AnyEvent::Impl::EV::], |
708 | [Event:: => AnyEvent::Impl::Event::], |
770 | [Event:: => AnyEvent::Impl::Event::], |
709 | [Tk:: => AnyEvent::Impl::Tk::], |
|
|
710 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
711 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
712 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
771 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
713 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
772 | # everything below here will not be autoprobed |
714 | [Glib:: => AnyEvent::Impl::Glib::], |
773 | # as the pureperl backend should work everywhere |
|
|
774 | # and is usually faster |
|
|
775 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
776 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
715 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
777 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
716 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
778 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
717 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
779 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
|
|
780 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
781 | [Prima:: => AnyEvent::Impl::POE::], |
718 | ); |
782 | ); |
719 | |
783 | |
720 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
784 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
721 | |
785 | |
722 | our @post_detect; |
786 | our @post_detect; |
… | |
… | |
730 | 1 |
794 | 1 |
731 | } else { |
795 | } else { |
732 | push @post_detect, $cb; |
796 | push @post_detect, $cb; |
733 | |
797 | |
734 | defined wantarray |
798 | defined wantarray |
735 | ? bless \$cb, "AnyEvent::Util::Guard" |
799 | ? bless \$cb, "AnyEvent::Util::PostDetect" |
736 | : () |
800 | : () |
737 | } |
801 | } |
738 | } |
802 | } |
739 | |
803 | |
740 | sub AnyEvent::Util::Guard::DESTROY { |
804 | sub AnyEvent::Util::PostDetect::DESTROY { |
741 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
805 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
742 | } |
806 | } |
743 | |
807 | |
744 | sub detect() { |
808 | sub detect() { |
745 | unless ($MODEL) { |
809 | unless ($MODEL) { |
746 | no strict 'refs'; |
810 | no strict 'refs'; |
|
|
811 | local $SIG{__DIE__}; |
747 | |
812 | |
748 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
813 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
749 | my $model = "AnyEvent::Impl::$1"; |
814 | my $model = "AnyEvent::Impl::$1"; |
750 | if (eval "require $model") { |
815 | if (eval "require $model") { |
751 | $MODEL = $model; |
816 | $MODEL = $model; |
… | |
… | |
811 | package AnyEvent::Base; |
876 | package AnyEvent::Base; |
812 | |
877 | |
813 | # default implementation for ->condvar |
878 | # default implementation for ->condvar |
814 | |
879 | |
815 | sub condvar { |
880 | sub condvar { |
816 | bless {}, "AnyEvent::Base::CondVar" |
881 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
817 | } |
882 | } |
818 | |
883 | |
819 | # default implementation for ->signal |
884 | # default implementation for ->signal |
820 | |
885 | |
821 | our %SIG_CB; |
886 | our %SIG_CB; |
… | |
… | |
874 | or Carp::croak "required option 'pid' is missing"; |
939 | or Carp::croak "required option 'pid' is missing"; |
875 | |
940 | |
876 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
941 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
877 | |
942 | |
878 | unless ($WNOHANG) { |
943 | unless ($WNOHANG) { |
879 | $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; |
944 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
880 | } |
945 | } |
881 | |
946 | |
882 | unless ($CHLD_W) { |
947 | unless ($CHLD_W) { |
883 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
948 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
884 | # child could be a zombie already, so make at least one round |
949 | # child could be a zombie already, so make at least one round |
… | |
… | |
895 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
960 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
896 | |
961 | |
897 | undef $CHLD_W unless keys %PID_CB; |
962 | undef $CHLD_W unless keys %PID_CB; |
898 | } |
963 | } |
899 | |
964 | |
900 | package AnyEvent::Base::CondVar; |
965 | package AnyEvent::CondVar; |
901 | |
966 | |
902 | # wake up the waiter |
967 | our @ISA = AnyEvent::CondVar::Base::; |
|
|
968 | |
|
|
969 | package AnyEvent::CondVar::Base; |
|
|
970 | |
|
|
971 | use overload |
|
|
972 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
|
|
973 | fallback => 1; |
|
|
974 | |
903 | sub _send { |
975 | sub _send { |
904 | &{ delete $_[0]{_ae_cb} } if $_[0]{_ae_cb}; |
976 | # nop |
905 | } |
977 | } |
906 | |
978 | |
907 | sub send { |
979 | sub send { |
908 | my $cv = shift; |
980 | my $cv = shift; |
909 | $cv->{_ae_sent} = [@_]; |
981 | $cv->{_ae_sent} = [@_]; |
|
|
982 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
910 | $cv->_send; |
983 | $cv->_send; |
911 | } |
984 | } |
912 | |
985 | |
913 | sub croak { |
986 | sub croak { |
914 | $_[0]{_ae_croak} = $_[1]; |
987 | $_[0]{_ae_croak} = $_[1]; |
… | |
… | |
917 | |
990 | |
918 | sub ready { |
991 | sub ready { |
919 | $_[0]{_ae_sent} |
992 | $_[0]{_ae_sent} |
920 | } |
993 | } |
921 | |
994 | |
|
|
995 | sub _wait { |
|
|
996 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
|
|
997 | } |
|
|
998 | |
922 | sub recv { |
999 | sub recv { |
923 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
1000 | $_[0]->_wait; |
924 | |
1001 | |
925 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1002 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
926 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1003 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
927 | } |
1004 | } |
928 | |
1005 | |
… | |
… | |
936 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
1013 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
937 | } |
1014 | } |
938 | |
1015 | |
939 | sub end { |
1016 | sub end { |
940 | return if --$_[0]{_ae_counter}; |
1017 | return if --$_[0]{_ae_counter}; |
941 | &{ $_[0]{_ae_end_cb} } if $_[0]{_ae_end_cb}; |
1018 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
942 | } |
1019 | } |
943 | |
1020 | |
944 | # undocumented/compatibility with pre-3.4 |
1021 | # undocumented/compatibility with pre-3.4 |
945 | *broadcast = \&send; |
1022 | *broadcast = \&send; |
946 | *wait = \&recv; |
1023 | *wait = \&_wait; |
947 | |
1024 | |
948 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1025 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
949 | |
1026 | |
950 | This is an advanced topic that you do not normally need to use AnyEvent in |
1027 | This is an advanced topic that you do not normally need to use AnyEvent in |
951 | a module. This section is only of use to event loop authors who want to |
1028 | a module. This section is only of use to event loop authors who want to |
… | |
… | |
1008 | model it chooses. |
1085 | model it chooses. |
1009 | |
1086 | |
1010 | =item C<PERL_ANYEVENT_MODEL> |
1087 | =item C<PERL_ANYEVENT_MODEL> |
1011 | |
1088 | |
1012 | This can be used to specify the event model to be used by AnyEvent, before |
1089 | This can be used to specify the event model to be used by AnyEvent, before |
1013 | autodetection and -probing kicks in. It must be a string consisting |
1090 | auto detection and -probing kicks in. It must be a string consisting |
1014 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
1091 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
1015 | and the resulting module name is loaded and if the load was successful, |
1092 | and the resulting module name is loaded and if the load was successful, |
1016 | used as event model. If it fails to load AnyEvent will proceed with |
1093 | used as event model. If it fails to load AnyEvent will proceed with |
1017 | autodetection and -probing. |
1094 | auto detection and -probing. |
1018 | |
1095 | |
1019 | This functionality might change in future versions. |
1096 | This functionality might change in future versions. |
1020 | |
1097 | |
1021 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1098 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1022 | could start your program like this: |
1099 | could start your program like this: |
1023 | |
1100 | |
1024 | PERL_ANYEVENT_MODEL=Perl perl ... |
1101 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
1102 | |
|
|
1103 | =item C<PERL_ANYEVENT_PROTOCOLS> |
|
|
1104 | |
|
|
1105 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
|
|
1106 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
|
|
1107 | of auto probing). |
|
|
1108 | |
|
|
1109 | Must be set to a comma-separated list of protocols or address families, |
|
|
1110 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
|
|
1111 | used, and preference will be given to protocols mentioned earlier in the |
|
|
1112 | list. |
|
|
1113 | |
|
|
1114 | This variable can effectively be used for denial-of-service attacks |
|
|
1115 | against local programs (e.g. when setuid), although the impact is likely |
|
|
1116 | small, as the program has to handle connection errors already- |
|
|
1117 | |
|
|
1118 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
|
|
1119 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
|
|
1120 | - only support IPv4, never try to resolve or contact IPv6 |
|
|
1121 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
|
|
1122 | IPv6, but prefer IPv6 over IPv4. |
|
|
1123 | |
|
|
1124 | =item C<PERL_ANYEVENT_EDNS0> |
|
|
1125 | |
|
|
1126 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
|
|
1127 | for DNS. This extension is generally useful to reduce DNS traffic, but |
|
|
1128 | some (broken) firewalls drop such DNS packets, which is why it is off by |
|
|
1129 | default. |
|
|
1130 | |
|
|
1131 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
|
|
1132 | EDNS0 in its DNS requests. |
|
|
1133 | |
|
|
1134 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1135 | |
|
|
1136 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1137 | will create in parallel. |
1025 | |
1138 | |
1026 | =back |
1139 | =back |
1027 | |
1140 | |
1028 | =head1 EXAMPLE PROGRAM |
1141 | =head1 EXAMPLE PROGRAM |
1029 | |
1142 | |
… | |
… | |
1040 | poll => 'r', |
1153 | poll => 'r', |
1041 | cb => sub { |
1154 | cb => sub { |
1042 | warn "io event <$_[0]>\n"; # will always output <r> |
1155 | warn "io event <$_[0]>\n"; # will always output <r> |
1043 | chomp (my $input = <STDIN>); # read a line |
1156 | chomp (my $input = <STDIN>); # read a line |
1044 | warn "read: $input\n"; # output what has been read |
1157 | warn "read: $input\n"; # output what has been read |
1045 | $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i |
1158 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1046 | }, |
1159 | }, |
1047 | ); |
1160 | ); |
1048 | |
1161 | |
1049 | my $time_watcher; # can only be used once |
1162 | my $time_watcher; # can only be used once |
1050 | |
1163 | |
… | |
… | |
1055 | }); |
1168 | }); |
1056 | } |
1169 | } |
1057 | |
1170 | |
1058 | new_timer; # create first timer |
1171 | new_timer; # create first timer |
1059 | |
1172 | |
1060 | $cv->wait; # wait until user enters /^q/i |
1173 | $cv->recv; # wait until user enters /^q/i |
1061 | |
1174 | |
1062 | =head1 REAL-WORLD EXAMPLE |
1175 | =head1 REAL-WORLD EXAMPLE |
1063 | |
1176 | |
1064 | Consider the L<Net::FCP> module. It features (among others) the following |
1177 | Consider the L<Net::FCP> module. It features (among others) the following |
1065 | API calls, which are to freenet what HTTP GET requests are to http: |
1178 | API calls, which are to freenet what HTTP GET requests are to http: |
… | |
… | |
1115 | syswrite $txn->{fh}, $txn->{request} |
1228 | syswrite $txn->{fh}, $txn->{request} |
1116 | or die "connection or write error"; |
1229 | or die "connection or write error"; |
1117 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1230 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1118 | |
1231 | |
1119 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
1232 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
1120 | result and signals any possible waiters that the request ahs finished: |
1233 | result and signals any possible waiters that the request has finished: |
1121 | |
1234 | |
1122 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1235 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1123 | |
1236 | |
1124 | if (end-of-file or data complete) { |
1237 | if (end-of-file or data complete) { |
1125 | $txn->{result} = $txn->{buf}; |
1238 | $txn->{result} = $txn->{buf}; |
1126 | $txn->{finished}->broadcast; |
1239 | $txn->{finished}->send; |
1127 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
1240 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
1128 | } |
1241 | } |
1129 | |
1242 | |
1130 | The C<result> method, finally, just waits for the finished signal (if the |
1243 | The C<result> method, finally, just waits for the finished signal (if the |
1131 | request was already finished, it doesn't wait, of course, and returns the |
1244 | request was already finished, it doesn't wait, of course, and returns the |
1132 | data: |
1245 | data: |
1133 | |
1246 | |
1134 | $txn->{finished}->wait; |
1247 | $txn->{finished}->recv; |
1135 | return $txn->{result}; |
1248 | return $txn->{result}; |
1136 | |
1249 | |
1137 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1250 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1138 | that occured during request processing. The C<result> method detects |
1251 | that occurred during request processing. The C<result> method detects |
1139 | whether an exception as thrown (it is stored inside the $txn object) |
1252 | whether an exception as thrown (it is stored inside the $txn object) |
1140 | and just throws the exception, which means connection errors and other |
1253 | and just throws the exception, which means connection errors and other |
1141 | problems get reported tot he code that tries to use the result, not in a |
1254 | problems get reported tot he code that tries to use the result, not in a |
1142 | random callback. |
1255 | random callback. |
1143 | |
1256 | |
… | |
… | |
1174 | |
1287 | |
1175 | my $quit = AnyEvent->condvar; |
1288 | my $quit = AnyEvent->condvar; |
1176 | |
1289 | |
1177 | $fcp->txn_client_get ($url)->cb (sub { |
1290 | $fcp->txn_client_get ($url)->cb (sub { |
1178 | ... |
1291 | ... |
1179 | $quit->broadcast; |
1292 | $quit->send; |
1180 | }); |
1293 | }); |
1181 | |
1294 | |
1182 | $quit->wait; |
1295 | $quit->recv; |
1183 | |
1296 | |
1184 | |
1297 | |
1185 | =head1 BENCHMARKS |
1298 | =head1 BENCHMARKS |
1186 | |
1299 | |
1187 | To give you an idea of the performance and overheads that AnyEvent adds |
1300 | To give you an idea of the performance and overheads that AnyEvent adds |
… | |
… | |
1189 | of various event loops I prepared some benchmarks. |
1302 | of various event loops I prepared some benchmarks. |
1190 | |
1303 | |
1191 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
1304 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
1192 | |
1305 | |
1193 | Here is a benchmark of various supported event models used natively and |
1306 | Here is a benchmark of various supported event models used natively and |
1194 | through anyevent. The benchmark creates a lot of timers (with a zero |
1307 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1195 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1308 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1196 | which it is), lets them fire exactly once and destroys them again. |
1309 | which it is), lets them fire exactly once and destroys them again. |
1197 | |
1310 | |
1198 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1311 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1199 | distribution. |
1312 | distribution. |
… | |
… | |
1216 | all watchers, to avoid adding memory overhead. That means closure creation |
1329 | all watchers, to avoid adding memory overhead. That means closure creation |
1217 | and memory usage is not included in the figures. |
1330 | and memory usage is not included in the figures. |
1218 | |
1331 | |
1219 | I<invoke> is the time, in microseconds, used to invoke a simple |
1332 | I<invoke> is the time, in microseconds, used to invoke a simple |
1220 | callback. The callback simply counts down a Perl variable and after it was |
1333 | callback. The callback simply counts down a Perl variable and after it was |
1221 | invoked "watcher" times, it would C<< ->broadcast >> a condvar once to |
1334 | invoked "watcher" times, it would C<< ->send >> a condvar once to |
1222 | signal the end of this phase. |
1335 | signal the end of this phase. |
1223 | |
1336 | |
1224 | I<destroy> is the time, in microseconds, that it takes to destroy a single |
1337 | I<destroy> is the time, in microseconds, that it takes to destroy a single |
1225 | watcher. |
1338 | watcher. |
1226 | |
1339 | |
… | |
… | |
1322 | |
1435 | |
1323 | =back |
1436 | =back |
1324 | |
1437 | |
1325 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1438 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1326 | |
1439 | |
1327 | This benchmark atcually benchmarks the event loop itself. It works by |
1440 | This benchmark actually benchmarks the event loop itself. It works by |
1328 | creating a number of "servers": each server consists of a socketpair, a |
1441 | creating a number of "servers": each server consists of a socket pair, a |
1329 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1442 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1330 | watcher waiting for input on one side of the socket. Each time the socket |
1443 | watcher waiting for input on one side of the socket. Each time the socket |
1331 | watcher reads a byte it will write that byte to a random other "server". |
1444 | watcher reads a byte it will write that byte to a random other "server". |
1332 | |
1445 | |
1333 | The effect is that there will be a lot of I/O watchers, only part of which |
1446 | The effect is that there will be a lot of I/O watchers, only part of which |
1334 | are active at any one point (so there is a constant number of active |
1447 | are active at any one point (so there is a constant number of active |
1335 | fds for each loop iterstaion, but which fds these are is random). The |
1448 | fds for each loop iteration, but which fds these are is random). The |
1336 | timeout is reset each time something is read because that reflects how |
1449 | timeout is reset each time something is read because that reflects how |
1337 | most timeouts work (and puts extra pressure on the event loops). |
1450 | most timeouts work (and puts extra pressure on the event loops). |
1338 | |
1451 | |
1339 | In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100 |
1452 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
1340 | (1%) are active. This mirrors the activity of large servers with many |
1453 | (1%) are active. This mirrors the activity of large servers with many |
1341 | connections, most of which are idle at any one point in time. |
1454 | connections, most of which are idle at any one point in time. |
1342 | |
1455 | |
1343 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1456 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1344 | distribution. |
1457 | distribution. |
… | |
… | |
1346 | =head3 Explanation of the columns |
1459 | =head3 Explanation of the columns |
1347 | |
1460 | |
1348 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1461 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1349 | each server has a read and write socket end). |
1462 | each server has a read and write socket end). |
1350 | |
1463 | |
1351 | I<create> is the time it takes to create a socketpair (which is |
1464 | I<create> is the time it takes to create a socket pair (which is |
1352 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1465 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1353 | |
1466 | |
1354 | I<request>, the most important value, is the time it takes to handle a |
1467 | I<request>, the most important value, is the time it takes to handle a |
1355 | single "request", that is, reading the token from the pipe and forwarding |
1468 | single "request", that is, reading the token from the pipe and forwarding |
1356 | it to another server. This includes deleting the old timeout and creating |
1469 | it to another server. This includes deleting the old timeout and creating |
… | |
… | |
1429 | speed most when you have lots of watchers, not when you only have a few of |
1542 | speed most when you have lots of watchers, not when you only have a few of |
1430 | them). |
1543 | them). |
1431 | |
1544 | |
1432 | EV is again fastest. |
1545 | EV is again fastest. |
1433 | |
1546 | |
1434 | Perl again comes second. It is noticably faster than the C-based event |
1547 | Perl again comes second. It is noticeably faster than the C-based event |
1435 | loops Event and Glib, although the difference is too small to really |
1548 | loops Event and Glib, although the difference is too small to really |
1436 | matter. |
1549 | matter. |
1437 | |
1550 | |
1438 | POE also performs much better in this case, but is is still far behind the |
1551 | POE also performs much better in this case, but is is still far behind the |
1439 | others. |
1552 | others. |
… | |
… | |
1479 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1592 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1480 | |
1593 | |
1481 | |
1594 | |
1482 | =head1 SEE ALSO |
1595 | =head1 SEE ALSO |
1483 | |
1596 | |
|
|
1597 | Utility functions: L<AnyEvent::Util>. |
|
|
1598 | |
1484 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
1599 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
1485 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
1600 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
1486 | |
1601 | |
1487 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
1602 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
1488 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
1603 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
1489 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
1604 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
1490 | L<AnyEvent::Impl::POE>. |
1605 | L<AnyEvent::Impl::POE>. |
1491 | |
1606 | |
|
|
1607 | Non-blocking file handles, sockets, TCP clients and |
|
|
1608 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. |
|
|
1609 | |
|
|
1610 | Asynchronous DNS: L<AnyEvent::DNS>. |
|
|
1611 | |
1492 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
1612 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
1493 | |
1613 | |
1494 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
1614 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1495 | |
1615 | |
1496 | |
1616 | |
1497 | =head1 AUTHOR |
1617 | =head1 AUTHOR |
1498 | |
1618 | |
1499 | Marc Lehmann <schmorp@schmorp.de> |
1619 | Marc Lehmann <schmorp@schmorp.de> |