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, POE - various supported event loops |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt |
|
|
6 | and POE are various supported event loops/environments. |
6 | |
7 | |
7 | =head1 SYNOPSIS |
8 | =head1 SYNOPSIS |
8 | |
9 | |
9 | use AnyEvent; |
10 | use AnyEvent; |
10 | |
11 | |
|
|
12 | # if you prefer function calls, look at the AE manpage for |
|
|
13 | # an alternative API. |
|
|
14 | |
|
|
15 | # file handle or descriptor readable |
11 | my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... }); |
16 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
12 | |
17 | |
|
|
18 | # one-shot or repeating timers |
13 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
19 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
14 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
20 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...); |
15 | |
21 | |
16 | print AnyEvent->now; # prints current event loop time |
22 | print AnyEvent->now; # prints current event loop time |
17 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
23 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
18 | |
24 | |
|
|
25 | # POSIX signal |
19 | my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); |
26 | my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); |
20 | |
27 | |
|
|
28 | # child process exit |
21 | my $w = AnyEvent->child (pid => $pid, cb => sub { |
29 | my $w = AnyEvent->child (pid => $pid, cb => sub { |
22 | my ($pid, $status) = @_; |
30 | my ($pid, $status) = @_; |
23 | ... |
31 | ... |
24 | }); |
32 | }); |
|
|
33 | |
|
|
34 | # called when event loop idle (if applicable) |
|
|
35 | my $w = AnyEvent->idle (cb => sub { ... }); |
25 | |
36 | |
26 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
37 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
27 | $w->send; # wake up current and all future recv's |
38 | $w->send; # wake up current and all future recv's |
28 | $w->recv; # enters "main loop" till $condvar gets ->send |
39 | $w->recv; # enters "main loop" till $condvar gets ->send |
29 | # use a condvar in callback mode: |
40 | # use a condvar in callback mode: |
… | |
… | |
32 | =head1 INTRODUCTION/TUTORIAL |
43 | =head1 INTRODUCTION/TUTORIAL |
33 | |
44 | |
34 | This manpage is mainly a reference manual. If you are interested |
45 | This manpage is mainly a reference manual. If you are interested |
35 | 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 |
36 | 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. |
37 | |
58 | |
38 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
59 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
39 | |
60 | |
40 | 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 |
41 | nowadays. So what is different about AnyEvent? |
62 | nowadays. So what is different about AnyEvent? |
… | |
… | |
57 | 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 |
58 | model you use. |
79 | model you use. |
59 | |
80 | |
60 | 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 |
61 | 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 |
62 | 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 |
63 | cannot use anything else, as they are simply incompatible to everything |
84 | cannot use anything else, as they are simply incompatible to everything |
64 | 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 |
65 | 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. |
66 | |
87 | |
67 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
88 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
68 | 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 |
69 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
90 | with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module |
70 | your module uses one of those, every user of your module has to use it, |
91 | uses one of those, every user of your module has to use it, too. But if |
71 | too. But if your module uses AnyEvent, it works transparently with all |
92 | your module uses AnyEvent, it works transparently with all event models it |
72 | event models it supports (including stuff like IO::Async, as long as those |
93 | supports (including stuff like IO::Async, as long as those use one of the |
73 | use one of the supported event loops. It is trivial to add new event loops |
94 | supported event loops. It is easy to add new event loops to AnyEvent, too, |
74 | to AnyEvent, too, so it is future-proof). |
95 | so it is future-proof). |
75 | |
96 | |
76 | 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 |
77 | 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 |
78 | 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 |
79 | 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 |
80 | 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 |
81 | technically possible. |
102 | technically possible. |
82 | |
103 | |
83 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
104 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
84 | of useful functionality, such as an asynchronous DNS resolver, 100% |
105 | of useful functionality, such as an asynchronous DNS resolver, 100% |
… | |
… | |
90 | 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 |
91 | model, you should I<not> use this module. |
112 | model, you should I<not> use this module. |
92 | |
113 | |
93 | =head1 DESCRIPTION |
114 | =head1 DESCRIPTION |
94 | |
115 | |
95 | L<AnyEvent> provides an identical interface to multiple event loops. This |
116 | L<AnyEvent> provides a uniform interface to various event loops. This |
96 | allows module authors to utilise an event loop without forcing module |
117 | allows module authors to use event loop functionality without forcing |
97 | 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 |
98 | peacefully at any one time). |
119 | than one event loop cannot coexist peacefully). |
99 | |
120 | |
100 | 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> |
101 | module. |
122 | module. |
102 | |
123 | |
103 | 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 |
104 | 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 |
105 | following modules is already loaded: L<EV>, |
126 | following modules is already loaded: L<EV>, L<AnyEvent::Loop>, |
106 | 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 |
107 | 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 |
108 | 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 |
109 | adaptor should always succeed) in the order given. The first one that can |
130 | available, the pure-perl L<AnyEvent::Loop> should always work, so |
110 | be successfully loaded will be used. If, after this, still none could be |
131 | the other two are not normally tried. |
111 | found, AnyEvent will fall back to a pure-perl event loop, which is not |
|
|
112 | very efficient, but should work everywhere. |
|
|
113 | |
132 | |
114 | Because AnyEvent first checks for modules that are already loaded, loading |
133 | Because AnyEvent first checks for modules that are already loaded, loading |
115 | an event model explicitly before first using AnyEvent will likely make |
134 | an event model explicitly before first using AnyEvent will likely make |
116 | that model the default. For example: |
135 | that model the default. For example: |
117 | |
136 | |
… | |
… | |
119 | use AnyEvent; |
138 | use AnyEvent; |
120 | |
139 | |
121 | # .. AnyEvent will likely default to Tk |
140 | # .. AnyEvent will likely default to Tk |
122 | |
141 | |
123 | 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 |
124 | 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, |
125 | use AnyEvent so their modules work together with others seamlessly... |
144 | as very few modules hardcode event loops without announcing this very |
|
|
145 | loudly. |
126 | |
146 | |
127 | The pure-perl implementation of AnyEvent is called |
147 | The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like |
128 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
148 | other event modules you can load it explicitly and enjoy the high |
129 | explicitly and enjoy the high availability of that event loop :) |
149 | availability of that event loop :) |
130 | |
150 | |
131 | =head1 WATCHERS |
151 | =head1 WATCHERS |
132 | |
152 | |
133 | AnyEvent has the central concept of a I<watcher>, which is an object that |
153 | AnyEvent has the central concept of a I<watcher>, which is an object that |
134 | stores relevant data for each kind of event you are waiting for, such as |
154 | stores relevant data for each kind of event you are waiting for, such as |
… | |
… | |
139 | 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 |
140 | is in control). |
160 | is in control). |
141 | |
161 | |
142 | Note that B<callbacks must not permanently change global variables> |
162 | Note that B<callbacks must not permanently change global variables> |
143 | 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<< |
144 | 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 |
145 | 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 |
146 | widely between event loops. |
166 | widely between event loops. |
147 | |
167 | |
148 | 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 |
149 | 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 |
150 | to it). |
170 | to it). |
151 | |
171 | |
152 | 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. |
153 | |
173 | |
154 | Many watchers either are used with "recursion" (repeating timers for |
174 | Many watchers either are used with "recursion" (repeating timers for |
155 | 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. |
156 | |
176 | |
157 | An any way to achieve that is this pattern: |
177 | One way to achieve that is this pattern: |
158 | |
178 | |
159 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
179 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
160 | # you can use $w here, for example to undef it |
180 | # you can use $w here, for example to undef it |
161 | undef $w; |
181 | undef $w; |
162 | }); |
182 | }); |
… | |
… | |
165 | 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 |
166 | declared. |
186 | declared. |
167 | |
187 | |
168 | =head2 I/O WATCHERS |
188 | =head2 I/O WATCHERS |
169 | |
189 | |
|
|
190 | $w = AnyEvent->io ( |
|
|
191 | fh => <filehandle_or_fileno>, |
|
|
192 | poll => <"r" or "w">, |
|
|
193 | cb => <callback>, |
|
|
194 | ); |
|
|
195 | |
170 | 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 |
171 | with the following mandatory key-value pairs as arguments: |
197 | with the following mandatory key-value pairs as arguments: |
172 | |
198 | |
173 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events |
199 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
174 | (AnyEvent might or might not keep a reference to this file handle). C<poll> |
200 | for events (AnyEvent might or might not keep a reference to this file |
|
|
201 | handle). Note that only file handles pointing to things for which |
|
|
202 | non-blocking operation makes sense are allowed. This includes sockets, |
|
|
203 | most character devices, pipes, fifos and so on, but not for example files |
|
|
204 | or block devices. |
|
|
205 | |
175 | must be a string that is either C<r> or C<w>, which creates a watcher |
206 | C<poll> must be a string that is either C<r> or C<w>, which creates a |
176 | waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the |
207 | watcher waiting for "r"eadable or "w"ritable events, respectively. |
|
|
208 | |
177 | callback to invoke each time the file handle becomes ready. |
209 | C<cb> is the callback to invoke each time the file handle becomes ready. |
178 | |
210 | |
179 | Although the callback might get passed parameters, their value and |
211 | Although the callback might get passed parameters, their value and |
180 | presence is undefined and you cannot rely on them. Portable AnyEvent |
212 | presence is undefined and you cannot rely on them. Portable AnyEvent |
181 | callbacks cannot use arguments passed to I/O watcher callbacks. |
213 | callbacks cannot use arguments passed to I/O watcher callbacks. |
182 | |
214 | |
183 | 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. |
184 | 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 |
185 | underlying file descriptor. |
217 | underlying file descriptor. |
186 | |
218 | |
187 | Some event loops issue spurious readyness notifications, so you should |
219 | Some event loops issue spurious readiness notifications, so you should |
188 | 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 |
189 | handles. |
221 | handles. |
190 | |
222 | |
191 | 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 |
192 | watcher. |
224 | watcher. |
… | |
… | |
197 | undef $w; |
229 | undef $w; |
198 | }); |
230 | }); |
199 | |
231 | |
200 | =head2 TIME WATCHERS |
232 | =head2 TIME WATCHERS |
201 | |
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 | |
202 | 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 >> |
203 | method with the following mandatory arguments: |
243 | method with the following mandatory arguments: |
204 | |
244 | |
205 | C<after> specifies after how many seconds (fractional values are |
245 | C<after> specifies after how many seconds (fractional values are |
206 | 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 |
… | |
… | |
208 | |
248 | |
209 | Although the callback might get passed parameters, their value and |
249 | Although the callback might get passed parameters, their value and |
210 | presence is undefined and you cannot rely on them. Portable AnyEvent |
250 | presence is undefined and you cannot rely on them. Portable AnyEvent |
211 | callbacks cannot use arguments passed to time watcher callbacks. |
251 | callbacks cannot use arguments passed to time watcher callbacks. |
212 | |
252 | |
213 | 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 |
214 | parameter, C<interval>, as a strictly positive number (> 0), then the |
254 | parameter, C<interval>, as a strictly positive number (> 0), then the |
215 | callback will be invoked regularly at that interval (in fractional |
255 | callback will be invoked regularly at that interval (in fractional |
216 | 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 |
217 | 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. |
218 | |
258 | |
219 | The callback will be rescheduled before invoking the callback, but no |
259 | The callback will be rescheduled before invoking the callback, but no |
220 | 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 |
221 | only approximate. |
261 | only approximate. |
222 | |
262 | |
223 | Example: fire an event after 7.7 seconds. |
263 | Example: fire an event after 7.7 seconds. |
224 | |
264 | |
225 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
265 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
… | |
… | |
243 | |
283 | |
244 | 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 |
245 | use absolute time internally. This makes a difference when your clock |
285 | use absolute time internally. This makes a difference when your clock |
246 | "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 |
247 | 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 |
248 | 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. |
249 | |
289 | |
250 | 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 |
251 | 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 |
252 | 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) |
253 | timers. |
293 | timers. |
254 | |
294 | |
255 | AnyEvent always prefers relative timers, if available, matching the |
295 | AnyEvent always prefers relative timers, if available, matching the |
256 | AnyEvent API. |
296 | AnyEvent API. |
… | |
… | |
278 | 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 |
279 | function to call when you want to know the current time.> |
319 | function to call when you want to know the current time.> |
280 | |
320 | |
281 | This function is also often faster then C<< AnyEvent->time >>, and |
321 | This function is also often faster then C<< AnyEvent->time >>, and |
282 | thus the preferred method if you want some timestamp (for example, |
322 | thus the preferred method if you want some timestamp (for example, |
283 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
323 | L<AnyEvent::Handle> uses this to update its activity timeouts). |
284 | |
324 | |
285 | 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 |
286 | with your timing, you can skip it without bad conscience. |
326 | with your timing; you can skip it without a bad conscience. |
287 | |
327 | |
288 | 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> |
289 | and L<EV> and the following set-up: |
329 | and L<EV> and the following set-up: |
290 | |
330 | |
291 | 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 |
292 | time=500 (assume no other callbacks delay processing). In your callback, |
332 | time=500 (assume no other callbacks delay processing). In your callback, |
293 | 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 |
294 | 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 |
295 | after three seconds. |
335 | after three seconds. |
296 | |
336 | |
… | |
… | |
314 | In either case, if you care (and in most cases, you don't), then you |
354 | In either case, if you care (and in most cases, you don't), then you |
315 | can get whatever behaviour you want with any event loop, by taking the |
355 | can get whatever behaviour you want with any event loop, by taking the |
316 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
356 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
317 | account. |
357 | account. |
318 | |
358 | |
|
|
359 | =item AnyEvent->now_update |
|
|
360 | |
|
|
361 | Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current |
|
|
362 | time for each loop iteration (see the discussion of L<< AnyEvent->now >>, |
|
|
363 | above). |
|
|
364 | |
|
|
365 | When a callback runs for a long time (or when the process sleeps), then |
|
|
366 | this "current" time will differ substantially from the real time, which |
|
|
367 | might affect timers and time-outs. |
|
|
368 | |
|
|
369 | When this is the case, you can call this method, which will update the |
|
|
370 | event loop's idea of "current time". |
|
|
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 | |
|
|
379 | Note that updating the time I<might> cause some events to be handled. |
|
|
380 | |
319 | =back |
381 | =back |
320 | |
382 | |
321 | =head2 SIGNAL WATCHERS |
383 | =head2 SIGNAL WATCHERS |
|
|
384 | |
|
|
385 | $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>); |
322 | |
386 | |
323 | 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 |
324 | 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 |
325 | callback to be invoked whenever a signal occurs. |
389 | callback to be invoked whenever a signal occurs. |
326 | |
390 | |
… | |
… | |
332 | invocation, and callback invocation will be synchronous. Synchronous means |
396 | invocation, and callback invocation will be synchronous. Synchronous means |
333 | that it might take a while until the signal gets handled by the process, |
397 | that it might take a while until the signal gets handled by the process, |
334 | but it is guaranteed not to interrupt any other callbacks. |
398 | but it is guaranteed not to interrupt any other callbacks. |
335 | |
399 | |
336 | The main advantage of using these watchers is that you can share a signal |
400 | The main advantage of using these watchers is that you can share a signal |
337 | between multiple watchers. |
401 | between multiple watchers, and AnyEvent will ensure that signals will not |
|
|
402 | interrupt your program at bad times. |
338 | |
403 | |
339 | This watcher might use C<%SIG>, so programs overwriting those signals |
404 | This watcher might use C<%SIG> (depending on the event loop used), |
340 | directly will likely not work correctly. |
405 | so programs overwriting those signals directly will likely not work |
|
|
406 | correctly. |
341 | |
407 | |
342 | Example: exit on SIGINT |
408 | Example: exit on SIGINT |
343 | |
409 | |
344 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
410 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
345 | |
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 | |
|
|
431 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
|
|
432 | callbacks to signals in a generic way, which is a pity, as you cannot |
|
|
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, |
|
|
435 | signals will be delayed. The maximum time a signal might be delayed is |
|
|
436 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
|
|
437 | variable can be changed only before the first signal watcher is created, |
|
|
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 |
|
|
440 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
441 | saving. |
|
|
442 | |
|
|
443 | All these problems can be avoided by installing the optional |
|
|
444 | L<Async::Interrupt> module, which works with most event loops. It will not |
|
|
445 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
|
|
446 | (and not with L<POE> currently, as POE does its own workaround with |
|
|
447 | one-second latency). For those, you just have to suffer the delays. |
|
|
448 | |
346 | =head2 CHILD PROCESS WATCHERS |
449 | =head2 CHILD PROCESS WATCHERS |
347 | |
450 | |
|
|
451 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
|
|
452 | |
348 | 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. |
349 | |
454 | |
350 | 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, |
351 | 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 |
352 | 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 |
353 | any trace events (stopped/continued). |
458 | finished and an exit status is available, not on any trace events |
|
|
459 | (stopped/continued). |
354 | |
460 | |
355 | 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 |
356 | 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 |
357 | callback arguments. |
463 | callback arguments. |
358 | |
464 | |
… | |
… | |
363 | |
469 | |
364 | There is a slight catch to child watchers, however: you usually start them |
470 | There is a slight catch to child watchers, however: you usually start them |
365 | I<after> the child process was created, and this means the process could |
471 | I<after> the child process was created, and this means the process could |
366 | have exited already (and no SIGCHLD will be sent anymore). |
472 | have exited already (and no SIGCHLD will be sent anymore). |
367 | |
473 | |
368 | Not all event models handle this correctly (POE doesn't), but even for |
474 | Not all event models handle this correctly (neither POE nor IO::Async do, |
|
|
475 | see their AnyEvent::Impl manpages for details), but even for event models |
369 | event models that I<do> handle this correctly, they usually need to be |
476 | that I<do> handle this correctly, they usually need to be loaded before |
370 | loaded before the process exits (i.e. before you fork in the first place). |
477 | the process exits (i.e. before you fork in the first place). AnyEvent's |
|
|
478 | pure perl event loop handles all cases correctly regardless of when you |
|
|
479 | start the watcher. |
371 | |
480 | |
372 | This means you cannot create a child watcher as the very first thing in an |
481 | This means you cannot create a child watcher as the very first |
373 | AnyEvent program, you I<have> to create at least one watcher before you |
482 | thing in an AnyEvent program, you I<have> to create at least one |
374 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
483 | watcher before you C<fork> the child (alternatively, you can call |
|
|
484 | C<AnyEvent::detect>). |
|
|
485 | |
|
|
486 | As most event loops do not support waiting for child events, they will be |
|
|
487 | emulated by AnyEvent in most cases, in which case the latency and race |
|
|
488 | problems mentioned in the description of signal watchers apply. |
375 | |
489 | |
376 | Example: fork a process and wait for it |
490 | Example: fork a process and wait for it |
377 | |
491 | |
378 | my $done = AnyEvent->condvar; |
492 | my $done = AnyEvent->condvar; |
379 | |
493 | |
… | |
… | |
389 | ); |
503 | ); |
390 | |
504 | |
391 | # do something else, then wait for process exit |
505 | # do something else, then wait for process exit |
392 | $done->recv; |
506 | $done->recv; |
393 | |
507 | |
|
|
508 | =head2 IDLE WATCHERS |
|
|
509 | |
|
|
510 | $w = AnyEvent->idle (cb => <callback>); |
|
|
511 | |
|
|
512 | This will repeatedly invoke the callback after the process becomes idle, |
|
|
513 | until either the watcher is destroyed or new events have been detected. |
|
|
514 | |
|
|
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 |
|
|
525 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
|
|
526 | will simply call the callback "from time to time". |
|
|
527 | |
|
|
528 | Example: read lines from STDIN, but only process them when the |
|
|
529 | program is otherwise idle: |
|
|
530 | |
|
|
531 | my @lines; # read data |
|
|
532 | my $idle_w; |
|
|
533 | my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
|
|
534 | push @lines, scalar <STDIN>; |
|
|
535 | |
|
|
536 | # start an idle watcher, if not already done |
|
|
537 | $idle_w ||= AnyEvent->idle (cb => sub { |
|
|
538 | # handle only one line, when there are lines left |
|
|
539 | if (my $line = shift @lines) { |
|
|
540 | print "handled when idle: $line"; |
|
|
541 | } else { |
|
|
542 | # otherwise disable the idle watcher again |
|
|
543 | undef $idle_w; |
|
|
544 | } |
|
|
545 | }); |
|
|
546 | }); |
|
|
547 | |
394 | =head2 CONDITION VARIABLES |
548 | =head2 CONDITION VARIABLES |
|
|
549 | |
|
|
550 | $cv = AnyEvent->condvar; |
|
|
551 | |
|
|
552 | $cv->send (<list>); |
|
|
553 | my @res = $cv->recv; |
395 | |
554 | |
396 | 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 |
397 | 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 |
398 | will actively watch for new events and call your callbacks. |
557 | will actively watch for new events and call your callbacks. |
399 | |
558 | |
400 | AnyEvent is different, it expects somebody else to run the event loop and |
559 | AnyEvent is slightly different: it expects somebody else to run the event |
401 | 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). |
402 | |
561 | |
403 | 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 |
404 | because they represent a condition that must become true. |
563 | they represent a condition that must become true. |
|
|
564 | |
|
|
565 | Now is probably a good time to look at the examples further below. |
405 | |
566 | |
406 | Condition variables can be created by calling the C<< AnyEvent->condvar |
567 | Condition variables can be created by calling the C<< AnyEvent->condvar |
407 | >> method, usually without arguments. The only argument pair allowed is |
568 | >> method, usually without arguments. The only argument pair allowed is |
408 | |
|
|
409 | C<cb>, which specifies a callback to be called when the condition variable |
569 | C<cb>, which specifies a callback to be called when the condition variable |
410 | becomes true, with the condition variable as the first argument (but not |
570 | becomes true, with the condition variable as the first argument (but not |
411 | the results). |
571 | the results). |
412 | |
572 | |
413 | After creation, the condition variable is "false" until it becomes "true" |
573 | After creation, the condition variable is "false" until it becomes "true" |
414 | 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 |
415 | 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<< |
416 | ->send >> method). |
576 | ->send >> method). |
417 | |
577 | |
418 | 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 |
419 | 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: |
420 | in time where multiple outstanding events have been processed. And yet |
580 | |
421 | another way to call them is transactions - each condition variable can be |
581 | =over 4 |
422 | used to represent a transaction, which finishes at some point and delivers |
582 | |
423 | 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 |
424 | |
601 | |
425 | Condition variables are very useful to signal that something has finished, |
602 | Condition variables are very useful to signal that something has finished, |
426 | 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, |
427 | 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 |
428 | 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 |
… | |
… | |
441 | |
618 | |
442 | 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 |
443 | 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 |
444 | 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 |
445 | 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 |
446 | it's C<new> method in your own C<new> method. |
623 | its C<new> method in your own C<new> method. |
447 | |
624 | |
448 | 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 |
449 | eventually calls C<< -> send >>, and the "consumer side", which waits |
626 | eventually calls C<< -> send >>, and the "consumer side", which waits |
450 | for the send to occur. |
627 | for the send to occur. |
451 | |
628 | |
452 | Example: wait for a timer. |
629 | Example: wait for a timer. |
453 | |
630 | |
454 | # wait till the result is ready |
631 | # condition: "wait till the timer is fired" |
455 | my $result_ready = AnyEvent->condvar; |
632 | my $timer_fired = AnyEvent->condvar; |
456 | |
633 | |
457 | # do something such as adding a timer |
634 | # create the timer - we could wait for, say |
458 | # or socket watcher the calls $result_ready->send |
635 | # a handle becomign ready, or even an |
459 | # when the "result" is ready. |
636 | # AnyEvent::HTTP request to finish, but |
460 | # in this case, we simply use a timer: |
637 | # in this case, we simply use a timer: |
461 | my $w = AnyEvent->timer ( |
638 | my $w = AnyEvent->timer ( |
462 | after => 1, |
639 | after => 1, |
463 | cb => sub { $result_ready->send }, |
640 | cb => sub { $timer_fired->send }, |
464 | ); |
641 | ); |
465 | |
642 | |
466 | # this "blocks" (while handling events) till the callback |
643 | # this "blocks" (while handling events) till the callback |
467 | # calls send |
644 | # calls ->send |
468 | $result_ready->recv; |
645 | $timer_fired->recv; |
469 | |
646 | |
470 | Example: wait for a timer, but take advantage of the fact that |
647 | Example: wait for a timer, but take advantage of the fact that condition |
471 | condition variables are also code references. |
648 | variables are also callable directly. |
472 | |
649 | |
473 | my $done = AnyEvent->condvar; |
650 | my $done = AnyEvent->condvar; |
474 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
651 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
475 | $done->recv; |
652 | $done->recv; |
476 | |
653 | |
… | |
… | |
482 | |
659 | |
483 | ... |
660 | ... |
484 | |
661 | |
485 | my @info = $couchdb->info->recv; |
662 | my @info = $couchdb->info->recv; |
486 | |
663 | |
487 | And this is how you would just ste a callback to be called whenever the |
664 | And this is how you would just set a callback to be called whenever the |
488 | results are available: |
665 | results are available: |
489 | |
666 | |
490 | $couchdb->info->cb (sub { |
667 | $couchdb->info->cb (sub { |
491 | my @info = $_[0]->recv; |
668 | my @info = $_[0]->recv; |
492 | }); |
669 | }); |
… | |
… | |
510 | immediately from within send. |
687 | immediately from within send. |
511 | |
688 | |
512 | Any arguments passed to the C<send> call will be returned by all |
689 | Any arguments passed to the C<send> call will be returned by all |
513 | future C<< ->recv >> calls. |
690 | future C<< ->recv >> calls. |
514 | |
691 | |
515 | Condition variables are overloaded so one can call them directly |
692 | Condition variables are overloaded so one can call them directly (as if |
516 | (as 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 |
517 | C<send>. Note, however, that many C-based event loops do not handle |
694 | C<send>. |
518 | overloading, so as tempting as it may be, passing a condition variable |
|
|
519 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
520 | support overloading, however, as well as all functions that use perl to |
|
|
521 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
522 | example). |
|
|
523 | |
695 | |
524 | =item $cv->croak ($error) |
696 | =item $cv->croak ($error) |
525 | |
697 | |
526 | 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 |
527 | C<Carp::croak> with the given error message/object/scalar. |
699 | C<Carp::croak> with the given error message/object/scalar. |
528 | |
700 | |
529 | 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 |
530 | user/consumer. |
702 | user/consumer. Doing it this way instead of calling C<croak> directly |
|
|
703 | delays the error detection, but has the overwhelming advantage that it |
|
|
704 | diagnoses the error at the place where the result is expected, and not |
|
|
705 | deep in some event callback with no connection to the actual code causing |
|
|
706 | the problem. |
531 | |
707 | |
532 | =item $cv->begin ([group callback]) |
708 | =item $cv->begin ([group callback]) |
533 | |
709 | |
534 | =item $cv->end |
710 | =item $cv->end |
535 | |
|
|
536 | These two methods are EXPERIMENTAL and MIGHT CHANGE. |
|
|
537 | |
711 | |
538 | These two methods can be used to combine many transactions/events into |
712 | These two methods can be used to combine many transactions/events into |
539 | 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 |
540 | to use a condition variable for the whole process. |
714 | to use a condition variable for the whole process. |
541 | |
715 | |
542 | 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 |
543 | 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 |
544 | >>, 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 |
545 | 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 |
546 | 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. |
547 | |
722 | |
548 | Let's clarify this with the ping example: |
723 | You can think of C<< $cv->send >> giving you an OR condition (one call |
|
|
724 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
|
|
725 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
|
|
726 | |
|
|
727 | Let's start with a simple example: you have two I/O watchers (for example, |
|
|
728 | STDOUT and STDERR for a program), and you want to wait for both streams to |
|
|
729 | close before activating a condvar: |
549 | |
730 | |
550 | my $cv = AnyEvent->condvar; |
731 | my $cv = AnyEvent->condvar; |
551 | |
732 | |
|
|
733 | $cv->begin; # first watcher |
|
|
734 | my $w1 = AnyEvent->io (fh => $fh1, cb => sub { |
|
|
735 | defined sysread $fh1, my $buf, 4096 |
|
|
736 | or $cv->end; |
|
|
737 | }); |
|
|
738 | |
|
|
739 | $cv->begin; # second watcher |
|
|
740 | my $w2 = AnyEvent->io (fh => $fh2, cb => sub { |
|
|
741 | defined sysread $fh2, my $buf, 4096 |
|
|
742 | or $cv->end; |
|
|
743 | }); |
|
|
744 | |
|
|
745 | $cv->recv; |
|
|
746 | |
|
|
747 | This works because for every event source (EOF on file handle), there is |
|
|
748 | one call to C<begin>, so the condvar waits for all calls to C<end> before |
|
|
749 | sending. |
|
|
750 | |
|
|
751 | The ping example mentioned above is slightly more complicated, as the |
|
|
752 | there are results to be passwd back, and the number of tasks that are |
|
|
753 | begun can potentially be zero: |
|
|
754 | |
|
|
755 | my $cv = AnyEvent->condvar; |
|
|
756 | |
552 | my %result; |
757 | my %result; |
553 | $cv->begin (sub { $cv->send (\%result) }); |
758 | $cv->begin (sub { shift->send (\%result) }); |
554 | |
759 | |
555 | for my $host (@list_of_hosts) { |
760 | for my $host (@list_of_hosts) { |
556 | $cv->begin; |
761 | $cv->begin; |
557 | ping_host_then_call_callback $host, sub { |
762 | ping_host_then_call_callback $host, sub { |
558 | $result{$host} = ...; |
763 | $result{$host} = ...; |
… | |
… | |
573 | loop, which serves two important purposes: first, it sets the callback |
778 | loop, which serves two important purposes: first, it sets the callback |
574 | 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 |
575 | 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 |
576 | doesn't execute once). |
781 | doesn't execute once). |
577 | |
782 | |
578 | This is the general pattern when you "fan out" into multiple subrequests: |
783 | This is the general pattern when you "fan out" into multiple (but |
579 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
784 | potentially zero) subrequests: use an outer C<begin>/C<end> pair to set |
580 | is called at least once, and then, for each subrequest you start, call |
785 | the callback and ensure C<end> is called at least once, and then, for each |
581 | C<begin> and for each subrequest you finish, call C<end>. |
786 | subrequest you start, call C<begin> and for each subrequest you finish, |
|
|
787 | call C<end>. |
582 | |
788 | |
583 | =back |
789 | =back |
584 | |
790 | |
585 | =head3 METHODS FOR CONSUMERS |
791 | =head3 METHODS FOR CONSUMERS |
586 | |
792 | |
… | |
… | |
590 | =over 4 |
796 | =over 4 |
591 | |
797 | |
592 | =item $cv->recv |
798 | =item $cv->recv |
593 | |
799 | |
594 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
800 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
595 | >> methods have been called on c<$cv>, while servicing other watchers |
801 | >> methods have been called on C<$cv>, while servicing other watchers |
596 | normally. |
802 | normally. |
597 | |
803 | |
598 | 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 |
599 | will return immediately. |
805 | will return immediately. |
600 | |
806 | |
… | |
… | |
602 | function will call C<croak>. |
808 | function will call C<croak>. |
603 | |
809 | |
604 | In list context, all parameters passed to C<send> will be returned, |
810 | In list context, all parameters passed to C<send> will be returned, |
605 | in scalar context only the first one will be returned. |
811 | in scalar context only the first one will be returned. |
606 | |
812 | |
|
|
813 | Note that doing a blocking wait in a callback is not supported by any |
|
|
814 | event loop, that is, recursive invocation of a blocking C<< ->recv |
|
|
815 | >> is not allowed, and the C<recv> call will C<croak> if such a |
|
|
816 | condition is detected. This condition can be slightly loosened by using |
|
|
817 | L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from |
|
|
818 | any thread that doesn't run the event loop itself. |
|
|
819 | |
607 | Not all event models support a blocking wait - some die in that case |
820 | Not all event models support a blocking wait - some die in that case |
608 | (programs might want to do that to stay interactive), so I<if you are |
821 | (programs might want to do that to stay interactive), so I<if you are |
609 | using this from a module, never require a blocking wait>, but let the |
822 | using this from a module, never require a blocking wait>. Instead, let the |
610 | 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 |
611 | condition variables with some kind of request results and supporting |
824 | condition variables with some kind of request results and supporting |
612 | 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, |
613 | while still supporting blocking waits if the caller so desires). |
826 | while still supporting blocking waits if the caller so desires). |
614 | |
827 | |
615 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
|
|
616 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
|
|
617 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
|
|
618 | can supply. |
|
|
619 | |
|
|
620 | The L<Coro> module, however, I<can> and I<does> supply coroutines and, in |
|
|
621 | fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe |
|
|
622 | versions and also integrates coroutines into AnyEvent, making blocking |
|
|
623 | C<< ->recv >> calls perfectly safe as long as they are done from another |
|
|
624 | coroutine (one that doesn't run the event loop). |
|
|
625 | |
|
|
626 | 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 |
627 | 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 |
628 | 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 |
629 | waits otherwise. |
831 | waits otherwise. |
630 | |
832 | |
631 | =item $bool = $cv->ready |
833 | =item $bool = $cv->ready |
… | |
… | |
637 | |
839 | |
638 | 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 |
639 | replaces it before doing so. |
841 | replaces it before doing so. |
640 | |
842 | |
641 | 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 |
642 | 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 |
643 | variable itself. Calling C<recv> inside the callback or at any later time |
845 | condition variable itself. If the condition is already true, the |
644 | 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. |
645 | |
848 | |
646 | =back |
849 | =back |
647 | |
850 | |
|
|
851 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
|
|
852 | |
|
|
853 | The available backend classes are (every class has its own manpage): |
|
|
854 | |
|
|
855 | =over 4 |
|
|
856 | |
|
|
857 | =item Backends that are autoprobed when no other event loop can be found. |
|
|
858 | |
|
|
859 | EV is the preferred backend when no other event loop seems to be in |
|
|
860 | use. If EV is not installed, then AnyEvent will fall back to its own |
|
|
861 | pure-perl implementation, which is available everywhere as it comes with |
|
|
862 | AnyEvent itself. |
|
|
863 | |
|
|
864 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
|
|
865 | AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable. |
|
|
866 | |
|
|
867 | =item Backends that are transparently being picked up when they are used. |
|
|
868 | |
|
|
869 | These will be used if they are already loaded when the first watcher |
|
|
870 | is created, in which case it is assumed that the application is using |
|
|
871 | them. This means that AnyEvent will automatically pick the right backend |
|
|
872 | when the main program loads an event module before anything starts to |
|
|
873 | create watchers. Nothing special needs to be done by the main program. |
|
|
874 | |
|
|
875 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
876 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
|
|
877 | AnyEvent::Impl::Tk based on Tk, very broken. |
|
|
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
880 | AnyEvent::Impl::Irssi used when running within irssi. |
|
|
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
|
|
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
|
|
883 | AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). |
|
|
884 | |
|
|
885 | =item Backends with special needs. |
|
|
886 | |
|
|
887 | Qt requires the Qt::Application to be instantiated first, but will |
|
|
888 | otherwise be picked up automatically. As long as the main program |
|
|
889 | instantiates the application before any AnyEvent watchers are created, |
|
|
890 | everything should just work. |
|
|
891 | |
|
|
892 | AnyEvent::Impl::Qt based on Qt. |
|
|
893 | |
|
|
894 | =item Event loops that are indirectly supported via other backends. |
|
|
895 | |
|
|
896 | Some event loops can be supported via other modules: |
|
|
897 | |
|
|
898 | There is no direct support for WxWidgets (L<Wx>) or L<Prima>. |
|
|
899 | |
|
|
900 | B<WxWidgets> has no support for watching file handles. However, you can |
|
|
901 | use WxWidgets through the POE adaptor, as POE has a Wx backend that simply |
|
|
902 | polls 20 times per second, which was considered to be too horrible to even |
|
|
903 | consider for AnyEvent. |
|
|
904 | |
|
|
905 | B<Prima> is not supported as nobody seems to be using it, but it has a POE |
|
|
906 | backend, so it can be supported through POE. |
|
|
907 | |
|
|
908 | AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to |
|
|
909 | load L<POE> when detecting them, in the hope that POE will pick them up, |
|
|
910 | in which case everything will be automatic. |
|
|
911 | |
|
|
912 | =back |
|
|
913 | |
648 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
914 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
649 | |
915 | |
|
|
916 | These are not normally required to use AnyEvent, but can be useful to |
|
|
917 | write AnyEvent extension modules. |
|
|
918 | |
650 | =over 4 |
919 | =over 4 |
651 | |
920 | |
652 | =item $AnyEvent::MODEL |
921 | =item $AnyEvent::MODEL |
653 | |
922 | |
654 | Contains C<undef> until the first watcher is being created. Then it |
923 | Contains C<undef> until the first watcher is being created, before the |
|
|
924 | backend has been autodetected. |
|
|
925 | |
655 | contains the event model that is being used, which is the name of the |
926 | Afterwards it contains the event model that is being used, which is the |
656 | Perl class implementing the model. This class is usually one of the |
927 | name of the Perl class implementing the model. This class is usually one |
657 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
928 | of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the |
658 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
929 | case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it |
659 | |
930 | will be C<urxvt::anyevent>). |
660 | The known classes so far are: |
|
|
661 | |
|
|
662 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
|
|
663 | AnyEvent::Impl::Event based on Event, second best choice. |
|
|
664 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
665 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
|
|
666 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
|
|
667 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
|
|
668 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
669 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
|
|
670 | |
|
|
671 | There is no support for WxWidgets, as WxWidgets has no support for |
|
|
672 | watching file handles. However, you can use WxWidgets through the |
|
|
673 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
|
|
674 | second, which was considered to be too horrible to even consider for |
|
|
675 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
|
|
676 | it's adaptor. |
|
|
677 | |
|
|
678 | AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when |
|
|
679 | autodetecting them. |
|
|
680 | |
931 | |
681 | =item AnyEvent::detect |
932 | =item AnyEvent::detect |
682 | |
933 | |
683 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
934 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
684 | if necessary. You should only call this function right before you would |
935 | if necessary. You should only call this function right before you would |
685 | have created an AnyEvent watcher anyway, that is, as late as possible at |
936 | have created an AnyEvent watcher anyway, that is, as late as possible at |
686 | runtime. |
937 | runtime, and not e.g. during initialisation of your module. |
|
|
938 | |
|
|
939 | The effect of calling this function is as if a watcher had been created |
|
|
940 | (specifically, actions that happen "when the first watcher is created" |
|
|
941 | happen when calling detetc as well). |
|
|
942 | |
|
|
943 | If you need to do some initialisation before AnyEvent watchers are |
|
|
944 | created, use C<post_detect>. |
687 | |
945 | |
688 | =item $guard = AnyEvent::post_detect { BLOCK } |
946 | =item $guard = AnyEvent::post_detect { BLOCK } |
689 | |
947 | |
690 | Arranges for the code block to be executed as soon as the event model is |
948 | Arranges for the code block to be executed as soon as the event model is |
691 | autodetected (or immediately if this has already happened). |
949 | autodetected (or immediately if that has already happened). |
|
|
950 | |
|
|
951 | The block will be executed I<after> the actual backend has been detected |
|
|
952 | (C<$AnyEvent::MODEL> is set), but I<before> any watchers have been |
|
|
953 | created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do |
|
|
954 | other initialisations - see the sources of L<AnyEvent::Strict> or |
|
|
955 | L<AnyEvent::AIO> to see how this is used. |
|
|
956 | |
|
|
957 | The most common usage is to create some global watchers, without forcing |
|
|
958 | event module detection too early, for example, L<AnyEvent::AIO> creates |
|
|
959 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
|
|
960 | avoid autodetecting the event module at load time. |
692 | |
961 | |
693 | If called in scalar or list context, then it creates and returns an object |
962 | If called in scalar or list context, then it creates and returns an object |
694 | that automatically removes the callback again when it is destroyed. See |
963 | that automatically removes the callback again when it is destroyed (or |
|
|
964 | C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for |
695 | L<Coro::BDB> for a case where this is useful. |
965 | a case where this is useful. |
|
|
966 | |
|
|
967 | Example: Create a watcher for the IO::AIO module and store it in |
|
|
968 | C<$WATCHER>, but do so only do so after the event loop is initialised. |
|
|
969 | |
|
|
970 | our WATCHER; |
|
|
971 | |
|
|
972 | my $guard = AnyEvent::post_detect { |
|
|
973 | $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); |
|
|
974 | }; |
|
|
975 | |
|
|
976 | # the ||= is important in case post_detect immediately runs the block, |
|
|
977 | # as to not clobber the newly-created watcher. assigning both watcher and |
|
|
978 | # post_detect guard to the same variable has the advantage of users being |
|
|
979 | # able to just C<undef $WATCHER> if the watcher causes them grief. |
|
|
980 | |
|
|
981 | $WATCHER ||= $guard; |
696 | |
982 | |
697 | =item @AnyEvent::post_detect |
983 | =item @AnyEvent::post_detect |
698 | |
984 | |
699 | If there are any code references in this array (you can C<push> to it |
985 | If there are any code references in this array (you can C<push> to it |
700 | before or after loading AnyEvent), then they will called directly after |
986 | before or after loading AnyEvent), then they will be called directly |
701 | the event loop has been chosen. |
987 | after the event loop has been chosen. |
702 | |
988 | |
703 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
989 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
704 | if it contains a true value then the event loop has already been detected, |
990 | if it is defined then the event loop has already been detected, and the |
705 | and the array will be ignored. |
991 | array will be ignored. |
706 | |
992 | |
707 | Best use C<AnyEvent::post_detect { BLOCK }> instead. |
993 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
|
|
994 | it, as it takes care of these details. |
|
|
995 | |
|
|
996 | This variable is mainly useful for modules that can do something useful |
|
|
997 | when AnyEvent is used and thus want to know when it is initialised, but do |
|
|
998 | not need to even load it by default. This array provides the means to hook |
|
|
999 | into AnyEvent passively, without loading it. |
|
|
1000 | |
|
|
1001 | Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used |
|
|
1002 | together, you could put this into Coro (this is the actual code used by |
|
|
1003 | Coro to accomplish this): |
|
|
1004 | |
|
|
1005 | if (defined $AnyEvent::MODEL) { |
|
|
1006 | # AnyEvent already initialised, so load Coro::AnyEvent |
|
|
1007 | require Coro::AnyEvent; |
|
|
1008 | } else { |
|
|
1009 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
|
|
1010 | # as soon as it is |
|
|
1011 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
|
|
1012 | } |
|
|
1013 | |
|
|
1014 | =item AnyEvent::postpone { BLOCK } |
|
|
1015 | |
|
|
1016 | Arranges for the block to be executed as soon as possible, but not before |
|
|
1017 | the call itself returns. In practise, the block will be executed just |
|
|
1018 | before the event loop polls for new events, or shortly afterwards. |
|
|
1019 | |
|
|
1020 | This function never returns anything (to make the C<return postpone { ... |
|
|
1021 | }> idiom more useful. |
|
|
1022 | |
|
|
1023 | To understand the usefulness of this function, consider a function that |
|
|
1024 | asynchronously does something for you and returns some transaction |
|
|
1025 | object or guard to let you cancel the operation. For example, |
|
|
1026 | C<AnyEvent::Socket::tcp_connect>: |
|
|
1027 | |
|
|
1028 | # start a conenction attempt unless one is active |
|
|
1029 | $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub { |
|
|
1030 | delete $self->{connect_guard}; |
|
|
1031 | ... |
|
|
1032 | }; |
|
|
1033 | |
|
|
1034 | Imagine that this function could instantly call the callback, for |
|
|
1035 | example, because it detects an obvious error such as a negative port |
|
|
1036 | number. Invoking the callback before the function returns causes problems |
|
|
1037 | however: the callback will be called and will try to delete the guard |
|
|
1038 | object. But since the function hasn't returned yet, there is nothing to |
|
|
1039 | delete. When the function eventually returns it will assign the guard |
|
|
1040 | object to C<< $self->{connect_guard} >>, where it will likely never be |
|
|
1041 | deleted, so the program thinks it is still trying to connect. |
|
|
1042 | |
|
|
1043 | This is where C<AnyEvent::postpone> should be used. Instead of calling the |
|
|
1044 | callback directly on error: |
|
|
1045 | |
|
|
1046 | $cb->(undef), return # signal error to callback, BAD! |
|
|
1047 | if $some_error_condition; |
|
|
1048 | |
|
|
1049 | It should use C<postpone>: |
|
|
1050 | |
|
|
1051 | AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later |
|
|
1052 | if $some_error_condition; |
|
|
1053 | |
|
|
1054 | =item AnyEvent::log $level, $msg[, @args] |
|
|
1055 | |
|
|
1056 | Log the given C<$msg> at the given C<$level>. |
|
|
1057 | |
|
|
1058 | Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> - |
|
|
1059 | consequently, look at the L<AnyEvent::Log> documentation for details. |
|
|
1060 | |
|
|
1061 | If you want to sprinkle loads of logging calls around your code, consider |
|
|
1062 | creating a logger callback with the C<AnyEvent::Log::logger< function. |
708 | |
1063 | |
709 | =back |
1064 | =back |
710 | |
1065 | |
711 | =head1 WHAT TO DO IN A MODULE |
1066 | =head1 WHAT TO DO IN A MODULE |
712 | |
1067 | |
… | |
… | |
723 | because it will stall the whole program, and the whole point of using |
1078 | because it will stall the whole program, and the whole point of using |
724 | events is to stay interactive. |
1079 | events is to stay interactive. |
725 | |
1080 | |
726 | It is fine, however, to call C<< ->recv >> when the user of your module |
1081 | It is fine, however, to call C<< ->recv >> when the user of your module |
727 | requests it (i.e. if you create a http request object ad have a method |
1082 | requests it (i.e. if you create a http request object ad have a method |
728 | called C<results> that returns the results, it should call C<< ->recv >> |
1083 | called C<results> that returns the results, it may call C<< ->recv >> |
729 | freely, as the user of your module knows what she is doing. always). |
1084 | freely, as the user of your module knows what she is doing. Always). |
730 | |
1085 | |
731 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
1086 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
732 | |
1087 | |
733 | There will always be a single main program - the only place that should |
1088 | There will always be a single main program - the only place that should |
734 | dictate which event model to use. |
1089 | dictate which event model to use. |
735 | |
1090 | |
736 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
1091 | If the program is not event-based, it need not do anything special, even |
737 | do anything special (it does not need to be event-based) and let AnyEvent |
1092 | when it depends on a module that uses an AnyEvent. If the program itself |
738 | decide which implementation to chose if some module relies on it. |
1093 | uses AnyEvent, but does not care which event loop is used, all it needs |
|
|
1094 | to do is C<use AnyEvent>. In either case, AnyEvent will choose the best |
|
|
1095 | available loop implementation. |
739 | |
1096 | |
740 | If the main program relies on a specific event model - for example, in |
1097 | If the main program relies on a specific event model - for example, in |
741 | Gtk2 programs you have to rely on the Glib module - you should load the |
1098 | Gtk2 programs you have to rely on the Glib module - you should load the |
742 | event module before loading AnyEvent or any module that uses it: generally |
1099 | event module before loading AnyEvent or any module that uses it: generally |
743 | speaking, you should load it as early as possible. The reason is that |
1100 | speaking, you should load it as early as possible. The reason is that |
744 | modules might create watchers when they are loaded, and AnyEvent will |
1101 | modules might create watchers when they are loaded, and AnyEvent will |
745 | decide on the event model to use as soon as it creates watchers, and it |
1102 | decide on the event model to use as soon as it creates watchers, and it |
746 | might chose the wrong one unless you load the correct one yourself. |
1103 | might choose the wrong one unless you load the correct one yourself. |
747 | |
1104 | |
748 | You can chose to use a pure-perl implementation by loading the |
1105 | You can chose to use a pure-perl implementation by loading the |
749 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
1106 | C<AnyEvent::Loop> module, which gives you similar behaviour |
750 | everywhere, but letting AnyEvent chose the model is generally better. |
1107 | everywhere, but letting AnyEvent chose the model is generally better. |
751 | |
1108 | |
752 | =head2 MAINLOOP EMULATION |
1109 | =head2 MAINLOOP EMULATION |
753 | |
1110 | |
754 | Sometimes (often for short test scripts, or even standalone programs who |
1111 | Sometimes (often for short test scripts, or even standalone programs who |
… | |
… | |
767 | |
1124 | |
768 | |
1125 | |
769 | =head1 OTHER MODULES |
1126 | =head1 OTHER MODULES |
770 | |
1127 | |
771 | The following is a non-exhaustive list of additional modules that use |
1128 | The following is a non-exhaustive list of additional modules that use |
772 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
1129 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
773 | in the same program. Some of the modules come with AnyEvent, some are |
1130 | modules and other event loops in the same program. Some of the modules |
774 | available via CPAN. |
1131 | come as part of AnyEvent, the others are available via CPAN. |
775 | |
1132 | |
776 | =over 4 |
1133 | =over 4 |
777 | |
1134 | |
778 | =item L<AnyEvent::Util> |
1135 | =item L<AnyEvent::Util> |
779 | |
1136 | |
780 | Contains various utility functions that replace often-used but blocking |
1137 | Contains various utility functions that replace often-used blocking |
781 | functions such as C<inet_aton> by event-/callback-based versions. |
1138 | functions such as C<inet_aton> with event/callback-based versions. |
782 | |
1139 | |
783 | =item L<AnyEvent::Socket> |
1140 | =item L<AnyEvent::Socket> |
784 | |
1141 | |
785 | Provides various utility functions for (internet protocol) sockets, |
1142 | Provides various utility functions for (internet protocol) sockets, |
786 | addresses and name resolution. Also functions to create non-blocking tcp |
1143 | addresses and name resolution. Also functions to create non-blocking tcp |
… | |
… | |
788 | |
1145 | |
789 | =item L<AnyEvent::Handle> |
1146 | =item L<AnyEvent::Handle> |
790 | |
1147 | |
791 | Provide read and write buffers, manages watchers for reads and writes, |
1148 | Provide read and write buffers, manages watchers for reads and writes, |
792 | supports raw and formatted I/O, I/O queued and fully transparent and |
1149 | supports raw and formatted I/O, I/O queued and fully transparent and |
793 | non-blocking SSL/TLS. |
1150 | non-blocking SSL/TLS (via L<AnyEvent::TLS>). |
794 | |
1151 | |
795 | =item L<AnyEvent::DNS> |
1152 | =item L<AnyEvent::DNS> |
796 | |
1153 | |
797 | Provides rich asynchronous DNS resolver capabilities. |
1154 | Provides rich asynchronous DNS resolver capabilities. |
798 | |
1155 | |
|
|
1156 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
|
|
1157 | |
|
|
1158 | Implement event-based interfaces to the protocols of the same name (for |
|
|
1159 | the curious, IGS is the International Go Server and FCP is the Freenet |
|
|
1160 | Client Protocol). |
|
|
1161 | |
|
|
1162 | =item L<AnyEvent::Handle::UDP> |
|
|
1163 | |
|
|
1164 | Here be danger! |
|
|
1165 | |
|
|
1166 | As Pauli would put it, "Not only is it not right, it's not even wrong!" - |
|
|
1167 | there are so many things wrong with AnyEvent::Handle::UDP, most notably |
|
|
1168 | its use of a stream-based API with a protocol that isn't streamable, that |
|
|
1169 | the only way to improve it is to delete it. |
|
|
1170 | |
|
|
1171 | It features data corruption (but typically only under load) and general |
|
|
1172 | confusion. On top, the author is not only clueless about UDP but also |
|
|
1173 | fact-resistant - some gems of his understanding: "connect doesn't work |
|
|
1174 | with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not |
|
|
1175 | packets", "I don't need to implement proper error checking as UDP doesn't |
|
|
1176 | support error checking" and so on - he doesn't even understand what's |
|
|
1177 | wrong with his module when it is explained to him. |
|
|
1178 | |
799 | =item L<AnyEvent::HTTP> |
1179 | =item L<AnyEvent::DBI> |
800 | |
1180 | |
801 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
1181 | Executes L<DBI> requests asynchronously in a proxy process for you, |
802 | HTTP requests. |
1182 | notifying you in an event-based way when the operation is finished. |
|
|
1183 | |
|
|
1184 | =item L<AnyEvent::AIO> |
|
|
1185 | |
|
|
1186 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
|
|
1187 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
|
|
1188 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
|
|
1189 | file I/O, and much more. |
803 | |
1190 | |
804 | =item L<AnyEvent::HTTPD> |
1191 | =item L<AnyEvent::HTTPD> |
805 | |
1192 | |
806 | Provides a simple web application server framework. |
1193 | A simple embedded webserver. |
807 | |
1194 | |
808 | =item L<AnyEvent::FastPing> |
1195 | =item L<AnyEvent::FastPing> |
809 | |
1196 | |
810 | The fastest ping in the west. |
1197 | The fastest ping in the west. |
811 | |
1198 | |
812 | =item L<AnyEvent::DBI> |
|
|
813 | |
|
|
814 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
815 | |
|
|
816 | =item L<AnyEvent::AIO> |
|
|
817 | |
|
|
818 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
819 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
820 | together. |
|
|
821 | |
|
|
822 | =item L<AnyEvent::BDB> |
|
|
823 | |
|
|
824 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
825 | L<BDB> and AnyEvent together. |
|
|
826 | |
|
|
827 | =item L<AnyEvent::GPSD> |
|
|
828 | |
|
|
829 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
830 | |
|
|
831 | =item L<AnyEvent::IGS> |
|
|
832 | |
|
|
833 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
834 | L<App::IGS>). |
|
|
835 | |
|
|
836 | =item L<AnyEvent::IRC> |
|
|
837 | |
|
|
838 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
839 | |
|
|
840 | =item L<Net::XMPP2> |
|
|
841 | |
|
|
842 | AnyEvent based XMPP (Jabber protocol) module family. |
|
|
843 | |
|
|
844 | =item L<Net::FCP> |
|
|
845 | |
|
|
846 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
|
|
847 | of AnyEvent. |
|
|
848 | |
|
|
849 | =item L<Event::ExecFlow> |
|
|
850 | |
|
|
851 | High level API for event-based execution flow control. |
|
|
852 | |
|
|
853 | =item L<Coro> |
1199 | =item L<Coro> |
854 | |
1200 | |
855 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1201 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
856 | |
1202 | |
857 | =item L<IO::Lambda> |
|
|
858 | |
|
|
859 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
|
|
860 | |
|
|
861 | =back |
1203 | =back |
862 | |
1204 | |
863 | =cut |
1205 | =cut |
864 | |
1206 | |
865 | package AnyEvent; |
1207 | package AnyEvent; |
866 | |
1208 | |
867 | no warnings; |
1209 | # basically a tuned-down version of common::sense |
868 | use strict qw(vars subs); |
1210 | sub common_sense { |
|
|
1211 | # from common:.sense 3.4 |
|
|
1212 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; |
|
|
1213 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
|
|
1214 | $^H |= 0x00000600; |
|
|
1215 | } |
869 | |
1216 | |
|
|
1217 | BEGIN { AnyEvent::common_sense } |
|
|
1218 | |
870 | use Carp; |
1219 | use Carp (); |
871 | |
1220 | |
872 | our $VERSION = 4.341; |
1221 | our $VERSION = '6.01'; |
873 | our $MODEL; |
1222 | our $MODEL; |
874 | |
1223 | |
875 | our $AUTOLOAD; |
|
|
876 | our @ISA; |
1224 | our @ISA; |
877 | |
1225 | |
878 | our @REGISTRY; |
1226 | our @REGISTRY; |
879 | |
1227 | |
880 | our $WIN32; |
1228 | our $VERBOSE; |
881 | |
1229 | |
882 | BEGIN { |
1230 | BEGIN { |
883 | my $win32 = ! ! ($^O =~ /mswin32/i); |
1231 | require "AnyEvent/constants.pl"; |
884 | eval "sub WIN32(){ $win32 }"; |
|
|
885 | } |
|
|
886 | |
1232 | |
|
|
1233 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
|
|
1234 | |
|
|
1235 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
|
|
1236 | if ${^TAINT}; |
|
|
1237 | |
887 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1238 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
|
|
1239 | } |
|
|
1240 | |
|
|
1241 | our $MAX_SIGNAL_LATENCY = 10; |
888 | |
1242 | |
889 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1243 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
890 | |
1244 | |
891 | { |
1245 | { |
892 | my $idx; |
1246 | my $idx; |
893 | $PROTOCOL{$_} = ++$idx |
1247 | $PROTOCOL{$_} = ++$idx |
894 | for reverse split /\s*,\s*/, |
1248 | for reverse split /\s*,\s*/, |
895 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1249 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
896 | } |
1250 | } |
897 | |
1251 | |
|
|
1252 | our @post_detect; |
|
|
1253 | |
|
|
1254 | sub post_detect(&) { |
|
|
1255 | my ($cb) = @_; |
|
|
1256 | |
|
|
1257 | push @post_detect, $cb; |
|
|
1258 | |
|
|
1259 | defined wantarray |
|
|
1260 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1261 | : () |
|
|
1262 | } |
|
|
1263 | |
|
|
1264 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1265 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1266 | } |
|
|
1267 | |
|
|
1268 | our $POSTPONE_W; |
|
|
1269 | our @POSTPONE; |
|
|
1270 | |
|
|
1271 | sub _postpone_exec { |
|
|
1272 | undef $POSTPONE_W; |
|
|
1273 | |
|
|
1274 | &{ shift @POSTPONE } |
|
|
1275 | while @POSTPONE; |
|
|
1276 | } |
|
|
1277 | |
|
|
1278 | sub postpone(&) { |
|
|
1279 | push @POSTPONE, shift; |
|
|
1280 | |
|
|
1281 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
|
|
1282 | |
|
|
1283 | () |
|
|
1284 | } |
|
|
1285 | |
|
|
1286 | sub log($$;@) { |
|
|
1287 | require AnyEvent::Log; |
|
|
1288 | # AnyEvent::Log overwrites this function |
|
|
1289 | goto &log; |
|
|
1290 | } |
|
|
1291 | |
898 | my @models = ( |
1292 | our @models = ( |
899 | [EV:: => AnyEvent::Impl::EV::], |
1293 | [EV:: => AnyEvent::Impl::EV:: , 1], |
900 | [Event:: => AnyEvent::Impl::Event::], |
1294 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
901 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
|
|
902 | # everything below here will not be autoprobed |
1295 | # everything below here will not (normally) be autoprobed |
903 | # as the pureperl backend should work everywhere |
1296 | # as the pure perl backend should work everywhere |
904 | # and is usually faster |
1297 | # and is usually faster |
|
|
1298 | [Event:: => AnyEvent::Impl::Event::, 1], |
|
|
1299 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
|
|
1300 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1301 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
905 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1302 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
906 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
|
|
907 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
908 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1303 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
909 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1304 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
910 | [Wx:: => AnyEvent::Impl::POE::], |
1305 | [Wx:: => AnyEvent::Impl::POE::], |
911 | [Prima:: => AnyEvent::Impl::POE::], |
1306 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
1307 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
|
|
1308 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
|
|
1309 | [FLTK:: => AnyEvent::Impl::FLTK2::], |
912 | ); |
1310 | ); |
913 | |
1311 | |
914 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
1312 | our @isa_hook; |
915 | |
1313 | |
916 | our @post_detect; |
1314 | sub _isa_set { |
|
|
1315 | my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL); |
917 | |
1316 | |
|
|
1317 | @{"$pkg[$_-1]::ISA"} = $pkg[$_] |
|
|
1318 | for 1 .. $#pkg; |
|
|
1319 | |
|
|
1320 | grep $_ && $_->[1], @isa_hook |
|
|
1321 | and AE::_reset (); |
|
|
1322 | } |
|
|
1323 | |
|
|
1324 | # used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy |
|
|
1325 | sub _isa_hook($$;$) { |
|
|
1326 | my ($i, $pkg, $reset_ae) = @_; |
|
|
1327 | |
|
|
1328 | $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef; |
|
|
1329 | |
|
|
1330 | _isa_set; |
|
|
1331 | } |
|
|
1332 | |
|
|
1333 | # all autoloaded methods reserve the complete glob, not just the method slot. |
|
|
1334 | # due to bugs in perls method cache implementation. |
|
|
1335 | our @methods = qw(io timer time now now_update signal child idle condvar); |
|
|
1336 | |
918 | sub post_detect(&) { |
1337 | sub detect() { |
919 | my ($cb) = @_; |
1338 | return $MODEL if $MODEL; # some programs keep references to detect |
920 | |
1339 | |
921 | if ($MODEL) { |
1340 | local $!; # for good measure |
922 | $cb->(); |
1341 | local $SIG{__DIE__}; # we use eval |
923 | |
1342 | |
924 | 1 |
1343 | # free some memory |
|
|
1344 | *detect = sub () { $MODEL }; |
|
|
1345 | # undef &func doesn't correctly update the method cache. grmbl. |
|
|
1346 | # so we delete the whole glob. grmbl. |
|
|
1347 | # otoh, perl doesn't let me undef an active usb, but it lets me free |
|
|
1348 | # a glob with an active sub. hrm. i hope it works, but perl is |
|
|
1349 | # usually buggy in this department. sigh. |
|
|
1350 | delete @{"AnyEvent::"}{@methods}; |
|
|
1351 | undef @methods; |
|
|
1352 | |
|
|
1353 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
|
|
1354 | my $model = $1; |
|
|
1355 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
|
|
1356 | if (eval "require $model") { |
|
|
1357 | $MODEL = $model; |
|
|
1358 | AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it." |
|
|
1359 | if $VERBOSE >= 7; |
925 | } else { |
1360 | } else { |
926 | push @post_detect, $cb; |
1361 | AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; |
927 | |
1362 | } |
928 | defined wantarray |
|
|
929 | ? bless \$cb, "AnyEvent::Util::PostDetect" |
|
|
930 | : () |
|
|
931 | } |
1363 | } |
932 | } |
|
|
933 | |
1364 | |
934 | sub AnyEvent::Util::PostDetect::DESTROY { |
1365 | # check for already loaded models |
935 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
936 | } |
|
|
937 | |
|
|
938 | sub detect() { |
|
|
939 | unless ($MODEL) { |
1366 | unless ($MODEL) { |
940 | no strict 'refs'; |
1367 | for (@REGISTRY, @models) { |
941 | local $SIG{__DIE__}; |
1368 | my ($package, $model) = @$_; |
942 | |
1369 | if (${"$package\::VERSION"} > 0) { |
943 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
|
|
944 | my $model = "AnyEvent::Impl::$1"; |
|
|
945 | if (eval "require $model") { |
1370 | if (eval "require $model") { |
946 | $MODEL = $model; |
1371 | $MODEL = $model; |
947 | warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; |
1372 | AnyEvent::log 7 => "autodetected model '$model', using it." |
948 | } else { |
1373 | if $VERBOSE >= 7; |
949 | warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; |
1374 | last; |
|
|
1375 | } |
950 | } |
1376 | } |
951 | } |
1377 | } |
952 | |
1378 | |
953 | # check for already loaded models |
|
|
954 | unless ($MODEL) { |
1379 | unless ($MODEL) { |
|
|
1380 | # try to autoload a model |
955 | for (@REGISTRY, @models) { |
1381 | for (@REGISTRY, @models) { |
956 | my ($package, $model) = @$_; |
1382 | my ($package, $model, $autoload) = @$_; |
|
|
1383 | if ( |
|
|
1384 | $autoload |
|
|
1385 | and eval "require $package" |
957 | if (${"$package\::VERSION"} > 0) { |
1386 | and ${"$package\::VERSION"} > 0 |
958 | if (eval "require $model") { |
1387 | and eval "require $model" |
|
|
1388 | ) { |
959 | $MODEL = $model; |
1389 | $MODEL = $model; |
960 | warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; |
1390 | AnyEvent::log 7 => "autoloaded model '$model', using it." |
|
|
1391 | if $VERBOSE >= 7; |
961 | last; |
1392 | last; |
962 | } |
|
|
963 | } |
1393 | } |
964 | } |
1394 | } |
965 | |
1395 | |
966 | unless ($MODEL) { |
|
|
967 | # try to load a model |
|
|
968 | |
|
|
969 | for (@REGISTRY, @models) { |
|
|
970 | my ($package, $model) = @$_; |
|
|
971 | if (eval "require $package" |
|
|
972 | and ${"$package\::VERSION"} > 0 |
|
|
973 | and eval "require $model") { |
|
|
974 | $MODEL = $model; |
|
|
975 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; |
|
|
976 | last; |
|
|
977 | } |
|
|
978 | } |
|
|
979 | |
|
|
980 | $MODEL |
1396 | $MODEL |
981 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
1397 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; |
982 | } |
|
|
983 | } |
1398 | } |
984 | |
|
|
985 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
986 | |
|
|
987 | unshift @ISA, $MODEL; |
|
|
988 | |
|
|
989 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
|
|
990 | |
|
|
991 | (shift @post_detect)->() while @post_detect; |
|
|
992 | } |
1399 | } |
993 | |
1400 | |
|
|
1401 | # free memory only needed for probing |
|
|
1402 | undef @models; |
|
|
1403 | undef @REGISTRY; |
|
|
1404 | |
|
|
1405 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1406 | |
|
|
1407 | # now nuke some methods that are overridden by the backend. |
|
|
1408 | # SUPER usage is not allowed in these. |
|
|
1409 | for (qw(time signal child idle)) { |
|
|
1410 | undef &{"AnyEvent::Base::$_"} |
|
|
1411 | if defined &{"$MODEL\::$_"}; |
|
|
1412 | } |
|
|
1413 | |
|
|
1414 | _isa_set; |
|
|
1415 | |
|
|
1416 | # we're officially open! |
|
|
1417 | |
|
|
1418 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
|
|
1419 | require AnyEvent::Strict; |
|
|
1420 | } |
|
|
1421 | |
|
|
1422 | if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { |
|
|
1423 | require AnyEvent::Debug; |
|
|
1424 | AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); |
|
|
1425 | } |
|
|
1426 | |
|
|
1427 | if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { |
|
|
1428 | require AnyEvent::Socket; |
|
|
1429 | require AnyEvent::Debug; |
|
|
1430 | |
|
|
1431 | my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; |
|
|
1432 | $shell =~ s/\$\$/$$/g; |
|
|
1433 | |
|
|
1434 | my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); |
|
|
1435 | $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); |
|
|
1436 | } |
|
|
1437 | |
|
|
1438 | # now the anyevent environment is set up as the user told us to, so |
|
|
1439 | # call the actual user code - post detects |
|
|
1440 | |
|
|
1441 | (shift @post_detect)->() while @post_detect; |
|
|
1442 | undef @post_detect; |
|
|
1443 | |
|
|
1444 | *post_detect = sub(&) { |
|
|
1445 | shift->(); |
|
|
1446 | |
|
|
1447 | undef |
|
|
1448 | }; |
|
|
1449 | |
994 | $MODEL |
1450 | $MODEL |
995 | } |
1451 | } |
996 | |
1452 | |
997 | sub AUTOLOAD { |
1453 | for my $name (@methods) { |
998 | (my $func = $AUTOLOAD) =~ s/.*://; |
1454 | *$name = sub { |
999 | |
1455 | detect; |
1000 | $method{$func} |
1456 | # we use goto because |
1001 | or croak "$func: not a valid method for AnyEvent objects"; |
1457 | # a) it makes the thunk more transparent |
1002 | |
1458 | # b) it allows us to delete the thunk later |
1003 | detect unless $MODEL; |
1459 | goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" } |
1004 | |
1460 | }; |
1005 | my $class = shift; |
|
|
1006 | $class->$func (@_); |
|
|
1007 | } |
1461 | } |
1008 | |
1462 | |
1009 | # utility function to dup a filehandle. this is used by many backends |
1463 | # utility function to dup a filehandle. this is used by many backends |
1010 | # to support binding more than one watcher per filehandle (they usually |
1464 | # to support binding more than one watcher per filehandle (they usually |
1011 | # allow only one watcher per fd, so we dup it to get a different one). |
1465 | # allow only one watcher per fd, so we dup it to get a different one). |
1012 | sub _dupfh($$$$) { |
1466 | sub _dupfh($$;$$) { |
1013 | my ($poll, $fh, $r, $w) = @_; |
1467 | my ($poll, $fh, $r, $w) = @_; |
1014 | |
1468 | |
1015 | # cygwin requires the fh mode to be matching, unix doesn't |
1469 | # cygwin requires the fh mode to be matching, unix doesn't |
1016 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1470 | my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&"); |
1017 | : $poll eq "w" ? ($w, ">") |
|
|
1018 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
|
|
1019 | |
1471 | |
1020 | open my $fh2, "$mode&" . fileno $fh |
1472 | open my $fh2, $mode, $fh |
1021 | or die "cannot dup() filehandle: $!"; |
1473 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
1022 | |
1474 | |
1023 | # we assume CLOEXEC is already set by perl in all important cases |
1475 | # we assume CLOEXEC is already set by perl in all important cases |
1024 | |
1476 | |
1025 | ($fh2, $rw) |
1477 | ($fh2, $rw) |
1026 | } |
1478 | } |
1027 | |
1479 | |
|
|
1480 | =head1 SIMPLIFIED AE API |
|
|
1481 | |
|
|
1482 | Starting with version 5.0, AnyEvent officially supports a second, much |
|
|
1483 | simpler, API that is designed to reduce the calling, typing and memory |
|
|
1484 | overhead by using function call syntax and a fixed number of parameters. |
|
|
1485 | |
|
|
1486 | See the L<AE> manpage for details. |
|
|
1487 | |
|
|
1488 | =cut |
|
|
1489 | |
|
|
1490 | package AE; |
|
|
1491 | |
|
|
1492 | our $VERSION = $AnyEvent::VERSION; |
|
|
1493 | |
|
|
1494 | sub _reset() { |
|
|
1495 | eval q{ |
|
|
1496 | # fall back to the main API by default - backends and AnyEvent::Base |
|
|
1497 | # implementations can overwrite these. |
|
|
1498 | |
|
|
1499 | sub io($$$) { |
|
|
1500 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
|
|
1501 | } |
|
|
1502 | |
|
|
1503 | sub timer($$$) { |
|
|
1504 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
|
|
1505 | } |
|
|
1506 | |
|
|
1507 | sub signal($$) { |
|
|
1508 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
|
|
1509 | } |
|
|
1510 | |
|
|
1511 | sub child($$) { |
|
|
1512 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
|
|
1513 | } |
|
|
1514 | |
|
|
1515 | sub idle($) { |
|
|
1516 | AnyEvent->idle (cb => $_[0]); |
|
|
1517 | } |
|
|
1518 | |
|
|
1519 | sub cv(;&) { |
|
|
1520 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
|
|
1521 | } |
|
|
1522 | |
|
|
1523 | sub now() { |
|
|
1524 | AnyEvent->now |
|
|
1525 | } |
|
|
1526 | |
|
|
1527 | sub now_update() { |
|
|
1528 | AnyEvent->now_update |
|
|
1529 | } |
|
|
1530 | |
|
|
1531 | sub time() { |
|
|
1532 | AnyEvent->time |
|
|
1533 | } |
|
|
1534 | |
|
|
1535 | *postpone = \&AnyEvent::postpone; |
|
|
1536 | *log = \&AnyEvent::log; |
|
|
1537 | }; |
|
|
1538 | die if $@; |
|
|
1539 | } |
|
|
1540 | |
|
|
1541 | BEGIN { _reset } |
|
|
1542 | |
1028 | package AnyEvent::Base; |
1543 | package AnyEvent::Base; |
1029 | |
1544 | |
1030 | # default implementation for now and time |
1545 | # default implementations for many methods |
1031 | |
1546 | |
1032 | BEGIN { |
1547 | sub time { |
|
|
1548 | eval q{ # poor man's autoloading {} |
|
|
1549 | # probe for availability of Time::HiRes |
1033 | if (eval "use Time::HiRes (); time (); 1") { |
1550 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
|
|
1551 | AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy." |
|
|
1552 | if $AnyEvent::VERBOSE >= 8; |
|
|
1553 | *time = sub { Time::HiRes::time () }; |
1034 | *_time = \&Time::HiRes::time; |
1554 | *AE::time = \& Time::HiRes::time ; |
1035 | # if (eval "use POSIX (); (POSIX::times())... |
1555 | # if (eval "use POSIX (); (POSIX::times())... |
1036 | } else { |
1556 | } else { |
1037 | *_time = sub { time }; # epic fail |
1557 | AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!"; |
|
|
1558 | *time = sub { CORE::time }; |
|
|
1559 | *AE::time = sub (){ CORE::time }; |
|
|
1560 | } |
|
|
1561 | |
|
|
1562 | *now = \&time; |
|
|
1563 | }; |
|
|
1564 | die if $@; |
|
|
1565 | |
|
|
1566 | &time |
|
|
1567 | } |
|
|
1568 | |
|
|
1569 | *now = \&time; |
|
|
1570 | sub now_update { } |
|
|
1571 | |
|
|
1572 | sub _poll { |
|
|
1573 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
|
|
1574 | } |
|
|
1575 | |
|
|
1576 | # default implementation for ->condvar |
|
|
1577 | # in fact, the default should not be overwritten |
|
|
1578 | |
|
|
1579 | sub condvar { |
|
|
1580 | eval q{ # poor man's autoloading {} |
|
|
1581 | *condvar = sub { |
|
|
1582 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
|
|
1583 | }; |
|
|
1584 | |
|
|
1585 | *AE::cv = sub (;&) { |
|
|
1586 | bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar" |
|
|
1587 | }; |
|
|
1588 | }; |
|
|
1589 | die if $@; |
|
|
1590 | |
|
|
1591 | &condvar |
|
|
1592 | } |
|
|
1593 | |
|
|
1594 | # default implementation for ->signal |
|
|
1595 | |
|
|
1596 | our $HAVE_ASYNC_INTERRUPT; |
|
|
1597 | |
|
|
1598 | sub _have_async_interrupt() { |
|
|
1599 | $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} |
|
|
1600 | && eval "use Async::Interrupt 1.02 (); 1") |
|
|
1601 | unless defined $HAVE_ASYNC_INTERRUPT; |
|
|
1602 | |
|
|
1603 | $HAVE_ASYNC_INTERRUPT |
|
|
1604 | } |
|
|
1605 | |
|
|
1606 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
|
|
1607 | our (%SIG_ASY, %SIG_ASY_W); |
|
|
1608 | our ($SIG_COUNT, $SIG_TW); |
|
|
1609 | |
|
|
1610 | # install a dummy wakeup watcher to reduce signal catching latency |
|
|
1611 | # used by Impls |
|
|
1612 | sub _sig_add() { |
|
|
1613 | unless ($SIG_COUNT++) { |
|
|
1614 | # try to align timer on a full-second boundary, if possible |
|
|
1615 | my $NOW = AE::now; |
|
|
1616 | |
|
|
1617 | $SIG_TW = AE::timer |
|
|
1618 | $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
|
|
1619 | $MAX_SIGNAL_LATENCY, |
|
|
1620 | sub { } # just for the PERL_ASYNC_CHECK |
|
|
1621 | ; |
1038 | } |
1622 | } |
1039 | } |
1623 | } |
1040 | |
1624 | |
1041 | sub time { _time } |
1625 | sub _sig_del { |
1042 | sub now { _time } |
1626 | undef $SIG_TW |
1043 | |
1627 | unless --$SIG_COUNT; |
1044 | # default implementation for ->condvar |
|
|
1045 | |
|
|
1046 | sub condvar { |
|
|
1047 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
|
|
1048 | } |
1628 | } |
1049 | |
1629 | |
1050 | # default implementation for ->signal |
1630 | our $_sig_name_init; $_sig_name_init = sub { |
|
|
1631 | eval q{ # poor man's autoloading {} |
|
|
1632 | undef $_sig_name_init; |
1051 | |
1633 | |
1052 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1634 | if (_have_async_interrupt) { |
|
|
1635 | *sig2num = \&Async::Interrupt::sig2num; |
|
|
1636 | *sig2name = \&Async::Interrupt::sig2name; |
|
|
1637 | } else { |
|
|
1638 | require Config; |
1053 | |
1639 | |
1054 | sub _signal_exec { |
1640 | my %signame2num; |
1055 | sysread $SIGPIPE_R, my $dummy, 4; |
1641 | @signame2num{ split ' ', $Config::Config{sig_name} } |
|
|
1642 | = split ' ', $Config::Config{sig_num}; |
1056 | |
1643 | |
1057 | while (%SIG_EV) { |
1644 | my @signum2name; |
1058 | for (keys %SIG_EV) { |
1645 | @signum2name[values %signame2num] = keys %signame2num; |
1059 | delete $SIG_EV{$_}; |
1646 | |
1060 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1647 | *sig2num = sub($) { |
|
|
1648 | $_[0] > 0 ? shift : $signame2num{+shift} |
|
|
1649 | }; |
|
|
1650 | *sig2name = sub ($) { |
|
|
1651 | $_[0] > 0 ? $signum2name[+shift] : shift |
|
|
1652 | }; |
1061 | } |
1653 | } |
1062 | } |
1654 | }; |
1063 | } |
1655 | die if $@; |
|
|
1656 | }; |
|
|
1657 | |
|
|
1658 | sub sig2num ($) { &$_sig_name_init; &sig2num } |
|
|
1659 | sub sig2name($) { &$_sig_name_init; &sig2name } |
1064 | |
1660 | |
1065 | sub signal { |
1661 | sub signal { |
1066 | my (undef, %arg) = @_; |
1662 | eval q{ # poor man's autoloading {} |
|
|
1663 | # probe for availability of Async::Interrupt |
|
|
1664 | if (_have_async_interrupt) { |
|
|
1665 | AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling." |
|
|
1666 | if $AnyEvent::VERBOSE >= 8; |
1067 | |
1667 | |
1068 | unless ($SIGPIPE_R) { |
1668 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1069 | if (AnyEvent::WIN32) { |
1669 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1070 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1670 | |
1071 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1072 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1073 | } else { |
1671 | } else { |
|
|
1672 | AnyEvent::log 8 => "using emulated perl signal handling with latency timer." |
|
|
1673 | if $AnyEvent::VERBOSE >= 8; |
|
|
1674 | |
|
|
1675 | if (AnyEvent::WIN32) { |
|
|
1676 | require AnyEvent::Util; |
|
|
1677 | |
|
|
1678 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1679 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; |
|
|
1680 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case |
|
|
1681 | } else { |
1074 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1682 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1075 | require Fcntl; |
|
|
1076 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1683 | fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R; |
1077 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
1684 | fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1685 | |
|
|
1686 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1687 | fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC; |
|
|
1688 | fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC; |
|
|
1689 | } |
|
|
1690 | |
|
|
1691 | $SIGPIPE_R |
|
|
1692 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1693 | |
|
|
1694 | $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec; |
1078 | } |
1695 | } |
1079 | |
1696 | |
1080 | $SIGPIPE_R |
1697 | *signal = $HAVE_ASYNC_INTERRUPT |
1081 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1698 | ? sub { |
|
|
1699 | my (undef, %arg) = @_; |
1082 | |
1700 | |
1083 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
1701 | # async::interrupt |
1084 | } |
|
|
1085 | |
|
|
1086 | my $signal = uc $arg{signal} |
1702 | my $signal = sig2num $arg{signal}; |
1087 | or Carp::croak "required option 'signal' is missing"; |
|
|
1088 | |
|
|
1089 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1703 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1704 | |
|
|
1705 | $SIG_ASY{$signal} ||= new Async::Interrupt |
|
|
1706 | cb => sub { undef $SIG_EV{$signal} }, |
|
|
1707 | signal => $signal, |
|
|
1708 | pipe => [$SIGPIPE_R->filenos], |
|
|
1709 | pipe_autodrain => 0, |
|
|
1710 | ; |
|
|
1711 | |
|
|
1712 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1713 | } |
|
|
1714 | : sub { |
|
|
1715 | my (undef, %arg) = @_; |
|
|
1716 | |
|
|
1717 | # pure perl |
|
|
1718 | my $signal = sig2name $arg{signal}; |
|
|
1719 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1720 | |
1090 | $SIG{$signal} ||= sub { |
1721 | $SIG{$signal} ||= sub { |
|
|
1722 | local $!; |
1091 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1723 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1092 | undef $SIG_EV{$signal}; |
1724 | undef $SIG_EV{$signal}; |
|
|
1725 | }; |
|
|
1726 | |
|
|
1727 | # can't do signal processing without introducing races in pure perl, |
|
|
1728 | # so limit the signal latency. |
|
|
1729 | _sig_add; |
|
|
1730 | |
|
|
1731 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1732 | } |
|
|
1733 | ; |
|
|
1734 | |
|
|
1735 | *AnyEvent::Base::signal::DESTROY = sub { |
|
|
1736 | my ($signal, $cb) = @{$_[0]}; |
|
|
1737 | |
|
|
1738 | _sig_del; |
|
|
1739 | |
|
|
1740 | delete $SIG_CB{$signal}{$cb}; |
|
|
1741 | |
|
|
1742 | $HAVE_ASYNC_INTERRUPT |
|
|
1743 | ? delete $SIG_ASY{$signal} |
|
|
1744 | : # delete doesn't work with older perls - they then |
|
|
1745 | # print weird messages, or just unconditionally exit |
|
|
1746 | # instead of getting the default action. |
|
|
1747 | undef $SIG{$signal} |
|
|
1748 | unless keys %{ $SIG_CB{$signal} }; |
|
|
1749 | }; |
|
|
1750 | |
|
|
1751 | *_signal_exec = sub { |
|
|
1752 | $HAVE_ASYNC_INTERRUPT |
|
|
1753 | ? $SIGPIPE_R->drain |
|
|
1754 | : sysread $SIGPIPE_R, (my $dummy), 9; |
|
|
1755 | |
|
|
1756 | while (%SIG_EV) { |
|
|
1757 | for (keys %SIG_EV) { |
|
|
1758 | delete $SIG_EV{$_}; |
|
|
1759 | &$_ for values %{ $SIG_CB{$_} || {} }; |
|
|
1760 | } |
|
|
1761 | } |
|
|
1762 | }; |
1093 | }; |
1763 | }; |
|
|
1764 | die if $@; |
1094 | |
1765 | |
1095 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1766 | &signal |
1096 | } |
|
|
1097 | |
|
|
1098 | sub AnyEvent::Base::Signal::DESTROY { |
|
|
1099 | my ($signal, $cb) = @{$_[0]}; |
|
|
1100 | |
|
|
1101 | delete $SIG_CB{$signal}{$cb}; |
|
|
1102 | |
|
|
1103 | delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
|
|
1104 | } |
1767 | } |
1105 | |
1768 | |
1106 | # default implementation for ->child |
1769 | # default implementation for ->child |
1107 | |
1770 | |
1108 | our %PID_CB; |
1771 | our %PID_CB; |
1109 | our $CHLD_W; |
1772 | our $CHLD_W; |
1110 | our $CHLD_DELAY_W; |
1773 | our $CHLD_DELAY_W; |
1111 | our $PID_IDLE; |
|
|
1112 | our $WNOHANG; |
|
|
1113 | |
1774 | |
1114 | sub _child_wait { |
1775 | # used by many Impl's |
1115 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1776 | sub _emit_childstatus($$) { |
|
|
1777 | my (undef, $rpid, $rstatus) = @_; |
|
|
1778 | |
|
|
1779 | $_->($rpid, $rstatus) |
1116 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1780 | for values %{ $PID_CB{$rpid} || {} }, |
1117 | (values %{ $PID_CB{0} || {} }); |
1781 | values %{ $PID_CB{0} || {} }; |
1118 | } |
|
|
1119 | |
|
|
1120 | undef $PID_IDLE; |
|
|
1121 | } |
|
|
1122 | |
|
|
1123 | sub _sigchld { |
|
|
1124 | # make sure we deliver these changes "synchronous" with the event loop. |
|
|
1125 | $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub { |
|
|
1126 | undef $CHLD_DELAY_W; |
|
|
1127 | &_child_wait; |
|
|
1128 | }); |
|
|
1129 | } |
1782 | } |
1130 | |
1783 | |
1131 | sub child { |
1784 | sub child { |
|
|
1785 | eval q{ # poor man's autoloading {} |
|
|
1786 | *_sigchld = sub { |
|
|
1787 | my $pid; |
|
|
1788 | |
|
|
1789 | AnyEvent->_emit_childstatus ($pid, $?) |
|
|
1790 | while ($pid = waitpid -1, WNOHANG) > 0; |
|
|
1791 | }; |
|
|
1792 | |
|
|
1793 | *child = sub { |
1132 | my (undef, %arg) = @_; |
1794 | my (undef, %arg) = @_; |
1133 | |
1795 | |
1134 | defined (my $pid = $arg{pid} + 0) |
1796 | my $pid = $arg{pid}; |
1135 | or Carp::croak "required option 'pid' is missing"; |
1797 | my $cb = $arg{cb}; |
1136 | |
1798 | |
1137 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1799 | $PID_CB{$pid}{$cb+0} = $cb; |
1138 | |
1800 | |
1139 | unless ($WNOHANG) { |
|
|
1140 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
|
|
1141 | } |
|
|
1142 | |
|
|
1143 | unless ($CHLD_W) { |
1801 | unless ($CHLD_W) { |
1144 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1802 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1145 | # child could be a zombie already, so make at least one round |
1803 | # child could be a zombie already, so make at least one round |
1146 | &_sigchld; |
1804 | &_sigchld; |
1147 | } |
1805 | } |
1148 | |
1806 | |
1149 | bless [$pid, $arg{cb}], "AnyEvent::Base::Child" |
1807 | bless [$pid, $cb+0], "AnyEvent::Base::child" |
1150 | } |
1808 | }; |
1151 | |
1809 | |
1152 | sub AnyEvent::Base::Child::DESTROY { |
1810 | *AnyEvent::Base::child::DESTROY = sub { |
1153 | my ($pid, $cb) = @{$_[0]}; |
1811 | my ($pid, $icb) = @{$_[0]}; |
1154 | |
1812 | |
1155 | delete $PID_CB{$pid}{$cb}; |
1813 | delete $PID_CB{$pid}{$icb}; |
1156 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1814 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1157 | |
1815 | |
1158 | undef $CHLD_W unless keys %PID_CB; |
1816 | undef $CHLD_W unless keys %PID_CB; |
|
|
1817 | }; |
|
|
1818 | }; |
|
|
1819 | die if $@; |
|
|
1820 | |
|
|
1821 | &child |
|
|
1822 | } |
|
|
1823 | |
|
|
1824 | # idle emulation is done by simply using a timer, regardless |
|
|
1825 | # of whether the process is idle or not, and not letting |
|
|
1826 | # the callback use more than 50% of the time. |
|
|
1827 | sub idle { |
|
|
1828 | eval q{ # poor man's autoloading {} |
|
|
1829 | *idle = sub { |
|
|
1830 | my (undef, %arg) = @_; |
|
|
1831 | |
|
|
1832 | my ($cb, $w, $rcb) = $arg{cb}; |
|
|
1833 | |
|
|
1834 | $rcb = sub { |
|
|
1835 | if ($cb) { |
|
|
1836 | $w = AE::time; |
|
|
1837 | &$cb; |
|
|
1838 | $w = AE::time - $w; |
|
|
1839 | |
|
|
1840 | # never use more then 50% of the time for the idle watcher, |
|
|
1841 | # within some limits |
|
|
1842 | $w = 0.0001 if $w < 0.0001; |
|
|
1843 | $w = 5 if $w > 5; |
|
|
1844 | |
|
|
1845 | $w = AE::timer $w, 0, $rcb; |
|
|
1846 | } else { |
|
|
1847 | # clean up... |
|
|
1848 | undef $w; |
|
|
1849 | undef $rcb; |
|
|
1850 | } |
|
|
1851 | }; |
|
|
1852 | |
|
|
1853 | $w = AE::timer 0.05, 0, $rcb; |
|
|
1854 | |
|
|
1855 | bless \\$cb, "AnyEvent::Base::idle" |
|
|
1856 | }; |
|
|
1857 | |
|
|
1858 | *AnyEvent::Base::idle::DESTROY = sub { |
|
|
1859 | undef $${$_[0]}; |
|
|
1860 | }; |
|
|
1861 | }; |
|
|
1862 | die if $@; |
|
|
1863 | |
|
|
1864 | &idle |
1159 | } |
1865 | } |
1160 | |
1866 | |
1161 | package AnyEvent::CondVar; |
1867 | package AnyEvent::CondVar; |
1162 | |
1868 | |
1163 | our @ISA = AnyEvent::CondVar::Base::; |
1869 | our @ISA = AnyEvent::CondVar::Base::; |
1164 | |
1870 | |
|
|
1871 | # only to be used for subclassing |
|
|
1872 | sub new { |
|
|
1873 | my $class = shift; |
|
|
1874 | bless AnyEvent->condvar (@_), $class |
|
|
1875 | } |
|
|
1876 | |
1165 | package AnyEvent::CondVar::Base; |
1877 | package AnyEvent::CondVar::Base; |
1166 | |
1878 | |
1167 | use overload |
1879 | #use overload |
1168 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1880 | # '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
1169 | fallback => 1; |
1881 | # fallback => 1; |
|
|
1882 | |
|
|
1883 | # save 300+ kilobytes by dirtily hardcoding overloading |
|
|
1884 | ${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching. |
|
|
1885 | *{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod." |
|
|
1886 | *{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{} |
|
|
1887 | ${'AnyEvent::CondVar::Base::()'} = 1; # fallback |
|
|
1888 | |
|
|
1889 | our $WAITING; |
1170 | |
1890 | |
1171 | sub _send { |
1891 | sub _send { |
1172 | # nop |
1892 | # nop |
|
|
1893 | } |
|
|
1894 | |
|
|
1895 | sub _wait { |
|
|
1896 | AnyEvent->_poll until $_[0]{_ae_sent}; |
1173 | } |
1897 | } |
1174 | |
1898 | |
1175 | sub send { |
1899 | sub send { |
1176 | my $cv = shift; |
1900 | my $cv = shift; |
1177 | $cv->{_ae_sent} = [@_]; |
1901 | $cv->{_ae_sent} = [@_]; |
… | |
… | |
1186 | |
1910 | |
1187 | sub ready { |
1911 | sub ready { |
1188 | $_[0]{_ae_sent} |
1912 | $_[0]{_ae_sent} |
1189 | } |
1913 | } |
1190 | |
1914 | |
1191 | sub _wait { |
|
|
1192 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
|
|
1193 | } |
|
|
1194 | |
|
|
1195 | sub recv { |
1915 | sub recv { |
|
|
1916 | unless ($_[0]{_ae_sent}) { |
|
|
1917 | $WAITING |
|
|
1918 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted"; |
|
|
1919 | |
|
|
1920 | local $WAITING = 1; |
1196 | $_[0]->_wait; |
1921 | $_[0]->_wait; |
|
|
1922 | } |
1197 | |
1923 | |
1198 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1924 | $_[0]{_ae_croak} |
1199 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1925 | and Carp::croak $_[0]{_ae_croak}; |
|
|
1926 | |
|
|
1927 | wantarray |
|
|
1928 | ? @{ $_[0]{_ae_sent} } |
|
|
1929 | : $_[0]{_ae_sent}[0] |
1200 | } |
1930 | } |
1201 | |
1931 | |
1202 | sub cb { |
1932 | sub cb { |
1203 | $_[0]{_ae_cb} = $_[1] if @_ > 1; |
1933 | my $cv = shift; |
|
|
1934 | |
|
|
1935 | @_ |
|
|
1936 | and $cv->{_ae_cb} = shift |
|
|
1937 | and $cv->{_ae_sent} |
|
|
1938 | and (delete $cv->{_ae_cb})->($cv); |
|
|
1939 | |
1204 | $_[0]{_ae_cb} |
1940 | $cv->{_ae_cb} |
1205 | } |
1941 | } |
1206 | |
1942 | |
1207 | sub begin { |
1943 | sub begin { |
1208 | ++$_[0]{_ae_counter}; |
1944 | ++$_[0]{_ae_counter}; |
1209 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
1945 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
… | |
… | |
1214 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
1950 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
1215 | } |
1951 | } |
1216 | |
1952 | |
1217 | # undocumented/compatibility with pre-3.4 |
1953 | # undocumented/compatibility with pre-3.4 |
1218 | *broadcast = \&send; |
1954 | *broadcast = \&send; |
1219 | *wait = \&_wait; |
1955 | *wait = \&recv; |
1220 | |
1956 | |
1221 | =head1 ERROR AND EXCEPTION HANDLING |
1957 | =head1 ERROR AND EXCEPTION HANDLING |
1222 | |
1958 | |
1223 | In general, AnyEvent does not do any error handling - it relies on the |
1959 | In general, AnyEvent does not do any error handling - it relies on the |
1224 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
1960 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
… | |
… | |
1237 | so on. |
1973 | so on. |
1238 | |
1974 | |
1239 | =head1 ENVIRONMENT VARIABLES |
1975 | =head1 ENVIRONMENT VARIABLES |
1240 | |
1976 | |
1241 | The following environment variables are used by this module or its |
1977 | The following environment variables are used by this module or its |
1242 | submodules: |
1978 | submodules. |
|
|
1979 | |
|
|
1980 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
1981 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
1982 | enabled. |
1243 | |
1983 | |
1244 | =over 4 |
1984 | =over 4 |
1245 | |
1985 | |
1246 | =item C<PERL_ANYEVENT_VERBOSE> |
1986 | =item C<PERL_ANYEVENT_VERBOSE> |
1247 | |
1987 | |
1248 | By default, AnyEvent will be completely silent except in fatal |
1988 | By default, AnyEvent will be completely silent except in fatal |
1249 | conditions. You can set this environment variable to make AnyEvent more |
1989 | conditions. You can set this environment variable to make AnyEvent more |
1250 | talkative. |
1990 | talkative. |
1251 | |
1991 | |
1252 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
1992 | When set to C<5> or higher, causes AnyEvent to warn about unexpected |
1253 | conditions, such as not being able to load the event model specified by |
1993 | conditions, such as not being able to load the event model specified by |
1254 | C<PERL_ANYEVENT_MODEL>. |
1994 | C<PERL_ANYEVENT_MODEL>. |
1255 | |
1995 | |
1256 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1996 | When set to C<7> or higher, cause AnyEvent to report to STDERR which event |
1257 | model it chooses. |
1997 | model it chooses. |
|
|
1998 | |
|
|
1999 | When set to C<8> or higher, then AnyEvent will report extra information on |
|
|
2000 | which optional modules it loads and how it implements certain features. |
1258 | |
2001 | |
1259 | =item C<PERL_ANYEVENT_STRICT> |
2002 | =item C<PERL_ANYEVENT_STRICT> |
1260 | |
2003 | |
1261 | AnyEvent does not do much argument checking by default, as thorough |
2004 | AnyEvent does not do much argument checking by default, as thorough |
1262 | argument checking is very costly. Setting this variable to a true value |
2005 | argument checking is very costly. Setting this variable to a true value |
1263 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
2006 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1264 | check the arguments passed to most method calls. If it finds any problems |
2007 | check the arguments passed to most method calls. If it finds any problems, |
1265 | it will croak. |
2008 | it will croak. |
1266 | |
2009 | |
1267 | In other words, enables "strict" mode. |
2010 | In other words, enables "strict" mode. |
1268 | |
2011 | |
1269 | Unlike C<use strict>, it is definitely recommended ot keep it off in |
2012 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
1270 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
2013 | >>, it is definitely recommended to keep it off in production. Keeping |
1271 | developing programs can be very useful, however. |
2014 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
|
|
2015 | can be very useful, however. |
|
|
2016 | |
|
|
2017 | =item C<PERL_ANYEVENT_DEBUG_SHELL> |
|
|
2018 | |
|
|
2019 | If this env variable is set, then its contents will be interpreted by |
|
|
2020 | C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of |
|
|
2021 | C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on |
|
|
2022 | that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. |
|
|
2023 | |
|
|
2024 | This takes place when the first watcher is created. |
|
|
2025 | |
|
|
2026 | For example, to bind a debug shell on a unix domain socket in |
|
|
2027 | F<< /tmp/debug<pid>.sock >>, you could use this: |
|
|
2028 | |
|
|
2029 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
|
|
2030 | |
|
|
2031 | Note that creating sockets in F</tmp> is very unsafe on multiuser |
|
|
2032 | systems. |
|
|
2033 | |
|
|
2034 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
|
|
2035 | |
|
|
2036 | Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for |
|
|
2037 | debugging purposes. See C<AnyEvent::Debug::wrap> for details. |
1272 | |
2038 | |
1273 | =item C<PERL_ANYEVENT_MODEL> |
2039 | =item C<PERL_ANYEVENT_MODEL> |
1274 | |
2040 | |
1275 | This can be used to specify the event model to be used by AnyEvent, before |
2041 | This can be used to specify the event model to be used by AnyEvent, before |
1276 | auto detection and -probing kicks in. It must be a string consisting |
2042 | auto detection and -probing kicks in. |
1277 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
2043 | |
|
|
2044 | It normally is a string consisting entirely of ASCII letters (e.g. C<EV> |
|
|
2045 | or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the |
1278 | and the resulting module name is loaded and if the load was successful, |
2046 | resulting module name is loaded and - if the load was successful - used as |
1279 | used as event model. If it fails to load AnyEvent will proceed with |
2047 | event model backend. If it fails to load then AnyEvent will proceed with |
1280 | auto detection and -probing. |
2048 | auto detection and -probing. |
1281 | |
2049 | |
1282 | This functionality might change in future versions. |
2050 | If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then |
|
|
2051 | nothing gets prepended and the module name is used as-is (hint: C<::> at |
|
|
2052 | the end of a string designates a module name and quotes it appropriately). |
1283 | |
2053 | |
1284 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
2054 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
1285 | could start your program like this: |
2055 | could start your program like this: |
1286 | |
2056 | |
1287 | PERL_ANYEVENT_MODEL=Perl perl ... |
2057 | PERL_ANYEVENT_MODEL=Perl perl ... |
1288 | |
2058 | |
1289 | =item C<PERL_ANYEVENT_PROTOCOLS> |
2059 | =item C<PERL_ANYEVENT_PROTOCOLS> |
… | |
… | |
1319 | |
2089 | |
1320 | =item C<PERL_ANYEVENT_MAX_FORKS> |
2090 | =item C<PERL_ANYEVENT_MAX_FORKS> |
1321 | |
2091 | |
1322 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
2092 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
1323 | will create in parallel. |
2093 | will create in parallel. |
|
|
2094 | |
|
|
2095 | =item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS> |
|
|
2096 | |
|
|
2097 | The default value for the C<max_outstanding> parameter for the default DNS |
|
|
2098 | resolver - this is the maximum number of parallel DNS requests that are |
|
|
2099 | sent to the DNS server. |
|
|
2100 | |
|
|
2101 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
|
|
2102 | |
|
|
2103 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
|
|
2104 | configuration) in the default resolver. When set to the empty string, no |
|
|
2105 | default config will be used. |
|
|
2106 | |
|
|
2107 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
|
|
2108 | |
|
|
2109 | When neither C<ca_file> nor C<ca_path> was specified during |
|
|
2110 | L<AnyEvent::TLS> context creation, and either of these environment |
|
|
2111 | variables exist, they will be used to specify CA certificate locations |
|
|
2112 | instead of a system-dependent default. |
|
|
2113 | |
|
|
2114 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
|
|
2115 | |
|
|
2116 | When these are set to C<1>, then the respective modules are not |
|
|
2117 | loaded. Mostly good for testing AnyEvent itself. |
1324 | |
2118 | |
1325 | =back |
2119 | =back |
1326 | |
2120 | |
1327 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
2121 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1328 | |
2122 | |
… | |
… | |
1386 | warn "read: $input\n"; # output what has been read |
2180 | warn "read: $input\n"; # output what has been read |
1387 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
2181 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1388 | }, |
2182 | }, |
1389 | ); |
2183 | ); |
1390 | |
2184 | |
1391 | my $time_watcher; # can only be used once |
|
|
1392 | |
|
|
1393 | sub new_timer { |
|
|
1394 | $timer = AnyEvent->timer (after => 1, cb => sub { |
2185 | my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub { |
1395 | warn "timeout\n"; # print 'timeout' about every second |
2186 | warn "timeout\n"; # print 'timeout' at most every second |
1396 | &new_timer; # and restart the time |
|
|
1397 | }); |
2187 | }); |
1398 | } |
|
|
1399 | |
|
|
1400 | new_timer; # create first timer |
|
|
1401 | |
2188 | |
1402 | $cv->recv; # wait until user enters /^q/i |
2189 | $cv->recv; # wait until user enters /^q/i |
1403 | |
2190 | |
1404 | =head1 REAL-WORLD EXAMPLE |
2191 | =head1 REAL-WORLD EXAMPLE |
1405 | |
2192 | |
… | |
… | |
1478 | |
2265 | |
1479 | The actual code goes further and collects all errors (C<die>s, exceptions) |
2266 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1480 | that occurred during request processing. The C<result> method detects |
2267 | that occurred during request processing. The C<result> method detects |
1481 | whether an exception as thrown (it is stored inside the $txn object) |
2268 | whether an exception as thrown (it is stored inside the $txn object) |
1482 | and just throws the exception, which means connection errors and other |
2269 | and just throws the exception, which means connection errors and other |
1483 | problems get reported tot he code that tries to use the result, not in a |
2270 | problems get reported to the code that tries to use the result, not in a |
1484 | random callback. |
2271 | random callback. |
1485 | |
2272 | |
1486 | All of this enables the following usage styles: |
2273 | All of this enables the following usage styles: |
1487 | |
2274 | |
1488 | 1. Blocking: |
2275 | 1. Blocking: |
… | |
… | |
1536 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
2323 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1537 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
2324 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1538 | which it is), lets them fire exactly once and destroys them again. |
2325 | which it is), lets them fire exactly once and destroys them again. |
1539 | |
2326 | |
1540 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
2327 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1541 | distribution. |
2328 | distribution. It uses the L<AE> interface, which makes a real difference |
|
|
2329 | for the EV and Perl backends only. |
1542 | |
2330 | |
1543 | =head3 Explanation of the columns |
2331 | =head3 Explanation of the columns |
1544 | |
2332 | |
1545 | I<watcher> is the number of event watchers created/destroyed. Since |
2333 | I<watcher> is the number of event watchers created/destroyed. Since |
1546 | different event models feature vastly different performances, each event |
2334 | different event models feature vastly different performances, each event |
… | |
… | |
1567 | watcher. |
2355 | watcher. |
1568 | |
2356 | |
1569 | =head3 Results |
2357 | =head3 Results |
1570 | |
2358 | |
1571 | name watchers bytes create invoke destroy comment |
2359 | name watchers bytes create invoke destroy comment |
1572 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
2360 | EV/EV 100000 223 0.47 0.43 0.27 EV native interface |
1573 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
2361 | EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers |
1574 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
2362 | Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal |
1575 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
2363 | Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation |
1576 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
2364 | Event/Event 16000 516 31.16 31.84 0.82 Event native interface |
1577 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
2365 | Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers |
|
|
2366 | IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll |
|
|
2367 | IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll |
1578 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
2368 | Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour |
1579 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
2369 | Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers |
1580 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
2370 | POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event |
1581 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
2371 | POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select |
1582 | |
2372 | |
1583 | =head3 Discussion |
2373 | =head3 Discussion |
1584 | |
2374 | |
1585 | The benchmark does I<not> measure scalability of the event loop very |
2375 | The benchmark does I<not> measure scalability of the event loop very |
1586 | well. For example, a select-based event loop (such as the pure perl one) |
2376 | well. For example, a select-based event loop (such as the pure perl one) |
… | |
… | |
1598 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
2388 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
1599 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
2389 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
1600 | cycles with POE. |
2390 | cycles with POE. |
1601 | |
2391 | |
1602 | C<EV> is the sole leader regarding speed and memory use, which are both |
2392 | C<EV> is the sole leader regarding speed and memory use, which are both |
1603 | maximal/minimal, respectively. Even when going through AnyEvent, it uses |
2393 | maximal/minimal, respectively. When using the L<AE> API there is zero |
|
|
2394 | overhead (when going through the AnyEvent API create is about 5-6 times |
|
|
2395 | slower, with other times being equal, so still uses far less memory than |
1604 | far less memory than any other event loop and is still faster than Event |
2396 | any other event loop and is still faster than Event natively). |
1605 | natively. |
|
|
1606 | |
2397 | |
1607 | The pure perl implementation is hit in a few sweet spots (both the |
2398 | The pure perl implementation is hit in a few sweet spots (both the |
1608 | constant timeout and the use of a single fd hit optimisations in the perl |
2399 | constant timeout and the use of a single fd hit optimisations in the perl |
1609 | interpreter and the backend itself). Nevertheless this shows that it |
2400 | interpreter and the backend itself). Nevertheless this shows that it |
1610 | adds very little overhead in itself. Like any select-based backend its |
2401 | adds very little overhead in itself. Like any select-based backend its |
1611 | performance becomes really bad with lots of file descriptors (and few of |
2402 | performance becomes really bad with lots of file descriptors (and few of |
1612 | them active), of course, but this was not subject of this benchmark. |
2403 | them active), of course, but this was not subject of this benchmark. |
1613 | |
2404 | |
1614 | The C<Event> module has a relatively high setup and callback invocation |
2405 | The C<Event> module has a relatively high setup and callback invocation |
1615 | cost, but overall scores in on the third place. |
2406 | cost, but overall scores in on the third place. |
|
|
2407 | |
|
|
2408 | C<IO::Async> performs admirably well, about on par with C<Event>, even |
|
|
2409 | when using its pure perl backend. |
1616 | |
2410 | |
1617 | C<Glib>'s memory usage is quite a bit higher, but it features a |
2411 | C<Glib>'s memory usage is quite a bit higher, but it features a |
1618 | faster callback invocation and overall ends up in the same class as |
2412 | faster callback invocation and overall ends up in the same class as |
1619 | C<Event>. However, Glib scales extremely badly, doubling the number of |
2413 | C<Event>. However, Glib scales extremely badly, doubling the number of |
1620 | watchers increases the processing time by more than a factor of four, |
2414 | watchers increases the processing time by more than a factor of four, |
… | |
… | |
1655 | (even when used without AnyEvent), but most event loops have acceptable |
2449 | (even when used without AnyEvent), but most event loops have acceptable |
1656 | performance with or without AnyEvent. |
2450 | performance with or without AnyEvent. |
1657 | |
2451 | |
1658 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2452 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
1659 | the actual event loop, only with extremely fast event loops such as EV |
2453 | the actual event loop, only with extremely fast event loops such as EV |
1660 | adds AnyEvent significant overhead. |
2454 | does AnyEvent add significant overhead. |
1661 | |
2455 | |
1662 | =item * You should avoid POE like the plague if you want performance or |
2456 | =item * You should avoid POE like the plague if you want performance or |
1663 | reasonable memory usage. |
2457 | reasonable memory usage. |
1664 | |
2458 | |
1665 | =back |
2459 | =back |
… | |
… | |
1681 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
2475 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
1682 | (1%) are active. This mirrors the activity of large servers with many |
2476 | (1%) are active. This mirrors the activity of large servers with many |
1683 | connections, most of which are idle at any one point in time. |
2477 | connections, most of which are idle at any one point in time. |
1684 | |
2478 | |
1685 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
2479 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1686 | distribution. |
2480 | distribution. It uses the L<AE> interface, which makes a real difference |
|
|
2481 | for the EV and Perl backends only. |
1687 | |
2482 | |
1688 | =head3 Explanation of the columns |
2483 | =head3 Explanation of the columns |
1689 | |
2484 | |
1690 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
2485 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1691 | each server has a read and write socket end). |
2486 | each server has a read and write socket end). |
… | |
… | |
1698 | it to another server. This includes deleting the old timeout and creating |
2493 | it to another server. This includes deleting the old timeout and creating |
1699 | a new one that moves the timeout into the future. |
2494 | a new one that moves the timeout into the future. |
1700 | |
2495 | |
1701 | =head3 Results |
2496 | =head3 Results |
1702 | |
2497 | |
1703 | name sockets create request |
2498 | name sockets create request |
1704 | EV 20000 69.01 11.16 |
2499 | EV 20000 62.66 7.99 |
1705 | Perl 20000 73.32 35.87 |
2500 | Perl 20000 68.32 32.64 |
1706 | Event 20000 212.62 257.32 |
2501 | IOAsync 20000 174.06 101.15 epoll |
1707 | Glib 20000 651.16 1896.30 |
2502 | IOAsync 20000 174.67 610.84 poll |
|
|
2503 | Event 20000 202.69 242.91 |
|
|
2504 | Glib 20000 557.01 1689.52 |
1708 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
2505 | POE 20000 341.54 12086.32 uses POE::Loop::Event |
1709 | |
2506 | |
1710 | =head3 Discussion |
2507 | =head3 Discussion |
1711 | |
2508 | |
1712 | This benchmark I<does> measure scalability and overall performance of the |
2509 | This benchmark I<does> measure scalability and overall performance of the |
1713 | particular event loop. |
2510 | particular event loop. |
… | |
… | |
1715 | EV is again fastest. Since it is using epoll on my system, the setup time |
2512 | EV is again fastest. Since it is using epoll on my system, the setup time |
1716 | is relatively high, though. |
2513 | is relatively high, though. |
1717 | |
2514 | |
1718 | Perl surprisingly comes second. It is much faster than the C-based event |
2515 | Perl surprisingly comes second. It is much faster than the C-based event |
1719 | loops Event and Glib. |
2516 | loops Event and Glib. |
|
|
2517 | |
|
|
2518 | IO::Async performs very well when using its epoll backend, and still quite |
|
|
2519 | good compared to Glib when using its pure perl backend. |
1720 | |
2520 | |
1721 | Event suffers from high setup time as well (look at its code and you will |
2521 | Event suffers from high setup time as well (look at its code and you will |
1722 | understand why). Callback invocation also has a high overhead compared to |
2522 | understand why). Callback invocation also has a high overhead compared to |
1723 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
2523 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
1724 | uses select or poll in basically all documented configurations. |
2524 | uses select or poll in basically all documented configurations. |
… | |
… | |
1787 | =item * C-based event loops perform very well with small number of |
2587 | =item * C-based event loops perform very well with small number of |
1788 | watchers, as the management overhead dominates. |
2588 | watchers, as the management overhead dominates. |
1789 | |
2589 | |
1790 | =back |
2590 | =back |
1791 | |
2591 | |
|
|
2592 | =head2 THE IO::Lambda BENCHMARK |
|
|
2593 | |
|
|
2594 | Recently I was told about the benchmark in the IO::Lambda manpage, which |
|
|
2595 | could be misinterpreted to make AnyEvent look bad. In fact, the benchmark |
|
|
2596 | simply compares IO::Lambda with POE, and IO::Lambda looks better (which |
|
|
2597 | shouldn't come as a surprise to anybody). As such, the benchmark is |
|
|
2598 | fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't |
|
|
2599 | very optimal. But how would AnyEvent compare when used without the extra |
|
|
2600 | baggage? To explore this, I wrote the equivalent benchmark for AnyEvent. |
|
|
2601 | |
|
|
2602 | The benchmark itself creates an echo-server, and then, for 500 times, |
|
|
2603 | connects to the echo server, sends a line, waits for the reply, and then |
|
|
2604 | creates the next connection. This is a rather bad benchmark, as it doesn't |
|
|
2605 | test the efficiency of the framework or much non-blocking I/O, but it is a |
|
|
2606 | benchmark nevertheless. |
|
|
2607 | |
|
|
2608 | name runtime |
|
|
2609 | Lambda/select 0.330 sec |
|
|
2610 | + optimized 0.122 sec |
|
|
2611 | Lambda/AnyEvent 0.327 sec |
|
|
2612 | + optimized 0.138 sec |
|
|
2613 | Raw sockets/select 0.077 sec |
|
|
2614 | POE/select, components 0.662 sec |
|
|
2615 | POE/select, raw sockets 0.226 sec |
|
|
2616 | POE/select, optimized 0.404 sec |
|
|
2617 | |
|
|
2618 | AnyEvent/select/nb 0.085 sec |
|
|
2619 | AnyEvent/EV/nb 0.068 sec |
|
|
2620 | +state machine 0.134 sec |
|
|
2621 | |
|
|
2622 | The benchmark is also a bit unfair (my fault): the IO::Lambda/POE |
|
|
2623 | benchmarks actually make blocking connects and use 100% blocking I/O, |
|
|
2624 | defeating the purpose of an event-based solution. All of the newly |
|
|
2625 | written AnyEvent benchmarks use 100% non-blocking connects (using |
|
|
2626 | AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS |
|
|
2627 | resolver), so AnyEvent is at a disadvantage here, as non-blocking connects |
|
|
2628 | generally require a lot more bookkeeping and event handling than blocking |
|
|
2629 | connects (which involve a single syscall only). |
|
|
2630 | |
|
|
2631 | The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which |
|
|
2632 | offers similar expressive power as POE and IO::Lambda, using conventional |
|
|
2633 | Perl syntax. This means that both the echo server and the client are 100% |
|
|
2634 | non-blocking, further placing it at a disadvantage. |
|
|
2635 | |
|
|
2636 | As you can see, the AnyEvent + EV combination even beats the |
|
|
2637 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
|
|
2638 | backend easily beats IO::Lambda and POE. |
|
|
2639 | |
|
|
2640 | And even the 100% non-blocking version written using the high-level (and |
|
|
2641 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda |
|
|
2642 | higher level ("unoptimised") abstractions by a large margin, even though |
|
|
2643 | it does all of DNS, tcp-connect and socket I/O in a non-blocking way. |
|
|
2644 | |
|
|
2645 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
|
|
2646 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
|
|
2647 | part of the IO::Lambda distribution and were used without any changes. |
|
|
2648 | |
1792 | |
2649 | |
1793 | =head1 SIGNALS |
2650 | =head1 SIGNALS |
1794 | |
2651 | |
1795 | AnyEvent currently installs handlers for these signals: |
2652 | AnyEvent currently installs handlers for these signals: |
1796 | |
2653 | |
… | |
… | |
1799 | =item SIGCHLD |
2656 | =item SIGCHLD |
1800 | |
2657 | |
1801 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2658 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
1802 | emulation for event loops that do not support them natively. Also, some |
2659 | emulation for event loops that do not support them natively. Also, some |
1803 | event loops install a similar handler. |
2660 | event loops install a similar handler. |
|
|
2661 | |
|
|
2662 | Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then |
|
|
2663 | AnyEvent will reset it to default, to avoid losing child exit statuses. |
1804 | |
2664 | |
1805 | =item SIGPIPE |
2665 | =item SIGPIPE |
1806 | |
2666 | |
1807 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2667 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
1808 | when AnyEvent gets loaded. |
2668 | when AnyEvent gets loaded. |
… | |
… | |
1820 | |
2680 | |
1821 | =back |
2681 | =back |
1822 | |
2682 | |
1823 | =cut |
2683 | =cut |
1824 | |
2684 | |
|
|
2685 | undef $SIG{CHLD} |
|
|
2686 | if $SIG{CHLD} eq 'IGNORE'; |
|
|
2687 | |
1825 | $SIG{PIPE} = sub { } |
2688 | $SIG{PIPE} = sub { } |
1826 | unless defined $SIG{PIPE}; |
2689 | unless defined $SIG{PIPE}; |
1827 | |
2690 | |
|
|
2691 | =head1 RECOMMENDED/OPTIONAL MODULES |
|
|
2692 | |
|
|
2693 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
|
|
2694 | its built-in modules) are required to use it. |
|
|
2695 | |
|
|
2696 | That does not mean that AnyEvent won't take advantage of some additional |
|
|
2697 | modules if they are installed. |
|
|
2698 | |
|
|
2699 | This section explains which additional modules will be used, and how they |
|
|
2700 | affect AnyEvent's operation. |
|
|
2701 | |
|
|
2702 | =over 4 |
|
|
2703 | |
|
|
2704 | =item L<Async::Interrupt> |
|
|
2705 | |
|
|
2706 | This slightly arcane module is used to implement fast signal handling: To |
|
|
2707 | my knowledge, there is no way to do completely race-free and quick |
|
|
2708 | signal handling in pure perl. To ensure that signals still get |
|
|
2709 | delivered, AnyEvent will start an interval timer to wake up perl (and |
|
|
2710 | catch the signals) with some delay (default is 10 seconds, look for |
|
|
2711 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
|
|
2712 | |
|
|
2713 | If this module is available, then it will be used to implement signal |
|
|
2714 | catching, which means that signals will not be delayed, and the event loop |
|
|
2715 | will not be interrupted regularly, which is more efficient (and good for |
|
|
2716 | battery life on laptops). |
|
|
2717 | |
|
|
2718 | This affects not just the pure-perl event loop, but also other event loops |
|
|
2719 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
|
|
2720 | |
|
|
2721 | Some event loops (POE, Event, Event::Lib) offer signal watchers natively, |
|
|
2722 | and either employ their own workarounds (POE) or use AnyEvent's workaround |
|
|
2723 | (using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt> |
|
|
2724 | does nothing for those backends. |
|
|
2725 | |
|
|
2726 | =item L<EV> |
|
|
2727 | |
|
|
2728 | This module isn't really "optional", as it is simply one of the backend |
|
|
2729 | event loops that AnyEvent can use. However, it is simply the best event |
|
|
2730 | loop available in terms of features, speed and stability: It supports |
|
|
2731 | the AnyEvent API optimally, implements all the watcher types in XS, does |
|
|
2732 | automatic timer adjustments even when no monotonic clock is available, |
|
|
2733 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
|
|
2734 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
|
|
2735 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
|
|
2736 | |
|
|
2737 | If you only use backends that rely on another event loop (e.g. C<Tk>), |
|
|
2738 | then this module will do nothing for you. |
|
|
2739 | |
|
|
2740 | =item L<Guard> |
|
|
2741 | |
|
|
2742 | The guard module, when used, will be used to implement |
|
|
2743 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
|
|
2744 | lot less memory), but otherwise doesn't affect guard operation much. It is |
|
|
2745 | purely used for performance. |
|
|
2746 | |
|
|
2747 | =item L<JSON> and L<JSON::XS> |
|
|
2748 | |
|
|
2749 | One of these modules is required when you want to read or write JSON data |
|
|
2750 | via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take |
|
|
2751 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
|
|
2752 | |
|
|
2753 | =item L<Net::SSLeay> |
|
|
2754 | |
|
|
2755 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
|
|
2756 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
|
|
2757 | the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. |
|
|
2758 | |
|
|
2759 | =item L<Time::HiRes> |
|
|
2760 | |
|
|
2761 | This module is part of perl since release 5.008. It will be used when the |
|
|
2762 | chosen event library does not come with a timing source of its own. The |
|
|
2763 | pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to |
|
|
2764 | try to use a monotonic clock for timing stability. |
|
|
2765 | |
|
|
2766 | =back |
|
|
2767 | |
1828 | |
2768 | |
1829 | =head1 FORK |
2769 | =head1 FORK |
1830 | |
2770 | |
1831 | Most event libraries are not fork-safe. The ones who are usually are |
2771 | Most event libraries are not fork-safe. The ones who are usually are |
1832 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2772 | because they rely on inefficient but fork-safe C<select> or C<poll> calls |
1833 | calls. Only L<EV> is fully fork-aware. |
2773 | - higher performance APIs such as BSD's kqueue or the dreaded Linux epoll |
|
|
2774 | are usually badly thought-out hacks that are incompatible with fork in |
|
|
2775 | one way or another. Only L<EV> is fully fork-aware and ensures that you |
|
|
2776 | continue event-processing in both parent and child (or both, if you know |
|
|
2777 | what you are doing). |
|
|
2778 | |
|
|
2779 | This means that, in general, you cannot fork and do event processing in |
|
|
2780 | the child if the event library was initialised before the fork (which |
|
|
2781 | usually happens when the first AnyEvent watcher is created, or the library |
|
|
2782 | is loaded). |
1834 | |
2783 | |
1835 | If you have to fork, you must either do so I<before> creating your first |
2784 | If you have to fork, you must either do so I<before> creating your first |
1836 | watcher OR you must not use AnyEvent at all in the child. |
2785 | watcher OR you must not use AnyEvent at all in the child OR you must do |
|
|
2786 | something completely out of the scope of AnyEvent. |
|
|
2787 | |
|
|
2788 | The problem of doing event processing in the parent I<and> the child |
|
|
2789 | is much more complicated: even for backends that I<are> fork-aware or |
|
|
2790 | fork-safe, their behaviour is not usually what you want: fork clones all |
|
|
2791 | watchers, that means all timers, I/O watchers etc. are active in both |
|
|
2792 | parent and child, which is almost never what you want. USing C<exec> |
|
|
2793 | to start worker children from some kind of manage rprocess is usually |
|
|
2794 | preferred, because it is much easier and cleaner, at the expense of having |
|
|
2795 | to have another binary. |
1837 | |
2796 | |
1838 | |
2797 | |
1839 | =head1 SECURITY CONSIDERATIONS |
2798 | =head1 SECURITY CONSIDERATIONS |
1840 | |
2799 | |
1841 | AnyEvent can be forced to load any event model via |
2800 | AnyEvent can be forced to load any event model via |
… | |
… | |
1853 | use AnyEvent; |
2812 | use AnyEvent; |
1854 | |
2813 | |
1855 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
2814 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1856 | be used to probe what backend is used and gain other information (which is |
2815 | be used to probe what backend is used and gain other information (which is |
1857 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
2816 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
1858 | $ENV{PERL_ANYEGENT_STRICT}. |
2817 | $ENV{PERL_ANYEVENT_STRICT}. |
|
|
2818 | |
|
|
2819 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
2820 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
2821 | enabled. |
1859 | |
2822 | |
1860 | |
2823 | |
1861 | =head1 BUGS |
2824 | =head1 BUGS |
1862 | |
2825 | |
1863 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
2826 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
… | |
… | |
1867 | pronounced). |
2830 | pronounced). |
1868 | |
2831 | |
1869 | |
2832 | |
1870 | =head1 SEE ALSO |
2833 | =head1 SEE ALSO |
1871 | |
2834 | |
1872 | Utility functions: L<AnyEvent::Util>. |
2835 | Tutorial/Introduction: L<AnyEvent::Intro>. |
1873 | |
2836 | |
1874 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
2837 | FAQ: L<AnyEvent::FAQ>. |
1875 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2838 | |
|
|
2839 | Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log> |
|
|
2840 | (simply logging). |
|
|
2841 | |
|
|
2842 | Development/Debugging: L<AnyEvent::Strict> (stricter checking), |
|
|
2843 | L<AnyEvent::Debug> (interactive shell, watcher tracing). |
|
|
2844 | |
|
|
2845 | Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, |
|
|
2846 | L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, |
|
|
2847 | L<Qt>, L<POE>, L<FLTK>. |
1876 | |
2848 | |
1877 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2849 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
1878 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2850 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
1879 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2851 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
|
|
2852 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>, |
1880 | L<AnyEvent::Impl::POE>. |
2853 | L<AnyEvent::Impl::FLTK>. |
1881 | |
2854 | |
1882 | Non-blocking file handles, sockets, TCP clients and |
2855 | Non-blocking handles, pipes, stream sockets, TCP clients and |
1883 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. |
2856 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
1884 | |
2857 | |
1885 | Asynchronous DNS: L<AnyEvent::DNS>. |
2858 | Asynchronous DNS: L<AnyEvent::DNS>. |
1886 | |
2859 | |
1887 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
2860 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
1888 | |
2861 | |
1889 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
2862 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>, |
|
|
2863 | L<AnyEvent::HTTP>. |
1890 | |
2864 | |
1891 | |
2865 | |
1892 | =head1 AUTHOR |
2866 | =head1 AUTHOR |
1893 | |
2867 | |
1894 | Marc Lehmann <schmorp@schmorp.de> |
2868 | Marc Lehmann <schmorp@schmorp.de> |