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? |
… | |
… | |
132 | Many watchers either are used with "recursion" (repeating timers for |
138 | Many watchers either are used with "recursion" (repeating timers for |
133 | 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. |
134 | |
140 | |
135 | An any way to achieve that is this pattern: |
141 | An any way to achieve that is this pattern: |
136 | |
142 | |
137 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
143 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
138 | # you can use $w here, for example to undef it |
144 | # you can use $w here, for example to undef it |
139 | undef $w; |
145 | undef $w; |
140 | }); |
146 | }); |
141 | |
147 | |
142 | 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, |
143 | 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 |
144 | declared. |
150 | declared. |
145 | |
151 | |
146 | =head2 I/O WATCHERS |
152 | =head2 I/O WATCHERS |
147 | |
153 | |
148 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
154 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
149 | with the following mandatory key-value pairs as arguments: |
155 | with the following mandatory key-value pairs as arguments: |
150 | |
156 | |
151 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch |
157 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events |
152 | for events. C<poll> must be a string that is either C<r> or C<w>, |
158 | (AnyEvent might or might not keep a reference to this file handle). C<poll> |
153 | which creates a watcher waiting for "r"eadable or "w"ritable events, |
159 | must be a string that is either C<r> or C<w>, which creates a watcher |
154 | respectively. C<cb> is the callback to invoke each time the file handle |
160 | waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the |
155 | becomes ready. |
161 | callback to invoke each time the file handle becomes ready. |
156 | |
162 | |
157 | Although the callback might get passed parameters, their value and |
163 | Although the callback might get passed parameters, their value and |
158 | presence is undefined and you cannot rely on them. Portable AnyEvent |
164 | presence is undefined and you cannot rely on them. Portable AnyEvent |
159 | callbacks cannot use arguments passed to I/O watcher callbacks. |
165 | callbacks cannot use arguments passed to I/O watcher callbacks. |
160 | |
166 | |
… | |
… | |
164 | |
170 | |
165 | Some event loops issue spurious readyness notifications, so you should |
171 | Some event loops issue spurious readyness notifications, so you should |
166 | always use non-blocking calls when reading/writing from/to your file |
172 | always use non-blocking calls when reading/writing from/to your file |
167 | handles. |
173 | handles. |
168 | |
174 | |
169 | Example: |
|
|
170 | |
|
|
171 | # wait for readability of STDIN, then read a line and disable the watcher |
175 | Example: wait for readability of STDIN, then read a line and disable the |
|
|
176 | watcher. |
|
|
177 | |
172 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
178 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
173 | chomp (my $input = <STDIN>); |
179 | chomp (my $input = <STDIN>); |
174 | warn "read: $input\n"; |
180 | warn "read: $input\n"; |
175 | undef $w; |
181 | undef $w; |
176 | }); |
182 | }); |
… | |
… | |
186 | |
192 | |
187 | Although the callback might get passed parameters, their value and |
193 | Although the callback might get passed parameters, their value and |
188 | presence is undefined and you cannot rely on them. Portable AnyEvent |
194 | presence is undefined and you cannot rely on them. Portable AnyEvent |
189 | callbacks cannot use arguments passed to time watcher callbacks. |
195 | callbacks cannot use arguments passed to time watcher callbacks. |
190 | |
196 | |
191 | The timer callback will be invoked at most once: if you want a repeating |
197 | The callback will normally be invoked once only. If you specify another |
192 | timer you have to create a new watcher (this is a limitation by both Tk |
198 | parameter, C<interval>, as a strictly positive number (> 0), then the |
193 | and Glib). |
199 | callback will be invoked regularly at that interval (in fractional |
|
|
200 | seconds) after the first invocation. If C<interval> is specified with a |
|
|
201 | false value, then it is treated as if it were missing. |
194 | |
202 | |
195 | Example: |
203 | The callback will be rescheduled before invoking the callback, but no |
|
|
204 | attempt is done to avoid timer drift in most backends, so the interval is |
|
|
205 | only approximate. |
196 | |
206 | |
197 | # fire an event after 7.7 seconds |
207 | Example: fire an event after 7.7 seconds. |
|
|
208 | |
198 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
209 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
199 | warn "timeout\n"; |
210 | warn "timeout\n"; |
200 | }); |
211 | }); |
201 | |
212 | |
202 | # to cancel the timer: |
213 | # to cancel the timer: |
203 | undef $w; |
214 | undef $w; |
204 | |
215 | |
205 | Example 2: |
|
|
206 | |
|
|
207 | # fire an event after 0.5 seconds, then roughly every second |
216 | Example 2: fire an event after 0.5 seconds, then roughly every second. |
208 | my $w; |
|
|
209 | |
217 | |
210 | my $cb = sub { |
|
|
211 | # cancel the old timer while creating a new one |
|
|
212 | $w = AnyEvent->timer (after => 1, cb => $cb); |
218 | my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { |
|
|
219 | warn "timeout\n"; |
213 | }; |
220 | }; |
214 | |
|
|
215 | # start the "loop" by creating the first watcher |
|
|
216 | $w = AnyEvent->timer (after => 0.5, cb => $cb); |
|
|
217 | |
221 | |
218 | =head3 TIMING ISSUES |
222 | =head3 TIMING ISSUES |
219 | |
223 | |
220 | There are two ways to handle timers: based on real time (relative, "fire |
224 | There are two ways to handle timers: based on real time (relative, "fire |
221 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
225 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
… | |
… | |
346 | AnyEvent program, you I<have> to create at least one watcher before you |
350 | AnyEvent program, you I<have> to create at least one watcher before you |
347 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
351 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
348 | |
352 | |
349 | Example: fork a process and wait for it |
353 | Example: fork a process and wait for it |
350 | |
354 | |
351 | my $done = AnyEvent->condvar; |
355 | my $done = AnyEvent->condvar; |
352 | |
356 | |
353 | my $pid = fork or exit 5; |
357 | my $pid = fork or exit 5; |
354 | |
358 | |
355 | my $w = AnyEvent->child ( |
359 | my $w = AnyEvent->child ( |
356 | pid => $pid, |
360 | pid => $pid, |
357 | cb => sub { |
361 | cb => sub { |
358 | my ($pid, $status) = @_; |
362 | my ($pid, $status) = @_; |
359 | warn "pid $pid exited with status $status"; |
363 | warn "pid $pid exited with status $status"; |
360 | $done->send; |
364 | $done->send; |
361 | }, |
365 | }, |
362 | ); |
366 | ); |
363 | |
367 | |
364 | # do something else, then wait for process exit |
368 | # do something else, then wait for process exit |
365 | $done->recv; |
369 | $done->recv; |
366 | |
370 | |
367 | =head2 CONDITION VARIABLES |
371 | =head2 CONDITION VARIABLES |
368 | |
372 | |
369 | If you are familiar with some event loops you will know that all of them |
373 | If you are familiar with some event loops you will know that all of them |
370 | require you to run some blocking "loop", "run" or similar function that |
374 | require you to run some blocking "loop", "run" or similar function that |
… | |
… | |
591 | |
595 | |
592 | This is a mutator function that returns the callback set and optionally |
596 | This is a mutator function that returns the callback set and optionally |
593 | replaces it before doing so. |
597 | replaces it before doing so. |
594 | |
598 | |
595 | The callback will be called when the condition becomes "true", i.e. when |
599 | The callback will be called when the condition becomes "true", i.e. when |
596 | C<send> or C<croak> are called. Calling C<recv> inside the callback |
600 | C<send> or C<croak> are called, with the only argument being the condition |
597 | or at any later time is guaranteed not to block. |
601 | variable itself. Calling C<recv> inside the callback or at any later time |
|
|
602 | is guaranteed not to block. |
598 | |
603 | |
599 | =back |
604 | =back |
600 | |
605 | |
601 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
606 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
602 | |
607 | |
… | |
… | |
731 | =item L<AnyEvent::Util> |
736 | =item L<AnyEvent::Util> |
732 | |
737 | |
733 | Contains various utility functions that replace often-used but blocking |
738 | Contains various utility functions that replace often-used but blocking |
734 | functions such as C<inet_aton> by event-/callback-based versions. |
739 | functions such as C<inet_aton> by event-/callback-based versions. |
735 | |
740 | |
736 | =item L<AnyEvent::Handle> |
|
|
737 | |
|
|
738 | Provide read and write buffers and manages watchers for reads and writes. |
|
|
739 | |
|
|
740 | =item L<AnyEvent::Socket> |
741 | =item L<AnyEvent::Socket> |
741 | |
742 | |
742 | Provides various utility functions for (internet protocol) sockets, |
743 | Provides various utility functions for (internet protocol) sockets, |
743 | addresses and name resolution. Also functions to create non-blocking tcp |
744 | addresses and name resolution. Also functions to create non-blocking tcp |
744 | connections or tcp servers, with IPv6 and SRV record support and more. |
745 | connections or tcp servers, with IPv6 and SRV record support and more. |
745 | |
746 | |
|
|
747 | =item L<AnyEvent::Handle> |
|
|
748 | |
|
|
749 | Provide read and write buffers, manages watchers for reads and writes, |
|
|
750 | supports raw and formatted I/O, I/O queued and fully transparent and |
|
|
751 | non-blocking SSL/TLS. |
|
|
752 | |
746 | =item L<AnyEvent::DNS> |
753 | =item L<AnyEvent::DNS> |
747 | |
754 | |
748 | Provides rich asynchronous DNS resolver capabilities. |
755 | Provides rich asynchronous DNS resolver capabilities. |
749 | |
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 | |
750 | =item L<AnyEvent::HTTPD> |
762 | =item L<AnyEvent::HTTPD> |
751 | |
763 | |
752 | Provides a simple web application server framework. |
764 | Provides a simple web application server framework. |
753 | |
765 | |
754 | =item L<AnyEvent::FastPing> |
766 | =item L<AnyEvent::FastPing> |
755 | |
767 | |
756 | The fastest ping in the west. |
768 | The fastest ping in the west. |
|
|
769 | |
|
|
770 | =item L<AnyEvent::DBI> |
|
|
771 | |
|
|
772 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
773 | |
|
|
774 | =item L<AnyEvent::AIO> |
|
|
775 | |
|
|
776 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
777 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
778 | together. |
|
|
779 | |
|
|
780 | =item L<AnyEvent::BDB> |
|
|
781 | |
|
|
782 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
783 | L<BDB> and AnyEvent together. |
|
|
784 | |
|
|
785 | =item L<AnyEvent::GPSD> |
|
|
786 | |
|
|
787 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
788 | |
|
|
789 | =item L<AnyEvent::IGS> |
|
|
790 | |
|
|
791 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
792 | L<App::IGS>). |
757 | |
793 | |
758 | =item L<Net::IRC3> |
794 | =item L<Net::IRC3> |
759 | |
795 | |
760 | AnyEvent based IRC client module family. |
796 | AnyEvent based IRC client module family. |
761 | |
797 | |
… | |
… | |
774 | |
810 | |
775 | =item L<Coro> |
811 | =item L<Coro> |
776 | |
812 | |
777 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
813 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
778 | |
814 | |
779 | =item L<AnyEvent::AIO>, L<IO::AIO> |
|
|
780 | |
|
|
781 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
782 | programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent |
|
|
783 | together. |
|
|
784 | |
|
|
785 | =item L<AnyEvent::BDB>, L<BDB> |
|
|
786 | |
|
|
787 | Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses |
|
|
788 | IO::AIO and AnyEvent together. |
|
|
789 | |
|
|
790 | =item L<IO::Lambda> |
815 | =item L<IO::Lambda> |
791 | |
816 | |
792 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
817 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
793 | |
818 | |
794 | =back |
819 | =back |
… | |
… | |
800 | no warnings; |
825 | no warnings; |
801 | use strict; |
826 | use strict; |
802 | |
827 | |
803 | use Carp; |
828 | use Carp; |
804 | |
829 | |
805 | our $VERSION = '4.1'; |
830 | our $VERSION = 4.2; |
806 | our $MODEL; |
831 | our $MODEL; |
807 | |
832 | |
808 | our $AUTOLOAD; |
833 | our $AUTOLOAD; |
809 | our @ISA; |
834 | our @ISA; |
810 | |
835 | |
… | |
… | |
972 | sub AnyEvent::Base::Signal::DESTROY { |
997 | sub AnyEvent::Base::Signal::DESTROY { |
973 | my ($signal, $cb) = @{$_[0]}; |
998 | my ($signal, $cb) = @{$_[0]}; |
974 | |
999 | |
975 | delete $SIG_CB{$signal}{$cb}; |
1000 | delete $SIG_CB{$signal}{$cb}; |
976 | |
1001 | |
977 | $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; |
1002 | delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
978 | } |
1003 | } |
979 | |
1004 | |
980 | # default implementation for ->child |
1005 | # default implementation for ->child |
981 | |
1006 | |
982 | our %PID_CB; |
1007 | our %PID_CB; |
… | |
… | |
1166 | This functionality might change in future versions. |
1191 | This functionality might change in future versions. |
1167 | |
1192 | |
1168 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1193 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1169 | could start your program like this: |
1194 | could start your program like this: |
1170 | |
1195 | |
1171 | PERL_ANYEVENT_MODEL=Perl perl ... |
1196 | PERL_ANYEVENT_MODEL=Perl perl ... |
1172 | |
1197 | |
1173 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1198 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1174 | |
1199 | |
1175 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1200 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1176 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
1201 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
… | |
… | |
1651 | specified in the variable. |
1676 | specified in the variable. |
1652 | |
1677 | |
1653 | You can make AnyEvent completely ignore this variable by deleting it |
1678 | You can make AnyEvent completely ignore this variable by deleting it |
1654 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1679 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1655 | |
1680 | |
1656 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1681 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1657 | |
1682 | |
1658 | use AnyEvent; |
1683 | use AnyEvent; |
1659 | |
1684 | |
1660 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1685 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1661 | be used to probe what backend is used and gain other information (which is |
1686 | be used to probe what backend is used and gain other information (which is |
1662 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1687 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
|
|
1688 | |
|
|
1689 | |
|
|
1690 | =head1 BUGS |
|
|
1691 | |
|
|
1692 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
|
|
1693 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
|
|
1694 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
|
|
1695 | mamleaks, such as leaking on C<map> and C<grep> but it is usually not as |
|
|
1696 | pronounced). |
1663 | |
1697 | |
1664 | |
1698 | |
1665 | =head1 SEE ALSO |
1699 | =head1 SEE ALSO |
1666 | |
1700 | |
1667 | Utility functions: L<AnyEvent::Util>. |
1701 | Utility functions: L<AnyEvent::Util>. |
… | |
… | |
1684 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1718 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1685 | |
1719 | |
1686 | |
1720 | |
1687 | =head1 AUTHOR |
1721 | =head1 AUTHOR |
1688 | |
1722 | |
1689 | Marc Lehmann <schmorp@schmorp.de> |
1723 | Marc Lehmann <schmorp@schmorp.de> |
1690 | http://home.schmorp.de/ |
1724 | http://home.schmorp.de/ |
1691 | |
1725 | |
1692 | =cut |
1726 | =cut |
1693 | |
1727 | |
1694 | 1 |
1728 | 1 |
1695 | |
1729 | |