1 | =head1 => NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - provide framework for multiple event loops |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
6 | |
6 | |
… | |
… | |
17 | }); |
17 | }); |
18 | |
18 | |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
20 | $w->send; # wake up current and all future recv's |
20 | $w->send; # wake up current and all future recv's |
21 | $w->recv; # enters "main loop" till $condvar gets ->send |
21 | $w->recv; # enters "main loop" till $condvar gets ->send |
|
|
22 | |
|
|
23 | =head1 INTRODUCTION/TUTORIAL |
|
|
24 | |
|
|
25 | This manpage is mainly a reference manual. If you are interested |
|
|
26 | in a tutorial or some gentle introduction, have a look at the |
|
|
27 | L<AnyEvent::Intro> manpage. |
22 | |
28 | |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
29 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
24 | |
30 | |
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
31 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
26 | nowadays. So what is different about AnyEvent? |
32 | nowadays. So what is different about AnyEvent? |
… | |
… | |
48 | isn't itself. What's worse, all the potential users of your module are |
54 | isn't itself. What's worse, all the potential users of your module are |
49 | I<also> forced to use the same event loop you use. |
55 | I<also> forced to use the same event loop you use. |
50 | |
56 | |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
57 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
58 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
53 | with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if |
59 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
54 | your module uses one of those, every user of your module has to use it, |
60 | your module uses one of those, every user of your module has to use it, |
55 | too. But if your module uses AnyEvent, it works transparently with all |
61 | too. But if your module uses AnyEvent, it works transparently with all |
56 | event models it supports (including stuff like POE and IO::Async, as long |
62 | event models it supports (including stuff like POE and IO::Async, as long |
57 | as those use one of the supported event loops. It is trivial to add new |
63 | as those use one of the supported event loops. It is trivial to add new |
58 | event loops to AnyEvent, too, so it is future-proof). |
64 | event loops to AnyEvent, too, so it is future-proof). |
59 | |
65 | |
60 | In addition to being free of having to use I<the one and only true event |
66 | 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 |
67 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
62 | modules, you get an enourmous amount of code and strict rules you have to |
68 | modules, you get an enormous amount of code and strict rules you have to |
63 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
69 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
64 | offering the functionality that is necessary, in as thin as a wrapper as |
70 | offering the functionality that is necessary, in as thin as a wrapper as |
65 | technically possible. |
71 | technically possible. |
66 | |
72 | |
|
|
73 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
|
|
74 | of useful functionality, such as an asynchronous DNS resolver, 100% |
|
|
75 | non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms |
|
|
76 | such as Windows) and lots of real-world knowledge and workarounds for |
|
|
77 | platform bugs and differences. |
|
|
78 | |
67 | Of course, if you want lots of policy (this can arguably be somewhat |
79 | Now, if you I<do want> lots of policy (this can arguably be somewhat |
68 | useful) and you want to force your users to use the one and only event |
80 | useful) and you want to force your users to use the one and only event |
69 | model, you should I<not> use this module. |
81 | model, you should I<not> use this module. |
70 | |
82 | |
71 | =head1 DESCRIPTION |
83 | =head1 DESCRIPTION |
72 | |
84 | |
… | |
… | |
102 | starts using it, all bets are off. Maybe you should tell their authors to |
114 | starts using it, all bets are off. Maybe you should tell their authors to |
103 | use AnyEvent so their modules work together with others seamlessly... |
115 | use AnyEvent so their modules work together with others seamlessly... |
104 | |
116 | |
105 | The pure-perl implementation of AnyEvent is called |
117 | The pure-perl implementation of AnyEvent is called |
106 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
118 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
107 | explicitly. |
119 | explicitly and enjoy the high availability of that event loop :) |
108 | |
120 | |
109 | =head1 WATCHERS |
121 | =head1 WATCHERS |
110 | |
122 | |
111 | AnyEvent has the central concept of a I<watcher>, which is an object that |
123 | AnyEvent has the central concept of a I<watcher>, which is an object that |
112 | stores relevant data for each kind of event you are waiting for, such as |
124 | stores relevant data for each kind of event you are waiting for, such as |
113 | the callback to call, the filehandle to watch, etc. |
125 | the callback to call, the file handle to watch, etc. |
114 | |
126 | |
115 | These watchers are normal Perl objects with normal Perl lifetime. After |
127 | These watchers are normal Perl objects with normal Perl lifetime. After |
116 | creating a watcher it will immediately "watch" for events and invoke the |
128 | creating a watcher it will immediately "watch" for events and invoke the |
117 | callback when the event occurs (of course, only when the event model |
129 | callback when the event occurs (of course, only when the event model |
118 | is in control). |
130 | is in control). |
… | |
… | |
126 | Many watchers either are used with "recursion" (repeating timers for |
138 | Many watchers either are used with "recursion" (repeating timers for |
127 | example), or need to refer to their watcher object in other ways. |
139 | example), or need to refer to their watcher object in other ways. |
128 | |
140 | |
129 | An any way to achieve that is this pattern: |
141 | An any way to achieve that is this pattern: |
130 | |
142 | |
131 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
143 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
132 | # you can use $w here, for example to undef it |
144 | # you can use $w here, for example to undef it |
133 | undef $w; |
145 | undef $w; |
134 | }); |
146 | }); |
135 | |
147 | |
136 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
148 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
137 | my variables are only visible after the statement in which they are |
149 | my variables are only visible after the statement in which they are |
138 | declared. |
150 | declared. |
139 | |
151 | |
140 | =head2 I/O WATCHERS |
152 | =head2 I/O WATCHERS |
141 | |
153 | |
142 | 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 |
143 | with the following mandatory key-value pairs as arguments: |
155 | with the following mandatory key-value pairs as arguments: |
144 | |
156 | |
145 | 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 |
146 | 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> |
147 | 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 |
148 | 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 |
149 | becomes ready. |
161 | callback to invoke each time the file handle becomes ready. |
150 | |
162 | |
151 | Although the callback might get passed parameters, their value and |
163 | Although the callback might get passed parameters, their value and |
152 | presence is undefined and you cannot rely on them. Portable AnyEvent |
164 | presence is undefined and you cannot rely on them. Portable AnyEvent |
153 | callbacks cannot use arguments passed to I/O watcher callbacks. |
165 | callbacks cannot use arguments passed to I/O watcher callbacks. |
154 | |
166 | |
… | |
… | |
158 | |
170 | |
159 | Some event loops issue spurious readyness notifications, so you should |
171 | Some event loops issue spurious readyness notifications, so you should |
160 | 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 |
161 | handles. |
173 | handles. |
162 | |
174 | |
163 | Example: |
|
|
164 | |
|
|
165 | # 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 | |
166 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
178 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
167 | chomp (my $input = <STDIN>); |
179 | chomp (my $input = <STDIN>); |
168 | warn "read: $input\n"; |
180 | warn "read: $input\n"; |
169 | undef $w; |
181 | undef $w; |
170 | }); |
182 | }); |
… | |
… | |
180 | |
192 | |
181 | Although the callback might get passed parameters, their value and |
193 | Although the callback might get passed parameters, their value and |
182 | presence is undefined and you cannot rely on them. Portable AnyEvent |
194 | presence is undefined and you cannot rely on them. Portable AnyEvent |
183 | callbacks cannot use arguments passed to time watcher callbacks. |
195 | callbacks cannot use arguments passed to time watcher callbacks. |
184 | |
196 | |
185 | 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 |
186 | 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 |
187 | 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. |
188 | |
202 | |
189 | 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. |
190 | |
206 | |
191 | # fire an event after 7.7 seconds |
207 | Example: fire an event after 7.7 seconds. |
|
|
208 | |
192 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
209 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
193 | warn "timeout\n"; |
210 | warn "timeout\n"; |
194 | }); |
211 | }); |
195 | |
212 | |
196 | # to cancel the timer: |
213 | # to cancel the timer: |
197 | undef $w; |
214 | undef $w; |
198 | |
215 | |
199 | Example 2: |
|
|
200 | |
|
|
201 | # 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. |
202 | my $w; |
|
|
203 | |
217 | |
204 | my $cb = sub { |
|
|
205 | # cancel the old timer while creating a new one |
|
|
206 | $w = AnyEvent->timer (after => 1, cb => $cb); |
218 | my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { |
|
|
219 | warn "timeout\n"; |
207 | }; |
220 | }; |
208 | |
|
|
209 | # start the "loop" by creating the first watcher |
|
|
210 | $w = AnyEvent->timer (after => 0.5, cb => $cb); |
|
|
211 | |
221 | |
212 | =head3 TIMING ISSUES |
222 | =head3 TIMING ISSUES |
213 | |
223 | |
214 | 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 |
215 | 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 |
… | |
… | |
227 | timers. |
237 | timers. |
228 | |
238 | |
229 | AnyEvent always prefers relative timers, if available, matching the |
239 | AnyEvent always prefers relative timers, if available, matching the |
230 | AnyEvent API. |
240 | AnyEvent API. |
231 | |
241 | |
|
|
242 | AnyEvent has two additional methods that return the "current time": |
|
|
243 | |
|
|
244 | =over 4 |
|
|
245 | |
|
|
246 | =item AnyEvent->time |
|
|
247 | |
|
|
248 | This returns the "current wallclock time" as a fractional number of |
|
|
249 | seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time> |
|
|
250 | return, and the result is guaranteed to be compatible with those). |
|
|
251 | |
|
|
252 | It progresses independently of any event loop processing, i.e. each call |
|
|
253 | will check the system clock, which usually gets updated frequently. |
|
|
254 | |
|
|
255 | =item AnyEvent->now |
|
|
256 | |
|
|
257 | This also returns the "current wallclock time", but unlike C<time>, above, |
|
|
258 | this value might change only once per event loop iteration, depending on |
|
|
259 | the event loop (most return the same time as C<time>, above). This is the |
|
|
260 | time that AnyEvent's timers get scheduled against. |
|
|
261 | |
|
|
262 | I<In almost all cases (in all cases if you don't care), this is the |
|
|
263 | function to call when you want to know the current time.> |
|
|
264 | |
|
|
265 | This function is also often faster then C<< AnyEvent->time >>, and |
|
|
266 | thus the preferred method if you want some timestamp (for example, |
|
|
267 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
|
|
268 | |
|
|
269 | The rest of this section is only of relevance if you try to be very exact |
|
|
270 | with your timing, you can skip it without bad conscience. |
|
|
271 | |
|
|
272 | For a practical example of when these times differ, consider L<Event::Lib> |
|
|
273 | and L<EV> and the following set-up: |
|
|
274 | |
|
|
275 | The event loop is running and has just invoked one of your callback at |
|
|
276 | time=500 (assume no other callbacks delay processing). In your callback, |
|
|
277 | you wait a second by executing C<sleep 1> (blocking the process for a |
|
|
278 | second) and then (at time=501) you create a relative timer that fires |
|
|
279 | after three seconds. |
|
|
280 | |
|
|
281 | With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will |
|
|
282 | both return C<501>, because that is the current time, and the timer will |
|
|
283 | be scheduled to fire at time=504 (C<501> + C<3>). |
|
|
284 | |
|
|
285 | With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current |
|
|
286 | time), but C<< AnyEvent->now >> returns C<500>, as that is the time the |
|
|
287 | last event processing phase started. With L<EV>, your timer gets scheduled |
|
|
288 | to run at time=503 (C<500> + C<3>). |
|
|
289 | |
|
|
290 | In one sense, L<Event::Lib> is more exact, as it uses the current time |
|
|
291 | regardless of any delays introduced by event processing. However, most |
|
|
292 | callbacks do not expect large delays in processing, so this causes a |
|
|
293 | higher drift (and a lot more system calls to get the current time). |
|
|
294 | |
|
|
295 | In another sense, L<EV> is more exact, as your timer will be scheduled at |
|
|
296 | the same time, regardless of how long event processing actually took. |
|
|
297 | |
|
|
298 | In either case, if you care (and in most cases, you don't), then you |
|
|
299 | can get whatever behaviour you want with any event loop, by taking the |
|
|
300 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
|
|
301 | account. |
|
|
302 | |
|
|
303 | =back |
|
|
304 | |
232 | =head2 SIGNAL WATCHERS |
305 | =head2 SIGNAL WATCHERS |
233 | |
306 | |
234 | You can watch for signals using a signal watcher, C<signal> is the signal |
307 | 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 |
308 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
236 | be invoked whenever a signal occurs. |
309 | be invoked whenever a signal occurs. |
237 | |
310 | |
238 | Although the callback might get passed parameters, their value and |
311 | Although the callback might get passed parameters, their value and |
239 | presence is undefined and you cannot rely on them. Portable AnyEvent |
312 | presence is undefined and you cannot rely on them. Portable AnyEvent |
240 | callbacks cannot use arguments passed to signal watcher callbacks. |
313 | callbacks cannot use arguments passed to signal watcher callbacks. |
241 | |
314 | |
242 | Multiple signal occurances can be clumped together into one callback |
315 | Multiple signal occurrences can be clumped together into one callback |
243 | invocation, and callback invocation will be synchronous. synchronous means |
316 | invocation, and callback invocation will be synchronous. Synchronous means |
244 | that it might take a while until the signal gets handled by the process, |
317 | that it might take a while until the signal gets handled by the process, |
245 | but it is guarenteed not to interrupt any other callbacks. |
318 | but it is guaranteed not to interrupt any other callbacks. |
246 | |
319 | |
247 | The main advantage of using these watchers is that you can share a signal |
320 | The main advantage of using these watchers is that you can share a signal |
248 | between multiple watchers. |
321 | between multiple watchers. |
249 | |
322 | |
250 | This watcher might use C<%SIG>, so programs overwriting those signals |
323 | This watcher might use C<%SIG>, so programs overwriting those signals |
… | |
… | |
277 | 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 |
278 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
351 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
279 | |
352 | |
280 | Example: fork a process and wait for it |
353 | Example: fork a process and wait for it |
281 | |
354 | |
282 | my $done = AnyEvent->condvar; |
355 | my $done = AnyEvent->condvar; |
283 | |
356 | |
284 | my $pid = fork or exit 5; |
357 | my $pid = fork or exit 5; |
285 | |
358 | |
286 | my $w = AnyEvent->child ( |
359 | my $w = AnyEvent->child ( |
287 | pid => $pid, |
360 | pid => $pid, |
288 | cb => sub { |
361 | cb => sub { |
289 | my ($pid, $status) = @_; |
362 | my ($pid, $status) = @_; |
290 | warn "pid $pid exited with status $status"; |
363 | warn "pid $pid exited with status $status"; |
291 | $done->send; |
364 | $done->send; |
292 | }, |
365 | }, |
293 | ); |
366 | ); |
294 | |
367 | |
295 | # do something else, then wait for process exit |
368 | # do something else, then wait for process exit |
296 | $done->recv; |
369 | $done->recv; |
297 | |
370 | |
298 | =head2 CONDITION VARIABLES |
371 | =head2 CONDITION VARIABLES |
299 | |
372 | |
300 | 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 |
301 | 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 |
… | |
… | |
310 | Condition variables can be created by calling the C<< AnyEvent->condvar |
383 | Condition variables can be created by calling the C<< AnyEvent->condvar |
311 | >> method, usually without arguments. The only argument pair allowed is |
384 | >> method, usually without arguments. The only argument pair allowed is |
312 | C<cb>, which specifies a callback to be called when the condition variable |
385 | C<cb>, which specifies a callback to be called when the condition variable |
313 | becomes true. |
386 | becomes true. |
314 | |
387 | |
315 | After creation, the conditon variable is "false" until it becomes "true" |
388 | After creation, the condition variable is "false" until it becomes "true" |
316 | by calling the C<send> method. |
389 | by calling the C<send> method (or calling the condition variable as if it |
|
|
390 | were a callback, read about the caveats in the description for the C<< |
|
|
391 | ->send >> method). |
317 | |
392 | |
318 | Condition variables are similar to callbacks, except that you can |
393 | Condition variables are similar to callbacks, except that you can |
319 | optionally wait for them. They can also be called merge points - points |
394 | optionally wait for them. They can also be called merge points - points |
320 | in time where multiple outstandign events have been processed. And yet |
395 | in time where multiple outstanding events have been processed. And yet |
321 | another way to call them is transations - each condition variable can be |
396 | another way to call them is transactions - each condition variable can be |
322 | used to represent a transaction, which finishes at some point and delivers |
397 | used to represent a transaction, which finishes at some point and delivers |
323 | a result. |
398 | a result. |
324 | |
399 | |
325 | Condition variables are very useful to signal that something has finished, |
400 | Condition variables are very useful to signal that something has finished, |
326 | for example, if you write a module that does asynchronous http requests, |
401 | for example, if you write a module that does asynchronous http requests, |
… | |
… | |
332 | you can block your main program until an event occurs - for example, you |
407 | you can block your main program until an event occurs - for example, you |
333 | could C<< ->recv >> in your main program until the user clicks the Quit |
408 | could C<< ->recv >> in your main program until the user clicks the Quit |
334 | button of your app, which would C<< ->send >> the "quit" event. |
409 | button of your app, which would C<< ->send >> the "quit" event. |
335 | |
410 | |
336 | Note that condition variables recurse into the event loop - if you have |
411 | Note that condition variables recurse into the event loop - if you have |
337 | two pieces of code that call C<< ->recv >> in a round-robbin fashion, you |
412 | two pieces of code that call C<< ->recv >> in a round-robin fashion, you |
338 | lose. Therefore, condition variables are good to export to your caller, but |
413 | lose. Therefore, condition variables are good to export to your caller, but |
339 | you should avoid making a blocking wait yourself, at least in callbacks, |
414 | you should avoid making a blocking wait yourself, at least in callbacks, |
340 | as this asks for trouble. |
415 | as this asks for trouble. |
341 | |
416 | |
342 | Condition variables are represented by hash refs in perl, and the keys |
417 | Condition variables are represented by hash refs in perl, and the keys |
… | |
… | |
347 | |
422 | |
348 | There are two "sides" to a condition variable - the "producer side" which |
423 | There are two "sides" to a condition variable - the "producer side" which |
349 | eventually calls C<< -> send >>, and the "consumer side", which waits |
424 | eventually calls C<< -> send >>, and the "consumer side", which waits |
350 | for the send to occur. |
425 | for the send to occur. |
351 | |
426 | |
352 | Example: |
427 | Example: wait for a timer. |
353 | |
428 | |
354 | # wait till the result is ready |
429 | # wait till the result is ready |
355 | my $result_ready = AnyEvent->condvar; |
430 | my $result_ready = AnyEvent->condvar; |
356 | |
431 | |
357 | # do something such as adding a timer |
432 | # do something such as adding a timer |
… | |
… | |
365 | |
440 | |
366 | # this "blocks" (while handling events) till the callback |
441 | # this "blocks" (while handling events) till the callback |
367 | # calls send |
442 | # calls send |
368 | $result_ready->recv; |
443 | $result_ready->recv; |
369 | |
444 | |
|
|
445 | Example: wait for a timer, but take advantage of the fact that |
|
|
446 | condition variables are also code references. |
|
|
447 | |
|
|
448 | my $done = AnyEvent->condvar; |
|
|
449 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
|
|
450 | $done->recv; |
|
|
451 | |
370 | =head3 METHODS FOR PRODUCERS |
452 | =head3 METHODS FOR PRODUCERS |
371 | |
453 | |
372 | These methods should only be used by the producing side, i.e. the |
454 | These methods should only be used by the producing side, i.e. the |
373 | code/module that eventually sends the signal. Note that it is also |
455 | code/module that eventually sends the signal. Note that it is also |
374 | the producer side which creates the condvar in most cases, but it isn't |
456 | the producer side which creates the condvar in most cases, but it isn't |
… | |
… | |
385 | If a callback has been set on the condition variable, it is called |
467 | If a callback has been set on the condition variable, it is called |
386 | immediately from within send. |
468 | immediately from within send. |
387 | |
469 | |
388 | Any arguments passed to the C<send> call will be returned by all |
470 | Any arguments passed to the C<send> call will be returned by all |
389 | future C<< ->recv >> calls. |
471 | future C<< ->recv >> calls. |
|
|
472 | |
|
|
473 | Condition variables are overloaded so one can call them directly |
|
|
474 | (as a code reference). Calling them directly is the same as calling |
|
|
475 | C<send>. Note, however, that many C-based event loops do not handle |
|
|
476 | overloading, so as tempting as it may be, passing a condition variable |
|
|
477 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
478 | support overloading, however, as well as all functions that use perl to |
|
|
479 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
480 | example). |
390 | |
481 | |
391 | =item $cv->croak ($error) |
482 | =item $cv->croak ($error) |
392 | |
483 | |
393 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
484 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
394 | C<Carp::croak> with the given error message/object/scalar. |
485 | C<Carp::croak> with the given error message/object/scalar. |
… | |
… | |
443 | doesn't execute once). |
534 | doesn't execute once). |
444 | |
535 | |
445 | This is the general pattern when you "fan out" into multiple subrequests: |
536 | This is the general pattern when you "fan out" into multiple subrequests: |
446 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
537 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
447 | is called at least once, and then, for each subrequest you start, call |
538 | is called at least once, and then, for each subrequest you start, call |
448 | C<begin> and for eahc subrequest you finish, call C<end>. |
539 | C<begin> and for each subrequest you finish, call C<end>. |
449 | |
540 | |
450 | =back |
541 | =back |
451 | |
542 | |
452 | =head3 METHODS FOR CONSUMERS |
543 | =head3 METHODS FOR CONSUMERS |
453 | |
544 | |
… | |
… | |
475 | (programs might want to do that to stay interactive), so I<if you are |
566 | (programs might want to do that to stay interactive), so I<if you are |
476 | using this from a module, never require a blocking wait>, but let the |
567 | using this from a module, never require a blocking wait>, but let the |
477 | caller decide whether the call will block or not (for example, by coupling |
568 | caller decide whether the call will block or not (for example, by coupling |
478 | condition variables with some kind of request results and supporting |
569 | condition variables with some kind of request results and supporting |
479 | callbacks so the caller knows that getting the result will not block, |
570 | callbacks so the caller knows that getting the result will not block, |
480 | while still suppporting blocking waits if the caller so desires). |
571 | while still supporting blocking waits if the caller so desires). |
481 | |
572 | |
482 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
573 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
483 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
574 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
484 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
575 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
485 | can supply. |
576 | can supply. |
… | |
… | |
504 | |
595 | |
505 | 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 |
506 | replaces it before doing so. |
597 | replaces it before doing so. |
507 | |
598 | |
508 | 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 |
509 | 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 |
510 | 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. |
511 | |
603 | |
512 | =back |
604 | =back |
513 | |
605 | |
514 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
606 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
515 | |
607 | |
… | |
… | |
601 | |
693 | |
602 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
694 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
603 | do anything special (it does not need to be event-based) and let AnyEvent |
695 | do anything special (it does not need to be event-based) and let AnyEvent |
604 | decide which implementation to chose if some module relies on it. |
696 | decide which implementation to chose if some module relies on it. |
605 | |
697 | |
606 | If the main program relies on a specific event model. For example, in |
698 | If the main program relies on a specific event model - for example, in |
607 | Gtk2 programs you have to rely on the Glib module. You should load the |
699 | Gtk2 programs you have to rely on the Glib module - you should load the |
608 | event module before loading AnyEvent or any module that uses it: generally |
700 | event module before loading AnyEvent or any module that uses it: generally |
609 | speaking, you should load it as early as possible. The reason is that |
701 | speaking, you should load it as early as possible. The reason is that |
610 | modules might create watchers when they are loaded, and AnyEvent will |
702 | modules might create watchers when they are loaded, and AnyEvent will |
611 | decide on the event model to use as soon as it creates watchers, and it |
703 | decide on the event model to use as soon as it creates watchers, and it |
612 | might chose the wrong one unless you load the correct one yourself. |
704 | might chose the wrong one unless you load the correct one yourself. |
613 | |
705 | |
614 | You can chose to use a rather inefficient pure-perl implementation by |
706 | You can chose to use a pure-perl implementation by loading the |
615 | loading the C<AnyEvent::Impl::Perl> module, which gives you similar |
707 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
616 | behaviour everywhere, but letting AnyEvent chose is generally better. |
708 | everywhere, but letting AnyEvent chose the model is generally better. |
|
|
709 | |
|
|
710 | =head2 MAINLOOP EMULATION |
|
|
711 | |
|
|
712 | Sometimes (often for short test scripts, or even standalone programs who |
|
|
713 | only want to use AnyEvent), you do not want to run a specific event loop. |
|
|
714 | |
|
|
715 | In that case, you can use a condition variable like this: |
|
|
716 | |
|
|
717 | AnyEvent->condvar->recv; |
|
|
718 | |
|
|
719 | This has the effect of entering the event loop and looping forever. |
|
|
720 | |
|
|
721 | Note that usually your program has some exit condition, in which case |
|
|
722 | it is better to use the "traditional" approach of storing a condition |
|
|
723 | variable somewhere, waiting for it, and sending it when the program should |
|
|
724 | exit cleanly. |
|
|
725 | |
617 | |
726 | |
618 | =head1 OTHER MODULES |
727 | =head1 OTHER MODULES |
619 | |
728 | |
620 | The following is a non-exhaustive list of additional modules that use |
729 | The following is a non-exhaustive list of additional modules that use |
621 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
730 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
… | |
… | |
627 | =item L<AnyEvent::Util> |
736 | =item L<AnyEvent::Util> |
628 | |
737 | |
629 | Contains various utility functions that replace often-used but blocking |
738 | Contains various utility functions that replace often-used but blocking |
630 | functions such as C<inet_aton> by event-/callback-based versions. |
739 | functions such as C<inet_aton> by event-/callback-based versions. |
631 | |
740 | |
632 | =item L<AnyEvent::Handle> |
|
|
633 | |
|
|
634 | Provide read and write buffers and manages watchers for reads and writes. |
|
|
635 | |
|
|
636 | =item L<AnyEvent::Socket> |
741 | =item L<AnyEvent::Socket> |
637 | |
742 | |
638 | Provides various utility functions for (internet protocol) sockets, |
743 | Provides various utility functions for (internet protocol) sockets, |
639 | addresses and name resolution. Also functions to create non-blocking tcp |
744 | addresses and name resolution. Also functions to create non-blocking tcp |
640 | 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. |
641 | |
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 | |
|
|
753 | =item L<AnyEvent::DNS> |
|
|
754 | |
|
|
755 | Provides rich asynchronous DNS resolver capabilities. |
|
|
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 | |
642 | =item L<AnyEvent::HTTPD> |
762 | =item L<AnyEvent::HTTPD> |
643 | |
763 | |
644 | Provides a simple web application server framework. |
764 | Provides a simple web application server framework. |
645 | |
765 | |
646 | =item L<AnyEvent::DNS> |
|
|
647 | |
|
|
648 | Provides rich asynchronous DNS resolver capabilities. |
|
|
649 | |
|
|
650 | =item L<AnyEvent::FastPing> |
766 | =item L<AnyEvent::FastPing> |
651 | |
767 | |
652 | 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>). |
653 | |
793 | |
654 | =item L<Net::IRC3> |
794 | =item L<Net::IRC3> |
655 | |
795 | |
656 | AnyEvent based IRC client module family. |
796 | AnyEvent based IRC client module family. |
657 | |
797 | |
… | |
… | |
670 | |
810 | |
671 | =item L<Coro> |
811 | =item L<Coro> |
672 | |
812 | |
673 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
813 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
674 | |
814 | |
675 | =item L<AnyEvent::AIO>, L<IO::AIO> |
|
|
676 | |
|
|
677 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
678 | programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent |
|
|
679 | together. |
|
|
680 | |
|
|
681 | =item L<AnyEvent::BDB>, L<BDB> |
|
|
682 | |
|
|
683 | Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses |
|
|
684 | IO::AIO and AnyEvent together. |
|
|
685 | |
|
|
686 | =item L<IO::Lambda> |
815 | =item L<IO::Lambda> |
687 | |
816 | |
688 | 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. |
689 | |
818 | |
690 | =back |
819 | =back |
… | |
… | |
696 | no warnings; |
825 | no warnings; |
697 | use strict; |
826 | use strict; |
698 | |
827 | |
699 | use Carp; |
828 | use Carp; |
700 | |
829 | |
701 | our $VERSION = '3.6'; |
830 | our $VERSION = 4.2; |
702 | our $MODEL; |
831 | our $MODEL; |
703 | |
832 | |
704 | our $AUTOLOAD; |
833 | our $AUTOLOAD; |
705 | our @ISA; |
834 | our @ISA; |
706 | |
835 | |
|
|
836 | our @REGISTRY; |
|
|
837 | |
|
|
838 | our $WIN32; |
|
|
839 | |
|
|
840 | BEGIN { |
|
|
841 | my $win32 = ! ! ($^O =~ /mswin32/i); |
|
|
842 | eval "sub WIN32(){ $win32 }"; |
|
|
843 | } |
|
|
844 | |
707 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
845 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
708 | |
846 | |
709 | our @REGISTRY; |
847 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
710 | |
|
|
711 | our %PROTOCOL; # (ipv4|ipv6) => (1|2) |
|
|
712 | |
848 | |
713 | { |
849 | { |
714 | my $idx; |
850 | my $idx; |
715 | $PROTOCOL{$_} = ++$idx |
851 | $PROTOCOL{$_} = ++$idx |
|
|
852 | for reverse split /\s*,\s*/, |
716 | for split /\s*,\s*/, $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
853 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
717 | } |
854 | } |
718 | |
855 | |
719 | my @models = ( |
856 | my @models = ( |
720 | [EV:: => AnyEvent::Impl::EV::], |
857 | [EV:: => AnyEvent::Impl::EV::], |
721 | [Event:: => AnyEvent::Impl::Event::], |
858 | [Event:: => AnyEvent::Impl::Event::], |
722 | [Tk:: => AnyEvent::Impl::Tk::], |
|
|
723 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
724 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
725 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
859 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
726 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
860 | # everything below here will not be autoprobed |
727 | [Glib:: => AnyEvent::Impl::Glib::], |
861 | # as the pureperl backend should work everywhere |
|
|
862 | # and is usually faster |
|
|
863 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
864 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
728 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
865 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
729 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
866 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
730 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
867 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
|
|
868 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
869 | [Prima:: => AnyEvent::Impl::POE::], |
731 | ); |
870 | ); |
732 | |
871 | |
733 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
872 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
734 | |
873 | |
735 | our @post_detect; |
874 | our @post_detect; |
736 | |
875 | |
737 | sub post_detect(&) { |
876 | sub post_detect(&) { |
738 | my ($cb) = @_; |
877 | my ($cb) = @_; |
… | |
… | |
755 | } |
894 | } |
756 | |
895 | |
757 | sub detect() { |
896 | sub detect() { |
758 | unless ($MODEL) { |
897 | unless ($MODEL) { |
759 | no strict 'refs'; |
898 | no strict 'refs'; |
|
|
899 | local $SIG{__DIE__}; |
760 | |
900 | |
761 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
901 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
762 | my $model = "AnyEvent::Impl::$1"; |
902 | my $model = "AnyEvent::Impl::$1"; |
763 | if (eval "require $model") { |
903 | if (eval "require $model") { |
764 | $MODEL = $model; |
904 | $MODEL = $model; |
… | |
… | |
821 | $class->$func (@_); |
961 | $class->$func (@_); |
822 | } |
962 | } |
823 | |
963 | |
824 | package AnyEvent::Base; |
964 | package AnyEvent::Base; |
825 | |
965 | |
|
|
966 | # default implementation for now and time |
|
|
967 | |
|
|
968 | use Time::HiRes (); |
|
|
969 | |
|
|
970 | sub time { Time::HiRes::time } |
|
|
971 | sub now { Time::HiRes::time } |
|
|
972 | |
826 | # default implementation for ->condvar |
973 | # default implementation for ->condvar |
827 | |
974 | |
828 | sub condvar { |
975 | sub condvar { |
829 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
976 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
830 | } |
977 | } |
… | |
… | |
850 | sub AnyEvent::Base::Signal::DESTROY { |
997 | sub AnyEvent::Base::Signal::DESTROY { |
851 | my ($signal, $cb) = @{$_[0]}; |
998 | my ($signal, $cb) = @{$_[0]}; |
852 | |
999 | |
853 | delete $SIG_CB{$signal}{$cb}; |
1000 | delete $SIG_CB{$signal}{$cb}; |
854 | |
1001 | |
855 | $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; |
1002 | delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
856 | } |
1003 | } |
857 | |
1004 | |
858 | # default implementation for ->child |
1005 | # default implementation for ->child |
859 | |
1006 | |
860 | our %PID_CB; |
1007 | our %PID_CB; |
… | |
… | |
887 | or Carp::croak "required option 'pid' is missing"; |
1034 | or Carp::croak "required option 'pid' is missing"; |
888 | |
1035 | |
889 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1036 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
890 | |
1037 | |
891 | unless ($WNOHANG) { |
1038 | unless ($WNOHANG) { |
892 | $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; |
1039 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
893 | } |
1040 | } |
894 | |
1041 | |
895 | unless ($CHLD_W) { |
1042 | unless ($CHLD_W) { |
896 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1043 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
897 | # child could be a zombie already, so make at least one round |
1044 | # child could be a zombie already, so make at least one round |
… | |
… | |
913 | package AnyEvent::CondVar; |
1060 | package AnyEvent::CondVar; |
914 | |
1061 | |
915 | our @ISA = AnyEvent::CondVar::Base::; |
1062 | our @ISA = AnyEvent::CondVar::Base::; |
916 | |
1063 | |
917 | package AnyEvent::CondVar::Base; |
1064 | package AnyEvent::CondVar::Base; |
|
|
1065 | |
|
|
1066 | use overload |
|
|
1067 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
|
|
1068 | fallback => 1; |
918 | |
1069 | |
919 | sub _send { |
1070 | sub _send { |
920 | # nop |
1071 | # nop |
921 | } |
1072 | } |
922 | |
1073 | |
… | |
… | |
1029 | model it chooses. |
1180 | model it chooses. |
1030 | |
1181 | |
1031 | =item C<PERL_ANYEVENT_MODEL> |
1182 | =item C<PERL_ANYEVENT_MODEL> |
1032 | |
1183 | |
1033 | This can be used to specify the event model to be used by AnyEvent, before |
1184 | This can be used to specify the event model to be used by AnyEvent, before |
1034 | autodetection and -probing kicks in. It must be a string consisting |
1185 | auto detection and -probing kicks in. It must be a string consisting |
1035 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
1186 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
1036 | and the resulting module name is loaded and if the load was successful, |
1187 | and the resulting module name is loaded and if the load was successful, |
1037 | used as event model. If it fails to load AnyEvent will proceed with |
1188 | used as event model. If it fails to load AnyEvent will proceed with |
1038 | autodetection and -probing. |
1189 | auto detection and -probing. |
1039 | |
1190 | |
1040 | This functionality might change in future versions. |
1191 | This functionality might change in future versions. |
1041 | |
1192 | |
1042 | 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 |
1043 | could start your program like this: |
1194 | could start your program like this: |
1044 | |
1195 | |
1045 | PERL_ANYEVENT_MODEL=Perl perl ... |
1196 | PERL_ANYEVENT_MODEL=Perl perl ... |
1046 | |
1197 | |
1047 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1198 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1048 | |
1199 | |
1049 | 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 |
1050 | 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 |
1051 | of autoprobing). |
1202 | of auto probing). |
1052 | |
1203 | |
1053 | Must be set to a comma-separated list of protocols or address families, |
1204 | Must be set to a comma-separated list of protocols or address families, |
1054 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
1205 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
1055 | used, and preference will be given to protocols mentioned earlier in the |
1206 | used, and preference will be given to protocols mentioned earlier in the |
1056 | list. |
1207 | list. |
1057 | |
1208 | |
|
|
1209 | This variable can effectively be used for denial-of-service attacks |
|
|
1210 | against local programs (e.g. when setuid), although the impact is likely |
|
|
1211 | small, as the program has to handle connection errors already- |
|
|
1212 | |
1058 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
1213 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
1059 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
1214 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
1060 | - only support IPv4, never try to resolve or contact IPv6 |
1215 | - only support IPv4, never try to resolve or contact IPv6 |
1061 | addressses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
1216 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
1062 | IPv6, but prefer IPv6 over IPv4. |
1217 | IPv6, but prefer IPv6 over IPv4. |
|
|
1218 | |
|
|
1219 | =item C<PERL_ANYEVENT_EDNS0> |
|
|
1220 | |
|
|
1221 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
|
|
1222 | for DNS. This extension is generally useful to reduce DNS traffic, but |
|
|
1223 | some (broken) firewalls drop such DNS packets, which is why it is off by |
|
|
1224 | default. |
|
|
1225 | |
|
|
1226 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
|
|
1227 | EDNS0 in its DNS requests. |
|
|
1228 | |
|
|
1229 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1230 | |
|
|
1231 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1232 | will create in parallel. |
1063 | |
1233 | |
1064 | =back |
1234 | =back |
1065 | |
1235 | |
1066 | =head1 EXAMPLE PROGRAM |
1236 | =head1 EXAMPLE PROGRAM |
1067 | |
1237 | |
… | |
… | |
1153 | syswrite $txn->{fh}, $txn->{request} |
1323 | syswrite $txn->{fh}, $txn->{request} |
1154 | or die "connection or write error"; |
1324 | or die "connection or write error"; |
1155 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1325 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1156 | |
1326 | |
1157 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
1327 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
1158 | result and signals any possible waiters that the request ahs finished: |
1328 | result and signals any possible waiters that the request has finished: |
1159 | |
1329 | |
1160 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1330 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1161 | |
1331 | |
1162 | if (end-of-file or data complete) { |
1332 | if (end-of-file or data complete) { |
1163 | $txn->{result} = $txn->{buf}; |
1333 | $txn->{result} = $txn->{buf}; |
… | |
… | |
1171 | |
1341 | |
1172 | $txn->{finished}->recv; |
1342 | $txn->{finished}->recv; |
1173 | return $txn->{result}; |
1343 | return $txn->{result}; |
1174 | |
1344 | |
1175 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1345 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1176 | that occured during request processing. The C<result> method detects |
1346 | that occurred during request processing. The C<result> method detects |
1177 | whether an exception as thrown (it is stored inside the $txn object) |
1347 | whether an exception as thrown (it is stored inside the $txn object) |
1178 | and just throws the exception, which means connection errors and other |
1348 | and just throws the exception, which means connection errors and other |
1179 | problems get reported tot he code that tries to use the result, not in a |
1349 | problems get reported tot he code that tries to use the result, not in a |
1180 | random callback. |
1350 | random callback. |
1181 | |
1351 | |
… | |
… | |
1227 | of various event loops I prepared some benchmarks. |
1397 | of various event loops I prepared some benchmarks. |
1228 | |
1398 | |
1229 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
1399 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
1230 | |
1400 | |
1231 | Here is a benchmark of various supported event models used natively and |
1401 | Here is a benchmark of various supported event models used natively and |
1232 | through anyevent. The benchmark creates a lot of timers (with a zero |
1402 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1233 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1403 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1234 | which it is), lets them fire exactly once and destroys them again. |
1404 | which it is), lets them fire exactly once and destroys them again. |
1235 | |
1405 | |
1236 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1406 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1237 | distribution. |
1407 | distribution. |
… | |
… | |
1360 | |
1530 | |
1361 | =back |
1531 | =back |
1362 | |
1532 | |
1363 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1533 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1364 | |
1534 | |
1365 | This benchmark atcually benchmarks the event loop itself. It works by |
1535 | This benchmark actually benchmarks the event loop itself. It works by |
1366 | creating a number of "servers": each server consists of a socketpair, a |
1536 | creating a number of "servers": each server consists of a socket pair, a |
1367 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1537 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1368 | watcher waiting for input on one side of the socket. Each time the socket |
1538 | watcher waiting for input on one side of the socket. Each time the socket |
1369 | watcher reads a byte it will write that byte to a random other "server". |
1539 | watcher reads a byte it will write that byte to a random other "server". |
1370 | |
1540 | |
1371 | The effect is that there will be a lot of I/O watchers, only part of which |
1541 | The effect is that there will be a lot of I/O watchers, only part of which |
1372 | are active at any one point (so there is a constant number of active |
1542 | are active at any one point (so there is a constant number of active |
1373 | fds for each loop iterstaion, but which fds these are is random). The |
1543 | fds for each loop iteration, but which fds these are is random). The |
1374 | timeout is reset each time something is read because that reflects how |
1544 | timeout is reset each time something is read because that reflects how |
1375 | most timeouts work (and puts extra pressure on the event loops). |
1545 | most timeouts work (and puts extra pressure on the event loops). |
1376 | |
1546 | |
1377 | In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100 |
1547 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
1378 | (1%) are active. This mirrors the activity of large servers with many |
1548 | (1%) are active. This mirrors the activity of large servers with many |
1379 | connections, most of which are idle at any one point in time. |
1549 | connections, most of which are idle at any one point in time. |
1380 | |
1550 | |
1381 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1551 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1382 | distribution. |
1552 | distribution. |
… | |
… | |
1384 | =head3 Explanation of the columns |
1554 | =head3 Explanation of the columns |
1385 | |
1555 | |
1386 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1556 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1387 | each server has a read and write socket end). |
1557 | each server has a read and write socket end). |
1388 | |
1558 | |
1389 | I<create> is the time it takes to create a socketpair (which is |
1559 | I<create> is the time it takes to create a socket pair (which is |
1390 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1560 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1391 | |
1561 | |
1392 | I<request>, the most important value, is the time it takes to handle a |
1562 | I<request>, the most important value, is the time it takes to handle a |
1393 | single "request", that is, reading the token from the pipe and forwarding |
1563 | single "request", that is, reading the token from the pipe and forwarding |
1394 | it to another server. This includes deleting the old timeout and creating |
1564 | it to another server. This includes deleting the old timeout and creating |
… | |
… | |
1467 | speed most when you have lots of watchers, not when you only have a few of |
1637 | speed most when you have lots of watchers, not when you only have a few of |
1468 | them). |
1638 | them). |
1469 | |
1639 | |
1470 | EV is again fastest. |
1640 | EV is again fastest. |
1471 | |
1641 | |
1472 | Perl again comes second. It is noticably faster than the C-based event |
1642 | Perl again comes second. It is noticeably faster than the C-based event |
1473 | loops Event and Glib, although the difference is too small to really |
1643 | loops Event and Glib, although the difference is too small to really |
1474 | matter. |
1644 | matter. |
1475 | |
1645 | |
1476 | POE also performs much better in this case, but is is still far behind the |
1646 | POE also performs much better in this case, but is is still far behind the |
1477 | others. |
1647 | others. |
… | |
… | |
1506 | specified in the variable. |
1676 | specified in the variable. |
1507 | |
1677 | |
1508 | You can make AnyEvent completely ignore this variable by deleting it |
1678 | You can make AnyEvent completely ignore this variable by deleting it |
1509 | 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: |
1510 | |
1680 | |
1511 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1681 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1512 | |
1682 | |
1513 | use AnyEvent; |
1683 | use AnyEvent; |
1514 | |
1684 | |
1515 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1685 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1516 | 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 |
1517 | 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). |
1518 | |
1697 | |
1519 | |
1698 | |
1520 | =head1 SEE ALSO |
1699 | =head1 SEE ALSO |
1521 | |
1700 | |
1522 | Utility functions: L<AnyEvent::Util>. |
1701 | Utility functions: L<AnyEvent::Util>. |
… | |
… | |
1539 | 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>. |
1540 | |
1719 | |
1541 | |
1720 | |
1542 | =head1 AUTHOR |
1721 | =head1 AUTHOR |
1543 | |
1722 | |
1544 | Marc Lehmann <schmorp@schmorp.de> |
1723 | Marc Lehmann <schmorp@schmorp.de> |
1545 | http://home.schmorp.de/ |
1724 | http://home.schmorp.de/ |
1546 | |
1725 | |
1547 | =cut |
1726 | =cut |
1548 | |
1727 | |
1549 | 1 |
1728 | 1 |
1550 | |
1729 | |