1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - the DBI of event loop programming |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt |
6 | event loops. |
6 | and POE are various supported event loops/environments. |
7 | |
7 | |
8 | =head1 SYNOPSIS |
8 | =head1 SYNOPSIS |
9 | |
9 | |
10 | use AnyEvent; |
10 | use AnyEvent; |
11 | |
11 | |
|
|
12 | # if you prefer function calls, look at the AE manpage for |
|
|
13 | # an alternative API. |
|
|
14 | |
12 | # file descriptor readable |
15 | # file handle or descriptor readable |
13 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
16 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
14 | |
17 | |
15 | # one-shot or repeating timers |
18 | # one-shot or repeating timers |
16 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
19 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
17 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
20 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...); |
18 | |
21 | |
19 | print AnyEvent->now; # prints current event loop time |
22 | print AnyEvent->now; # prints current event loop time |
20 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
23 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
21 | |
24 | |
22 | # POSIX signal |
25 | # POSIX signal |
… | |
… | |
40 | =head1 INTRODUCTION/TUTORIAL |
43 | =head1 INTRODUCTION/TUTORIAL |
41 | |
44 | |
42 | This manpage is mainly a reference manual. If you are interested |
45 | This manpage is mainly a reference manual. If you are interested |
43 | in a tutorial or some gentle introduction, have a look at the |
46 | in a tutorial or some gentle introduction, have a look at the |
44 | L<AnyEvent::Intro> manpage. |
47 | L<AnyEvent::Intro> manpage. |
|
|
48 | |
|
|
49 | =head1 SUPPORT |
|
|
50 | |
|
|
51 | An FAQ document is available as L<AnyEvent::FAQ>. |
|
|
52 | |
|
|
53 | There also is a mailinglist for discussing all things AnyEvent, and an IRC |
|
|
54 | channel, too. |
|
|
55 | |
|
|
56 | See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software |
|
|
57 | Repository>, at L<http://anyevent.schmorp.de>, for more info. |
45 | |
58 | |
46 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
59 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
47 | |
60 | |
48 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
61 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
49 | nowadays. So what is different about AnyEvent? |
62 | nowadays. So what is different about AnyEvent? |
… | |
… | |
65 | module users into the same thing by forcing them to use the same event |
78 | module users into the same thing by forcing them to use the same event |
66 | model you use. |
79 | model you use. |
67 | |
80 | |
68 | For modules like POE or IO::Async (which is a total misnomer as it is |
81 | For modules like POE or IO::Async (which is a total misnomer as it is |
69 | actually doing all I/O I<synchronously>...), using them in your module is |
82 | actually doing all I/O I<synchronously>...), using them in your module is |
70 | like joining a cult: After you joined, you are dependent on them and you |
83 | like joining a cult: After you join, you are dependent on them and you |
71 | cannot use anything else, as they are simply incompatible to everything |
84 | cannot use anything else, as they are simply incompatible to everything |
72 | that isn't them. What's worse, all the potential users of your |
85 | that isn't them. What's worse, all the potential users of your |
73 | module are I<also> forced to use the same event loop you use. |
86 | module are I<also> forced to use the same event loop you use. |
74 | |
87 | |
75 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
88 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
76 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
89 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
77 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
90 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
78 | your module uses one of those, every user of your module has to use it, |
91 | your module uses one of those, every user of your module has to use it, |
79 | too. But if your module uses AnyEvent, it works transparently with all |
92 | too. But if your module uses AnyEvent, it works transparently with all |
80 | event models it supports (including stuff like IO::Async, as long as those |
93 | event models it supports (including stuff like IO::Async, as long as those |
81 | use one of the supported event loops. It is trivial to add new event loops |
94 | use one of the supported event loops. It is easy to add new event loops |
82 | to AnyEvent, too, so it is future-proof). |
95 | to AnyEvent, too, so it is future-proof). |
83 | |
96 | |
84 | In addition to being free of having to use I<the one and only true event |
97 | In addition to being free of having to use I<the one and only true event |
85 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
98 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
86 | modules, you get an enormous amount of code and strict rules you have to |
99 | modules, you get an enormous amount of code and strict rules you have to |
87 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
100 | follow. AnyEvent, on the other hand, is lean and to the point, by only |
88 | offering the functionality that is necessary, in as thin as a wrapper as |
101 | offering the functionality that is necessary, in as thin as a wrapper as |
89 | technically possible. |
102 | technically possible. |
90 | |
103 | |
91 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
104 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
92 | of useful functionality, such as an asynchronous DNS resolver, 100% |
105 | of useful functionality, such as an asynchronous DNS resolver, 100% |
… | |
… | |
98 | useful) and you want to force your users to use the one and only event |
111 | useful) and you want to force your users to use the one and only event |
99 | model, you should I<not> use this module. |
112 | model, you should I<not> use this module. |
100 | |
113 | |
101 | =head1 DESCRIPTION |
114 | =head1 DESCRIPTION |
102 | |
115 | |
103 | L<AnyEvent> provides an identical interface to multiple event loops. This |
116 | L<AnyEvent> provides a uniform interface to various event loops. This |
104 | allows module authors to utilise an event loop without forcing module |
117 | allows module authors to use event loop functionality without forcing |
105 | users to use the same event loop (as only a single event loop can coexist |
118 | module users to use a specific event loop implementation (since more |
106 | peacefully at any one time). |
119 | than one event loop cannot coexist peacefully). |
107 | |
120 | |
108 | The interface itself is vaguely similar, but not identical to the L<Event> |
121 | The interface itself is vaguely similar, but not identical to the L<Event> |
109 | module. |
122 | module. |
110 | |
123 | |
111 | During the first call of any watcher-creation method, the module tries |
124 | During the first call of any watcher-creation method, the module tries |
112 | to detect the currently loaded event loop by probing whether one of the |
125 | to detect the currently loaded event loop by probing whether one of the |
113 | following modules is already loaded: L<EV>, |
126 | following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>, |
114 | L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, |
127 | L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one |
115 | L<POE>. The first one found is used. If none are found, the module tries |
128 | found is used. If none are detected, the module tries to load the first |
116 | to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl |
129 | four modules in the order given; but note that if L<EV> is not |
117 | adaptor should always succeed) in the order given. The first one that can |
130 | available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so |
118 | be successfully loaded will be used. If, after this, still none could be |
131 | the other two are not normally tried. |
119 | found, AnyEvent will fall back to a pure-perl event loop, which is not |
|
|
120 | very efficient, but should work everywhere. |
|
|
121 | |
132 | |
122 | Because AnyEvent first checks for modules that are already loaded, loading |
133 | Because AnyEvent first checks for modules that are already loaded, loading |
123 | an event model explicitly before first using AnyEvent will likely make |
134 | an event model explicitly before first using AnyEvent will likely make |
124 | that model the default. For example: |
135 | that model the default. For example: |
125 | |
136 | |
… | |
… | |
127 | use AnyEvent; |
138 | use AnyEvent; |
128 | |
139 | |
129 | # .. AnyEvent will likely default to Tk |
140 | # .. AnyEvent will likely default to Tk |
130 | |
141 | |
131 | The I<likely> means that, if any module loads another event model and |
142 | The I<likely> means that, if any module loads another event model and |
132 | starts using it, all bets are off. Maybe you should tell their authors to |
143 | starts using it, all bets are off - this case should be very rare though, |
133 | use AnyEvent so their modules work together with others seamlessly... |
144 | as very few modules hardcode event loops without announcing this very |
|
|
145 | loudly. |
134 | |
146 | |
135 | The pure-perl implementation of AnyEvent is called |
147 | The pure-perl implementation of AnyEvent is called |
136 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
148 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
137 | explicitly and enjoy the high availability of that event loop :) |
149 | explicitly and enjoy the high availability of that event loop :) |
138 | |
150 | |
… | |
… | |
147 | callback when the event occurs (of course, only when the event model |
159 | callback when the event occurs (of course, only when the event model |
148 | is in control). |
160 | is in control). |
149 | |
161 | |
150 | Note that B<callbacks must not permanently change global variables> |
162 | Note that B<callbacks must not permanently change global variables> |
151 | potentially in use by the event loop (such as C<$_> or C<$[>) and that B<< |
163 | potentially in use by the event loop (such as C<$_> or C<$[>) and that B<< |
152 | callbacks must not C<die> >>. The former is good programming practise in |
164 | callbacks must not C<die> >>. The former is good programming practice in |
153 | Perl and the latter stems from the fact that exception handling differs |
165 | Perl and the latter stems from the fact that exception handling differs |
154 | widely between event loops. |
166 | widely between event loops. |
155 | |
167 | |
156 | To disable the watcher you have to destroy it (e.g. by setting the |
168 | To disable a watcher you have to destroy it (e.g. by setting the |
157 | variable you store it in to C<undef> or otherwise deleting all references |
169 | variable you store it in to C<undef> or otherwise deleting all references |
158 | to it). |
170 | to it). |
159 | |
171 | |
160 | All watchers are created by calling a method on the C<AnyEvent> class. |
172 | All watchers are created by calling a method on the C<AnyEvent> class. |
161 | |
173 | |
162 | Many watchers either are used with "recursion" (repeating timers for |
174 | Many watchers either are used with "recursion" (repeating timers for |
163 | example), or need to refer to their watcher object in other ways. |
175 | example), or need to refer to their watcher object in other ways. |
164 | |
176 | |
165 | An any way to achieve that is this pattern: |
177 | One way to achieve that is this pattern: |
166 | |
178 | |
167 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
179 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
168 | # you can use $w here, for example to undef it |
180 | # you can use $w here, for example to undef it |
169 | undef $w; |
181 | undef $w; |
170 | }); |
182 | }); |
… | |
… | |
172 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
184 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
173 | my variables are only visible after the statement in which they are |
185 | my variables are only visible after the statement in which they are |
174 | declared. |
186 | declared. |
175 | |
187 | |
176 | =head2 I/O WATCHERS |
188 | =head2 I/O WATCHERS |
|
|
189 | |
|
|
190 | $w = AnyEvent->io ( |
|
|
191 | fh => <filehandle_or_fileno>, |
|
|
192 | poll => <"r" or "w">, |
|
|
193 | cb => <callback>, |
|
|
194 | ); |
177 | |
195 | |
178 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
196 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
179 | with the following mandatory key-value pairs as arguments: |
197 | with the following mandatory key-value pairs as arguments: |
180 | |
198 | |
181 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
199 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
… | |
… | |
196 | |
214 | |
197 | The I/O watcher might use the underlying file descriptor or a copy of it. |
215 | The I/O watcher might use the underlying file descriptor or a copy of it. |
198 | You must not close a file handle as long as any watcher is active on the |
216 | You must not close a file handle as long as any watcher is active on the |
199 | underlying file descriptor. |
217 | underlying file descriptor. |
200 | |
218 | |
201 | Some event loops issue spurious readyness notifications, so you should |
219 | Some event loops issue spurious readiness notifications, so you should |
202 | always use non-blocking calls when reading/writing from/to your file |
220 | always use non-blocking calls when reading/writing from/to your file |
203 | handles. |
221 | handles. |
204 | |
222 | |
205 | Example: wait for readability of STDIN, then read a line and disable the |
223 | Example: wait for readability of STDIN, then read a line and disable the |
206 | watcher. |
224 | watcher. |
… | |
… | |
211 | undef $w; |
229 | undef $w; |
212 | }); |
230 | }); |
213 | |
231 | |
214 | =head2 TIME WATCHERS |
232 | =head2 TIME WATCHERS |
215 | |
233 | |
|
|
234 | $w = AnyEvent->timer (after => <seconds>, cb => <callback>); |
|
|
235 | |
|
|
236 | $w = AnyEvent->timer ( |
|
|
237 | after => <fractional_seconds>, |
|
|
238 | interval => <fractional_seconds>, |
|
|
239 | cb => <callback>, |
|
|
240 | ); |
|
|
241 | |
216 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
242 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
217 | method with the following mandatory arguments: |
243 | method with the following mandatory arguments: |
218 | |
244 | |
219 | C<after> specifies after how many seconds (fractional values are |
245 | C<after> specifies after how many seconds (fractional values are |
220 | supported) the callback should be invoked. C<cb> is the callback to invoke |
246 | supported) the callback should be invoked. C<cb> is the callback to invoke |
… | |
… | |
222 | |
248 | |
223 | Although the callback might get passed parameters, their value and |
249 | Although the callback might get passed parameters, their value and |
224 | presence is undefined and you cannot rely on them. Portable AnyEvent |
250 | presence is undefined and you cannot rely on them. Portable AnyEvent |
225 | callbacks cannot use arguments passed to time watcher callbacks. |
251 | callbacks cannot use arguments passed to time watcher callbacks. |
226 | |
252 | |
227 | The callback will normally be invoked once only. If you specify another |
253 | The callback will normally be invoked only once. If you specify another |
228 | parameter, C<interval>, as a strictly positive number (> 0), then the |
254 | parameter, C<interval>, as a strictly positive number (> 0), then the |
229 | callback will be invoked regularly at that interval (in fractional |
255 | callback will be invoked regularly at that interval (in fractional |
230 | seconds) after the first invocation. If C<interval> is specified with a |
256 | seconds) after the first invocation. If C<interval> is specified with a |
231 | false value, then it is treated as if it were missing. |
257 | false value, then it is treated as if it were not specified at all. |
232 | |
258 | |
233 | The callback will be rescheduled before invoking the callback, but no |
259 | The callback will be rescheduled before invoking the callback, but no |
234 | attempt is done to avoid timer drift in most backends, so the interval is |
260 | attempt is made to avoid timer drift in most backends, so the interval is |
235 | only approximate. |
261 | only approximate. |
236 | |
262 | |
237 | Example: fire an event after 7.7 seconds. |
263 | Example: fire an event after 7.7 seconds. |
238 | |
264 | |
239 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
265 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
… | |
… | |
257 | |
283 | |
258 | While most event loops expect timers to specified in a relative way, they |
284 | While most event loops expect timers to specified in a relative way, they |
259 | use absolute time internally. This makes a difference when your clock |
285 | use absolute time internally. This makes a difference when your clock |
260 | "jumps", for example, when ntp decides to set your clock backwards from |
286 | "jumps", for example, when ntp decides to set your clock backwards from |
261 | the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to |
287 | the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to |
262 | fire "after" a second might actually take six years to finally fire. |
288 | fire "after a second" might actually take six years to finally fire. |
263 | |
289 | |
264 | AnyEvent cannot compensate for this. The only event loop that is conscious |
290 | AnyEvent cannot compensate for this. The only event loop that is conscious |
265 | about these issues is L<EV>, which offers both relative (ev_timer, based |
291 | of these issues is L<EV>, which offers both relative (ev_timer, based |
266 | on true relative time) and absolute (ev_periodic, based on wallclock time) |
292 | on true relative time) and absolute (ev_periodic, based on wallclock time) |
267 | timers. |
293 | timers. |
268 | |
294 | |
269 | AnyEvent always prefers relative timers, if available, matching the |
295 | AnyEvent always prefers relative timers, if available, matching the |
270 | AnyEvent API. |
296 | AnyEvent API. |
… | |
… | |
292 | I<In almost all cases (in all cases if you don't care), this is the |
318 | I<In almost all cases (in all cases if you don't care), this is the |
293 | function to call when you want to know the current time.> |
319 | function to call when you want to know the current time.> |
294 | |
320 | |
295 | This function is also often faster then C<< AnyEvent->time >>, and |
321 | This function is also often faster then C<< AnyEvent->time >>, and |
296 | thus the preferred method if you want some timestamp (for example, |
322 | thus the preferred method if you want some timestamp (for example, |
297 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
323 | L<AnyEvent::Handle> uses this to update its activity timeouts). |
298 | |
324 | |
299 | The rest of this section is only of relevance if you try to be very exact |
325 | The rest of this section is only of relevance if you try to be very exact |
300 | with your timing, you can skip it without bad conscience. |
326 | with your timing; you can skip it without a bad conscience. |
301 | |
327 | |
302 | For a practical example of when these times differ, consider L<Event::Lib> |
328 | For a practical example of when these times differ, consider L<Event::Lib> |
303 | and L<EV> and the following set-up: |
329 | and L<EV> and the following set-up: |
304 | |
330 | |
305 | The event loop is running and has just invoked one of your callback at |
331 | The event loop is running and has just invoked one of your callbacks at |
306 | time=500 (assume no other callbacks delay processing). In your callback, |
332 | time=500 (assume no other callbacks delay processing). In your callback, |
307 | you wait a second by executing C<sleep 1> (blocking the process for a |
333 | you wait a second by executing C<sleep 1> (blocking the process for a |
308 | second) and then (at time=501) you create a relative timer that fires |
334 | second) and then (at time=501) you create a relative timer that fires |
309 | after three seconds. |
335 | after three seconds. |
310 | |
336 | |
… | |
… | |
341 | might affect timers and time-outs. |
367 | might affect timers and time-outs. |
342 | |
368 | |
343 | When this is the case, you can call this method, which will update the |
369 | When this is the case, you can call this method, which will update the |
344 | event loop's idea of "current time". |
370 | event loop's idea of "current time". |
345 | |
371 | |
|
|
372 | A typical example would be a script in a web server (e.g. C<mod_perl>) - |
|
|
373 | when mod_perl executes the script, then the event loop will have the wrong |
|
|
374 | idea about the "current time" (being potentially far in the past, when the |
|
|
375 | script ran the last time). In that case you should arrange a call to C<< |
|
|
376 | AnyEvent->now_update >> each time the web server process wakes up again |
|
|
377 | (e.g. at the start of your script, or in a handler). |
|
|
378 | |
346 | Note that updating the time I<might> cause some events to be handled. |
379 | Note that updating the time I<might> cause some events to be handled. |
347 | |
380 | |
348 | =back |
381 | =back |
349 | |
382 | |
350 | =head2 SIGNAL WATCHERS |
383 | =head2 SIGNAL WATCHERS |
|
|
384 | |
|
|
385 | $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>); |
351 | |
386 | |
352 | You can watch for signals using a signal watcher, C<signal> is the signal |
387 | You can watch for signals using a signal watcher, C<signal> is the signal |
353 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
388 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
354 | callback to be invoked whenever a signal occurs. |
389 | callback to be invoked whenever a signal occurs. |
355 | |
390 | |
… | |
… | |
368 | |
403 | |
369 | This watcher might use C<%SIG> (depending on the event loop used), |
404 | This watcher might use C<%SIG> (depending on the event loop used), |
370 | so programs overwriting those signals directly will likely not work |
405 | so programs overwriting those signals directly will likely not work |
371 | correctly. |
406 | correctly. |
372 | |
407 | |
|
|
408 | Example: exit on SIGINT |
|
|
409 | |
|
|
410 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
|
|
411 | |
|
|
412 | =head3 Restart Behaviour |
|
|
413 | |
|
|
414 | While restart behaviour is up to the event loop implementation, most will |
|
|
415 | not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's |
|
|
416 | pure perl implementation). |
|
|
417 | |
|
|
418 | =head3 Safe/Unsafe Signals |
|
|
419 | |
|
|
420 | Perl signals can be either "safe" (synchronous to opcode handling) or |
|
|
421 | "unsafe" (asynchronous) - the former might get delayed indefinitely, the |
|
|
422 | latter might corrupt your memory. |
|
|
423 | |
|
|
424 | AnyEvent signal handlers are, in addition, synchronous to the event loop, |
|
|
425 | i.e. they will not interrupt your running perl program but will only be |
|
|
426 | called as part of the normal event handling (just like timer, I/O etc. |
|
|
427 | callbacks, too). |
|
|
428 | |
|
|
429 | =head3 Signal Races, Delays and Workarounds |
|
|
430 | |
373 | Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not |
431 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
374 | support attaching callbacks to signals, which is a pity, as you cannot do |
432 | callbacks to signals in a generic way, which is a pity, as you cannot |
375 | race-free signal handling in perl. AnyEvent will try to do it's best, but |
433 | do race-free signal handling in perl, requiring C libraries for |
|
|
434 | this. AnyEvent will try to do its best, which means in some cases, |
376 | in some cases, signals will be delayed. The maximum time a signal might |
435 | signals will be delayed. The maximum time a signal might be delayed is |
377 | be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 |
436 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
378 | seconds). This variable can be changed only before the first signal |
437 | variable can be changed only before the first signal watcher is created, |
379 | watcher is created, and should be left alone otherwise. Higher values |
438 | and should be left alone otherwise. This variable determines how often |
|
|
439 | AnyEvent polls for signals (in case a wake-up was missed). Higher values |
380 | will cause fewer spurious wake-ups, which is better for power and CPU |
440 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
441 | saving. |
|
|
442 | |
381 | saving. All these problems can be avoided by installing the optional |
443 | All these problems can be avoided by installing the optional |
382 | L<Async::Interrupt> module. |
444 | L<Async::Interrupt> module, which works with most event loops. It will not |
383 | |
445 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
384 | Example: exit on SIGINT |
446 | (and not with L<POE> currently, as POE does its own workaround with |
385 | |
447 | one-second latency). For those, you just have to suffer the delays. |
386 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
|
|
387 | |
448 | |
388 | =head2 CHILD PROCESS WATCHERS |
449 | =head2 CHILD PROCESS WATCHERS |
389 | |
450 | |
|
|
451 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
|
|
452 | |
390 | You can also watch on a child process exit and catch its exit status. |
453 | You can also watch for a child process exit and catch its exit status. |
391 | |
454 | |
392 | The child process is specified by the C<pid> argument (if set to C<0>, it |
455 | The child process is specified by the C<pid> argument (on some backends, |
393 | watches for any child process exit). The watcher will triggered only when |
456 | using C<0> watches for any child process exit, on others this will |
394 | the child process has finished and an exit status is available, not on |
457 | croak). The watcher will be triggered only when the child process has |
395 | any trace events (stopped/continued). |
458 | finished and an exit status is available, not on any trace events |
|
|
459 | (stopped/continued). |
396 | |
460 | |
397 | The callback will be called with the pid and exit status (as returned by |
461 | The callback will be called with the pid and exit status (as returned by |
398 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
462 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
399 | callback arguments. |
463 | callback arguments. |
400 | |
464 | |
… | |
… | |
441 | # do something else, then wait for process exit |
505 | # do something else, then wait for process exit |
442 | $done->recv; |
506 | $done->recv; |
443 | |
507 | |
444 | =head2 IDLE WATCHERS |
508 | =head2 IDLE WATCHERS |
445 | |
509 | |
446 | Sometimes there is a need to do something, but it is not so important |
510 | $w = AnyEvent->idle (cb => <callback>); |
447 | to do it instantly, but only when there is nothing better to do. This |
|
|
448 | "nothing better to do" is usually defined to be "no other events need |
|
|
449 | attention by the event loop". |
|
|
450 | |
511 | |
451 | Idle watchers ideally get invoked when the event loop has nothing |
512 | This will repeatedly invoke the callback after the process becomes idle, |
452 | better to do, just before it would block the process to wait for new |
513 | until either the watcher is destroyed or new events have been detected. |
453 | events. Instead of blocking, the idle watcher is invoked. |
|
|
454 | |
514 | |
455 | Most event loops unfortunately do not really support idle watchers (only |
515 | Idle watchers are useful when there is a need to do something, but it |
|
|
516 | is not so important (or wise) to do it instantly. The callback will be |
|
|
517 | invoked only when there is "nothing better to do", which is usually |
|
|
518 | defined as "all outstanding events have been handled and no new events |
|
|
519 | have been detected". That means that idle watchers ideally get invoked |
|
|
520 | when the event loop has just polled for new events but none have been |
|
|
521 | detected. Instead of blocking to wait for more events, the idle watchers |
|
|
522 | will be invoked. |
|
|
523 | |
|
|
524 | Unfortunately, most event loops do not really support idle watchers (only |
456 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
525 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
457 | will simply call the callback "from time to time". |
526 | will simply call the callback "from time to time". |
458 | |
527 | |
459 | Example: read lines from STDIN, but only process them when the |
528 | Example: read lines from STDIN, but only process them when the |
460 | program is otherwise idle: |
529 | program is otherwise idle: |
… | |
… | |
476 | }); |
545 | }); |
477 | }); |
546 | }); |
478 | |
547 | |
479 | =head2 CONDITION VARIABLES |
548 | =head2 CONDITION VARIABLES |
480 | |
549 | |
|
|
550 | $cv = AnyEvent->condvar; |
|
|
551 | |
|
|
552 | $cv->send (<list>); |
|
|
553 | my @res = $cv->recv; |
|
|
554 | |
481 | If you are familiar with some event loops you will know that all of them |
555 | If you are familiar with some event loops you will know that all of them |
482 | require you to run some blocking "loop", "run" or similar function that |
556 | require you to run some blocking "loop", "run" or similar function that |
483 | will actively watch for new events and call your callbacks. |
557 | will actively watch for new events and call your callbacks. |
484 | |
558 | |
485 | AnyEvent is slightly different: it expects somebody else to run the event |
559 | AnyEvent is slightly different: it expects somebody else to run the event |
486 | loop and will only block when necessary (usually when told by the user). |
560 | loop and will only block when necessary (usually when told by the user). |
487 | |
561 | |
488 | The instrument to do that is called a "condition variable", so called |
562 | The tool to do that is called a "condition variable", so called because |
489 | because they represent a condition that must become true. |
563 | they represent a condition that must become true. |
490 | |
564 | |
491 | Now is probably a good time to look at the examples further below. |
565 | Now is probably a good time to look at the examples further below. |
492 | |
566 | |
493 | Condition variables can be created by calling the C<< AnyEvent->condvar |
567 | Condition variables can be created by calling the C<< AnyEvent->condvar |
494 | >> method, usually without arguments. The only argument pair allowed is |
568 | >> method, usually without arguments. The only argument pair allowed is |
… | |
… | |
499 | After creation, the condition variable is "false" until it becomes "true" |
573 | After creation, the condition variable is "false" until it becomes "true" |
500 | by calling the C<send> method (or calling the condition variable as if it |
574 | by calling the C<send> method (or calling the condition variable as if it |
501 | were a callback, read about the caveats in the description for the C<< |
575 | were a callback, read about the caveats in the description for the C<< |
502 | ->send >> method). |
576 | ->send >> method). |
503 | |
577 | |
504 | Condition variables are similar to callbacks, except that you can |
578 | Since condition variables are the most complex part of the AnyEvent API, here are |
505 | optionally wait for them. They can also be called merge points - points |
579 | some different mental models of what they are - pick the ones you can connect to: |
506 | in time where multiple outstanding events have been processed. And yet |
580 | |
507 | another way to call them is transactions - each condition variable can be |
581 | =over 4 |
508 | used to represent a transaction, which finishes at some point and delivers |
582 | |
509 | a result. |
583 | =item * Condition variables are like callbacks - you can call them (and pass them instead |
|
|
584 | of callbacks). Unlike callbacks however, you can also wait for them to be called. |
|
|
585 | |
|
|
586 | =item * Condition variables are signals - one side can emit or send them, |
|
|
587 | the other side can wait for them, or install a handler that is called when |
|
|
588 | the signal fires. |
|
|
589 | |
|
|
590 | =item * Condition variables are like "Merge Points" - points in your program |
|
|
591 | where you merge multiple independent results/control flows into one. |
|
|
592 | |
|
|
593 | =item * Condition variables represent a transaction - functions that start |
|
|
594 | some kind of transaction can return them, leaving the caller the choice |
|
|
595 | between waiting in a blocking fashion, or setting a callback. |
|
|
596 | |
|
|
597 | =item * Condition variables represent future values, or promises to deliver |
|
|
598 | some result, long before the result is available. |
|
|
599 | |
|
|
600 | =back |
510 | |
601 | |
511 | Condition variables are very useful to signal that something has finished, |
602 | Condition variables are very useful to signal that something has finished, |
512 | for example, if you write a module that does asynchronous http requests, |
603 | for example, if you write a module that does asynchronous http requests, |
513 | then a condition variable would be the ideal candidate to signal the |
604 | then a condition variable would be the ideal candidate to signal the |
514 | availability of results. The user can either act when the callback is |
605 | availability of results. The user can either act when the callback is |
… | |
… | |
527 | |
618 | |
528 | Condition variables are represented by hash refs in perl, and the keys |
619 | Condition variables are represented by hash refs in perl, and the keys |
529 | used by AnyEvent itself are all named C<_ae_XXX> to make subclassing |
620 | used by AnyEvent itself are all named C<_ae_XXX> to make subclassing |
530 | easy (it is often useful to build your own transaction class on top of |
621 | easy (it is often useful to build your own transaction class on top of |
531 | AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call |
622 | AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call |
532 | it's C<new> method in your own C<new> method. |
623 | its C<new> method in your own C<new> method. |
533 | |
624 | |
534 | There are two "sides" to a condition variable - the "producer side" which |
625 | There are two "sides" to a condition variable - the "producer side" which |
535 | eventually calls C<< -> send >>, and the "consumer side", which waits |
626 | eventually calls C<< -> send >>, and the "consumer side", which waits |
536 | for the send to occur. |
627 | for the send to occur. |
537 | |
628 | |
538 | Example: wait for a timer. |
629 | Example: wait for a timer. |
539 | |
630 | |
540 | # wait till the result is ready |
631 | # condition: "wait till the timer is fired" |
541 | my $result_ready = AnyEvent->condvar; |
632 | my $timer_fired = AnyEvent->condvar; |
542 | |
633 | |
543 | # do something such as adding a timer |
634 | # create the timer - we could wait for, say |
544 | # or socket watcher the calls $result_ready->send |
635 | # a handle becomign ready, or even an |
545 | # when the "result" is ready. |
636 | # AnyEvent::HTTP request to finish, but |
546 | # in this case, we simply use a timer: |
637 | # in this case, we simply use a timer: |
547 | my $w = AnyEvent->timer ( |
638 | my $w = AnyEvent->timer ( |
548 | after => 1, |
639 | after => 1, |
549 | cb => sub { $result_ready->send }, |
640 | cb => sub { $timer_fired->send }, |
550 | ); |
641 | ); |
551 | |
642 | |
552 | # this "blocks" (while handling events) till the callback |
643 | # this "blocks" (while handling events) till the callback |
553 | # calls -<send |
644 | # calls ->send |
554 | $result_ready->recv; |
645 | $timer_fired->recv; |
555 | |
646 | |
556 | Example: wait for a timer, but take advantage of the fact that condition |
647 | Example: wait for a timer, but take advantage of the fact that condition |
557 | variables are also callable directly. |
648 | variables are also callable directly. |
558 | |
649 | |
559 | my $done = AnyEvent->condvar; |
650 | my $done = AnyEvent->condvar; |
… | |
… | |
602 | they were a code reference). Calling them directly is the same as calling |
693 | they were a code reference). Calling them directly is the same as calling |
603 | C<send>. |
694 | C<send>. |
604 | |
695 | |
605 | =item $cv->croak ($error) |
696 | =item $cv->croak ($error) |
606 | |
697 | |
607 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
698 | Similar to send, but causes all calls to C<< ->recv >> to invoke |
608 | C<Carp::croak> with the given error message/object/scalar. |
699 | C<Carp::croak> with the given error message/object/scalar. |
609 | |
700 | |
610 | This can be used to signal any errors to the condition variable |
701 | This can be used to signal any errors to the condition variable |
611 | user/consumer. Doing it this way instead of calling C<croak> directly |
702 | user/consumer. Doing it this way instead of calling C<croak> directly |
612 | delays the error detetcion, but has the overwhelmign advantage that it |
703 | delays the error detection, but has the overwhelming advantage that it |
613 | diagnoses the error at the place where the result is expected, and not |
704 | diagnoses the error at the place where the result is expected, and not |
614 | deep in some event clalback without connection to the actual code causing |
705 | deep in some event callback with no connection to the actual code causing |
615 | the problem. |
706 | the problem. |
616 | |
707 | |
617 | =item $cv->begin ([group callback]) |
708 | =item $cv->begin ([group callback]) |
618 | |
709 | |
619 | =item $cv->end |
710 | =item $cv->end |
… | |
… | |
622 | one. For example, a function that pings many hosts in parallel might want |
713 | one. For example, a function that pings many hosts in parallel might want |
623 | to use a condition variable for the whole process. |
714 | to use a condition variable for the whole process. |
624 | |
715 | |
625 | Every call to C<< ->begin >> will increment a counter, and every call to |
716 | Every call to C<< ->begin >> will increment a counter, and every call to |
626 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
717 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
627 | >>, the (last) callback passed to C<begin> will be executed. That callback |
718 | >>, the (last) callback passed to C<begin> will be executed, passing the |
628 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
719 | condvar as first argument. That callback is I<supposed> to call C<< ->send |
629 | callback was set, C<send> will be called without any arguments. |
720 | >>, but that is not required. If no group callback was set, C<send> will |
|
|
721 | be called without any arguments. |
630 | |
722 | |
631 | You can think of C<< $cv->send >> giving you an OR condition (one call |
723 | You can think of C<< $cv->send >> giving you an OR condition (one call |
632 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
724 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
633 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
725 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
634 | |
726 | |
… | |
… | |
656 | one call to C<begin>, so the condvar waits for all calls to C<end> before |
748 | one call to C<begin>, so the condvar waits for all calls to C<end> before |
657 | sending. |
749 | sending. |
658 | |
750 | |
659 | The ping example mentioned above is slightly more complicated, as the |
751 | The ping example mentioned above is slightly more complicated, as the |
660 | there are results to be passwd back, and the number of tasks that are |
752 | there are results to be passwd back, and the number of tasks that are |
661 | begung can potentially be zero: |
753 | begun can potentially be zero: |
662 | |
754 | |
663 | my $cv = AnyEvent->condvar; |
755 | my $cv = AnyEvent->condvar; |
664 | |
756 | |
665 | my %result; |
757 | my %result; |
666 | $cv->begin (sub { $cv->send (\%result) }); |
758 | $cv->begin (sub { shift->send (\%result) }); |
667 | |
759 | |
668 | for my $host (@list_of_hosts) { |
760 | for my $host (@list_of_hosts) { |
669 | $cv->begin; |
761 | $cv->begin; |
670 | ping_host_then_call_callback $host, sub { |
762 | ping_host_then_call_callback $host, sub { |
671 | $result{$host} = ...; |
763 | $result{$host} = ...; |
… | |
… | |
687 | to be called once the counter reaches C<0>, and second, it ensures that |
779 | to be called once the counter reaches C<0>, and second, it ensures that |
688 | C<send> is called even when C<no> hosts are being pinged (the loop |
780 | C<send> is called even when C<no> hosts are being pinged (the loop |
689 | doesn't execute once). |
781 | doesn't execute once). |
690 | |
782 | |
691 | This is the general pattern when you "fan out" into multiple (but |
783 | This is the general pattern when you "fan out" into multiple (but |
692 | potentially none) subrequests: use an outer C<begin>/C<end> pair to set |
784 | potentially zero) subrequests: use an outer C<begin>/C<end> pair to set |
693 | the callback and ensure C<end> is called at least once, and then, for each |
785 | the callback and ensure C<end> is called at least once, and then, for each |
694 | subrequest you start, call C<begin> and for each subrequest you finish, |
786 | subrequest you start, call C<begin> and for each subrequest you finish, |
695 | call C<end>. |
787 | call C<end>. |
696 | |
788 | |
697 | =back |
789 | =back |
… | |
… | |
704 | =over 4 |
796 | =over 4 |
705 | |
797 | |
706 | =item $cv->recv |
798 | =item $cv->recv |
707 | |
799 | |
708 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
800 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
709 | >> methods have been called on c<$cv>, while servicing other watchers |
801 | >> methods have been called on C<$cv>, while servicing other watchers |
710 | normally. |
802 | normally. |
711 | |
803 | |
712 | You can only wait once on a condition - additional calls are valid but |
804 | You can only wait once on a condition - additional calls are valid but |
713 | will return immediately. |
805 | will return immediately. |
714 | |
806 | |
… | |
… | |
731 | caller decide whether the call will block or not (for example, by coupling |
823 | caller decide whether the call will block or not (for example, by coupling |
732 | condition variables with some kind of request results and supporting |
824 | condition variables with some kind of request results and supporting |
733 | callbacks so the caller knows that getting the result will not block, |
825 | callbacks so the caller knows that getting the result will not block, |
734 | while still supporting blocking waits if the caller so desires). |
826 | while still supporting blocking waits if the caller so desires). |
735 | |
827 | |
736 | You can ensure that C<< -recv >> never blocks by setting a callback and |
828 | You can ensure that C<< ->recv >> never blocks by setting a callback and |
737 | only calling C<< ->recv >> from within that callback (or at a later |
829 | only calling C<< ->recv >> from within that callback (or at a later |
738 | time). This will work even when the event loop does not support blocking |
830 | time). This will work even when the event loop does not support blocking |
739 | waits otherwise. |
831 | waits otherwise. |
740 | |
832 | |
741 | =item $bool = $cv->ready |
833 | =item $bool = $cv->ready |
… | |
… | |
747 | |
839 | |
748 | This is a mutator function that returns the callback set and optionally |
840 | This is a mutator function that returns the callback set and optionally |
749 | replaces it before doing so. |
841 | replaces it before doing so. |
750 | |
842 | |
751 | The callback will be called when the condition becomes "true", i.e. when |
843 | The callback will be called when the condition becomes "true", i.e. when |
752 | C<send> or C<croak> are called, with the only argument being the condition |
844 | C<send> or C<croak> are called, with the only argument being the |
753 | variable itself. Calling C<recv> inside the callback or at any later time |
845 | condition variable itself. If the condition is already true, the |
754 | is guaranteed not to block. |
846 | callback is called immediately when it is set. Calling C<recv> inside |
|
|
847 | the callback or at any later time is guaranteed not to block. |
755 | |
848 | |
756 | =back |
849 | =back |
757 | |
850 | |
758 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
851 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
759 | |
852 | |
… | |
… | |
762 | =over 4 |
855 | =over 4 |
763 | |
856 | |
764 | =item Backends that are autoprobed when no other event loop can be found. |
857 | =item Backends that are autoprobed when no other event loop can be found. |
765 | |
858 | |
766 | EV is the preferred backend when no other event loop seems to be in |
859 | EV is the preferred backend when no other event loop seems to be in |
767 | use. If EV is not installed, then AnyEvent will try Event, and, failing |
860 | use. If EV is not installed, then AnyEvent will fall back to its own |
768 | that, will fall back to its own pure-perl implementation, which is |
861 | pure-perl implementation, which is available everywhere as it comes with |
769 | available everywhere as it comes with AnyEvent itself. |
862 | AnyEvent itself. |
770 | |
863 | |
771 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
864 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
772 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
773 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
865 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
774 | |
866 | |
775 | =item Backends that are transparently being picked up when they are used. |
867 | =item Backends that are transparently being picked up when they are used. |
776 | |
868 | |
777 | These will be used when they are currently loaded when the first watcher |
869 | These will be used if they are already loaded when the first watcher |
778 | is created, in which case it is assumed that the application is using |
870 | is created, in which case it is assumed that the application is using |
779 | them. This means that AnyEvent will automatically pick the right backend |
871 | them. This means that AnyEvent will automatically pick the right backend |
780 | when the main program loads an event module before anything starts to |
872 | when the main program loads an event module before anything starts to |
781 | create watchers. Nothing special needs to be done by the main program. |
873 | create watchers. Nothing special needs to be done by the main program. |
782 | |
874 | |
|
|
875 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
783 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
876 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
784 | AnyEvent::Impl::Tk based on Tk, very broken. |
877 | AnyEvent::Impl::Tk based on Tk, very broken. |
785 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
786 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
880 | AnyEvent::Impl::Irssi used when running within irssi. |
787 | |
881 | |
788 | =item Backends with special needs. |
882 | =item Backends with special needs. |
789 | |
883 | |
790 | Qt requires the Qt::Application to be instantiated first, but will |
884 | Qt requires the Qt::Application to be instantiated first, but will |
791 | otherwise be picked up automatically. As long as the main program |
885 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
796 | |
890 | |
797 | Support for IO::Async can only be partial, as it is too broken and |
891 | Support for IO::Async can only be partial, as it is too broken and |
798 | architecturally limited to even support the AnyEvent API. It also |
892 | architecturally limited to even support the AnyEvent API. It also |
799 | is the only event loop that needs the loop to be set explicitly, so |
893 | is the only event loop that needs the loop to be set explicitly, so |
800 | it can only be used by a main program knowing about AnyEvent. See |
894 | it can only be used by a main program knowing about AnyEvent. See |
801 | L<AnyEvent::Impl::Async> for the gory details. |
895 | L<AnyEvent::Impl::IOAsync> for the gory details. |
802 | |
896 | |
803 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
897 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
804 | |
898 | |
805 | =item Event loops that are indirectly supported via other backends. |
899 | =item Event loops that are indirectly supported via other backends. |
806 | |
900 | |
… | |
… | |
834 | Contains C<undef> until the first watcher is being created, before the |
928 | Contains C<undef> until the first watcher is being created, before the |
835 | backend has been autodetected. |
929 | backend has been autodetected. |
836 | |
930 | |
837 | Afterwards it contains the event model that is being used, which is the |
931 | Afterwards it contains the event model that is being used, which is the |
838 | name of the Perl class implementing the model. This class is usually one |
932 | name of the Perl class implementing the model. This class is usually one |
839 | of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the |
933 | of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the |
840 | case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it |
934 | case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it |
841 | will be C<urxvt::anyevent>). |
935 | will be C<urxvt::anyevent>). |
842 | |
936 | |
843 | =item AnyEvent::detect |
937 | =item AnyEvent::detect |
844 | |
938 | |
845 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
939 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
846 | if necessary. You should only call this function right before you would |
940 | if necessary. You should only call this function right before you would |
847 | have created an AnyEvent watcher anyway, that is, as late as possible at |
941 | have created an AnyEvent watcher anyway, that is, as late as possible at |
848 | runtime, and not e.g. while initialising of your module. |
942 | runtime, and not e.g. during initialisation of your module. |
849 | |
943 | |
850 | If you need to do some initialisation before AnyEvent watchers are |
944 | If you need to do some initialisation before AnyEvent watchers are |
851 | created, use C<post_detect>. |
945 | created, use C<post_detect>. |
852 | |
946 | |
853 | =item $guard = AnyEvent::post_detect { BLOCK } |
947 | =item $guard = AnyEvent::post_detect { BLOCK } |
854 | |
948 | |
855 | Arranges for the code block to be executed as soon as the event model is |
949 | Arranges for the code block to be executed as soon as the event model is |
856 | autodetected (or immediately if this has already happened). |
950 | autodetected (or immediately if that has already happened). |
857 | |
951 | |
858 | The block will be executed I<after> the actual backend has been detected |
952 | The block will be executed I<after> the actual backend has been detected |
859 | (C<$AnyEvent::MODEL> is set), but I<before> any watchers have been |
953 | (C<$AnyEvent::MODEL> is set), but I<before> any watchers have been |
860 | created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do |
954 | created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do |
861 | other initialisations - see the sources of L<AnyEvent::Strict> or |
955 | other initialisations - see the sources of L<AnyEvent::Strict> or |
… | |
… | |
865 | event module detection too early, for example, L<AnyEvent::AIO> creates |
959 | event module detection too early, for example, L<AnyEvent::AIO> creates |
866 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
960 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
867 | avoid autodetecting the event module at load time. |
961 | avoid autodetecting the event module at load time. |
868 | |
962 | |
869 | If called in scalar or list context, then it creates and returns an object |
963 | If called in scalar or list context, then it creates and returns an object |
870 | that automatically removes the callback again when it is destroyed. See |
964 | that automatically removes the callback again when it is destroyed (or |
|
|
965 | C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for |
871 | L<Coro::BDB> for a case where this is useful. |
966 | a case where this is useful. |
|
|
967 | |
|
|
968 | Example: Create a watcher for the IO::AIO module and store it in |
|
|
969 | C<$WATCHER>, but do so only do so after the event loop is initialised. |
|
|
970 | |
|
|
971 | our WATCHER; |
|
|
972 | |
|
|
973 | my $guard = AnyEvent::post_detect { |
|
|
974 | $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); |
|
|
975 | }; |
|
|
976 | |
|
|
977 | # the ||= is important in case post_detect immediately runs the block, |
|
|
978 | # as to not clobber the newly-created watcher. assigning both watcher and |
|
|
979 | # post_detect guard to the same variable has the advantage of users being |
|
|
980 | # able to just C<undef $WATCHER> if the watcher causes them grief. |
|
|
981 | |
|
|
982 | $WATCHER ||= $guard; |
872 | |
983 | |
873 | =item @AnyEvent::post_detect |
984 | =item @AnyEvent::post_detect |
874 | |
985 | |
875 | If there are any code references in this array (you can C<push> to it |
986 | If there are any code references in this array (you can C<push> to it |
876 | before or after loading AnyEvent), then they will called directly after |
987 | before or after loading AnyEvent), then they will be called directly |
877 | the event loop has been chosen. |
988 | after the event loop has been chosen. |
878 | |
989 | |
879 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
990 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
880 | if it is defined then the event loop has already been detected, and the |
991 | if it is defined then the event loop has already been detected, and the |
881 | array will be ignored. |
992 | array will be ignored. |
882 | |
993 | |
883 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
994 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
884 | it,as it takes care of these details. |
995 | it, as it takes care of these details. |
885 | |
996 | |
886 | This variable is mainly useful for modules that can do something useful |
997 | This variable is mainly useful for modules that can do something useful |
887 | when AnyEvent is used and thus want to know when it is initialised, but do |
998 | when AnyEvent is used and thus want to know when it is initialised, but do |
888 | not need to even load it by default. This array provides the means to hook |
999 | not need to even load it by default. This array provides the means to hook |
889 | into AnyEvent passively, without loading it. |
1000 | into AnyEvent passively, without loading it. |
890 | |
1001 | |
|
|
1002 | Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used |
|
|
1003 | together, you could put this into Coro (this is the actual code used by |
|
|
1004 | Coro to accomplish this): |
|
|
1005 | |
|
|
1006 | if (defined $AnyEvent::MODEL) { |
|
|
1007 | # AnyEvent already initialised, so load Coro::AnyEvent |
|
|
1008 | require Coro::AnyEvent; |
|
|
1009 | } else { |
|
|
1010 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
|
|
1011 | # as soon as it is |
|
|
1012 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
|
|
1013 | } |
|
|
1014 | |
891 | =back |
1015 | =back |
892 | |
1016 | |
893 | =head1 WHAT TO DO IN A MODULE |
1017 | =head1 WHAT TO DO IN A MODULE |
894 | |
1018 | |
895 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
1019 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
905 | because it will stall the whole program, and the whole point of using |
1029 | because it will stall the whole program, and the whole point of using |
906 | events is to stay interactive. |
1030 | events is to stay interactive. |
907 | |
1031 | |
908 | It is fine, however, to call C<< ->recv >> when the user of your module |
1032 | It is fine, however, to call C<< ->recv >> when the user of your module |
909 | requests it (i.e. if you create a http request object ad have a method |
1033 | requests it (i.e. if you create a http request object ad have a method |
910 | called C<results> that returns the results, it should call C<< ->recv >> |
1034 | called C<results> that returns the results, it may call C<< ->recv >> |
911 | freely, as the user of your module knows what she is doing. always). |
1035 | freely, as the user of your module knows what she is doing. Always). |
912 | |
1036 | |
913 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
1037 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
914 | |
1038 | |
915 | There will always be a single main program - the only place that should |
1039 | There will always be a single main program - the only place that should |
916 | dictate which event model to use. |
1040 | dictate which event model to use. |
917 | |
1041 | |
918 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
1042 | If the program is not event-based, it need not do anything special, even |
919 | do anything special (it does not need to be event-based) and let AnyEvent |
1043 | when it depends on a module that uses an AnyEvent. If the program itself |
920 | decide which implementation to chose if some module relies on it. |
1044 | uses AnyEvent, but does not care which event loop is used, all it needs |
|
|
1045 | to do is C<use AnyEvent>. In either case, AnyEvent will choose the best |
|
|
1046 | available loop implementation. |
921 | |
1047 | |
922 | If the main program relies on a specific event model - for example, in |
1048 | If the main program relies on a specific event model - for example, in |
923 | Gtk2 programs you have to rely on the Glib module - you should load the |
1049 | Gtk2 programs you have to rely on the Glib module - you should load the |
924 | event module before loading AnyEvent or any module that uses it: generally |
1050 | event module before loading AnyEvent or any module that uses it: generally |
925 | speaking, you should load it as early as possible. The reason is that |
1051 | speaking, you should load it as early as possible. The reason is that |
926 | modules might create watchers when they are loaded, and AnyEvent will |
1052 | modules might create watchers when they are loaded, and AnyEvent will |
927 | decide on the event model to use as soon as it creates watchers, and it |
1053 | decide on the event model to use as soon as it creates watchers, and it |
928 | might chose the wrong one unless you load the correct one yourself. |
1054 | might choose the wrong one unless you load the correct one yourself. |
929 | |
1055 | |
930 | You can chose to use a pure-perl implementation by loading the |
1056 | You can chose to use a pure-perl implementation by loading the |
931 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
1057 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
932 | everywhere, but letting AnyEvent chose the model is generally better. |
1058 | everywhere, but letting AnyEvent chose the model is generally better. |
933 | |
1059 | |
… | |
… | |
951 | =head1 OTHER MODULES |
1077 | =head1 OTHER MODULES |
952 | |
1078 | |
953 | The following is a non-exhaustive list of additional modules that use |
1079 | The following is a non-exhaustive list of additional modules that use |
954 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
1080 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
955 | modules and other event loops in the same program. Some of the modules |
1081 | modules and other event loops in the same program. Some of the modules |
956 | come with AnyEvent, most are available via CPAN. |
1082 | come as part of AnyEvent, the others are available via CPAN. |
957 | |
1083 | |
958 | =over 4 |
1084 | =over 4 |
959 | |
1085 | |
960 | =item L<AnyEvent::Util> |
1086 | =item L<AnyEvent::Util> |
961 | |
1087 | |
962 | Contains various utility functions that replace often-used but blocking |
1088 | Contains various utility functions that replace often-used blocking |
963 | functions such as C<inet_aton> by event-/callback-based versions. |
1089 | functions such as C<inet_aton> with event/callback-based versions. |
964 | |
1090 | |
965 | =item L<AnyEvent::Socket> |
1091 | =item L<AnyEvent::Socket> |
966 | |
1092 | |
967 | Provides various utility functions for (internet protocol) sockets, |
1093 | Provides various utility functions for (internet protocol) sockets, |
968 | addresses and name resolution. Also functions to create non-blocking tcp |
1094 | addresses and name resolution. Also functions to create non-blocking tcp |
… | |
… | |
970 | |
1096 | |
971 | =item L<AnyEvent::Handle> |
1097 | =item L<AnyEvent::Handle> |
972 | |
1098 | |
973 | Provide read and write buffers, manages watchers for reads and writes, |
1099 | Provide read and write buffers, manages watchers for reads and writes, |
974 | supports raw and formatted I/O, I/O queued and fully transparent and |
1100 | supports raw and formatted I/O, I/O queued and fully transparent and |
975 | non-blocking SSL/TLS (via L<AnyEvent::TLS>. |
1101 | non-blocking SSL/TLS (via L<AnyEvent::TLS>). |
976 | |
1102 | |
977 | =item L<AnyEvent::DNS> |
1103 | =item L<AnyEvent::DNS> |
978 | |
1104 | |
979 | Provides rich asynchronous DNS resolver capabilities. |
1105 | Provides rich asynchronous DNS resolver capabilities. |
980 | |
1106 | |
|
|
1107 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
|
|
1108 | |
|
|
1109 | Implement event-based interfaces to the protocols of the same name (for |
|
|
1110 | the curious, IGS is the International Go Server and FCP is the Freenet |
|
|
1111 | Client Protocol). |
|
|
1112 | |
|
|
1113 | =item L<AnyEvent::Handle::UDP> |
|
|
1114 | |
|
|
1115 | Here be danger! |
|
|
1116 | |
|
|
1117 | As Pauli would put it, "Not only is it not right, it's not even wrong!" - |
|
|
1118 | there are so many things wrong with AnyEvent::Handle::UDP, most notably |
|
|
1119 | its use of a stream-based API with a protocol that isn't streamable, that |
|
|
1120 | the only way to improve it is to delete it. |
|
|
1121 | |
|
|
1122 | It features data corruption (but typically only under load) and general |
|
|
1123 | confusion. On top, the author is not only clueless about UDP but also |
|
|
1124 | fact-resistant - some gems of his understanding: "connect doesn't work |
|
|
1125 | with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not |
|
|
1126 | packets", "I don't need to implement proper error checking as UDP doesn't |
|
|
1127 | support error checking" and so on - he doesn't even understand what's |
|
|
1128 | wrong with his module when it is explained to him. |
|
|
1129 | |
981 | =item L<AnyEvent::HTTP> |
1130 | =item L<AnyEvent::DBI> |
982 | |
1131 | |
983 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
1132 | Executes L<DBI> requests asynchronously in a proxy process for you, |
984 | HTTP requests. |
1133 | notifying you in an event-based way when the operation is finished. |
|
|
1134 | |
|
|
1135 | =item L<AnyEvent::AIO> |
|
|
1136 | |
|
|
1137 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
|
|
1138 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
|
|
1139 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
|
|
1140 | file I/O, and much more. |
985 | |
1141 | |
986 | =item L<AnyEvent::HTTPD> |
1142 | =item L<AnyEvent::HTTPD> |
987 | |
1143 | |
988 | Provides a simple web application server framework. |
1144 | A simple embedded webserver. |
989 | |
1145 | |
990 | =item L<AnyEvent::FastPing> |
1146 | =item L<AnyEvent::FastPing> |
991 | |
1147 | |
992 | The fastest ping in the west. |
1148 | The fastest ping in the west. |
993 | |
|
|
994 | =item L<AnyEvent::DBI> |
|
|
995 | |
|
|
996 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
997 | |
|
|
998 | =item L<AnyEvent::AIO> |
|
|
999 | |
|
|
1000 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
1001 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
1002 | together. |
|
|
1003 | |
|
|
1004 | =item L<AnyEvent::BDB> |
|
|
1005 | |
|
|
1006 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
1007 | L<BDB> and AnyEvent together. |
|
|
1008 | |
|
|
1009 | =item L<AnyEvent::GPSD> |
|
|
1010 | |
|
|
1011 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
1012 | |
|
|
1013 | =item L<AnyEvent::IRC> |
|
|
1014 | |
|
|
1015 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
1016 | |
|
|
1017 | =item L<AnyEvent::XMPP> |
|
|
1018 | |
|
|
1019 | AnyEvent based XMPP (Jabber protocol) module family (replacing the older |
|
|
1020 | Net::XMPP2>. |
|
|
1021 | |
|
|
1022 | =item L<AnyEvent::IGS> |
|
|
1023 | |
|
|
1024 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
1025 | L<App::IGS>). |
|
|
1026 | |
|
|
1027 | =item L<Net::FCP> |
|
|
1028 | |
|
|
1029 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
|
|
1030 | of AnyEvent. |
|
|
1031 | |
|
|
1032 | =item L<Event::ExecFlow> |
|
|
1033 | |
|
|
1034 | High level API for event-based execution flow control. |
|
|
1035 | |
1149 | |
1036 | =item L<Coro> |
1150 | =item L<Coro> |
1037 | |
1151 | |
1038 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1152 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1039 | |
1153 | |
… | |
… | |
1043 | |
1157 | |
1044 | package AnyEvent; |
1158 | package AnyEvent; |
1045 | |
1159 | |
1046 | # basically a tuned-down version of common::sense |
1160 | # basically a tuned-down version of common::sense |
1047 | sub common_sense { |
1161 | sub common_sense { |
1048 | # no warnings |
1162 | # from common:.sense 3.3 |
1049 | ${^WARNING_BITS} ^= ${^WARNING_BITS}; |
1163 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; |
1050 | # use strict vars subs |
1164 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1051 | $^H |= 0x00000600; |
1165 | $^H |= 0x00000600; |
1052 | } |
1166 | } |
1053 | |
1167 | |
1054 | BEGIN { AnyEvent::common_sense } |
1168 | BEGIN { AnyEvent::common_sense } |
1055 | |
1169 | |
1056 | use Carp (); |
1170 | use Carp (); |
1057 | |
1171 | |
1058 | our $VERSION = 4.85; |
1172 | our $VERSION = '5.29'; |
1059 | our $MODEL; |
1173 | our $MODEL; |
1060 | |
1174 | |
1061 | our $AUTOLOAD; |
1175 | our $AUTOLOAD; |
1062 | our @ISA; |
1176 | our @ISA; |
1063 | |
1177 | |
1064 | our @REGISTRY; |
1178 | our @REGISTRY; |
1065 | |
1179 | |
1066 | our $WIN32; |
|
|
1067 | |
|
|
1068 | our $VERBOSE; |
1180 | our $VERBOSE; |
1069 | |
1181 | |
1070 | BEGIN { |
1182 | BEGIN { |
1071 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1183 | require "AnyEvent/constants.pl"; |
|
|
1184 | |
1072 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1185 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1073 | |
1186 | |
1074 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1187 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1075 | if ${^TAINT}; |
1188 | if ${^TAINT}; |
1076 | |
1189 | |
1077 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1190 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
… | |
… | |
1088 | for reverse split /\s*,\s*/, |
1201 | for reverse split /\s*,\s*/, |
1089 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1202 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1090 | } |
1203 | } |
1091 | |
1204 | |
1092 | my @models = ( |
1205 | my @models = ( |
1093 | [EV:: => AnyEvent::Impl::EV::], |
1206 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1094 | [Event:: => AnyEvent::Impl::Event::], |
|
|
1095 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1207 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1096 | # everything below here will not be autoprobed |
1208 | # everything below here will not (normally) be autoprobed |
1097 | # as the pureperl backend should work everywhere |
1209 | # as the pureperl backend should work everywhere |
1098 | # and is usually faster |
1210 | # and is usually faster |
|
|
1211 | [Event:: => AnyEvent::Impl::Event::, 1], |
1099 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
1212 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1100 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1213 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1214 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1101 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1215 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1102 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1216 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1103 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1217 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1104 | [Wx:: => AnyEvent::Impl::POE::], |
1218 | [Wx:: => AnyEvent::Impl::POE::], |
1105 | [Prima:: => AnyEvent::Impl::POE::], |
1219 | [Prima:: => AnyEvent::Impl::POE::], |
1106 | # IO::Async is just too broken - we would need workarounds for its |
1220 | # IO::Async is just too broken - we would need workarounds for its |
1107 | # byzantine signal and broken child handling, among others. |
1221 | # byzantine signal and broken child handling, among others. |
1108 | # IO::Async is rather hard to detect, as it doesn't have any |
1222 | # IO::Async is rather hard to detect, as it doesn't have any |
1109 | # obvious default class. |
1223 | # obvious default class. |
1110 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1224 | [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1111 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1225 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1112 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1226 | [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1227 | [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1113 | ); |
1228 | ); |
1114 | |
1229 | |
1115 | our %method = map +($_ => 1), |
1230 | our %method = map +($_ => 1), |
1116 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1231 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1117 | |
1232 | |
1118 | our @post_detect; |
1233 | our @post_detect; |
1119 | |
1234 | |
1120 | sub post_detect(&) { |
1235 | sub post_detect(&) { |
1121 | my ($cb) = @_; |
1236 | my ($cb) = @_; |
1122 | |
1237 | |
1123 | if ($MODEL) { |
|
|
1124 | $cb->(); |
|
|
1125 | |
|
|
1126 | 1 |
|
|
1127 | } else { |
|
|
1128 | push @post_detect, $cb; |
1238 | push @post_detect, $cb; |
1129 | |
1239 | |
1130 | defined wantarray |
1240 | defined wantarray |
1131 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1241 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1132 | : () |
1242 | : () |
1133 | } |
|
|
1134 | } |
1243 | } |
1135 | |
1244 | |
1136 | sub AnyEvent::Util::postdetect::DESTROY { |
1245 | sub AnyEvent::Util::postdetect::DESTROY { |
1137 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1246 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1138 | } |
1247 | } |
1139 | |
1248 | |
1140 | sub detect() { |
1249 | sub detect() { |
|
|
1250 | # free some memory |
|
|
1251 | *detect = sub () { $MODEL }; |
|
|
1252 | |
|
|
1253 | local $!; # for good measure |
|
|
1254 | local $SIG{__DIE__}; |
|
|
1255 | |
|
|
1256 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
|
|
1257 | my $model = "AnyEvent::Impl::$1"; |
|
|
1258 | if (eval "require $model") { |
|
|
1259 | $MODEL = $model; |
|
|
1260 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
|
|
1261 | } else { |
|
|
1262 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
|
|
1263 | } |
|
|
1264 | } |
|
|
1265 | |
|
|
1266 | # check for already loaded models |
1141 | unless ($MODEL) { |
1267 | unless ($MODEL) { |
1142 | local $SIG{__DIE__}; |
1268 | for (@REGISTRY, @models) { |
1143 | |
1269 | my ($package, $model) = @$_; |
1144 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1270 | if (${"$package\::VERSION"} > 0) { |
1145 | my $model = "AnyEvent::Impl::$1"; |
|
|
1146 | if (eval "require $model") { |
1271 | if (eval "require $model") { |
1147 | $MODEL = $model; |
1272 | $MODEL = $model; |
1148 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
1273 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1149 | } else { |
1274 | last; |
1150 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1275 | } |
1151 | } |
1276 | } |
1152 | } |
1277 | } |
1153 | |
1278 | |
1154 | # check for already loaded models |
|
|
1155 | unless ($MODEL) { |
1279 | unless ($MODEL) { |
|
|
1280 | # try to autoload a model |
1156 | for (@REGISTRY, @models) { |
1281 | for (@REGISTRY, @models) { |
1157 | my ($package, $model) = @$_; |
1282 | my ($package, $model, $autoload) = @$_; |
|
|
1283 | if ( |
|
|
1284 | $autoload |
|
|
1285 | and eval "require $package" |
1158 | if (${"$package\::VERSION"} > 0) { |
1286 | and ${"$package\::VERSION"} > 0 |
1159 | if (eval "require $model") { |
1287 | and eval "require $model" |
|
|
1288 | ) { |
1160 | $MODEL = $model; |
1289 | $MODEL = $model; |
1161 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1290 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1162 | last; |
1291 | last; |
1163 | } |
|
|
1164 | } |
1292 | } |
1165 | } |
1293 | } |
1166 | |
1294 | |
1167 | unless ($MODEL) { |
|
|
1168 | # try to load a model |
|
|
1169 | |
|
|
1170 | for (@REGISTRY, @models) { |
|
|
1171 | my ($package, $model) = @$_; |
|
|
1172 | if (eval "require $package" |
|
|
1173 | and ${"$package\::VERSION"} > 0 |
|
|
1174 | and eval "require $model") { |
|
|
1175 | $MODEL = $model; |
|
|
1176 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1177 | last; |
|
|
1178 | } |
|
|
1179 | } |
|
|
1180 | |
|
|
1181 | $MODEL |
1295 | $MODEL |
1182 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
1296 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; |
1183 | } |
|
|
1184 | } |
1297 | } |
1185 | |
|
|
1186 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1187 | |
|
|
1188 | unshift @ISA, $MODEL; |
|
|
1189 | |
|
|
1190 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
|
|
1191 | |
|
|
1192 | (shift @post_detect)->() while @post_detect; |
|
|
1193 | } |
1298 | } |
|
|
1299 | |
|
|
1300 | @models = (); # free probe data |
|
|
1301 | |
|
|
1302 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1303 | unshift @ISA, $MODEL; |
|
|
1304 | |
|
|
1305 | # now nuke some methods that are overridden by the backend. |
|
|
1306 | # SUPER is not allowed. |
|
|
1307 | for (qw(time signal child idle)) { |
|
|
1308 | undef &{"AnyEvent::Base::$_"} |
|
|
1309 | if defined &{"$MODEL\::$_"}; |
|
|
1310 | } |
|
|
1311 | |
|
|
1312 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
|
|
1313 | eval { require AnyEvent::Strict }; |
|
|
1314 | warn "AnyEvent: cannot load AnyEvent::Strict ($@)\n" |
|
|
1315 | if $@ && $VERBOSE; |
|
|
1316 | } |
|
|
1317 | |
|
|
1318 | (shift @post_detect)->() while @post_detect; |
|
|
1319 | |
|
|
1320 | *post_detect = sub(&) { |
|
|
1321 | shift->(); |
|
|
1322 | |
|
|
1323 | undef |
|
|
1324 | }; |
1194 | |
1325 | |
1195 | $MODEL |
1326 | $MODEL |
1196 | } |
1327 | } |
1197 | |
1328 | |
1198 | sub AUTOLOAD { |
1329 | sub AUTOLOAD { |
1199 | (my $func = $AUTOLOAD) =~ s/.*://; |
1330 | (my $func = $AUTOLOAD) =~ s/.*://; |
1200 | |
1331 | |
1201 | $method{$func} |
1332 | $method{$func} |
1202 | or Carp::croak "$func: not a valid method for AnyEvent objects"; |
1333 | or Carp::croak "$func: not a valid AnyEvent class method"; |
1203 | |
1334 | |
1204 | detect unless $MODEL; |
1335 | detect; |
1205 | |
1336 | |
1206 | my $class = shift; |
1337 | my $class = shift; |
1207 | $class->$func (@_); |
1338 | $class->$func (@_); |
1208 | } |
1339 | } |
1209 | |
1340 | |
… | |
… | |
1222 | # we assume CLOEXEC is already set by perl in all important cases |
1353 | # we assume CLOEXEC is already set by perl in all important cases |
1223 | |
1354 | |
1224 | ($fh2, $rw) |
1355 | ($fh2, $rw) |
1225 | } |
1356 | } |
1226 | |
1357 | |
|
|
1358 | =head1 SIMPLIFIED AE API |
|
|
1359 | |
|
|
1360 | Starting with version 5.0, AnyEvent officially supports a second, much |
|
|
1361 | simpler, API that is designed to reduce the calling, typing and memory |
|
|
1362 | overhead by using function call syntax and a fixed number of parameters. |
|
|
1363 | |
|
|
1364 | See the L<AE> manpage for details. |
|
|
1365 | |
|
|
1366 | =cut |
|
|
1367 | |
|
|
1368 | package AE; |
|
|
1369 | |
|
|
1370 | our $VERSION = $AnyEvent::VERSION; |
|
|
1371 | |
|
|
1372 | # fall back to the main API by default - backends and AnyEvent::Base |
|
|
1373 | # implementations can overwrite these. |
|
|
1374 | |
|
|
1375 | sub io($$$) { |
|
|
1376 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
|
|
1377 | } |
|
|
1378 | |
|
|
1379 | sub timer($$$) { |
|
|
1380 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
|
|
1381 | } |
|
|
1382 | |
|
|
1383 | sub signal($$) { |
|
|
1384 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
|
|
1385 | } |
|
|
1386 | |
|
|
1387 | sub child($$) { |
|
|
1388 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
|
|
1389 | } |
|
|
1390 | |
|
|
1391 | sub idle($) { |
|
|
1392 | AnyEvent->idle (cb => $_[0]) |
|
|
1393 | } |
|
|
1394 | |
|
|
1395 | sub cv(;&) { |
|
|
1396 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
|
|
1397 | } |
|
|
1398 | |
|
|
1399 | sub now() { |
|
|
1400 | AnyEvent->now |
|
|
1401 | } |
|
|
1402 | |
|
|
1403 | sub now_update() { |
|
|
1404 | AnyEvent->now_update |
|
|
1405 | } |
|
|
1406 | |
|
|
1407 | sub time() { |
|
|
1408 | AnyEvent->time |
|
|
1409 | } |
|
|
1410 | |
1227 | package AnyEvent::Base; |
1411 | package AnyEvent::Base; |
1228 | |
1412 | |
1229 | # default implementations for many methods |
1413 | # default implementations for many methods |
1230 | |
1414 | |
1231 | sub _time { |
1415 | sub time { |
|
|
1416 | eval q{ # poor man's autoloading {} |
1232 | # probe for availability of Time::HiRes |
1417 | # probe for availability of Time::HiRes |
1233 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1418 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1234 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1419 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1235 | *_time = \&Time::HiRes::time; |
1420 | *AE::time = \&Time::HiRes::time; |
1236 | # if (eval "use POSIX (); (POSIX::times())... |
1421 | # if (eval "use POSIX (); (POSIX::times())... |
1237 | } else { |
1422 | } else { |
1238 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1423 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1239 | *_time = sub { time }; # epic fail |
1424 | *AE::time = sub (){ time }; # epic fail |
|
|
1425 | } |
|
|
1426 | |
|
|
1427 | *time = sub { AE::time }; # different prototypes |
1240 | } |
1428 | }; |
|
|
1429 | die if $@; |
1241 | |
1430 | |
1242 | &_time |
1431 | &time |
1243 | } |
1432 | } |
1244 | |
1433 | |
1245 | sub time { _time } |
1434 | *now = \&time; |
1246 | sub now { _time } |
1435 | |
1247 | sub now_update { } |
1436 | sub now_update { } |
1248 | |
1437 | |
1249 | # default implementation for ->condvar |
1438 | # default implementation for ->condvar |
1250 | |
1439 | |
1251 | sub condvar { |
1440 | sub condvar { |
|
|
1441 | eval q{ # poor man's autoloading {} |
|
|
1442 | *condvar = sub { |
1252 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1443 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
|
|
1444 | }; |
|
|
1445 | |
|
|
1446 | *AE::cv = sub (;&) { |
|
|
1447 | bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar" |
|
|
1448 | }; |
|
|
1449 | }; |
|
|
1450 | die if $@; |
|
|
1451 | |
|
|
1452 | &condvar |
1253 | } |
1453 | } |
1254 | |
1454 | |
1255 | # default implementation for ->signal |
1455 | # default implementation for ->signal |
1256 | |
1456 | |
1257 | our $HAVE_ASYNC_INTERRUPT; |
1457 | our $HAVE_ASYNC_INTERRUPT; |
|
|
1458 | |
|
|
1459 | sub _have_async_interrupt() { |
|
|
1460 | $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} |
|
|
1461 | && eval "use Async::Interrupt 1.02 (); 1") |
|
|
1462 | unless defined $HAVE_ASYNC_INTERRUPT; |
|
|
1463 | |
|
|
1464 | $HAVE_ASYNC_INTERRUPT |
|
|
1465 | } |
|
|
1466 | |
1258 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1467 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1259 | our (%SIG_ASY, %SIG_ASY_W); |
1468 | our (%SIG_ASY, %SIG_ASY_W); |
1260 | our ($SIG_COUNT, $SIG_TW); |
1469 | our ($SIG_COUNT, $SIG_TW); |
1261 | |
1470 | |
1262 | sub _signal_exec { |
|
|
1263 | $HAVE_ASYNC_INTERRUPT |
|
|
1264 | ? $SIGPIPE_R->drain |
|
|
1265 | : sysread $SIGPIPE_R, my $dummy, 9; |
|
|
1266 | |
|
|
1267 | while (%SIG_EV) { |
|
|
1268 | for (keys %SIG_EV) { |
|
|
1269 | delete $SIG_EV{$_}; |
|
|
1270 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1271 | } |
|
|
1272 | } |
|
|
1273 | } |
|
|
1274 | |
|
|
1275 | # install a dumym wakeupw atcher to reduce signal catching latency |
1471 | # install a dummy wakeup watcher to reduce signal catching latency |
|
|
1472 | # used by Impls |
1276 | sub _sig_add() { |
1473 | sub _sig_add() { |
1277 | unless ($SIG_COUNT++) { |
1474 | unless ($SIG_COUNT++) { |
1278 | # try to align timer on a full-second boundary, if possible |
1475 | # try to align timer on a full-second boundary, if possible |
1279 | my $NOW = AnyEvent->now; |
1476 | my $NOW = AE::now; |
1280 | |
1477 | |
1281 | $SIG_TW = AnyEvent->timer ( |
1478 | $SIG_TW = AE::timer |
1282 | after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
1479 | $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
1283 | interval => $MAX_SIGNAL_LATENCY, |
1480 | $MAX_SIGNAL_LATENCY, |
1284 | cb => sub { }, # just for the PERL_ASYNC_CHECK |
1481 | sub { } # just for the PERL_ASYNC_CHECK |
1285 | ); |
1482 | ; |
1286 | } |
1483 | } |
1287 | } |
1484 | } |
1288 | |
1485 | |
1289 | sub _sig_del { |
1486 | sub _sig_del { |
1290 | undef $SIG_TW |
1487 | undef $SIG_TW |
1291 | unless --$SIG_COUNT; |
1488 | unless --$SIG_COUNT; |
1292 | } |
1489 | } |
1293 | |
1490 | |
|
|
1491 | our $_sig_name_init; $_sig_name_init = sub { |
|
|
1492 | eval q{ # poor man's autoloading {} |
|
|
1493 | undef $_sig_name_init; |
|
|
1494 | |
|
|
1495 | if (_have_async_interrupt) { |
|
|
1496 | *sig2num = \&Async::Interrupt::sig2num; |
|
|
1497 | *sig2name = \&Async::Interrupt::sig2name; |
|
|
1498 | } else { |
|
|
1499 | require Config; |
|
|
1500 | |
|
|
1501 | my %signame2num; |
|
|
1502 | @signame2num{ split ' ', $Config::Config{sig_name} } |
|
|
1503 | = split ' ', $Config::Config{sig_num}; |
|
|
1504 | |
|
|
1505 | my @signum2name; |
|
|
1506 | @signum2name[values %signame2num] = keys %signame2num; |
|
|
1507 | |
|
|
1508 | *sig2num = sub($) { |
|
|
1509 | $_[0] > 0 ? shift : $signame2num{+shift} |
|
|
1510 | }; |
|
|
1511 | *sig2name = sub ($) { |
|
|
1512 | $_[0] > 0 ? $signum2name[+shift] : shift |
|
|
1513 | }; |
|
|
1514 | } |
|
|
1515 | }; |
|
|
1516 | die if $@; |
|
|
1517 | }; |
|
|
1518 | |
|
|
1519 | sub sig2num ($) { &$_sig_name_init; &sig2num } |
|
|
1520 | sub sig2name($) { &$_sig_name_init; &sig2name } |
|
|
1521 | |
1294 | sub _signal { |
1522 | sub signal { |
1295 | my (undef, %arg) = @_; |
1523 | eval q{ # poor man's autoloading {} |
|
|
1524 | # probe for availability of Async::Interrupt |
|
|
1525 | if (_have_async_interrupt) { |
|
|
1526 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1296 | |
1527 | |
1297 | my $signal = uc $arg{signal} |
1528 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1298 | or Carp::croak "required option 'signal' is missing"; |
1529 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1299 | |
1530 | |
1300 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1531 | } else { |
|
|
1532 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1301 | |
1533 | |
1302 | if ($HAVE_ASYNC_INTERRUPT) { |
1534 | if (AnyEvent::WIN32) { |
1303 | # async::interrupt |
1535 | require AnyEvent::Util; |
1304 | |
1536 | |
1305 | $SIG_ASY{$signal} ||= do { |
1537 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1306 | my $asy = new Async::Interrupt |
1538 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; |
1307 | cb => sub { undef $SIG_EV{$signal} }, |
1539 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case |
1308 | signal => $signal, |
1540 | } else { |
1309 | pipe => [$SIGPIPE_R->filenos], |
1541 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1542 | fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R; |
|
|
1543 | fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1544 | |
|
|
1545 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1546 | fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC; |
|
|
1547 | fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC; |
1310 | ; |
1548 | } |
1311 | $asy->pipe_autodrain (0); |
|
|
1312 | |
1549 | |
1313 | $asy |
1550 | $SIGPIPE_R |
|
|
1551 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1552 | |
|
|
1553 | $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec; |
|
|
1554 | } |
|
|
1555 | |
|
|
1556 | *signal = $HAVE_ASYNC_INTERRUPT |
|
|
1557 | ? sub { |
|
|
1558 | my (undef, %arg) = @_; |
|
|
1559 | |
|
|
1560 | # async::interrupt |
|
|
1561 | my $signal = sig2num $arg{signal}; |
|
|
1562 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1563 | |
|
|
1564 | $SIG_ASY{$signal} ||= new Async::Interrupt |
|
|
1565 | cb => sub { undef $SIG_EV{$signal} }, |
|
|
1566 | signal => $signal, |
|
|
1567 | pipe => [$SIGPIPE_R->filenos], |
|
|
1568 | pipe_autodrain => 0, |
|
|
1569 | ; |
|
|
1570 | |
|
|
1571 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1572 | } |
|
|
1573 | : sub { |
|
|
1574 | my (undef, %arg) = @_; |
|
|
1575 | |
|
|
1576 | # pure perl |
|
|
1577 | my $signal = sig2name $arg{signal}; |
|
|
1578 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1579 | |
|
|
1580 | $SIG{$signal} ||= sub { |
|
|
1581 | local $!; |
|
|
1582 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1583 | undef $SIG_EV{$signal}; |
|
|
1584 | }; |
|
|
1585 | |
|
|
1586 | # can't do signal processing without introducing races in pure perl, |
|
|
1587 | # so limit the signal latency. |
|
|
1588 | _sig_add; |
|
|
1589 | |
|
|
1590 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1591 | } |
|
|
1592 | ; |
|
|
1593 | |
|
|
1594 | *AnyEvent::Base::signal::DESTROY = sub { |
|
|
1595 | my ($signal, $cb) = @{$_[0]}; |
|
|
1596 | |
|
|
1597 | _sig_del; |
|
|
1598 | |
|
|
1599 | delete $SIG_CB{$signal}{$cb}; |
|
|
1600 | |
|
|
1601 | $HAVE_ASYNC_INTERRUPT |
|
|
1602 | ? delete $SIG_ASY{$signal} |
|
|
1603 | : # delete doesn't work with older perls - they then |
|
|
1604 | # print weird messages, or just unconditionally exit |
|
|
1605 | # instead of getting the default action. |
|
|
1606 | undef $SIG{$signal} |
|
|
1607 | unless keys %{ $SIG_CB{$signal} }; |
1314 | }; |
1608 | }; |
1315 | |
1609 | |
1316 | } else { |
1610 | *_signal_exec = sub { |
1317 | # pure perl |
1611 | $HAVE_ASYNC_INTERRUPT |
|
|
1612 | ? $SIGPIPE_R->drain |
|
|
1613 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1318 | |
1614 | |
1319 | $SIG{$signal} ||= sub { |
1615 | while (%SIG_EV) { |
1320 | local $!; |
1616 | for (keys %SIG_EV) { |
1321 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1617 | delete $SIG_EV{$_}; |
1322 | undef $SIG_EV{$signal}; |
1618 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1619 | } |
|
|
1620 | } |
1323 | }; |
1621 | }; |
1324 | |
|
|
1325 | # can't do signal processing without introducing races in pure perl, |
|
|
1326 | # so limit the signal latency. |
|
|
1327 | _sig_add; |
|
|
1328 | } |
1622 | }; |
|
|
1623 | die if $@; |
1329 | |
1624 | |
1330 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1331 | } |
|
|
1332 | |
|
|
1333 | sub signal { |
|
|
1334 | # probe for availability of Async::Interrupt |
|
|
1335 | if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { |
|
|
1336 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
|
|
1337 | |
|
|
1338 | $HAVE_ASYNC_INTERRUPT = 1; |
|
|
1339 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1340 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
|
|
1341 | |
|
|
1342 | } else { |
|
|
1343 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1344 | |
|
|
1345 | require Fcntl; |
|
|
1346 | |
|
|
1347 | if (AnyEvent::WIN32) { |
|
|
1348 | require AnyEvent::Util; |
|
|
1349 | |
|
|
1350 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1351 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1352 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1353 | } else { |
|
|
1354 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1355 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1356 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1357 | |
|
|
1358 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1359 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1360 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1361 | } |
|
|
1362 | |
|
|
1363 | $SIGPIPE_R |
|
|
1364 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1365 | |
|
|
1366 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1367 | } |
|
|
1368 | |
|
|
1369 | *signal = \&_signal; |
|
|
1370 | &signal |
1625 | &signal |
1371 | } |
|
|
1372 | |
|
|
1373 | sub AnyEvent::Base::signal::DESTROY { |
|
|
1374 | my ($signal, $cb) = @{$_[0]}; |
|
|
1375 | |
|
|
1376 | _sig_del; |
|
|
1377 | |
|
|
1378 | delete $SIG_CB{$signal}{$cb}; |
|
|
1379 | |
|
|
1380 | $HAVE_ASYNC_INTERRUPT |
|
|
1381 | ? delete $SIG_ASY{$signal} |
|
|
1382 | : # delete doesn't work with older perls - they then |
|
|
1383 | # print weird messages, or just unconditionally exit |
|
|
1384 | # instead of getting the default action. |
|
|
1385 | undef $SIG{$signal} |
|
|
1386 | unless keys %{ $SIG_CB{$signal} }; |
|
|
1387 | } |
1626 | } |
1388 | |
1627 | |
1389 | # default implementation for ->child |
1628 | # default implementation for ->child |
1390 | |
1629 | |
1391 | our %PID_CB; |
1630 | our %PID_CB; |
1392 | our $CHLD_W; |
1631 | our $CHLD_W; |
1393 | our $CHLD_DELAY_W; |
1632 | our $CHLD_DELAY_W; |
1394 | our $WNOHANG; |
1633 | our $WNOHANG; |
1395 | |
1634 | |
1396 | sub _sigchld { |
1635 | # used by many Impl's |
1397 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1636 | sub _emit_childstatus($$) { |
1398 | $_->($pid, $?) |
1637 | my (undef, $rpid, $rstatus) = @_; |
|
|
1638 | |
|
|
1639 | $_->($rpid, $rstatus) |
1399 | for values %{ $PID_CB{$pid} || {} }, |
1640 | for values %{ $PID_CB{$rpid} || {} }, |
1400 | values %{ $PID_CB{0} || {} }; |
1641 | values %{ $PID_CB{0} || {} }; |
1401 | } |
|
|
1402 | } |
1642 | } |
1403 | |
1643 | |
1404 | sub child { |
1644 | sub child { |
|
|
1645 | eval q{ # poor man's autoloading {} |
|
|
1646 | *_sigchld = sub { |
|
|
1647 | my $pid; |
|
|
1648 | |
|
|
1649 | AnyEvent->_emit_childstatus ($pid, $?) |
|
|
1650 | while ($pid = waitpid -1, $WNOHANG) > 0; |
|
|
1651 | }; |
|
|
1652 | |
|
|
1653 | *child = sub { |
1405 | my (undef, %arg) = @_; |
1654 | my (undef, %arg) = @_; |
1406 | |
1655 | |
1407 | defined (my $pid = $arg{pid} + 0) |
1656 | defined (my $pid = $arg{pid} + 0) |
1408 | or Carp::croak "required option 'pid' is missing"; |
1657 | or Carp::croak "required option 'pid' is missing"; |
1409 | |
1658 | |
1410 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1659 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1411 | |
1660 | |
1412 | # WNOHANG is almost cetrainly 1 everywhere |
1661 | # WNOHANG is almost cetrainly 1 everywhere |
1413 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1662 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1414 | ? 1 |
1663 | ? 1 |
1415 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1664 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1416 | |
1665 | |
1417 | unless ($CHLD_W) { |
1666 | unless ($CHLD_W) { |
1418 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1667 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1419 | # child could be a zombie already, so make at least one round |
1668 | # child could be a zombie already, so make at least one round |
1420 | &_sigchld; |
1669 | &_sigchld; |
1421 | } |
1670 | } |
1422 | |
1671 | |
1423 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1672 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1424 | } |
1673 | }; |
1425 | |
1674 | |
1426 | sub AnyEvent::Base::child::DESTROY { |
1675 | *AnyEvent::Base::child::DESTROY = sub { |
1427 | my ($pid, $cb) = @{$_[0]}; |
1676 | my ($pid, $cb) = @{$_[0]}; |
1428 | |
1677 | |
1429 | delete $PID_CB{$pid}{$cb}; |
1678 | delete $PID_CB{$pid}{$cb}; |
1430 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1679 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1431 | |
1680 | |
1432 | undef $CHLD_W unless keys %PID_CB; |
1681 | undef $CHLD_W unless keys %PID_CB; |
|
|
1682 | }; |
|
|
1683 | }; |
|
|
1684 | die if $@; |
|
|
1685 | |
|
|
1686 | &child |
1433 | } |
1687 | } |
1434 | |
1688 | |
1435 | # idle emulation is done by simply using a timer, regardless |
1689 | # idle emulation is done by simply using a timer, regardless |
1436 | # of whether the process is idle or not, and not letting |
1690 | # of whether the process is idle or not, and not letting |
1437 | # the callback use more than 50% of the time. |
1691 | # the callback use more than 50% of the time. |
1438 | sub idle { |
1692 | sub idle { |
|
|
1693 | eval q{ # poor man's autoloading {} |
|
|
1694 | *idle = sub { |
1439 | my (undef, %arg) = @_; |
1695 | my (undef, %arg) = @_; |
1440 | |
1696 | |
1441 | my ($cb, $w, $rcb) = $arg{cb}; |
1697 | my ($cb, $w, $rcb) = $arg{cb}; |
1442 | |
1698 | |
1443 | $rcb = sub { |
1699 | $rcb = sub { |
1444 | if ($cb) { |
1700 | if ($cb) { |
1445 | $w = _time; |
1701 | $w = _time; |
1446 | &$cb; |
1702 | &$cb; |
1447 | $w = _time - $w; |
1703 | $w = _time - $w; |
1448 | |
1704 | |
1449 | # never use more then 50% of the time for the idle watcher, |
1705 | # never use more then 50% of the time for the idle watcher, |
1450 | # within some limits |
1706 | # within some limits |
1451 | $w = 0.0001 if $w < 0.0001; |
1707 | $w = 0.0001 if $w < 0.0001; |
1452 | $w = 5 if $w > 5; |
1708 | $w = 5 if $w > 5; |
1453 | |
1709 | |
1454 | $w = AnyEvent->timer (after => $w, cb => $rcb); |
1710 | $w = AE::timer $w, 0, $rcb; |
1455 | } else { |
1711 | } else { |
1456 | # clean up... |
1712 | # clean up... |
1457 | undef $w; |
1713 | undef $w; |
1458 | undef $rcb; |
1714 | undef $rcb; |
|
|
1715 | } |
|
|
1716 | }; |
|
|
1717 | |
|
|
1718 | $w = AE::timer 0.05, 0, $rcb; |
|
|
1719 | |
|
|
1720 | bless \\$cb, "AnyEvent::Base::idle" |
1459 | } |
1721 | }; |
|
|
1722 | |
|
|
1723 | *AnyEvent::Base::idle::DESTROY = sub { |
|
|
1724 | undef $${$_[0]}; |
|
|
1725 | }; |
1460 | }; |
1726 | }; |
|
|
1727 | die if $@; |
1461 | |
1728 | |
1462 | $w = AnyEvent->timer (after => 0.05, cb => $rcb); |
1729 | &idle |
1463 | |
|
|
1464 | bless \\$cb, "AnyEvent::Base::idle" |
|
|
1465 | } |
|
|
1466 | |
|
|
1467 | sub AnyEvent::Base::idle::DESTROY { |
|
|
1468 | undef $${$_[0]}; |
|
|
1469 | } |
1730 | } |
1470 | |
1731 | |
1471 | package AnyEvent::CondVar; |
1732 | package AnyEvent::CondVar; |
1472 | |
1733 | |
1473 | our @ISA = AnyEvent::CondVar::Base::; |
1734 | our @ISA = AnyEvent::CondVar::Base::; |
|
|
1735 | |
|
|
1736 | # only to be used for subclassing |
|
|
1737 | sub new { |
|
|
1738 | my $class = shift; |
|
|
1739 | bless AnyEvent->condvar (@_), $class |
|
|
1740 | } |
1474 | |
1741 | |
1475 | package AnyEvent::CondVar::Base; |
1742 | package AnyEvent::CondVar::Base; |
1476 | |
1743 | |
1477 | #use overload |
1744 | #use overload |
1478 | # '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1745 | # '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
… | |
… | |
1521 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1788 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1522 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1789 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1523 | } |
1790 | } |
1524 | |
1791 | |
1525 | sub cb { |
1792 | sub cb { |
1526 | $_[0]{_ae_cb} = $_[1] if @_ > 1; |
1793 | my $cv = shift; |
|
|
1794 | |
|
|
1795 | @_ |
|
|
1796 | and $cv->{_ae_cb} = shift |
|
|
1797 | and $cv->{_ae_sent} |
|
|
1798 | and (delete $cv->{_ae_cb})->($cv); |
|
|
1799 | |
1527 | $_[0]{_ae_cb} |
1800 | $cv->{_ae_cb} |
1528 | } |
1801 | } |
1529 | |
1802 | |
1530 | sub begin { |
1803 | sub begin { |
1531 | ++$_[0]{_ae_counter}; |
1804 | ++$_[0]{_ae_counter}; |
1532 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
1805 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
… | |
… | |
1594 | check the arguments passed to most method calls. If it finds any problems, |
1867 | check the arguments passed to most method calls. If it finds any problems, |
1595 | it will croak. |
1868 | it will croak. |
1596 | |
1869 | |
1597 | In other words, enables "strict" mode. |
1870 | In other words, enables "strict" mode. |
1598 | |
1871 | |
1599 | Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> |
1872 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
1600 | >>, it is definitely recommended to keep it off in production. Keeping |
1873 | >>, it is definitely recommended to keep it off in production. Keeping |
1601 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
1874 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
1602 | can be very useful, however. |
1875 | can be very useful, however. |
1603 | |
1876 | |
1604 | =item C<PERL_ANYEVENT_MODEL> |
1877 | =item C<PERL_ANYEVENT_MODEL> |
… | |
… | |
1741 | warn "read: $input\n"; # output what has been read |
2014 | warn "read: $input\n"; # output what has been read |
1742 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
2015 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1743 | }, |
2016 | }, |
1744 | ); |
2017 | ); |
1745 | |
2018 | |
1746 | my $time_watcher; # can only be used once |
|
|
1747 | |
|
|
1748 | sub new_timer { |
|
|
1749 | $timer = AnyEvent->timer (after => 1, cb => sub { |
2019 | my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub { |
1750 | warn "timeout\n"; # print 'timeout' about every second |
2020 | warn "timeout\n"; # print 'timeout' at most every second |
1751 | &new_timer; # and restart the time |
|
|
1752 | }); |
2021 | }); |
1753 | } |
|
|
1754 | |
|
|
1755 | new_timer; # create first timer |
|
|
1756 | |
2022 | |
1757 | $cv->recv; # wait until user enters /^q/i |
2023 | $cv->recv; # wait until user enters /^q/i |
1758 | |
2024 | |
1759 | =head1 REAL-WORLD EXAMPLE |
2025 | =head1 REAL-WORLD EXAMPLE |
1760 | |
2026 | |
… | |
… | |
1833 | |
2099 | |
1834 | The actual code goes further and collects all errors (C<die>s, exceptions) |
2100 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1835 | that occurred during request processing. The C<result> method detects |
2101 | that occurred during request processing. The C<result> method detects |
1836 | whether an exception as thrown (it is stored inside the $txn object) |
2102 | whether an exception as thrown (it is stored inside the $txn object) |
1837 | and just throws the exception, which means connection errors and other |
2103 | and just throws the exception, which means connection errors and other |
1838 | problems get reported tot he code that tries to use the result, not in a |
2104 | problems get reported to the code that tries to use the result, not in a |
1839 | random callback. |
2105 | random callback. |
1840 | |
2106 | |
1841 | All of this enables the following usage styles: |
2107 | All of this enables the following usage styles: |
1842 | |
2108 | |
1843 | 1. Blocking: |
2109 | 1. Blocking: |
… | |
… | |
1891 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
2157 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1892 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
2158 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1893 | which it is), lets them fire exactly once and destroys them again. |
2159 | which it is), lets them fire exactly once and destroys them again. |
1894 | |
2160 | |
1895 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
2161 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1896 | distribution. |
2162 | distribution. It uses the L<AE> interface, which makes a real difference |
|
|
2163 | for the EV and Perl backends only. |
1897 | |
2164 | |
1898 | =head3 Explanation of the columns |
2165 | =head3 Explanation of the columns |
1899 | |
2166 | |
1900 | I<watcher> is the number of event watchers created/destroyed. Since |
2167 | I<watcher> is the number of event watchers created/destroyed. Since |
1901 | different event models feature vastly different performances, each event |
2168 | different event models feature vastly different performances, each event |
… | |
… | |
1922 | watcher. |
2189 | watcher. |
1923 | |
2190 | |
1924 | =head3 Results |
2191 | =head3 Results |
1925 | |
2192 | |
1926 | name watchers bytes create invoke destroy comment |
2193 | name watchers bytes create invoke destroy comment |
1927 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
2194 | EV/EV 100000 223 0.47 0.43 0.27 EV native interface |
1928 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
2195 | EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers |
1929 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
2196 | Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal |
1930 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
2197 | Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation |
1931 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
2198 | Event/Event 16000 516 31.16 31.84 0.82 Event native interface |
1932 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
2199 | Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers |
1933 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
2200 | IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll |
1934 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
2201 | IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll |
1935 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
2202 | Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour |
1936 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
2203 | Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers |
1937 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
2204 | POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event |
1938 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
2205 | POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select |
1939 | |
2206 | |
1940 | =head3 Discussion |
2207 | =head3 Discussion |
1941 | |
2208 | |
1942 | The benchmark does I<not> measure scalability of the event loop very |
2209 | The benchmark does I<not> measure scalability of the event loop very |
1943 | well. For example, a select-based event loop (such as the pure perl one) |
2210 | well. For example, a select-based event loop (such as the pure perl one) |
… | |
… | |
1955 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
2222 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
1956 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
2223 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
1957 | cycles with POE. |
2224 | cycles with POE. |
1958 | |
2225 | |
1959 | C<EV> is the sole leader regarding speed and memory use, which are both |
2226 | C<EV> is the sole leader regarding speed and memory use, which are both |
1960 | maximal/minimal, respectively. Even when going through AnyEvent, it uses |
2227 | maximal/minimal, respectively. When using the L<AE> API there is zero |
|
|
2228 | overhead (when going through the AnyEvent API create is about 5-6 times |
|
|
2229 | slower, with other times being equal, so still uses far less memory than |
1961 | far less memory than any other event loop and is still faster than Event |
2230 | any other event loop and is still faster than Event natively). |
1962 | natively. |
|
|
1963 | |
2231 | |
1964 | The pure perl implementation is hit in a few sweet spots (both the |
2232 | The pure perl implementation is hit in a few sweet spots (both the |
1965 | constant timeout and the use of a single fd hit optimisations in the perl |
2233 | constant timeout and the use of a single fd hit optimisations in the perl |
1966 | interpreter and the backend itself). Nevertheless this shows that it |
2234 | interpreter and the backend itself). Nevertheless this shows that it |
1967 | adds very little overhead in itself. Like any select-based backend its |
2235 | adds very little overhead in itself. Like any select-based backend its |
… | |
… | |
2041 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
2309 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
2042 | (1%) are active. This mirrors the activity of large servers with many |
2310 | (1%) are active. This mirrors the activity of large servers with many |
2043 | connections, most of which are idle at any one point in time. |
2311 | connections, most of which are idle at any one point in time. |
2044 | |
2312 | |
2045 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
2313 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
2046 | distribution. |
2314 | distribution. It uses the L<AE> interface, which makes a real difference |
|
|
2315 | for the EV and Perl backends only. |
2047 | |
2316 | |
2048 | =head3 Explanation of the columns |
2317 | =head3 Explanation of the columns |
2049 | |
2318 | |
2050 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
2319 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
2051 | each server has a read and write socket end). |
2320 | each server has a read and write socket end). |
… | |
… | |
2059 | a new one that moves the timeout into the future. |
2328 | a new one that moves the timeout into the future. |
2060 | |
2329 | |
2061 | =head3 Results |
2330 | =head3 Results |
2062 | |
2331 | |
2063 | name sockets create request |
2332 | name sockets create request |
2064 | EV 20000 69.01 11.16 |
2333 | EV 20000 62.66 7.99 |
2065 | Perl 20000 73.32 35.87 |
2334 | Perl 20000 68.32 32.64 |
2066 | IOAsync 20000 157.00 98.14 epoll |
2335 | IOAsync 20000 174.06 101.15 epoll |
2067 | IOAsync 20000 159.31 616.06 poll |
2336 | IOAsync 20000 174.67 610.84 poll |
2068 | Event 20000 212.62 257.32 |
2337 | Event 20000 202.69 242.91 |
2069 | Glib 20000 651.16 1896.30 |
2338 | Glib 20000 557.01 1689.52 |
2070 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
2339 | POE 20000 341.54 12086.32 uses POE::Loop::Event |
2071 | |
2340 | |
2072 | =head3 Discussion |
2341 | =head3 Discussion |
2073 | |
2342 | |
2074 | This benchmark I<does> measure scalability and overall performance of the |
2343 | This benchmark I<does> measure scalability and overall performance of the |
2075 | particular event loop. |
2344 | particular event loop. |
… | |
… | |
2201 | As you can see, the AnyEvent + EV combination even beats the |
2470 | As you can see, the AnyEvent + EV combination even beats the |
2202 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
2471 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
2203 | backend easily beats IO::Lambda and POE. |
2472 | backend easily beats IO::Lambda and POE. |
2204 | |
2473 | |
2205 | And even the 100% non-blocking version written using the high-level (and |
2474 | And even the 100% non-blocking version written using the high-level (and |
2206 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
2475 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda |
2207 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
2476 | higher level ("unoptimised") abstractions by a large margin, even though |
2208 | in a non-blocking way. |
2477 | it does all of DNS, tcp-connect and socket I/O in a non-blocking way. |
2209 | |
2478 | |
2210 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
2479 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
2211 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
2480 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
2212 | part of the IO::lambda distribution and were used without any changes. |
2481 | part of the IO::Lambda distribution and were used without any changes. |
2213 | |
2482 | |
2214 | |
2483 | |
2215 | =head1 SIGNALS |
2484 | =head1 SIGNALS |
2216 | |
2485 | |
2217 | AnyEvent currently installs handlers for these signals: |
2486 | AnyEvent currently installs handlers for these signals: |
… | |
… | |
2254 | unless defined $SIG{PIPE}; |
2523 | unless defined $SIG{PIPE}; |
2255 | |
2524 | |
2256 | =head1 RECOMMENDED/OPTIONAL MODULES |
2525 | =head1 RECOMMENDED/OPTIONAL MODULES |
2257 | |
2526 | |
2258 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
2527 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
2259 | it's built-in modules) are required to use it. |
2528 | its built-in modules) are required to use it. |
2260 | |
2529 | |
2261 | That does not mean that AnyEvent won't take advantage of some additional |
2530 | That does not mean that AnyEvent won't take advantage of some additional |
2262 | modules if they are installed. |
2531 | modules if they are installed. |
2263 | |
2532 | |
2264 | This section epxlains which additional modules will be used, and how they |
2533 | This section explains which additional modules will be used, and how they |
2265 | affect AnyEvent's operetion. |
2534 | affect AnyEvent's operation. |
2266 | |
2535 | |
2267 | =over 4 |
2536 | =over 4 |
2268 | |
2537 | |
2269 | =item L<Async::Interrupt> |
2538 | =item L<Async::Interrupt> |
2270 | |
2539 | |
2271 | This slightly arcane module is used to implement fast signal handling: To |
2540 | This slightly arcane module is used to implement fast signal handling: To |
2272 | my knowledge, there is no way to do completely race-free and quick |
2541 | my knowledge, there is no way to do completely race-free and quick |
2273 | signal handling in pure perl. To ensure that signals still get |
2542 | signal handling in pure perl. To ensure that signals still get |
2274 | delivered, AnyEvent will start an interval timer to wake up perl (and |
2543 | delivered, AnyEvent will start an interval timer to wake up perl (and |
2275 | catch the signals) with soemd elay (default is 10 seconds, look for |
2544 | catch the signals) with some delay (default is 10 seconds, look for |
2276 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
2545 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
2277 | |
2546 | |
2278 | If this module is available, then it will be used to implement signal |
2547 | If this module is available, then it will be used to implement signal |
2279 | catching, which means that signals will not be delayed, and the event loop |
2548 | catching, which means that signals will not be delayed, and the event loop |
2280 | will not be interrupted regularly, which is more efficient (And good for |
2549 | will not be interrupted regularly, which is more efficient (and good for |
2281 | battery life on laptops). |
2550 | battery life on laptops). |
2282 | |
2551 | |
2283 | This affects not just the pure-perl event loop, but also other event loops |
2552 | This affects not just the pure-perl event loop, but also other event loops |
2284 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
2553 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
|
|
2554 | |
|
|
2555 | Some event loops (POE, Event, Event::Lib) offer signal watchers natively, |
|
|
2556 | and either employ their own workarounds (POE) or use AnyEvent's workaround |
|
|
2557 | (using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt> |
|
|
2558 | does nothing for those backends. |
2285 | |
2559 | |
2286 | =item L<EV> |
2560 | =item L<EV> |
2287 | |
2561 | |
2288 | This module isn't really "optional", as it is simply one of the backend |
2562 | This module isn't really "optional", as it is simply one of the backend |
2289 | event loops that AnyEvent can use. However, it is simply the best event |
2563 | event loops that AnyEvent can use. However, it is simply the best event |
… | |
… | |
2292 | automatic timer adjustments even when no monotonic clock is available, |
2566 | automatic timer adjustments even when no monotonic clock is available, |
2293 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
2567 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
2294 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
2568 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
2295 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
2569 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
2296 | |
2570 | |
|
|
2571 | If you only use backends that rely on another event loop (e.g. C<Tk>), |
|
|
2572 | then this module will do nothing for you. |
|
|
2573 | |
2297 | =item L<Guard> |
2574 | =item L<Guard> |
2298 | |
2575 | |
2299 | The guard module, when used, will be used to implement |
2576 | The guard module, when used, will be used to implement |
2300 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
2577 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
2301 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2578 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2302 | purely used for performance. |
2579 | purely used for performance. |
2303 | |
2580 | |
2304 | =item L<JSON> and L<JSON::XS> |
2581 | =item L<JSON> and L<JSON::XS> |
2305 | |
2582 | |
2306 | This module is required when you want to read or write JSON data via |
2583 | One of these modules is required when you want to read or write JSON data |
2307 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
2584 | via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take |
2308 | advantage of the ulta-high-speed L<JSON::XS> module when it is installed. |
2585 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
2309 | |
|
|
2310 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
|
|
2311 | installed. |
|
|
2312 | |
2586 | |
2313 | =item L<Net::SSLeay> |
2587 | =item L<Net::SSLeay> |
2314 | |
2588 | |
2315 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
2589 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
2316 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
2590 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
2317 | the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. |
2591 | the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. |
2318 | |
2592 | |
2319 | =item L<Time::HiRes> |
2593 | =item L<Time::HiRes> |
2320 | |
2594 | |
2321 | This module is part of perl since release 5.008. It will be used when the |
2595 | This module is part of perl since release 5.008. It will be used when the |
2322 | chosen event library does not come with a timing source on it's own. The |
2596 | chosen event library does not come with a timing source of its own. The |
2323 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
2597 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
2324 | try to use a monotonic clock for timing stability. |
2598 | try to use a monotonic clock for timing stability. |
2325 | |
2599 | |
2326 | =back |
2600 | =back |
2327 | |
2601 | |
2328 | |
2602 | |
2329 | =head1 FORK |
2603 | =head1 FORK |
2330 | |
2604 | |
2331 | Most event libraries are not fork-safe. The ones who are usually are |
2605 | Most event libraries are not fork-safe. The ones who are usually are |
2332 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2606 | because they rely on inefficient but fork-safe C<select> or C<poll> calls |
2333 | calls. Only L<EV> is fully fork-aware. |
2607 | - higher performance APIs such as BSD's kqueue or the dreaded Linux epoll |
|
|
2608 | are usually badly thought-out hacks that are incompatible with fork in |
|
|
2609 | one way or another. Only L<EV> is fully fork-aware and ensures that you |
|
|
2610 | continue event-processing in both parent and child (or both, if you know |
|
|
2611 | what you are doing). |
|
|
2612 | |
|
|
2613 | This means that, in general, you cannot fork and do event processing in |
|
|
2614 | the child if the event library was initialised before the fork (which |
|
|
2615 | usually happens when the first AnyEvent watcher is created, or the library |
|
|
2616 | is loaded). |
2334 | |
2617 | |
2335 | If you have to fork, you must either do so I<before> creating your first |
2618 | If you have to fork, you must either do so I<before> creating your first |
2336 | watcher OR you must not use AnyEvent at all in the child OR you must do |
2619 | watcher OR you must not use AnyEvent at all in the child OR you must do |
2337 | something completely out of the scope of AnyEvent. |
2620 | something completely out of the scope of AnyEvent. |
|
|
2621 | |
|
|
2622 | The problem of doing event processing in the parent I<and> the child |
|
|
2623 | is much more complicated: even for backends that I<are> fork-aware or |
|
|
2624 | fork-safe, their behaviour is not usually what you want: fork clones all |
|
|
2625 | watchers, that means all timers, I/O watchers etc. are active in both |
|
|
2626 | parent and child, which is almost never what you want. USing C<exec> |
|
|
2627 | to start worker children from some kind of manage rprocess is usually |
|
|
2628 | preferred, because it is much easier and cleaner, at the expense of having |
|
|
2629 | to have another binary. |
2338 | |
2630 | |
2339 | |
2631 | |
2340 | =head1 SECURITY CONSIDERATIONS |
2632 | =head1 SECURITY CONSIDERATIONS |
2341 | |
2633 | |
2342 | AnyEvent can be forced to load any event model via |
2634 | AnyEvent can be forced to load any event model via |
… | |
… | |
2372 | pronounced). |
2664 | pronounced). |
2373 | |
2665 | |
2374 | |
2666 | |
2375 | =head1 SEE ALSO |
2667 | =head1 SEE ALSO |
2376 | |
2668 | |
|
|
2669 | Tutorial/Introduction: L<AnyEvent::Intro>. |
|
|
2670 | |
|
|
2671 | FAQ: L<AnyEvent::FAQ>. |
|
|
2672 | |
2377 | Utility functions: L<AnyEvent::Util>. |
2673 | Utility functions: L<AnyEvent::Util>. |
2378 | |
2674 | |
2379 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
2675 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
2380 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2676 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2381 | |
2677 | |
2382 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2678 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2383 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2679 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2384 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2680 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2385 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
2681 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2386 | |
2682 | |
2387 | Non-blocking file handles, sockets, TCP clients and |
2683 | Non-blocking file handles, sockets, TCP clients and |
2388 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2684 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2389 | |
2685 | |
2390 | Asynchronous DNS: L<AnyEvent::DNS>. |
2686 | Asynchronous DNS: L<AnyEvent::DNS>. |
2391 | |
2687 | |
2392 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, |
2688 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
2393 | L<Coro::Event>, |
|
|
2394 | |
2689 | |
2395 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, |
2690 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>, |
2396 | L<AnyEvent::HTTP>. |
2691 | L<AnyEvent::HTTP>. |
2397 | |
2692 | |
2398 | |
2693 | |
2399 | =head1 AUTHOR |
2694 | =head1 AUTHOR |
2400 | |
2695 | |