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 | |
… | |
… | |
17 | }); |
17 | }); |
18 | |
18 | |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
20 | $w->send; # wake up current and all future recv's |
20 | $w->send; # wake up current and all future recv's |
21 | $w->recv; # enters "main loop" till $condvar gets ->send |
21 | $w->recv; # enters "main loop" till $condvar gets ->send |
|
|
22 | |
|
|
23 | =head1 INTRODUCTION/TUTORIAL |
|
|
24 | |
|
|
25 | This manpage is mainly a reference manual. If you are interested |
|
|
26 | in a tutorial or some gentle introduction, have a look at the |
|
|
27 | L<AnyEvent::Intro> manpage. |
22 | |
28 | |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
29 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
24 | |
30 | |
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
31 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
26 | nowadays. So what is different about AnyEvent? |
32 | nowadays. So what is different about AnyEvent? |
… | |
… | |
48 | isn't itself. What's worse, all the potential users of your module are |
54 | 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. |
55 | I<also> forced to use the same event loop you use. |
50 | |
56 | |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
57 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
58 | 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 |
59 | 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, |
60 | 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 |
61 | 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 |
62 | 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 |
63 | 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). |
64 | 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 |
68 | 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 |
69 | 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 |
70 | offering the functionality that is necessary, in as thin as a wrapper as |
65 | technically possible. |
71 | technically possible. |
66 | |
72 | |
|
|
73 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
|
|
74 | of useful functionality, such as an asynchronous DNS resolver, 100% |
|
|
75 | non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms |
|
|
76 | such as Windows) and lots of real-world knowledge and workarounds for |
|
|
77 | platform bugs and differences. |
|
|
78 | |
67 | Of course, if you want lots of policy (this can arguably be somewhat |
79 | 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 |
80 | useful) and you want to force your users to use the one and only event |
69 | model, you should I<not> use this module. |
81 | model, you should I<not> use this module. |
70 | |
82 | |
71 | =head1 DESCRIPTION |
83 | =head1 DESCRIPTION |
72 | |
84 | |
… | |
… | |
102 | starts using it, all bets are off. Maybe you should tell their authors to |
114 | 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... |
115 | use AnyEvent so their modules work together with others seamlessly... |
104 | |
116 | |
105 | The pure-perl implementation of AnyEvent is called |
117 | The pure-perl implementation of AnyEvent is called |
106 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
118 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
107 | explicitly. |
119 | explicitly and enjoy the high availability of that event loop :) |
108 | |
120 | |
109 | =head1 WATCHERS |
121 | =head1 WATCHERS |
110 | |
122 | |
111 | AnyEvent has the central concept of a I<watcher>, which is an object that |
123 | 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 |
124 | stores relevant data for each kind of event you are waiting for, such as |
… | |
… | |
126 | Many watchers either are used with "recursion" (repeating timers for |
138 | Many watchers either are used with "recursion" (repeating timers for |
127 | example), or need to refer to their watcher object in other ways. |
139 | example), or need to refer to their watcher object in other ways. |
128 | |
140 | |
129 | An any way to achieve that is this pattern: |
141 | An any way to achieve that is this pattern: |
130 | |
142 | |
131 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
143 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
132 | # you can use $w here, for example to undef it |
144 | # you can use $w here, for example to undef it |
133 | undef $w; |
145 | undef $w; |
134 | }); |
146 | }); |
135 | |
147 | |
136 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
148 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
137 | my variables are only visible after the statement in which they are |
149 | my variables are only visible after the statement in which they are |
138 | declared. |
150 | declared. |
139 | |
151 | |
… | |
… | |
227 | timers. |
239 | timers. |
228 | |
240 | |
229 | AnyEvent always prefers relative timers, if available, matching the |
241 | AnyEvent always prefers relative timers, if available, matching the |
230 | AnyEvent API. |
242 | AnyEvent API. |
231 | |
243 | |
|
|
244 | AnyEvent has two additional methods that return the "current time": |
|
|
245 | |
|
|
246 | =over 4 |
|
|
247 | |
|
|
248 | =item AnyEvent->time |
|
|
249 | |
|
|
250 | This returns the "current wallclock time" as a fractional number of |
|
|
251 | seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time> |
|
|
252 | return, and the result is guaranteed to be compatible with those). |
|
|
253 | |
|
|
254 | It progresses independently of any event loop processing, i.e. each call |
|
|
255 | will check the system clock, which usually gets updated frequently. |
|
|
256 | |
|
|
257 | =item AnyEvent->now |
|
|
258 | |
|
|
259 | This also returns the "current wallclock time", but unlike C<time>, above, |
|
|
260 | this value might change only once per event loop iteration, depending on |
|
|
261 | the event loop (most return the same time as C<time>, above). This is the |
|
|
262 | time that AnyEvent's timers get scheduled against. |
|
|
263 | |
|
|
264 | I<In almost all cases (in all cases if you don't care), this is the |
|
|
265 | function to call when you want to know the current time.> |
|
|
266 | |
|
|
267 | This function is also often faster then C<< AnyEvent->time >>, and |
|
|
268 | thus the preferred method if you want some timestamp (for example, |
|
|
269 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
|
|
270 | |
|
|
271 | The rest of this section is only of relevance if you try to be very exact |
|
|
272 | with your timing, you can skip it without bad conscience. |
|
|
273 | |
|
|
274 | For a practical example of when these times differ, consider L<Event::Lib> |
|
|
275 | and L<EV> and the following set-up: |
|
|
276 | |
|
|
277 | The event loop is running and has just invoked one of your callback at |
|
|
278 | time=500 (assume no other callbacks delay processing). In your callback, |
|
|
279 | you wait a second by executing C<sleep 1> (blocking the process for a |
|
|
280 | second) and then (at time=501) you create a relative timer that fires |
|
|
281 | after three seconds. |
|
|
282 | |
|
|
283 | With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will |
|
|
284 | both return C<501>, because that is the current time, and the timer will |
|
|
285 | be scheduled to fire at time=504 (C<501> + C<3>). |
|
|
286 | |
|
|
287 | With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current |
|
|
288 | time), but C<< AnyEvent->now >> returns C<500>, as that is the time the |
|
|
289 | last event processing phase started. With L<EV>, your timer gets scheduled |
|
|
290 | to run at time=503 (C<500> + C<3>). |
|
|
291 | |
|
|
292 | In one sense, L<Event::Lib> is more exact, as it uses the current time |
|
|
293 | regardless of any delays introduced by event processing. However, most |
|
|
294 | callbacks do not expect large delays in processing, so this causes a |
|
|
295 | higher drift (and a lot more system calls to get the current time). |
|
|
296 | |
|
|
297 | In another sense, L<EV> is more exact, as your timer will be scheduled at |
|
|
298 | the same time, regardless of how long event processing actually took. |
|
|
299 | |
|
|
300 | In either case, if you care (and in most cases, you don't), then you |
|
|
301 | can get whatever behaviour you want with any event loop, by taking the |
|
|
302 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
|
|
303 | account. |
|
|
304 | |
|
|
305 | =back |
|
|
306 | |
232 | =head2 SIGNAL WATCHERS |
307 | =head2 SIGNAL WATCHERS |
233 | |
308 | |
234 | You can watch for signals using a signal watcher, C<signal> is the signal |
309 | 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 |
310 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
236 | be invoked whenever a signal occurs. |
311 | be invoked whenever a signal occurs. |
… | |
… | |
277 | AnyEvent program, you I<have> to create at least one watcher before you |
352 | AnyEvent program, you I<have> to create at least one watcher before you |
278 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
353 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
279 | |
354 | |
280 | Example: fork a process and wait for it |
355 | Example: fork a process and wait for it |
281 | |
356 | |
282 | my $done = AnyEvent->condvar; |
357 | my $done = AnyEvent->condvar; |
283 | |
358 | |
284 | my $pid = fork or exit 5; |
359 | my $pid = fork or exit 5; |
285 | |
360 | |
286 | my $w = AnyEvent->child ( |
361 | my $w = AnyEvent->child ( |
287 | pid => $pid, |
362 | pid => $pid, |
288 | cb => sub { |
363 | cb => sub { |
289 | my ($pid, $status) = @_; |
364 | my ($pid, $status) = @_; |
290 | warn "pid $pid exited with status $status"; |
365 | warn "pid $pid exited with status $status"; |
291 | $done->send; |
366 | $done->send; |
292 | }, |
367 | }, |
293 | ); |
368 | ); |
294 | |
369 | |
295 | # do something else, then wait for process exit |
370 | # do something else, then wait for process exit |
296 | $done->recv; |
371 | $done->recv; |
297 | |
372 | |
298 | =head2 CONDITION VARIABLES |
373 | =head2 CONDITION VARIABLES |
299 | |
374 | |
300 | If you are familiar with some event loops you will know that all of them |
375 | If you are familiar with some event loops you will know that all of them |
301 | require you to run some blocking "loop", "run" or similar function that |
376 | require you to run some blocking "loop", "run" or similar function that |
… | |
… | |
522 | |
597 | |
523 | This is a mutator function that returns the callback set and optionally |
598 | This is a mutator function that returns the callback set and optionally |
524 | replaces it before doing so. |
599 | replaces it before doing so. |
525 | |
600 | |
526 | The callback will be called when the condition becomes "true", i.e. when |
601 | The callback will be called when the condition becomes "true", i.e. when |
527 | C<send> or C<croak> are called. Calling C<recv> inside the callback |
602 | C<send> or C<croak> are called, with the only argument being the condition |
528 | or at any later time is guaranteed not to block. |
603 | variable itself. Calling C<recv> inside the callback or at any later time |
|
|
604 | is guaranteed not to block. |
529 | |
605 | |
530 | =back |
606 | =back |
531 | |
607 | |
532 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
608 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
533 | |
609 | |
… | |
… | |
676 | |
752 | |
677 | =item L<AnyEvent::DNS> |
753 | =item L<AnyEvent::DNS> |
678 | |
754 | |
679 | Provides rich asynchronous DNS resolver capabilities. |
755 | Provides rich asynchronous DNS resolver capabilities. |
680 | |
756 | |
|
|
757 | =item L<AnyEvent::HTTP> |
|
|
758 | |
|
|
759 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
|
|
760 | HTTP requests. |
|
|
761 | |
681 | =item L<AnyEvent::HTTPD> |
762 | =item L<AnyEvent::HTTPD> |
682 | |
763 | |
683 | Provides a simple web application server framework. |
764 | Provides a simple web application server framework. |
684 | |
765 | |
685 | =item L<AnyEvent::FastPing> |
766 | =item L<AnyEvent::FastPing> |
686 | |
767 | |
687 | The fastest ping in the west. |
768 | The fastest ping in the west. |
|
|
769 | |
|
|
770 | =item L<AnyEvent::DBI> |
|
|
771 | |
|
|
772 | Executes DBI requests asynchronously in a proxy process. |
688 | |
773 | |
689 | =item L<Net::IRC3> |
774 | =item L<Net::IRC3> |
690 | |
775 | |
691 | AnyEvent based IRC client module family. |
776 | AnyEvent based IRC client module family. |
692 | |
777 | |
… | |
… | |
731 | no warnings; |
816 | no warnings; |
732 | use strict; |
817 | use strict; |
733 | |
818 | |
734 | use Carp; |
819 | use Carp; |
735 | |
820 | |
736 | our $VERSION = '4.03'; |
821 | our $VERSION = '4.160'; # temporary workaround for broken fedora |
737 | our $MODEL; |
822 | our $MODEL; |
738 | |
823 | |
739 | our $AUTOLOAD; |
824 | our $AUTOLOAD; |
740 | our @ISA; |
825 | our @ISA; |
741 | |
826 | |
742 | our @REGISTRY; |
827 | our @REGISTRY; |
|
|
828 | |
|
|
829 | our $WIN32; |
|
|
830 | |
|
|
831 | BEGIN { |
|
|
832 | my $win32 = ! ! ($^O =~ /mswin32/i); |
|
|
833 | eval "sub WIN32(){ $win32 }"; |
|
|
834 | } |
743 | |
835 | |
744 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
836 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
745 | |
837 | |
746 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
838 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
747 | |
839 | |
… | |
… | |
766 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
858 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
767 | [Wx:: => AnyEvent::Impl::POE::], |
859 | [Wx:: => AnyEvent::Impl::POE::], |
768 | [Prima:: => AnyEvent::Impl::POE::], |
860 | [Prima:: => AnyEvent::Impl::POE::], |
769 | ); |
861 | ); |
770 | |
862 | |
771 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
863 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
772 | |
864 | |
773 | our @post_detect; |
865 | our @post_detect; |
774 | |
866 | |
775 | sub post_detect(&) { |
867 | sub post_detect(&) { |
776 | my ($cb) = @_; |
868 | my ($cb) = @_; |
… | |
… | |
860 | $class->$func (@_); |
952 | $class->$func (@_); |
861 | } |
953 | } |
862 | |
954 | |
863 | package AnyEvent::Base; |
955 | package AnyEvent::Base; |
864 | |
956 | |
|
|
957 | # default implementation for now and time |
|
|
958 | |
|
|
959 | use Time::HiRes (); |
|
|
960 | |
|
|
961 | sub time { Time::HiRes::time } |
|
|
962 | sub now { Time::HiRes::time } |
|
|
963 | |
865 | # default implementation for ->condvar |
964 | # default implementation for ->condvar |
866 | |
965 | |
867 | sub condvar { |
966 | sub condvar { |
868 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
967 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
869 | } |
968 | } |
… | |
… | |
889 | sub AnyEvent::Base::Signal::DESTROY { |
988 | sub AnyEvent::Base::Signal::DESTROY { |
890 | my ($signal, $cb) = @{$_[0]}; |
989 | my ($signal, $cb) = @{$_[0]}; |
891 | |
990 | |
892 | delete $SIG_CB{$signal}{$cb}; |
991 | delete $SIG_CB{$signal}{$cb}; |
893 | |
992 | |
894 | $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; |
993 | delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
895 | } |
994 | } |
896 | |
995 | |
897 | # default implementation for ->child |
996 | # default implementation for ->child |
898 | |
997 | |
899 | our %PID_CB; |
998 | our %PID_CB; |
… | |
… | |
1083 | This functionality might change in future versions. |
1182 | This functionality might change in future versions. |
1084 | |
1183 | |
1085 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1184 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1086 | could start your program like this: |
1185 | could start your program like this: |
1087 | |
1186 | |
1088 | PERL_ANYEVENT_MODEL=Perl perl ... |
1187 | PERL_ANYEVENT_MODEL=Perl perl ... |
1089 | |
1188 | |
1090 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1189 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1091 | |
1190 | |
1092 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1191 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1093 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
1192 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
… | |
… | |
1115 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1214 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1116 | default. |
1215 | default. |
1117 | |
1216 | |
1118 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1217 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1119 | EDNS0 in its DNS requests. |
1218 | EDNS0 in its DNS requests. |
|
|
1219 | |
|
|
1220 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1221 | |
|
|
1222 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1223 | will create in parallel. |
1120 | |
1224 | |
1121 | =back |
1225 | =back |
1122 | |
1226 | |
1123 | =head1 EXAMPLE PROGRAM |
1227 | =head1 EXAMPLE PROGRAM |
1124 | |
1228 | |
… | |
… | |
1563 | specified in the variable. |
1667 | specified in the variable. |
1564 | |
1668 | |
1565 | You can make AnyEvent completely ignore this variable by deleting it |
1669 | You can make AnyEvent completely ignore this variable by deleting it |
1566 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1670 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1567 | |
1671 | |
1568 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1672 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1569 | |
1673 | |
1570 | use AnyEvent; |
1674 | use AnyEvent; |
1571 | |
1675 | |
1572 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1676 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1573 | be used to probe what backend is used and gain other information (which is |
1677 | be used to probe what backend is used and gain other information (which is |
1574 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1678 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
|
|
1679 | |
|
|
1680 | |
|
|
1681 | =head1 BUGS |
|
|
1682 | |
|
|
1683 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
|
|
1684 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
|
|
1685 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
|
|
1686 | mamleaks, such as leaking on C<map> and C<grep> but it is usually not as |
|
|
1687 | pronounced). |
1575 | |
1688 | |
1576 | |
1689 | |
1577 | =head1 SEE ALSO |
1690 | =head1 SEE ALSO |
1578 | |
1691 | |
1579 | Utility functions: L<AnyEvent::Util>. |
1692 | Utility functions: L<AnyEvent::Util>. |
… | |
… | |
1596 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1709 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1597 | |
1710 | |
1598 | |
1711 | |
1599 | =head1 AUTHOR |
1712 | =head1 AUTHOR |
1600 | |
1713 | |
1601 | Marc Lehmann <schmorp@schmorp.de> |
1714 | Marc Lehmann <schmorp@schmorp.de> |
1602 | http://home.schmorp.de/ |
1715 | http://home.schmorp.de/ |
1603 | |
1716 | |
1604 | =cut |
1717 | =cut |
1605 | |
1718 | |
1606 | 1 |
1719 | 1 |
1607 | |
1720 | |