… | |
… | |
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). |
… | |
… | |
62 | modules, you get an enormous 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 |
… | |
… | |
226 | on true relative time) and absolute (ev_periodic, based on wallclock time) |
232 | on true relative time) and absolute (ev_periodic, based on wallclock time) |
227 | timers. |
233 | timers. |
228 | |
234 | |
229 | AnyEvent always prefers relative timers, if available, matching the |
235 | AnyEvent always prefers relative timers, if available, matching the |
230 | AnyEvent API. |
236 | AnyEvent API. |
|
|
237 | |
|
|
238 | AnyEvent has two additional methods that return the "current time": |
|
|
239 | |
|
|
240 | =over 4 |
|
|
241 | |
|
|
242 | =item AnyEvent->time |
|
|
243 | |
|
|
244 | This returns the "current wallclock time" as a fractional number of |
|
|
245 | seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time> |
|
|
246 | return, and the result is guaranteed to be compatible with those). |
|
|
247 | |
|
|
248 | It progresses independently of any event loop processing, i.e. each call |
|
|
249 | will check the system clock, which usually gets updated frequently. |
|
|
250 | |
|
|
251 | =item AnyEvent->now |
|
|
252 | |
|
|
253 | This also returns the "current wallclock time", but unlike C<time>, above, |
|
|
254 | this value might change only once per event loop iteration, depending on |
|
|
255 | the event loop (most return the same time as C<time>, above). This is the |
|
|
256 | time that AnyEvent's timers get scheduled against. |
|
|
257 | |
|
|
258 | I<In almost all cases (in all cases if you don't care), this is the |
|
|
259 | function to call when you want to know the current time.> |
|
|
260 | |
|
|
261 | This function is also often faster then C<< AnyEvent->time >>, and |
|
|
262 | thus the preferred method if you want some timestamp (for example, |
|
|
263 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
|
|
264 | |
|
|
265 | The rest of this section is only of relevance if you try to be very exact |
|
|
266 | with your timing, you can skip it without bad conscience. |
|
|
267 | |
|
|
268 | For a practical example of when these times differ, consider L<Event::Lib> |
|
|
269 | and L<EV> and the following set-up: |
|
|
270 | |
|
|
271 | The event loop is running and has just invoked one of your callback at |
|
|
272 | time=500 (assume no other callbacks delay processing). In your callback, |
|
|
273 | you wait a second by executing C<sleep 1> (blocking the process for a |
|
|
274 | second) and then (at time=501) you create a relative timer that fires |
|
|
275 | after three seconds. |
|
|
276 | |
|
|
277 | With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will |
|
|
278 | both return C<501>, because that is the current time, and the timer will |
|
|
279 | be scheduled to fire at time=504 (C<501> + C<3>). |
|
|
280 | |
|
|
281 | With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current |
|
|
282 | time), but C<< AnyEvent->now >> returns C<500>, as that is the time the |
|
|
283 | last event processing phase started. With L<EV>, your timer gets scheduled |
|
|
284 | to run at time=503 (C<500> + C<3>). |
|
|
285 | |
|
|
286 | In one sense, L<Event::Lib> is more exact, as it uses the current time |
|
|
287 | regardless of any delays introduced by event processing. However, most |
|
|
288 | callbacks do not expect large delays in processing, so this causes a |
|
|
289 | higher drift (and a lot more system calls to get the current time). |
|
|
290 | |
|
|
291 | In another sense, L<EV> is more exact, as your timer will be scheduled at |
|
|
292 | the same time, regardless of how long event processing actually took. |
|
|
293 | |
|
|
294 | In either case, if you care (and in most cases, you don't), then you |
|
|
295 | can get whatever behaviour you want with any event loop, by taking the |
|
|
296 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
|
|
297 | account. |
|
|
298 | |
|
|
299 | =back |
231 | |
300 | |
232 | =head2 SIGNAL WATCHERS |
301 | =head2 SIGNAL WATCHERS |
233 | |
302 | |
234 | You can watch for signals using a signal watcher, C<signal> is the signal |
303 | You can watch for signals using a signal watcher, C<signal> is the signal |
235 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
304 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
… | |
… | |
312 | C<cb>, which specifies a callback to be called when the condition variable |
381 | C<cb>, which specifies a callback to be called when the condition variable |
313 | becomes true. |
382 | becomes true. |
314 | |
383 | |
315 | After creation, the condition variable is "false" until it becomes "true" |
384 | After creation, the condition variable is "false" until it becomes "true" |
316 | by calling the C<send> method (or calling the condition variable as if it |
385 | by calling the C<send> method (or calling the condition variable as if it |
317 | were a callback). |
386 | were a callback, read about the caveats in the description for the C<< |
|
|
387 | ->send >> method). |
318 | |
388 | |
319 | Condition variables are similar to callbacks, except that you can |
389 | Condition variables are similar to callbacks, except that you can |
320 | optionally wait for them. They can also be called merge points - points |
390 | optionally wait for them. They can also be called merge points - points |
321 | in time where multiple outstanding events have been processed. And yet |
391 | in time where multiple outstanding events have been processed. And yet |
322 | another way to call them is transactions - each condition variable can be |
392 | another way to call them is transactions - each condition variable can be |
… | |
… | |
394 | immediately from within send. |
464 | immediately from within send. |
395 | |
465 | |
396 | Any arguments passed to the C<send> call will be returned by all |
466 | Any arguments passed to the C<send> call will be returned by all |
397 | future C<< ->recv >> calls. |
467 | future C<< ->recv >> calls. |
398 | |
468 | |
399 | Condition variables are overloaded so one can call them directly (as a |
469 | Condition variables are overloaded so one can call them directly |
400 | code reference). Calling them directly is the same as calling C<send>. |
470 | (as a code reference). Calling them directly is the same as calling |
|
|
471 | C<send>. Note, however, that many C-based event loops do not handle |
|
|
472 | overloading, so as tempting as it may be, passing a condition variable |
|
|
473 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
474 | support overloading, however, as well as all functions that use perl to |
|
|
475 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
476 | example). |
401 | |
477 | |
402 | =item $cv->croak ($error) |
478 | =item $cv->croak ($error) |
403 | |
479 | |
404 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
480 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
405 | C<Carp::croak> with the given error message/object/scalar. |
481 | C<Carp::croak> with the given error message/object/scalar. |
… | |
… | |
519 | The callback will be called when the condition becomes "true", i.e. when |
595 | The callback will be called when the condition becomes "true", i.e. when |
520 | C<send> or C<croak> are called. Calling C<recv> inside the callback |
596 | C<send> or C<croak> are called. Calling C<recv> inside the callback |
521 | or at any later time is guaranteed not to block. |
597 | or at any later time is guaranteed not to block. |
522 | |
598 | |
523 | =back |
599 | =back |
524 | |
|
|
525 | =head3 MAINLOOP EMULATION |
|
|
526 | |
|
|
527 | Sometimes (often for short test scripts, or even standalone programs |
|
|
528 | who only want to use AnyEvent), you I<do> want your program to block |
|
|
529 | indefinitely in some event loop. |
|
|
530 | |
|
|
531 | In that case, you cna use a condition variable like this: |
|
|
532 | |
|
|
533 | AnyEvent->condvar->recv; |
|
|
534 | |
|
|
535 | This has the effect of entering the event loop and looping forever. |
|
|
536 | |
|
|
537 | Note that usually your program has some exit condition, in which case |
|
|
538 | it is better to use the "traditional" approach of storing a condition |
|
|
539 | variable, waiting for it, and sending it when the program should exit |
|
|
540 | cleanly. |
|
|
541 | |
|
|
542 | |
600 | |
543 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
601 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
544 | |
602 | |
545 | =over 4 |
603 | =over 4 |
546 | |
604 | |
… | |
… | |
630 | |
688 | |
631 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
689 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
632 | do anything special (it does not need to be event-based) and let AnyEvent |
690 | do anything special (it does not need to be event-based) and let AnyEvent |
633 | decide which implementation to chose if some module relies on it. |
691 | decide which implementation to chose if some module relies on it. |
634 | |
692 | |
635 | If the main program relies on a specific event model. For example, in |
693 | If the main program relies on a specific event model - for example, in |
636 | Gtk2 programs you have to rely on the Glib module. You should load the |
694 | Gtk2 programs you have to rely on the Glib module - you should load the |
637 | event module before loading AnyEvent or any module that uses it: generally |
695 | event module before loading AnyEvent or any module that uses it: generally |
638 | speaking, you should load it as early as possible. The reason is that |
696 | speaking, you should load it as early as possible. The reason is that |
639 | modules might create watchers when they are loaded, and AnyEvent will |
697 | modules might create watchers when they are loaded, and AnyEvent will |
640 | decide on the event model to use as soon as it creates watchers, and it |
698 | decide on the event model to use as soon as it creates watchers, and it |
641 | might chose the wrong one unless you load the correct one yourself. |
699 | might chose the wrong one unless you load the correct one yourself. |
642 | |
700 | |
643 | You can chose to use a rather inefficient pure-perl implementation by |
701 | You can chose to use a pure-perl implementation by loading the |
644 | loading the C<AnyEvent::Impl::Perl> module, which gives you similar |
702 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
645 | behaviour everywhere, but letting AnyEvent chose is generally better. |
703 | everywhere, but letting AnyEvent chose the model is generally better. |
|
|
704 | |
|
|
705 | =head2 MAINLOOP EMULATION |
|
|
706 | |
|
|
707 | Sometimes (often for short test scripts, or even standalone programs who |
|
|
708 | only want to use AnyEvent), you do not want to run a specific event loop. |
|
|
709 | |
|
|
710 | In that case, you can use a condition variable like this: |
|
|
711 | |
|
|
712 | AnyEvent->condvar->recv; |
|
|
713 | |
|
|
714 | This has the effect of entering the event loop and looping forever. |
|
|
715 | |
|
|
716 | Note that usually your program has some exit condition, in which case |
|
|
717 | it is better to use the "traditional" approach of storing a condition |
|
|
718 | variable somewhere, waiting for it, and sending it when the program should |
|
|
719 | exit cleanly. |
|
|
720 | |
646 | |
721 | |
647 | =head1 OTHER MODULES |
722 | =head1 OTHER MODULES |
648 | |
723 | |
649 | The following is a non-exhaustive list of additional modules that use |
724 | The following is a non-exhaustive list of additional modules that use |
650 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
725 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
… | |
… | |
666 | |
741 | |
667 | Provides various utility functions for (internet protocol) sockets, |
742 | Provides various utility functions for (internet protocol) sockets, |
668 | addresses and name resolution. Also functions to create non-blocking tcp |
743 | addresses and name resolution. Also functions to create non-blocking tcp |
669 | connections or tcp servers, with IPv6 and SRV record support and more. |
744 | connections or tcp servers, with IPv6 and SRV record support and more. |
670 | |
745 | |
|
|
746 | =item L<AnyEvent::DNS> |
|
|
747 | |
|
|
748 | Provides rich asynchronous DNS resolver capabilities. |
|
|
749 | |
671 | =item L<AnyEvent::HTTPD> |
750 | =item L<AnyEvent::HTTPD> |
672 | |
751 | |
673 | Provides a simple web application server framework. |
752 | Provides a simple web application server framework. |
674 | |
|
|
675 | =item L<AnyEvent::DNS> |
|
|
676 | |
|
|
677 | Provides rich asynchronous DNS resolver capabilities. |
|
|
678 | |
753 | |
679 | =item L<AnyEvent::FastPing> |
754 | =item L<AnyEvent::FastPing> |
680 | |
755 | |
681 | The fastest ping in the west. |
756 | The fastest ping in the west. |
682 | |
757 | |
… | |
… | |
725 | no warnings; |
800 | no warnings; |
726 | use strict; |
801 | use strict; |
727 | |
802 | |
728 | use Carp; |
803 | use Carp; |
729 | |
804 | |
730 | our $VERSION = '4.03'; |
805 | our $VERSION = 4.11; |
731 | our $MODEL; |
806 | our $MODEL; |
732 | |
807 | |
733 | our $AUTOLOAD; |
808 | our $AUTOLOAD; |
734 | our @ISA; |
809 | our @ISA; |
735 | |
810 | |
|
|
811 | our @REGISTRY; |
|
|
812 | |
|
|
813 | our $WIN32; |
|
|
814 | |
|
|
815 | BEGIN { |
|
|
816 | my $win32 = ! ! ($^O =~ /mswin32/i); |
|
|
817 | eval "sub WIN32(){ $win32 }"; |
|
|
818 | } |
|
|
819 | |
736 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
820 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
737 | |
821 | |
738 | our @REGISTRY; |
822 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
739 | |
|
|
740 | our %PROTOCOL; # (ipv4|ipv6) => (1|2) |
|
|
741 | |
823 | |
742 | { |
824 | { |
743 | my $idx; |
825 | my $idx; |
744 | $PROTOCOL{$_} = ++$idx |
826 | $PROTOCOL{$_} = ++$idx |
|
|
827 | for reverse split /\s*,\s*/, |
745 | for split /\s*,\s*/, $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
828 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
746 | } |
829 | } |
747 | |
830 | |
748 | my @models = ( |
831 | my @models = ( |
749 | [EV:: => AnyEvent::Impl::EV::], |
832 | [EV:: => AnyEvent::Impl::EV::], |
750 | [Event:: => AnyEvent::Impl::Event::], |
833 | [Event:: => AnyEvent::Impl::Event::], |
751 | [Tk:: => AnyEvent::Impl::Tk::], |
|
|
752 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
753 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
754 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
834 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
755 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
835 | # everything below here will not be autoprobed |
756 | [Glib:: => AnyEvent::Impl::Glib::], |
836 | # as the pureperl backend should work everywhere |
|
|
837 | # and is usually faster |
|
|
838 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
839 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
757 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
840 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
758 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
841 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
759 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
842 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
|
|
843 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
844 | [Prima:: => AnyEvent::Impl::POE::], |
760 | ); |
845 | ); |
761 | |
846 | |
762 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
847 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
763 | |
848 | |
764 | our @post_detect; |
849 | our @post_detect; |
765 | |
850 | |
766 | sub post_detect(&) { |
851 | sub post_detect(&) { |
767 | my ($cb) = @_; |
852 | my ($cb) = @_; |
… | |
… | |
784 | } |
869 | } |
785 | |
870 | |
786 | sub detect() { |
871 | sub detect() { |
787 | unless ($MODEL) { |
872 | unless ($MODEL) { |
788 | no strict 'refs'; |
873 | no strict 'refs'; |
|
|
874 | local $SIG{__DIE__}; |
789 | |
875 | |
790 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
876 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
791 | my $model = "AnyEvent::Impl::$1"; |
877 | my $model = "AnyEvent::Impl::$1"; |
792 | if (eval "require $model") { |
878 | if (eval "require $model") { |
793 | $MODEL = $model; |
879 | $MODEL = $model; |
… | |
… | |
850 | $class->$func (@_); |
936 | $class->$func (@_); |
851 | } |
937 | } |
852 | |
938 | |
853 | package AnyEvent::Base; |
939 | package AnyEvent::Base; |
854 | |
940 | |
|
|
941 | # default implementation for now and time |
|
|
942 | |
|
|
943 | use Time::HiRes (); |
|
|
944 | |
|
|
945 | sub time { Time::HiRes::time } |
|
|
946 | sub now { Time::HiRes::time } |
|
|
947 | |
855 | # default implementation for ->condvar |
948 | # default implementation for ->condvar |
856 | |
949 | |
857 | sub condvar { |
950 | sub condvar { |
858 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
951 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
859 | } |
952 | } |
… | |
… | |
916 | or Carp::croak "required option 'pid' is missing"; |
1009 | or Carp::croak "required option 'pid' is missing"; |
917 | |
1010 | |
918 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1011 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
919 | |
1012 | |
920 | unless ($WNOHANG) { |
1013 | unless ($WNOHANG) { |
921 | $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; |
1014 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
922 | } |
1015 | } |
923 | |
1016 | |
924 | unless ($CHLD_W) { |
1017 | unless ($CHLD_W) { |
925 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1018 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
926 | # child could be a zombie already, so make at least one round |
1019 | # child could be a zombie already, so make at least one round |
… | |
… | |
1105 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1198 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1106 | default. |
1199 | default. |
1107 | |
1200 | |
1108 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1201 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1109 | EDNS0 in its DNS requests. |
1202 | EDNS0 in its DNS requests. |
|
|
1203 | |
|
|
1204 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1205 | |
|
|
1206 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1207 | will create in parallel. |
1110 | |
1208 | |
1111 | =back |
1209 | =back |
1112 | |
1210 | |
1113 | =head1 EXAMPLE PROGRAM |
1211 | =head1 EXAMPLE PROGRAM |
1114 | |
1212 | |