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 | |
… | |
… | |
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 | |
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. |
|
|
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? |
27 | |
33 | |
28 | Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of |
34 | Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of |
29 | policy> and AnyEvent is I<small and efficient>. |
35 | policy> and AnyEvent is I<small and efficient>. |
30 | |
36 | |
31 | First and foremost, I<AnyEvent is not an event model> itself, it only |
37 | First and foremost, I<AnyEvent is not an event model> itself, it only |
32 | interfaces to whatever event model the main program happens to use in a |
38 | interfaces to whatever event model the main program happens to use, in a |
33 | pragmatic way. For event models and certain classes of immortals alike, |
39 | pragmatic way. For event models and certain classes of immortals alike, |
34 | the statement "there can only be one" is a bitter reality: In general, |
40 | the statement "there can only be one" is a bitter reality: In general, |
35 | only one event loop can be active at the same time in a process. AnyEvent |
41 | only one event loop can be active at the same time in a process. AnyEvent |
36 | helps hiding the differences between those event loops. |
42 | cannot change this, but it can hide the differences between those event |
|
|
43 | loops. |
37 | |
44 | |
38 | The goal of AnyEvent is to offer module authors the ability to do event |
45 | The goal of AnyEvent is to offer module authors the ability to do event |
39 | programming (waiting for I/O or timer events) without subscribing to a |
46 | programming (waiting for I/O or timer events) without subscribing to a |
40 | religion, a way of living, and most importantly: without forcing your |
47 | religion, a way of living, and most importantly: without forcing your |
41 | module users into the same thing by forcing them to use the same event |
48 | module users into the same thing by forcing them to use the same event |
42 | model you use. |
49 | model you use. |
43 | |
50 | |
44 | For modules like POE or IO::Async (which is a total misnomer as it is |
51 | For modules like POE or IO::Async (which is a total misnomer as it is |
45 | actually doing all I/O I<synchronously>...), using them in your module is |
52 | actually doing all I/O I<synchronously>...), using them in your module is |
46 | like joining a cult: After you joined, you are dependent on them and you |
53 | like joining a cult: After you joined, you are dependent on them and you |
47 | cannot use anything else, as it is simply incompatible to everything that |
54 | cannot use anything else, as they are simply incompatible to everything |
48 | isn't itself. What's worse, all the potential users of your module are |
55 | that isn't them. What's worse, all the potential users of your |
49 | I<also> forced to use the same event loop you use. |
56 | module are I<also> forced to use the same event loop you use. |
50 | |
57 | |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
58 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
59 | 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 |
60 | 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, |
61 | 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 |
62 | 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 |
63 | event models it supports (including stuff like IO::Async, as long as those |
57 | as those use one of the supported event loops. It is trivial to add new |
64 | use one of the supported event loops. It is trivial to add new event loops |
58 | event loops to AnyEvent, too, so it is future-proof). |
65 | to AnyEvent, too, so it is future-proof). |
59 | |
66 | |
60 | In addition to being free of having to use I<the one and only true event |
67 | 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 |
68 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
62 | modules, you get an enormous amount of code and strict rules you have to |
69 | 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 |
70 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
… | |
… | |
132 | Many watchers either are used with "recursion" (repeating timers for |
139 | Many watchers either are used with "recursion" (repeating timers for |
133 | example), or need to refer to their watcher object in other ways. |
140 | example), or need to refer to their watcher object in other ways. |
134 | |
141 | |
135 | An any way to achieve that is this pattern: |
142 | An any way to achieve that is this pattern: |
136 | |
143 | |
137 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
144 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
138 | # you can use $w here, for example to undef it |
145 | # you can use $w here, for example to undef it |
139 | undef $w; |
146 | undef $w; |
140 | }); |
147 | }); |
141 | |
148 | |
142 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
149 | 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 |
150 | my variables are only visible after the statement in which they are |
144 | declared. |
151 | declared. |
145 | |
152 | |
146 | =head2 I/O WATCHERS |
153 | =head2 I/O WATCHERS |
147 | |
154 | |
148 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
155 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
149 | with the following mandatory key-value pairs as arguments: |
156 | with the following mandatory key-value pairs as arguments: |
150 | |
157 | |
151 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch |
158 | 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>, |
159 | (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, |
160 | 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 |
161 | waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the |
155 | becomes ready. |
162 | callback to invoke each time the file handle becomes ready. |
156 | |
163 | |
157 | Although the callback might get passed parameters, their value and |
164 | Although the callback might get passed parameters, their value and |
158 | presence is undefined and you cannot rely on them. Portable AnyEvent |
165 | presence is undefined and you cannot rely on them. Portable AnyEvent |
159 | callbacks cannot use arguments passed to I/O watcher callbacks. |
166 | callbacks cannot use arguments passed to I/O watcher callbacks. |
160 | |
167 | |
… | |
… | |
164 | |
171 | |
165 | Some event loops issue spurious readyness notifications, so you should |
172 | Some event loops issue spurious readyness notifications, so you should |
166 | always use non-blocking calls when reading/writing from/to your file |
173 | always use non-blocking calls when reading/writing from/to your file |
167 | handles. |
174 | handles. |
168 | |
175 | |
169 | Example: |
|
|
170 | |
|
|
171 | # wait for readability of STDIN, then read a line and disable the watcher |
176 | Example: wait for readability of STDIN, then read a line and disable the |
|
|
177 | watcher. |
|
|
178 | |
172 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
179 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
173 | chomp (my $input = <STDIN>); |
180 | chomp (my $input = <STDIN>); |
174 | warn "read: $input\n"; |
181 | warn "read: $input\n"; |
175 | undef $w; |
182 | undef $w; |
176 | }); |
183 | }); |
… | |
… | |
186 | |
193 | |
187 | Although the callback might get passed parameters, their value and |
194 | Although the callback might get passed parameters, their value and |
188 | presence is undefined and you cannot rely on them. Portable AnyEvent |
195 | presence is undefined and you cannot rely on them. Portable AnyEvent |
189 | callbacks cannot use arguments passed to time watcher callbacks. |
196 | callbacks cannot use arguments passed to time watcher callbacks. |
190 | |
197 | |
191 | The timer callback will be invoked at most once: if you want a repeating |
198 | 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 |
199 | parameter, C<interval>, as a strictly positive number (> 0), then the |
193 | and Glib). |
200 | callback will be invoked regularly at that interval (in fractional |
|
|
201 | seconds) after the first invocation. If C<interval> is specified with a |
|
|
202 | false value, then it is treated as if it were missing. |
194 | |
203 | |
195 | Example: |
204 | The callback will be rescheduled before invoking the callback, but no |
|
|
205 | attempt is done to avoid timer drift in most backends, so the interval is |
|
|
206 | only approximate. |
196 | |
207 | |
197 | # fire an event after 7.7 seconds |
208 | Example: fire an event after 7.7 seconds. |
|
|
209 | |
198 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
210 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
199 | warn "timeout\n"; |
211 | warn "timeout\n"; |
200 | }); |
212 | }); |
201 | |
213 | |
202 | # to cancel the timer: |
214 | # to cancel the timer: |
203 | undef $w; |
215 | undef $w; |
204 | |
216 | |
205 | Example 2: |
|
|
206 | |
|
|
207 | # fire an event after 0.5 seconds, then roughly every second |
217 | Example 2: fire an event after 0.5 seconds, then roughly every second. |
208 | my $w; |
|
|
209 | |
218 | |
210 | my $cb = sub { |
|
|
211 | # cancel the old timer while creating a new one |
|
|
212 | $w = AnyEvent->timer (after => 1, cb => $cb); |
219 | my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { |
|
|
220 | warn "timeout\n"; |
213 | }; |
221 | }; |
214 | |
|
|
215 | # start the "loop" by creating the first watcher |
|
|
216 | $w = AnyEvent->timer (after => 0.5, cb => $cb); |
|
|
217 | |
222 | |
218 | =head3 TIMING ISSUES |
223 | =head3 TIMING ISSUES |
219 | |
224 | |
220 | There are two ways to handle timers: based on real time (relative, "fire |
225 | 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 |
226 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
… | |
… | |
233 | timers. |
238 | timers. |
234 | |
239 | |
235 | AnyEvent always prefers relative timers, if available, matching the |
240 | AnyEvent always prefers relative timers, if available, matching the |
236 | AnyEvent API. |
241 | AnyEvent API. |
237 | |
242 | |
|
|
243 | AnyEvent has two additional methods that return the "current time": |
|
|
244 | |
|
|
245 | =over 4 |
|
|
246 | |
|
|
247 | =item AnyEvent->time |
|
|
248 | |
|
|
249 | This returns the "current wallclock time" as a fractional number of |
|
|
250 | seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time> |
|
|
251 | return, and the result is guaranteed to be compatible with those). |
|
|
252 | |
|
|
253 | It progresses independently of any event loop processing, i.e. each call |
|
|
254 | will check the system clock, which usually gets updated frequently. |
|
|
255 | |
|
|
256 | =item AnyEvent->now |
|
|
257 | |
|
|
258 | This also returns the "current wallclock time", but unlike C<time>, above, |
|
|
259 | this value might change only once per event loop iteration, depending on |
|
|
260 | the event loop (most return the same time as C<time>, above). This is the |
|
|
261 | time that AnyEvent's timers get scheduled against. |
|
|
262 | |
|
|
263 | I<In almost all cases (in all cases if you don't care), this is the |
|
|
264 | function to call when you want to know the current time.> |
|
|
265 | |
|
|
266 | This function is also often faster then C<< AnyEvent->time >>, and |
|
|
267 | thus the preferred method if you want some timestamp (for example, |
|
|
268 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
|
|
269 | |
|
|
270 | The rest of this section is only of relevance if you try to be very exact |
|
|
271 | with your timing, you can skip it without bad conscience. |
|
|
272 | |
|
|
273 | For a practical example of when these times differ, consider L<Event::Lib> |
|
|
274 | and L<EV> and the following set-up: |
|
|
275 | |
|
|
276 | The event loop is running and has just invoked one of your callback at |
|
|
277 | time=500 (assume no other callbacks delay processing). In your callback, |
|
|
278 | you wait a second by executing C<sleep 1> (blocking the process for a |
|
|
279 | second) and then (at time=501) you create a relative timer that fires |
|
|
280 | after three seconds. |
|
|
281 | |
|
|
282 | With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will |
|
|
283 | both return C<501>, because that is the current time, and the timer will |
|
|
284 | be scheduled to fire at time=504 (C<501> + C<3>). |
|
|
285 | |
|
|
286 | With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current |
|
|
287 | time), but C<< AnyEvent->now >> returns C<500>, as that is the time the |
|
|
288 | last event processing phase started. With L<EV>, your timer gets scheduled |
|
|
289 | to run at time=503 (C<500> + C<3>). |
|
|
290 | |
|
|
291 | In one sense, L<Event::Lib> is more exact, as it uses the current time |
|
|
292 | regardless of any delays introduced by event processing. However, most |
|
|
293 | callbacks do not expect large delays in processing, so this causes a |
|
|
294 | higher drift (and a lot more system calls to get the current time). |
|
|
295 | |
|
|
296 | In another sense, L<EV> is more exact, as your timer will be scheduled at |
|
|
297 | the same time, regardless of how long event processing actually took. |
|
|
298 | |
|
|
299 | In either case, if you care (and in most cases, you don't), then you |
|
|
300 | can get whatever behaviour you want with any event loop, by taking the |
|
|
301 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
|
|
302 | account. |
|
|
303 | |
|
|
304 | =back |
|
|
305 | |
238 | =head2 SIGNAL WATCHERS |
306 | =head2 SIGNAL WATCHERS |
239 | |
307 | |
240 | You can watch for signals using a signal watcher, C<signal> is the signal |
308 | You can watch for signals using a signal watcher, C<signal> is the signal |
241 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
309 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
242 | be invoked whenever a signal occurs. |
310 | callback to be invoked whenever a signal occurs. |
243 | |
311 | |
244 | Although the callback might get passed parameters, their value and |
312 | Although the callback might get passed parameters, their value and |
245 | presence is undefined and you cannot rely on them. Portable AnyEvent |
313 | presence is undefined and you cannot rely on them. Portable AnyEvent |
246 | callbacks cannot use arguments passed to signal watcher callbacks. |
314 | callbacks cannot use arguments passed to signal watcher callbacks. |
247 | |
315 | |
… | |
… | |
283 | AnyEvent program, you I<have> to create at least one watcher before you |
351 | AnyEvent program, you I<have> to create at least one watcher before you |
284 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
352 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
285 | |
353 | |
286 | Example: fork a process and wait for it |
354 | Example: fork a process and wait for it |
287 | |
355 | |
288 | my $done = AnyEvent->condvar; |
356 | my $done = AnyEvent->condvar; |
289 | |
357 | |
290 | my $pid = fork or exit 5; |
358 | my $pid = fork or exit 5; |
291 | |
359 | |
292 | my $w = AnyEvent->child ( |
360 | my $w = AnyEvent->child ( |
293 | pid => $pid, |
361 | pid => $pid, |
294 | cb => sub { |
362 | cb => sub { |
295 | my ($pid, $status) = @_; |
363 | my ($pid, $status) = @_; |
296 | warn "pid $pid exited with status $status"; |
364 | warn "pid $pid exited with status $status"; |
297 | $done->send; |
365 | $done->send; |
298 | }, |
366 | }, |
299 | ); |
367 | ); |
300 | |
368 | |
301 | # do something else, then wait for process exit |
369 | # do something else, then wait for process exit |
302 | $done->recv; |
370 | $done->recv; |
303 | |
371 | |
304 | =head2 CONDITION VARIABLES |
372 | =head2 CONDITION VARIABLES |
305 | |
373 | |
306 | If you are familiar with some event loops you will know that all of them |
374 | If you are familiar with some event loops you will know that all of them |
307 | require you to run some blocking "loop", "run" or similar function that |
375 | require you to run some blocking "loop", "run" or similar function that |
… | |
… | |
528 | |
596 | |
529 | This is a mutator function that returns the callback set and optionally |
597 | This is a mutator function that returns the callback set and optionally |
530 | replaces it before doing so. |
598 | replaces it before doing so. |
531 | |
599 | |
532 | The callback will be called when the condition becomes "true", i.e. when |
600 | The callback will be called when the condition becomes "true", i.e. when |
533 | C<send> or C<croak> are called. Calling C<recv> inside the callback |
601 | C<send> or C<croak> are called, with the only argument being the condition |
534 | or at any later time is guaranteed not to block. |
602 | variable itself. Calling C<recv> inside the callback or at any later time |
|
|
603 | is guaranteed not to block. |
535 | |
604 | |
536 | =back |
605 | =back |
537 | |
606 | |
538 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
607 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
539 | |
608 | |
… | |
… | |
668 | =item L<AnyEvent::Util> |
737 | =item L<AnyEvent::Util> |
669 | |
738 | |
670 | Contains various utility functions that replace often-used but blocking |
739 | Contains various utility functions that replace often-used but blocking |
671 | functions such as C<inet_aton> by event-/callback-based versions. |
740 | functions such as C<inet_aton> by event-/callback-based versions. |
672 | |
741 | |
673 | =item L<AnyEvent::Handle> |
|
|
674 | |
|
|
675 | Provide read and write buffers and manages watchers for reads and writes. |
|
|
676 | |
|
|
677 | =item L<AnyEvent::Socket> |
742 | =item L<AnyEvent::Socket> |
678 | |
743 | |
679 | Provides various utility functions for (internet protocol) sockets, |
744 | Provides various utility functions for (internet protocol) sockets, |
680 | addresses and name resolution. Also functions to create non-blocking tcp |
745 | addresses and name resolution. Also functions to create non-blocking tcp |
681 | connections or tcp servers, with IPv6 and SRV record support and more. |
746 | connections or tcp servers, with IPv6 and SRV record support and more. |
682 | |
747 | |
|
|
748 | =item L<AnyEvent::Handle> |
|
|
749 | |
|
|
750 | Provide read and write buffers, manages watchers for reads and writes, |
|
|
751 | supports raw and formatted I/O, I/O queued and fully transparent and |
|
|
752 | non-blocking SSL/TLS. |
|
|
753 | |
683 | =item L<AnyEvent::DNS> |
754 | =item L<AnyEvent::DNS> |
684 | |
755 | |
685 | Provides rich asynchronous DNS resolver capabilities. |
756 | Provides rich asynchronous DNS resolver capabilities. |
686 | |
757 | |
|
|
758 | =item L<AnyEvent::HTTP> |
|
|
759 | |
|
|
760 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
|
|
761 | HTTP requests. |
|
|
762 | |
687 | =item L<AnyEvent::HTTPD> |
763 | =item L<AnyEvent::HTTPD> |
688 | |
764 | |
689 | Provides a simple web application server framework. |
765 | Provides a simple web application server framework. |
690 | |
766 | |
691 | =item L<AnyEvent::FastPing> |
767 | =item L<AnyEvent::FastPing> |
692 | |
768 | |
693 | The fastest ping in the west. |
769 | The fastest ping in the west. |
|
|
770 | |
|
|
771 | =item L<AnyEvent::DBI> |
|
|
772 | |
|
|
773 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
774 | |
|
|
775 | =item L<AnyEvent::AIO> |
|
|
776 | |
|
|
777 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
778 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
779 | together. |
|
|
780 | |
|
|
781 | =item L<AnyEvent::BDB> |
|
|
782 | |
|
|
783 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
784 | L<BDB> and AnyEvent together. |
|
|
785 | |
|
|
786 | =item L<AnyEvent::GPSD> |
|
|
787 | |
|
|
788 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
789 | |
|
|
790 | =item L<AnyEvent::IGS> |
|
|
791 | |
|
|
792 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
793 | L<App::IGS>). |
694 | |
794 | |
695 | =item L<Net::IRC3> |
795 | =item L<Net::IRC3> |
696 | |
796 | |
697 | AnyEvent based IRC client module family. |
797 | AnyEvent based IRC client module family. |
698 | |
798 | |
… | |
… | |
711 | |
811 | |
712 | =item L<Coro> |
812 | =item L<Coro> |
713 | |
813 | |
714 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
814 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
715 | |
815 | |
716 | =item L<AnyEvent::AIO>, L<IO::AIO> |
|
|
717 | |
|
|
718 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
719 | programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent |
|
|
720 | together. |
|
|
721 | |
|
|
722 | =item L<AnyEvent::BDB>, L<BDB> |
|
|
723 | |
|
|
724 | Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses |
|
|
725 | IO::AIO and AnyEvent together. |
|
|
726 | |
|
|
727 | =item L<IO::Lambda> |
816 | =item L<IO::Lambda> |
728 | |
817 | |
729 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
818 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
730 | |
819 | |
731 | =back |
820 | =back |
… | |
… | |
737 | no warnings; |
826 | no warnings; |
738 | use strict; |
827 | use strict; |
739 | |
828 | |
740 | use Carp; |
829 | use Carp; |
741 | |
830 | |
742 | our $VERSION = '4.05'; |
831 | our $VERSION = 4.2; |
743 | our $MODEL; |
832 | our $MODEL; |
744 | |
833 | |
745 | our $AUTOLOAD; |
834 | our $AUTOLOAD; |
746 | our @ISA; |
835 | our @ISA; |
747 | |
836 | |
… | |
… | |
779 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
868 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
780 | [Wx:: => AnyEvent::Impl::POE::], |
869 | [Wx:: => AnyEvent::Impl::POE::], |
781 | [Prima:: => AnyEvent::Impl::POE::], |
870 | [Prima:: => AnyEvent::Impl::POE::], |
782 | ); |
871 | ); |
783 | |
872 | |
784 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
873 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
785 | |
874 | |
786 | our @post_detect; |
875 | our @post_detect; |
787 | |
876 | |
788 | sub post_detect(&) { |
877 | sub post_detect(&) { |
789 | my ($cb) = @_; |
878 | my ($cb) = @_; |
… | |
… | |
850 | $MODEL |
939 | $MODEL |
851 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
940 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
852 | } |
941 | } |
853 | } |
942 | } |
854 | |
943 | |
|
|
944 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
945 | |
855 | unshift @ISA, $MODEL; |
946 | unshift @ISA, $MODEL; |
856 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
947 | |
|
|
948 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
857 | |
949 | |
858 | (shift @post_detect)->() while @post_detect; |
950 | (shift @post_detect)->() while @post_detect; |
859 | } |
951 | } |
860 | |
952 | |
861 | $MODEL |
953 | $MODEL |
… | |
… | |
871 | |
963 | |
872 | my $class = shift; |
964 | my $class = shift; |
873 | $class->$func (@_); |
965 | $class->$func (@_); |
874 | } |
966 | } |
875 | |
967 | |
|
|
968 | # utility function to dup a filehandle. this is used by many backends |
|
|
969 | # to support binding more than one watcher per filehandle (they usually |
|
|
970 | # allow only one watcher per fd, so we dup it to get a different one). |
|
|
971 | sub _dupfh($$$$) { |
|
|
972 | my ($poll, $fh, $r, $w) = @_; |
|
|
973 | |
|
|
974 | require Fcntl; |
|
|
975 | |
|
|
976 | # cygwin requires the fh mode to be matching, unix doesn't |
|
|
977 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
|
|
978 | : $poll eq "w" ? ($w, ">") |
|
|
979 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
|
|
980 | |
|
|
981 | open my $fh2, "$mode&" . fileno $fh |
|
|
982 | or die "cannot dup() filehandle: $!"; |
|
|
983 | |
|
|
984 | # we assume CLOEXEC is already set by perl in all important cases |
|
|
985 | |
|
|
986 | ($fh2, $rw) |
|
|
987 | } |
|
|
988 | |
876 | package AnyEvent::Base; |
989 | package AnyEvent::Base; |
|
|
990 | |
|
|
991 | # default implementation for now and time |
|
|
992 | |
|
|
993 | use Time::HiRes (); |
|
|
994 | |
|
|
995 | sub time { Time::HiRes::time } |
|
|
996 | sub now { Time::HiRes::time } |
877 | |
997 | |
878 | # default implementation for ->condvar |
998 | # default implementation for ->condvar |
879 | |
999 | |
880 | sub condvar { |
1000 | sub condvar { |
881 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
1001 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
… | |
… | |
902 | sub AnyEvent::Base::Signal::DESTROY { |
1022 | sub AnyEvent::Base::Signal::DESTROY { |
903 | my ($signal, $cb) = @{$_[0]}; |
1023 | my ($signal, $cb) = @{$_[0]}; |
904 | |
1024 | |
905 | delete $SIG_CB{$signal}{$cb}; |
1025 | delete $SIG_CB{$signal}{$cb}; |
906 | |
1026 | |
907 | $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; |
1027 | delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
908 | } |
1028 | } |
909 | |
1029 | |
910 | # default implementation for ->child |
1030 | # default implementation for ->child |
911 | |
1031 | |
912 | our %PID_CB; |
1032 | our %PID_CB; |
… | |
… | |
1082 | C<PERL_ANYEVENT_MODEL>. |
1202 | C<PERL_ANYEVENT_MODEL>. |
1083 | |
1203 | |
1084 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1204 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1085 | model it chooses. |
1205 | model it chooses. |
1086 | |
1206 | |
|
|
1207 | =item C<PERL_ANYEVENT_STRICT> |
|
|
1208 | |
|
|
1209 | AnyEvent does not do much argument checking by default, as thorough |
|
|
1210 | argument checking is very costly. Setting this variable to a true value |
|
|
1211 | will cause AnyEvent to thoroughly check the arguments passed to most |
|
|
1212 | method calls and croaks if it finds any problems. In other words, enables |
|
|
1213 | "strict" mode. Unlike C<use strict> it is definitely recommended ot keep |
|
|
1214 | it off in production. |
|
|
1215 | |
1087 | =item C<PERL_ANYEVENT_MODEL> |
1216 | =item C<PERL_ANYEVENT_MODEL> |
1088 | |
1217 | |
1089 | This can be used to specify the event model to be used by AnyEvent, before |
1218 | This can be used to specify the event model to be used by AnyEvent, before |
1090 | auto detection and -probing kicks in. It must be a string consisting |
1219 | auto detection and -probing kicks in. It must be a string consisting |
1091 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
1220 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
… | |
… | |
1096 | This functionality might change in future versions. |
1225 | This functionality might change in future versions. |
1097 | |
1226 | |
1098 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1227 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1099 | could start your program like this: |
1228 | could start your program like this: |
1100 | |
1229 | |
1101 | PERL_ANYEVENT_MODEL=Perl perl ... |
1230 | PERL_ANYEVENT_MODEL=Perl perl ... |
1102 | |
1231 | |
1103 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1232 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1104 | |
1233 | |
1105 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1234 | 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 |
1235 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
… | |
… | |
1581 | specified in the variable. |
1710 | specified in the variable. |
1582 | |
1711 | |
1583 | You can make AnyEvent completely ignore this variable by deleting it |
1712 | You can make AnyEvent completely ignore this variable by deleting it |
1584 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1713 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1585 | |
1714 | |
1586 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1715 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1587 | |
1716 | |
1588 | use AnyEvent; |
1717 | use AnyEvent; |
1589 | |
1718 | |
1590 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1719 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1591 | be used to probe what backend is used and gain other information (which is |
1720 | be used to probe what backend is used and gain other information (which is |
1592 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1721 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
|
|
1722 | $ENV{PERL_ANYEGENT_STRICT}. |
|
|
1723 | |
|
|
1724 | |
|
|
1725 | =head1 BUGS |
|
|
1726 | |
|
|
1727 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
|
|
1728 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
|
|
1729 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
|
|
1730 | mamleaks, such as leaking on C<map> and C<grep> but it is usually not as |
|
|
1731 | pronounced). |
1593 | |
1732 | |
1594 | |
1733 | |
1595 | =head1 SEE ALSO |
1734 | =head1 SEE ALSO |
1596 | |
1735 | |
1597 | Utility functions: L<AnyEvent::Util>. |
1736 | Utility functions: L<AnyEvent::Util>. |
… | |
… | |
1614 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1753 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1615 | |
1754 | |
1616 | |
1755 | |
1617 | =head1 AUTHOR |
1756 | =head1 AUTHOR |
1618 | |
1757 | |
1619 | Marc Lehmann <schmorp@schmorp.de> |
1758 | Marc Lehmann <schmorp@schmorp.de> |
1620 | http://home.schmorp.de/ |
1759 | http://home.schmorp.de/ |
1621 | |
1760 | |
1622 | =cut |
1761 | =cut |
1623 | |
1762 | |
1624 | 1 |
1763 | 1 |
1625 | |
1764 | |