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 | |
7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
8 | |
8 | |
9 | use AnyEvent; |
9 | use AnyEvent; |
10 | |
10 | |
11 | my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { |
11 | my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... }); |
12 | ... |
|
|
13 | }); |
|
|
14 | |
12 | |
15 | my $w = AnyEvent->timer (after => $seconds, cb => sub { |
13 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
|
|
14 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
|
|
15 | |
|
|
16 | print AnyEvent->now; # prints current event loop time |
|
|
17 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
|
|
18 | |
|
|
19 | my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); |
|
|
20 | |
|
|
21 | my $w = AnyEvent->child (pid => $pid, cb => sub { |
|
|
22 | my ($pid, $status) = @_; |
16 | ... |
23 | ... |
17 | }); |
24 | }); |
18 | |
25 | |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
26 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
20 | $w->send; # wake up current and all future recv's |
27 | $w->send; # wake up current and all future recv's |
21 | $w->recv; # enters "main loop" till $condvar gets ->send |
28 | $w->recv; # enters "main loop" till $condvar gets ->send |
|
|
29 | # use a condvar in callback mode: |
|
|
30 | $w->cb (sub { $_[0]->recv }); |
|
|
31 | |
|
|
32 | =head1 INTRODUCTION/TUTORIAL |
|
|
33 | |
|
|
34 | This manpage is mainly a reference manual. If you are interested |
|
|
35 | in a tutorial or some gentle introduction, have a look at the |
|
|
36 | L<AnyEvent::Intro> manpage. |
22 | |
37 | |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
38 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
24 | |
39 | |
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
40 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
26 | nowadays. So what is different about AnyEvent? |
41 | nowadays. So what is different about AnyEvent? |
27 | |
42 | |
28 | Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of |
43 | Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of |
29 | policy> and AnyEvent is I<small and efficient>. |
44 | policy> and AnyEvent is I<small and efficient>. |
30 | |
45 | |
31 | First and foremost, I<AnyEvent is not an event model> itself, it only |
46 | 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 |
47 | 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, |
48 | 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, |
49 | 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 |
50 | only one event loop can be active at the same time in a process. AnyEvent |
36 | helps hiding the differences between those event loops. |
51 | cannot change this, but it can hide the differences between those event |
|
|
52 | loops. |
37 | |
53 | |
38 | The goal of AnyEvent is to offer module authors the ability to do event |
54 | 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 |
55 | programming (waiting for I/O or timer events) without subscribing to a |
40 | religion, a way of living, and most importantly: without forcing your |
56 | 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 |
57 | module users into the same thing by forcing them to use the same event |
42 | model you use. |
58 | model you use. |
43 | |
59 | |
44 | For modules like POE or IO::Async (which is a total misnomer as it is |
60 | 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 |
61 | 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 |
62 | 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 |
63 | 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 |
64 | 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. |
65 | module are I<also> forced to use the same event loop you use. |
50 | |
66 | |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
67 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
68 | 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 |
69 | 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, |
70 | 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 |
71 | 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 |
72 | 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 |
73 | 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). |
74 | to AnyEvent, too, so it is future-proof). |
59 | |
75 | |
60 | In addition to being free of having to use I<the one and only true event |
76 | 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 |
77 | 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 |
78 | 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 |
79 | 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 |
80 | offering the functionality that is necessary, in as thin as a wrapper as |
65 | technically possible. |
81 | technically possible. |
66 | |
82 | |
|
|
83 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
|
|
84 | of useful functionality, such as an asynchronous DNS resolver, 100% |
|
|
85 | non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms |
|
|
86 | such as Windows) and lots of real-world knowledge and workarounds for |
|
|
87 | platform bugs and differences. |
|
|
88 | |
67 | Of course, if you want lots of policy (this can arguably be somewhat |
89 | 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 |
90 | useful) and you want to force your users to use the one and only event |
69 | model, you should I<not> use this module. |
91 | model, you should I<not> use this module. |
70 | |
92 | |
71 | =head1 DESCRIPTION |
93 | =head1 DESCRIPTION |
72 | |
94 | |
… | |
… | |
102 | starts using it, all bets are off. Maybe you should tell their authors to |
124 | 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... |
125 | use AnyEvent so their modules work together with others seamlessly... |
104 | |
126 | |
105 | The pure-perl implementation of AnyEvent is called |
127 | The pure-perl implementation of AnyEvent is called |
106 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
128 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
107 | explicitly. |
129 | explicitly and enjoy the high availability of that event loop :) |
108 | |
130 | |
109 | =head1 WATCHERS |
131 | =head1 WATCHERS |
110 | |
132 | |
111 | AnyEvent has the central concept of a I<watcher>, which is an object that |
133 | 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 |
134 | 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 |
148 | Many watchers either are used with "recursion" (repeating timers for |
127 | example), or need to refer to their watcher object in other ways. |
149 | example), or need to refer to their watcher object in other ways. |
128 | |
150 | |
129 | An any way to achieve that is this pattern: |
151 | An any way to achieve that is this pattern: |
130 | |
152 | |
131 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
153 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
132 | # you can use $w here, for example to undef it |
154 | # you can use $w here, for example to undef it |
133 | undef $w; |
155 | undef $w; |
134 | }); |
156 | }); |
135 | |
157 | |
136 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
158 | 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 |
159 | my variables are only visible after the statement in which they are |
138 | declared. |
160 | declared. |
139 | |
161 | |
140 | =head2 I/O WATCHERS |
162 | =head2 I/O WATCHERS |
141 | |
163 | |
142 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
164 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
143 | with the following mandatory key-value pairs as arguments: |
165 | with the following mandatory key-value pairs as arguments: |
144 | |
166 | |
145 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch |
167 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events |
146 | for events. C<poll> must be a string that is either C<r> or C<w>, |
168 | (AnyEvent might or might not keep a reference to this file handle). C<poll> |
147 | which creates a watcher waiting for "r"eadable or "w"ritable events, |
169 | must be a string that is either C<r> or C<w>, which creates a watcher |
148 | respectively. C<cb> is the callback to invoke each time the file handle |
170 | waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the |
149 | becomes ready. |
171 | callback to invoke each time the file handle becomes ready. |
150 | |
172 | |
151 | Although the callback might get passed parameters, their value and |
173 | Although the callback might get passed parameters, their value and |
152 | presence is undefined and you cannot rely on them. Portable AnyEvent |
174 | presence is undefined and you cannot rely on them. Portable AnyEvent |
153 | callbacks cannot use arguments passed to I/O watcher callbacks. |
175 | callbacks cannot use arguments passed to I/O watcher callbacks. |
154 | |
176 | |
… | |
… | |
158 | |
180 | |
159 | Some event loops issue spurious readyness notifications, so you should |
181 | Some event loops issue spurious readyness notifications, so you should |
160 | always use non-blocking calls when reading/writing from/to your file |
182 | always use non-blocking calls when reading/writing from/to your file |
161 | handles. |
183 | handles. |
162 | |
184 | |
163 | Example: |
|
|
164 | |
|
|
165 | # wait for readability of STDIN, then read a line and disable the watcher |
185 | Example: wait for readability of STDIN, then read a line and disable the |
|
|
186 | watcher. |
|
|
187 | |
166 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
188 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
167 | chomp (my $input = <STDIN>); |
189 | chomp (my $input = <STDIN>); |
168 | warn "read: $input\n"; |
190 | warn "read: $input\n"; |
169 | undef $w; |
191 | undef $w; |
170 | }); |
192 | }); |
… | |
… | |
180 | |
202 | |
181 | Although the callback might get passed parameters, their value and |
203 | Although the callback might get passed parameters, their value and |
182 | presence is undefined and you cannot rely on them. Portable AnyEvent |
204 | presence is undefined and you cannot rely on them. Portable AnyEvent |
183 | callbacks cannot use arguments passed to time watcher callbacks. |
205 | callbacks cannot use arguments passed to time watcher callbacks. |
184 | |
206 | |
185 | The timer callback will be invoked at most once: if you want a repeating |
207 | The callback will normally be invoked once only. If you specify another |
186 | timer you have to create a new watcher (this is a limitation by both Tk |
208 | parameter, C<interval>, as a strictly positive number (> 0), then the |
187 | and Glib). |
209 | callback will be invoked regularly at that interval (in fractional |
|
|
210 | seconds) after the first invocation. If C<interval> is specified with a |
|
|
211 | false value, then it is treated as if it were missing. |
188 | |
212 | |
189 | Example: |
213 | The callback will be rescheduled before invoking the callback, but no |
|
|
214 | attempt is done to avoid timer drift in most backends, so the interval is |
|
|
215 | only approximate. |
190 | |
216 | |
191 | # fire an event after 7.7 seconds |
217 | Example: fire an event after 7.7 seconds. |
|
|
218 | |
192 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
219 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
193 | warn "timeout\n"; |
220 | warn "timeout\n"; |
194 | }); |
221 | }); |
195 | |
222 | |
196 | # to cancel the timer: |
223 | # to cancel the timer: |
197 | undef $w; |
224 | undef $w; |
198 | |
225 | |
199 | Example 2: |
|
|
200 | |
|
|
201 | # fire an event after 0.5 seconds, then roughly every second |
226 | Example 2: fire an event after 0.5 seconds, then roughly every second. |
202 | my $w; |
|
|
203 | |
227 | |
204 | my $cb = sub { |
|
|
205 | # cancel the old timer while creating a new one |
|
|
206 | $w = AnyEvent->timer (after => 1, cb => $cb); |
228 | my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { |
|
|
229 | warn "timeout\n"; |
207 | }; |
230 | }; |
208 | |
|
|
209 | # start the "loop" by creating the first watcher |
|
|
210 | $w = AnyEvent->timer (after => 0.5, cb => $cb); |
|
|
211 | |
231 | |
212 | =head3 TIMING ISSUES |
232 | =head3 TIMING ISSUES |
213 | |
233 | |
214 | There are two ways to handle timers: based on real time (relative, "fire |
234 | There are two ways to handle timers: based on real time (relative, "fire |
215 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
235 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
… | |
… | |
227 | timers. |
247 | timers. |
228 | |
248 | |
229 | AnyEvent always prefers relative timers, if available, matching the |
249 | AnyEvent always prefers relative timers, if available, matching the |
230 | AnyEvent API. |
250 | AnyEvent API. |
231 | |
251 | |
|
|
252 | AnyEvent has two additional methods that return the "current time": |
|
|
253 | |
|
|
254 | =over 4 |
|
|
255 | |
|
|
256 | =item AnyEvent->time |
|
|
257 | |
|
|
258 | This returns the "current wallclock time" as a fractional number of |
|
|
259 | seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time> |
|
|
260 | return, and the result is guaranteed to be compatible with those). |
|
|
261 | |
|
|
262 | It progresses independently of any event loop processing, i.e. each call |
|
|
263 | will check the system clock, which usually gets updated frequently. |
|
|
264 | |
|
|
265 | =item AnyEvent->now |
|
|
266 | |
|
|
267 | This also returns the "current wallclock time", but unlike C<time>, above, |
|
|
268 | this value might change only once per event loop iteration, depending on |
|
|
269 | the event loop (most return the same time as C<time>, above). This is the |
|
|
270 | time that AnyEvent's timers get scheduled against. |
|
|
271 | |
|
|
272 | I<In almost all cases (in all cases if you don't care), this is the |
|
|
273 | function to call when you want to know the current time.> |
|
|
274 | |
|
|
275 | This function is also often faster then C<< AnyEvent->time >>, and |
|
|
276 | thus the preferred method if you want some timestamp (for example, |
|
|
277 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
|
|
278 | |
|
|
279 | The rest of this section is only of relevance if you try to be very exact |
|
|
280 | with your timing, you can skip it without bad conscience. |
|
|
281 | |
|
|
282 | For a practical example of when these times differ, consider L<Event::Lib> |
|
|
283 | and L<EV> and the following set-up: |
|
|
284 | |
|
|
285 | The event loop is running and has just invoked one of your callback at |
|
|
286 | time=500 (assume no other callbacks delay processing). In your callback, |
|
|
287 | you wait a second by executing C<sleep 1> (blocking the process for a |
|
|
288 | second) and then (at time=501) you create a relative timer that fires |
|
|
289 | after three seconds. |
|
|
290 | |
|
|
291 | With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will |
|
|
292 | both return C<501>, because that is the current time, and the timer will |
|
|
293 | be scheduled to fire at time=504 (C<501> + C<3>). |
|
|
294 | |
|
|
295 | With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current |
|
|
296 | time), but C<< AnyEvent->now >> returns C<500>, as that is the time the |
|
|
297 | last event processing phase started. With L<EV>, your timer gets scheduled |
|
|
298 | to run at time=503 (C<500> + C<3>). |
|
|
299 | |
|
|
300 | In one sense, L<Event::Lib> is more exact, as it uses the current time |
|
|
301 | regardless of any delays introduced by event processing. However, most |
|
|
302 | callbacks do not expect large delays in processing, so this causes a |
|
|
303 | higher drift (and a lot more system calls to get the current time). |
|
|
304 | |
|
|
305 | In another sense, L<EV> is more exact, as your timer will be scheduled at |
|
|
306 | the same time, regardless of how long event processing actually took. |
|
|
307 | |
|
|
308 | In either case, if you care (and in most cases, you don't), then you |
|
|
309 | can get whatever behaviour you want with any event loop, by taking the |
|
|
310 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
|
|
311 | account. |
|
|
312 | |
|
|
313 | =back |
|
|
314 | |
232 | =head2 SIGNAL WATCHERS |
315 | =head2 SIGNAL WATCHERS |
233 | |
316 | |
234 | You can watch for signals using a signal watcher, C<signal> is the signal |
317 | 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 |
318 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
236 | be invoked whenever a signal occurs. |
319 | callback to be invoked whenever a signal occurs. |
237 | |
320 | |
238 | Although the callback might get passed parameters, their value and |
321 | Although the callback might get passed parameters, their value and |
239 | presence is undefined and you cannot rely on them. Portable AnyEvent |
322 | presence is undefined and you cannot rely on them. Portable AnyEvent |
240 | callbacks cannot use arguments passed to signal watcher callbacks. |
323 | callbacks cannot use arguments passed to signal watcher callbacks. |
241 | |
324 | |
… | |
… | |
277 | AnyEvent program, you I<have> to create at least one watcher before you |
360 | 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>). |
361 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
279 | |
362 | |
280 | Example: fork a process and wait for it |
363 | Example: fork a process and wait for it |
281 | |
364 | |
282 | my $done = AnyEvent->condvar; |
365 | my $done = AnyEvent->condvar; |
283 | |
366 | |
284 | my $pid = fork or exit 5; |
367 | my $pid = fork or exit 5; |
285 | |
368 | |
286 | my $w = AnyEvent->child ( |
369 | my $w = AnyEvent->child ( |
287 | pid => $pid, |
370 | pid => $pid, |
288 | cb => sub { |
371 | cb => sub { |
289 | my ($pid, $status) = @_; |
372 | my ($pid, $status) = @_; |
290 | warn "pid $pid exited with status $status"; |
373 | warn "pid $pid exited with status $status"; |
291 | $done->send; |
374 | $done->send; |
292 | }, |
375 | }, |
293 | ); |
376 | ); |
294 | |
377 | |
295 | # do something else, then wait for process exit |
378 | # do something else, then wait for process exit |
296 | $done->recv; |
379 | $done->recv; |
297 | |
380 | |
298 | =head2 CONDITION VARIABLES |
381 | =head2 CONDITION VARIABLES |
299 | |
382 | |
300 | If you are familiar with some event loops you will know that all of them |
383 | 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 |
384 | require you to run some blocking "loop", "run" or similar function that |
… | |
… | |
307 | The instrument to do that is called a "condition variable", so called |
390 | The instrument to do that is called a "condition variable", so called |
308 | because they represent a condition that must become true. |
391 | because they represent a condition that must become true. |
309 | |
392 | |
310 | Condition variables can be created by calling the C<< AnyEvent->condvar |
393 | Condition variables can be created by calling the C<< AnyEvent->condvar |
311 | >> method, usually without arguments. The only argument pair allowed is |
394 | >> method, usually without arguments. The only argument pair allowed is |
|
|
395 | |
312 | C<cb>, which specifies a callback to be called when the condition variable |
396 | C<cb>, which specifies a callback to be called when the condition variable |
313 | becomes true. |
397 | becomes true, with the condition variable as the first argument (but not |
|
|
398 | the results). |
314 | |
399 | |
315 | After creation, the condition variable is "false" until it becomes "true" |
400 | 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 |
401 | by calling the C<send> method (or calling the condition variable as if it |
317 | were a callback, read about the caveats in the description for the C<< |
402 | were a callback, read about the caveats in the description for the C<< |
318 | ->send >> method). |
403 | ->send >> method). |
… | |
… | |
374 | |
459 | |
375 | my $done = AnyEvent->condvar; |
460 | my $done = AnyEvent->condvar; |
376 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
461 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
377 | $done->recv; |
462 | $done->recv; |
378 | |
463 | |
|
|
464 | Example: Imagine an API that returns a condvar and doesn't support |
|
|
465 | callbacks. This is how you make a synchronous call, for example from |
|
|
466 | the main program: |
|
|
467 | |
|
|
468 | use AnyEvent::CouchDB; |
|
|
469 | |
|
|
470 | ... |
|
|
471 | |
|
|
472 | my @info = $couchdb->info->recv; |
|
|
473 | |
|
|
474 | And this is how you would just ste a callback to be called whenever the |
|
|
475 | results are available: |
|
|
476 | |
|
|
477 | $couchdb->info->cb (sub { |
|
|
478 | my @info = $_[0]->recv; |
|
|
479 | }); |
|
|
480 | |
379 | =head3 METHODS FOR PRODUCERS |
481 | =head3 METHODS FOR PRODUCERS |
380 | |
482 | |
381 | These methods should only be used by the producing side, i.e. the |
483 | These methods should only be used by the producing side, i.e. the |
382 | code/module that eventually sends the signal. Note that it is also |
484 | code/module that eventually sends the signal. Note that it is also |
383 | the producer side which creates the condvar in most cases, but it isn't |
485 | the producer side which creates the condvar in most cases, but it isn't |
… | |
… | |
516 | =item $bool = $cv->ready |
618 | =item $bool = $cv->ready |
517 | |
619 | |
518 | Returns true when the condition is "true", i.e. whether C<send> or |
620 | Returns true when the condition is "true", i.e. whether C<send> or |
519 | C<croak> have been called. |
621 | C<croak> have been called. |
520 | |
622 | |
521 | =item $cb = $cv->cb ([new callback]) |
623 | =item $cb = $cv->cb ($cb->($cv)) |
522 | |
624 | |
523 | This is a mutator function that returns the callback set and optionally |
625 | This is a mutator function that returns the callback set and optionally |
524 | replaces it before doing so. |
626 | replaces it before doing so. |
525 | |
627 | |
526 | The callback will be called when the condition becomes "true", i.e. when |
628 | 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 |
629 | 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. |
630 | variable itself. Calling C<recv> inside the callback or at any later time |
|
|
631 | is guaranteed not to block. |
529 | |
632 | |
530 | =back |
633 | =back |
531 | |
634 | |
532 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
635 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
533 | |
636 | |
… | |
… | |
662 | =item L<AnyEvent::Util> |
765 | =item L<AnyEvent::Util> |
663 | |
766 | |
664 | Contains various utility functions that replace often-used but blocking |
767 | Contains various utility functions that replace often-used but blocking |
665 | functions such as C<inet_aton> by event-/callback-based versions. |
768 | functions such as C<inet_aton> by event-/callback-based versions. |
666 | |
769 | |
667 | =item L<AnyEvent::Handle> |
|
|
668 | |
|
|
669 | Provide read and write buffers and manages watchers for reads and writes. |
|
|
670 | |
|
|
671 | =item L<AnyEvent::Socket> |
770 | =item L<AnyEvent::Socket> |
672 | |
771 | |
673 | Provides various utility functions for (internet protocol) sockets, |
772 | Provides various utility functions for (internet protocol) sockets, |
674 | addresses and name resolution. Also functions to create non-blocking tcp |
773 | addresses and name resolution. Also functions to create non-blocking tcp |
675 | connections or tcp servers, with IPv6 and SRV record support and more. |
774 | connections or tcp servers, with IPv6 and SRV record support and more. |
676 | |
775 | |
|
|
776 | =item L<AnyEvent::Handle> |
|
|
777 | |
|
|
778 | Provide read and write buffers, manages watchers for reads and writes, |
|
|
779 | supports raw and formatted I/O, I/O queued and fully transparent and |
|
|
780 | non-blocking SSL/TLS. |
|
|
781 | |
677 | =item L<AnyEvent::DNS> |
782 | =item L<AnyEvent::DNS> |
678 | |
783 | |
679 | Provides rich asynchronous DNS resolver capabilities. |
784 | Provides rich asynchronous DNS resolver capabilities. |
680 | |
785 | |
|
|
786 | =item L<AnyEvent::HTTP> |
|
|
787 | |
|
|
788 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
|
|
789 | HTTP requests. |
|
|
790 | |
681 | =item L<AnyEvent::HTTPD> |
791 | =item L<AnyEvent::HTTPD> |
682 | |
792 | |
683 | Provides a simple web application server framework. |
793 | Provides a simple web application server framework. |
684 | |
794 | |
685 | =item L<AnyEvent::FastPing> |
795 | =item L<AnyEvent::FastPing> |
686 | |
796 | |
687 | The fastest ping in the west. |
797 | The fastest ping in the west. |
|
|
798 | |
|
|
799 | =item L<AnyEvent::DBI> |
|
|
800 | |
|
|
801 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
802 | |
|
|
803 | =item L<AnyEvent::AIO> |
|
|
804 | |
|
|
805 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
806 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
807 | together. |
|
|
808 | |
|
|
809 | =item L<AnyEvent::BDB> |
|
|
810 | |
|
|
811 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
812 | L<BDB> and AnyEvent together. |
|
|
813 | |
|
|
814 | =item L<AnyEvent::GPSD> |
|
|
815 | |
|
|
816 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
817 | |
|
|
818 | =item L<AnyEvent::IGS> |
|
|
819 | |
|
|
820 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
821 | L<App::IGS>). |
688 | |
822 | |
689 | =item L<Net::IRC3> |
823 | =item L<Net::IRC3> |
690 | |
824 | |
691 | AnyEvent based IRC client module family. |
825 | AnyEvent based IRC client module family. |
692 | |
826 | |
… | |
… | |
705 | |
839 | |
706 | =item L<Coro> |
840 | =item L<Coro> |
707 | |
841 | |
708 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
842 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
709 | |
843 | |
710 | =item L<AnyEvent::AIO>, L<IO::AIO> |
|
|
711 | |
|
|
712 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
713 | programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent |
|
|
714 | together. |
|
|
715 | |
|
|
716 | =item L<AnyEvent::BDB>, L<BDB> |
|
|
717 | |
|
|
718 | Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses |
|
|
719 | IO::AIO and AnyEvent together. |
|
|
720 | |
|
|
721 | =item L<IO::Lambda> |
844 | =item L<IO::Lambda> |
722 | |
845 | |
723 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
846 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
724 | |
847 | |
725 | =back |
848 | =back |
… | |
… | |
731 | no warnings; |
854 | no warnings; |
732 | use strict; |
855 | use strict; |
733 | |
856 | |
734 | use Carp; |
857 | use Carp; |
735 | |
858 | |
736 | our $VERSION = '4.03'; |
859 | our $VERSION = 4.233; |
737 | our $MODEL; |
860 | our $MODEL; |
738 | |
861 | |
739 | our $AUTOLOAD; |
862 | our $AUTOLOAD; |
740 | our @ISA; |
863 | our @ISA; |
741 | |
864 | |
742 | our @REGISTRY; |
865 | our @REGISTRY; |
|
|
866 | |
|
|
867 | our $WIN32; |
|
|
868 | |
|
|
869 | BEGIN { |
|
|
870 | my $win32 = ! ! ($^O =~ /mswin32/i); |
|
|
871 | eval "sub WIN32(){ $win32 }"; |
|
|
872 | } |
743 | |
873 | |
744 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
874 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
745 | |
875 | |
746 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
876 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
747 | |
877 | |
… | |
… | |
766 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
896 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
767 | [Wx:: => AnyEvent::Impl::POE::], |
897 | [Wx:: => AnyEvent::Impl::POE::], |
768 | [Prima:: => AnyEvent::Impl::POE::], |
898 | [Prima:: => AnyEvent::Impl::POE::], |
769 | ); |
899 | ); |
770 | |
900 | |
771 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
901 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
772 | |
902 | |
773 | our @post_detect; |
903 | our @post_detect; |
774 | |
904 | |
775 | sub post_detect(&) { |
905 | sub post_detect(&) { |
776 | my ($cb) = @_; |
906 | my ($cb) = @_; |
… | |
… | |
793 | } |
923 | } |
794 | |
924 | |
795 | sub detect() { |
925 | sub detect() { |
796 | unless ($MODEL) { |
926 | unless ($MODEL) { |
797 | no strict 'refs'; |
927 | no strict 'refs'; |
|
|
928 | local $SIG{__DIE__}; |
798 | |
929 | |
799 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
930 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
800 | my $model = "AnyEvent::Impl::$1"; |
931 | my $model = "AnyEvent::Impl::$1"; |
801 | if (eval "require $model") { |
932 | if (eval "require $model") { |
802 | $MODEL = $model; |
933 | $MODEL = $model; |
… | |
… | |
836 | $MODEL |
967 | $MODEL |
837 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
968 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
838 | } |
969 | } |
839 | } |
970 | } |
840 | |
971 | |
|
|
972 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
973 | |
841 | unshift @ISA, $MODEL; |
974 | unshift @ISA, $MODEL; |
842 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
975 | |
|
|
976 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
843 | |
977 | |
844 | (shift @post_detect)->() while @post_detect; |
978 | (shift @post_detect)->() while @post_detect; |
845 | } |
979 | } |
846 | |
980 | |
847 | $MODEL |
981 | $MODEL |
… | |
… | |
857 | |
991 | |
858 | my $class = shift; |
992 | my $class = shift; |
859 | $class->$func (@_); |
993 | $class->$func (@_); |
860 | } |
994 | } |
861 | |
995 | |
|
|
996 | # utility function to dup a filehandle. this is used by many backends |
|
|
997 | # to support binding more than one watcher per filehandle (they usually |
|
|
998 | # allow only one watcher per fd, so we dup it to get a different one). |
|
|
999 | sub _dupfh($$$$) { |
|
|
1000 | my ($poll, $fh, $r, $w) = @_; |
|
|
1001 | |
|
|
1002 | require Fcntl; |
|
|
1003 | |
|
|
1004 | # cygwin requires the fh mode to be matching, unix doesn't |
|
|
1005 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
|
|
1006 | : $poll eq "w" ? ($w, ">") |
|
|
1007 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
|
|
1008 | |
|
|
1009 | open my $fh2, "$mode&" . fileno $fh |
|
|
1010 | or die "cannot dup() filehandle: $!"; |
|
|
1011 | |
|
|
1012 | # we assume CLOEXEC is already set by perl in all important cases |
|
|
1013 | |
|
|
1014 | ($fh2, $rw) |
|
|
1015 | } |
|
|
1016 | |
862 | package AnyEvent::Base; |
1017 | package AnyEvent::Base; |
|
|
1018 | |
|
|
1019 | # default implementation for now and time |
|
|
1020 | |
|
|
1021 | BEGIN { |
|
|
1022 | if (eval "use Time::HiRes (); time (); 1") { |
|
|
1023 | *_time = \&Time::HiRes::time; |
|
|
1024 | # if (eval "use POSIX (); (POSIX::times())... |
|
|
1025 | } else { |
|
|
1026 | *_time = \&CORE::time; # epic fail |
|
|
1027 | } |
|
|
1028 | } |
|
|
1029 | |
|
|
1030 | sub time { _time } |
|
|
1031 | sub now { _time } |
863 | |
1032 | |
864 | # default implementation for ->condvar |
1033 | # default implementation for ->condvar |
865 | |
1034 | |
866 | sub condvar { |
1035 | sub condvar { |
867 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
1036 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
… | |
… | |
888 | sub AnyEvent::Base::Signal::DESTROY { |
1057 | sub AnyEvent::Base::Signal::DESTROY { |
889 | my ($signal, $cb) = @{$_[0]}; |
1058 | my ($signal, $cb) = @{$_[0]}; |
890 | |
1059 | |
891 | delete $SIG_CB{$signal}{$cb}; |
1060 | delete $SIG_CB{$signal}{$cb}; |
892 | |
1061 | |
893 | $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; |
1062 | delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
894 | } |
1063 | } |
895 | |
1064 | |
896 | # default implementation for ->child |
1065 | # default implementation for ->child |
897 | |
1066 | |
898 | our %PID_CB; |
1067 | our %PID_CB; |
… | |
… | |
925 | or Carp::croak "required option 'pid' is missing"; |
1094 | or Carp::croak "required option 'pid' is missing"; |
926 | |
1095 | |
927 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1096 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
928 | |
1097 | |
929 | unless ($WNOHANG) { |
1098 | unless ($WNOHANG) { |
930 | $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; |
1099 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
931 | } |
1100 | } |
932 | |
1101 | |
933 | unless ($CHLD_W) { |
1102 | unless ($CHLD_W) { |
934 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1103 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
935 | # child could be a zombie already, so make at least one round |
1104 | # child could be a zombie already, so make at least one round |
… | |
… | |
1068 | C<PERL_ANYEVENT_MODEL>. |
1237 | C<PERL_ANYEVENT_MODEL>. |
1069 | |
1238 | |
1070 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1239 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1071 | model it chooses. |
1240 | model it chooses. |
1072 | |
1241 | |
|
|
1242 | =item C<PERL_ANYEVENT_STRICT> |
|
|
1243 | |
|
|
1244 | AnyEvent does not do much argument checking by default, as thorough |
|
|
1245 | argument checking is very costly. Setting this variable to a true value |
|
|
1246 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
|
|
1247 | check the arguments passed to most method calls. If it finds any problems |
|
|
1248 | it will croak. |
|
|
1249 | |
|
|
1250 | In other words, enables "strict" mode. |
|
|
1251 | |
|
|
1252 | Unlike C<use strict> it is definitely recommended ot keep it off in |
|
|
1253 | production. |
|
|
1254 | |
1073 | =item C<PERL_ANYEVENT_MODEL> |
1255 | =item C<PERL_ANYEVENT_MODEL> |
1074 | |
1256 | |
1075 | This can be used to specify the event model to be used by AnyEvent, before |
1257 | This can be used to specify the event model to be used by AnyEvent, before |
1076 | auto detection and -probing kicks in. It must be a string consisting |
1258 | auto detection and -probing kicks in. It must be a string consisting |
1077 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
1259 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
… | |
… | |
1082 | This functionality might change in future versions. |
1264 | This functionality might change in future versions. |
1083 | |
1265 | |
1084 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1266 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1085 | could start your program like this: |
1267 | could start your program like this: |
1086 | |
1268 | |
1087 | PERL_ANYEVENT_MODEL=Perl perl ... |
1269 | PERL_ANYEVENT_MODEL=Perl perl ... |
1088 | |
1270 | |
1089 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1271 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1090 | |
1272 | |
1091 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1273 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1092 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
1274 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
… | |
… | |
1114 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1296 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1115 | default. |
1297 | default. |
1116 | |
1298 | |
1117 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1299 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1118 | EDNS0 in its DNS requests. |
1300 | EDNS0 in its DNS requests. |
|
|
1301 | |
|
|
1302 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1303 | |
|
|
1304 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1305 | will create in parallel. |
1119 | |
1306 | |
1120 | =back |
1307 | =back |
1121 | |
1308 | |
1122 | =head1 EXAMPLE PROGRAM |
1309 | =head1 EXAMPLE PROGRAM |
1123 | |
1310 | |
… | |
… | |
1562 | specified in the variable. |
1749 | specified in the variable. |
1563 | |
1750 | |
1564 | You can make AnyEvent completely ignore this variable by deleting it |
1751 | You can make AnyEvent completely ignore this variable by deleting it |
1565 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1752 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1566 | |
1753 | |
1567 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1754 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1568 | |
1755 | |
1569 | use AnyEvent; |
1756 | use AnyEvent; |
1570 | |
1757 | |
1571 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1758 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1572 | be used to probe what backend is used and gain other information (which is |
1759 | be used to probe what backend is used and gain other information (which is |
1573 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1760 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
|
|
1761 | $ENV{PERL_ANYEGENT_STRICT}. |
|
|
1762 | |
|
|
1763 | |
|
|
1764 | =head1 BUGS |
|
|
1765 | |
|
|
1766 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
|
|
1767 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
|
|
1768 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
|
|
1769 | mamleaks, such as leaking on C<map> and C<grep> but it is usually not as |
|
|
1770 | pronounced). |
1574 | |
1771 | |
1575 | |
1772 | |
1576 | =head1 SEE ALSO |
1773 | =head1 SEE ALSO |
1577 | |
1774 | |
1578 | Utility functions: L<AnyEvent::Util>. |
1775 | Utility functions: L<AnyEvent::Util>. |
… | |
… | |
1595 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1792 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1596 | |
1793 | |
1597 | |
1794 | |
1598 | =head1 AUTHOR |
1795 | =head1 AUTHOR |
1599 | |
1796 | |
1600 | Marc Lehmann <schmorp@schmorp.de> |
1797 | Marc Lehmann <schmorp@schmorp.de> |
1601 | http://home.schmorp.de/ |
1798 | http://home.schmorp.de/ |
1602 | |
1799 | |
1603 | =cut |
1800 | =cut |
1604 | |
1801 | |
1605 | 1 |
1802 | 1 |
1606 | |
1803 | |