1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - provide framework for multiple event loops |
4 | |
4 | |
5 | Event, Coro, Glib, Tk, Perl - various supported event loops |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
|
|
6 | event loops. |
6 | |
7 | |
7 | =head1 SYNOPSIS |
8 | =head1 SYNOPSIS |
8 | |
9 | |
9 | use AnyEvent; |
10 | use AnyEvent; |
10 | |
11 | |
|
|
12 | # file descriptor readable |
11 | my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { |
13 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
|
|
14 | |
|
|
15 | # one-shot or repeating timers |
|
|
16 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
|
|
17 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
|
|
18 | |
|
|
19 | print AnyEvent->now; # prints current event loop time |
|
|
20 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
|
|
21 | |
|
|
22 | # POSIX signal |
|
|
23 | my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); |
|
|
24 | |
|
|
25 | # child process exit |
|
|
26 | my $w = AnyEvent->child (pid => $pid, cb => sub { |
|
|
27 | my ($pid, $status) = @_; |
12 | ... |
28 | ... |
13 | }); |
29 | }); |
14 | |
30 | |
15 | my $w = AnyEvent->timer (after => $seconds, cb => sub { |
31 | # called when event loop idle (if applicable) |
16 | ... |
32 | my $w = AnyEvent->idle (cb => sub { ... }); |
17 | }); |
|
|
18 | |
33 | |
19 | my $w = AnyEvent->condvar; # stores wether a condition was flagged |
34 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
|
|
35 | $w->send; # wake up current and all future recv's |
20 | $w->wait; # enters "main loop" till $condvar gets ->broadcast |
36 | $w->recv; # enters "main loop" till $condvar gets ->send |
21 | $w->broadcast; # wake up current and all future wait's |
37 | # use a condvar in callback mode: |
|
|
38 | $w->cb (sub { $_[0]->recv }); |
|
|
39 | |
|
|
40 | =head1 INTRODUCTION/TUTORIAL |
|
|
41 | |
|
|
42 | This manpage is mainly a reference manual. If you are interested |
|
|
43 | in a tutorial or some gentle introduction, have a look at the |
|
|
44 | L<AnyEvent::Intro> manpage. |
|
|
45 | |
|
|
46 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
|
|
47 | |
|
|
48 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
|
|
49 | nowadays. So what is different about AnyEvent? |
|
|
50 | |
|
|
51 | Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of |
|
|
52 | policy> and AnyEvent is I<small and efficient>. |
|
|
53 | |
|
|
54 | First and foremost, I<AnyEvent is not an event model> itself, it only |
|
|
55 | interfaces to whatever event model the main program happens to use, in a |
|
|
56 | pragmatic way. For event models and certain classes of immortals alike, |
|
|
57 | the statement "there can only be one" is a bitter reality: In general, |
|
|
58 | only one event loop can be active at the same time in a process. AnyEvent |
|
|
59 | cannot change this, but it can hide the differences between those event |
|
|
60 | loops. |
|
|
61 | |
|
|
62 | The goal of AnyEvent is to offer module authors the ability to do event |
|
|
63 | programming (waiting for I/O or timer events) without subscribing to a |
|
|
64 | religion, a way of living, and most importantly: without forcing your |
|
|
65 | module users into the same thing by forcing them to use the same event |
|
|
66 | model you use. |
|
|
67 | |
|
|
68 | For modules like POE or IO::Async (which is a total misnomer as it is |
|
|
69 | actually doing all I/O I<synchronously>...), using them in your module is |
|
|
70 | like joining a cult: After you joined, you are dependent on them and you |
|
|
71 | cannot use anything else, as they are simply incompatible to everything |
|
|
72 | that isn't them. What's worse, all the potential users of your |
|
|
73 | module are I<also> forced to use the same event loop you use. |
|
|
74 | |
|
|
75 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
|
|
76 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
|
|
77 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
|
|
78 | your module uses one of those, every user of your module has to use it, |
|
|
79 | too. But if your module uses AnyEvent, it works transparently with all |
|
|
80 | event models it supports (including stuff like IO::Async, as long as those |
|
|
81 | use one of the supported event loops. It is trivial to add new event loops |
|
|
82 | to AnyEvent, too, so it is future-proof). |
|
|
83 | |
|
|
84 | In addition to being free of having to use I<the one and only true event |
|
|
85 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
|
|
86 | modules, you get an enormous amount of code and strict rules you have to |
|
|
87 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
|
|
88 | offering the functionality that is necessary, in as thin as a wrapper as |
|
|
89 | technically possible. |
|
|
90 | |
|
|
91 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
|
|
92 | of useful functionality, such as an asynchronous DNS resolver, 100% |
|
|
93 | non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms |
|
|
94 | such as Windows) and lots of real-world knowledge and workarounds for |
|
|
95 | platform bugs and differences. |
|
|
96 | |
|
|
97 | Now, if you I<do want> lots of policy (this can arguably be somewhat |
|
|
98 | useful) and you want to force your users to use the one and only event |
|
|
99 | model, you should I<not> use this module. |
22 | |
100 | |
23 | =head1 DESCRIPTION |
101 | =head1 DESCRIPTION |
24 | |
102 | |
25 | L<AnyEvent> provides an identical interface to multiple event loops. This |
103 | L<AnyEvent> provides an identical interface to multiple event loops. This |
26 | allows module authors to utilise an event loop without forcing module |
104 | allows module authors to utilise an event loop without forcing module |
27 | users to use the same event loop (as only a single event loop can coexist |
105 | users to use the same event loop (as only a single event loop can coexist |
28 | peacefully at any one time). |
106 | peacefully at any one time). |
29 | |
107 | |
30 | The interface itself is vaguely similar but not identical to the Event |
108 | The interface itself is vaguely similar, but not identical to the L<Event> |
31 | module. |
109 | module. |
32 | |
110 | |
33 | On the first call of any method, the module tries to detect the currently |
111 | During the first call of any watcher-creation method, the module tries |
34 | loaded event loop by probing wether any of the following modules is |
112 | to detect the currently loaded event loop by probing whether one of the |
35 | loaded: L<Coro::Event>, L<Event>, L<Glib>, L<Tk>. The first one found is |
113 | following modules is already loaded: L<EV>, |
36 | used. If none is found, the module tries to load these modules in the |
114 | L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, |
37 | order given. The first one that could be successfully loaded will be |
115 | L<POE>. The first one found is used. If none are found, the module tries |
38 | used. If still none could be found, AnyEvent will fall back to a pure-perl |
116 | to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl |
39 | event loop, which is also not very efficient. |
117 | adaptor should always succeed) in the order given. The first one that can |
|
|
118 | be successfully loaded will be used. If, after this, still none could be |
|
|
119 | found, AnyEvent will fall back to a pure-perl event loop, which is not |
|
|
120 | very efficient, but should work everywhere. |
40 | |
121 | |
41 | Because AnyEvent first checks for modules that are already loaded, loading |
122 | Because AnyEvent first checks for modules that are already loaded, loading |
42 | an Event model explicitly before first using AnyEvent will likely make |
123 | an event model explicitly before first using AnyEvent will likely make |
43 | that model the default. For example: |
124 | that model the default. For example: |
44 | |
125 | |
45 | use Tk; |
126 | use Tk; |
46 | use AnyEvent; |
127 | use AnyEvent; |
47 | |
128 | |
48 | # .. AnyEvent will likely default to Tk |
129 | # .. AnyEvent will likely default to Tk |
49 | |
130 | |
|
|
131 | The I<likely> means that, if any module loads another event model and |
|
|
132 | starts using it, all bets are off. Maybe you should tell their authors to |
|
|
133 | use AnyEvent so their modules work together with others seamlessly... |
|
|
134 | |
50 | The pure-perl implementation of AnyEvent is called |
135 | The pure-perl implementation of AnyEvent is called |
51 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
136 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
52 | explicitly. |
137 | explicitly and enjoy the high availability of that event loop :) |
53 | |
138 | |
54 | =head1 WATCHERS |
139 | =head1 WATCHERS |
55 | |
140 | |
56 | AnyEvent has the central concept of a I<watcher>, which is an object that |
141 | AnyEvent has the central concept of a I<watcher>, which is an object that |
57 | stores relevant data for each kind of event you are waiting for, such as |
142 | stores relevant data for each kind of event you are waiting for, such as |
58 | the callback to call, the filehandle to watch, etc. |
143 | the callback to call, the file handle to watch, etc. |
59 | |
144 | |
60 | These watchers are normal Perl objects with normal Perl lifetime. After |
145 | These watchers are normal Perl objects with normal Perl lifetime. After |
61 | creating a watcher it will immediately "watch" for events and invoke |
146 | creating a watcher it will immediately "watch" for events and invoke the |
|
|
147 | callback when the event occurs (of course, only when the event model |
|
|
148 | is in control). |
|
|
149 | |
|
|
150 | Note that B<callbacks must not permanently change global variables> |
|
|
151 | potentially in use by the event loop (such as C<$_> or C<$[>) and that B<< |
|
|
152 | callbacks must not C<die> >>. The former is good programming practise in |
|
|
153 | Perl and the latter stems from the fact that exception handling differs |
|
|
154 | widely between event loops. |
|
|
155 | |
62 | the callback. To disable the watcher you have to destroy it (e.g. by |
156 | To disable the watcher you have to destroy it (e.g. by setting the |
63 | setting the variable that stores it to C<undef> or otherwise deleting all |
157 | variable you store it in to C<undef> or otherwise deleting all references |
64 | references to it). |
158 | to it). |
65 | |
159 | |
66 | All watchers are created by calling a method on the C<AnyEvent> class. |
160 | All watchers are created by calling a method on the C<AnyEvent> class. |
67 | |
161 | |
|
|
162 | Many watchers either are used with "recursion" (repeating timers for |
|
|
163 | example), or need to refer to their watcher object in other ways. |
|
|
164 | |
|
|
165 | An any way to achieve that is this pattern: |
|
|
166 | |
|
|
167 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
|
|
168 | # you can use $w here, for example to undef it |
|
|
169 | undef $w; |
|
|
170 | }); |
|
|
171 | |
|
|
172 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
|
|
173 | my variables are only visible after the statement in which they are |
|
|
174 | declared. |
|
|
175 | |
68 | =head2 IO WATCHERS |
176 | =head2 I/O WATCHERS |
69 | |
177 | |
70 | You can create I/O watcher by calling the C<< AnyEvent->io >> method with |
178 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
71 | the following mandatory arguments: |
179 | with the following mandatory key-value pairs as arguments: |
72 | |
180 | |
73 | C<fh> the Perl I<filehandle> (not filedescriptor) to watch for |
181 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
|
|
182 | for events (AnyEvent might or might not keep a reference to this file |
|
|
183 | handle). Note that only file handles pointing to things for which |
|
|
184 | non-blocking operation makes sense are allowed. This includes sockets, |
|
|
185 | most character devices, pipes, fifos and so on, but not for example files |
|
|
186 | or block devices. |
|
|
187 | |
74 | events. C<poll> must be a string that is either C<r> or C<w>, that creates |
188 | C<poll> must be a string that is either C<r> or C<w>, which creates a |
75 | a watcher waiting for "r"eadable or "w"ritable events. C<cb> teh callback |
189 | watcher waiting for "r"eadable or "w"ritable events, respectively. |
76 | to invoke everytime the filehandle becomes ready. |
|
|
77 | |
190 | |
78 | Only one io watcher per C<fh> and C<poll> combination is allowed (i.e. on |
191 | C<cb> is the callback to invoke each time the file handle becomes ready. |
79 | a socket you can have one r + one w, not any more (limitation comes from |
|
|
80 | Tk - if you are sure you are not using Tk this limitation is gone). |
|
|
81 | |
192 | |
82 | Filehandles will be kept alive, so as long as the watcher exists, the |
193 | Although the callback might get passed parameters, their value and |
83 | filehandle exists, too. |
194 | presence is undefined and you cannot rely on them. Portable AnyEvent |
|
|
195 | callbacks cannot use arguments passed to I/O watcher callbacks. |
84 | |
196 | |
85 | Example: |
197 | The I/O watcher might use the underlying file descriptor or a copy of it. |
|
|
198 | You must not close a file handle as long as any watcher is active on the |
|
|
199 | underlying file descriptor. |
86 | |
200 | |
|
|
201 | Some event loops issue spurious readyness notifications, so you should |
|
|
202 | always use non-blocking calls when reading/writing from/to your file |
|
|
203 | handles. |
|
|
204 | |
87 | # wait for readability of STDIN, then read a line and disable the watcher |
205 | Example: wait for readability of STDIN, then read a line and disable the |
|
|
206 | watcher. |
|
|
207 | |
88 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
208 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
89 | chomp (my $input = <STDIN>); |
209 | chomp (my $input = <STDIN>); |
90 | warn "read: $input\n"; |
210 | warn "read: $input\n"; |
91 | undef $w; |
211 | undef $w; |
92 | }); |
212 | }); |
… | |
… | |
94 | =head2 TIME WATCHERS |
214 | =head2 TIME WATCHERS |
95 | |
215 | |
96 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
216 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
97 | method with the following mandatory arguments: |
217 | method with the following mandatory arguments: |
98 | |
218 | |
99 | C<after> after how many seconds (fractions are supported) should the timer |
219 | C<after> specifies after how many seconds (fractional values are |
100 | activate. C<cb> the callback to invoke. |
220 | supported) the callback should be invoked. C<cb> is the callback to invoke |
|
|
221 | in that case. |
101 | |
222 | |
102 | The timer callback will be invoked at most once: if you want a repeating |
223 | Although the callback might get passed parameters, their value and |
103 | timer you have to create a new watcher (this is a limitation by both Tk |
224 | presence is undefined and you cannot rely on them. Portable AnyEvent |
104 | and Glib). |
225 | callbacks cannot use arguments passed to time watcher callbacks. |
105 | |
226 | |
106 | Example: |
227 | The callback will normally be invoked once only. If you specify another |
|
|
228 | parameter, C<interval>, as a strictly positive number (> 0), then the |
|
|
229 | callback will be invoked regularly at that interval (in fractional |
|
|
230 | seconds) after the first invocation. If C<interval> is specified with a |
|
|
231 | false value, then it is treated as if it were missing. |
107 | |
232 | |
|
|
233 | The callback will be rescheduled before invoking the callback, but no |
|
|
234 | attempt is done to avoid timer drift in most backends, so the interval is |
|
|
235 | only approximate. |
|
|
236 | |
108 | # fire an event after 7.7 seconds |
237 | Example: fire an event after 7.7 seconds. |
|
|
238 | |
109 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
239 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
110 | warn "timeout\n"; |
240 | warn "timeout\n"; |
111 | }); |
241 | }); |
112 | |
242 | |
113 | # to cancel the timer: |
243 | # to cancel the timer: |
114 | undef $w |
244 | undef $w; |
115 | |
245 | |
116 | =head2 CONDITION WATCHERS |
246 | Example 2: fire an event after 0.5 seconds, then roughly every second. |
117 | |
247 | |
118 | Condition watchers can be created by calling the C<< AnyEvent->condvar >> |
248 | my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { |
119 | method without any arguments. |
249 | warn "timeout\n"; |
|
|
250 | }; |
120 | |
251 | |
121 | A condition watcher watches for a condition - precisely that the C<< |
252 | =head3 TIMING ISSUES |
122 | ->broadcast >> method has been called. |
|
|
123 | |
253 | |
124 | The watcher has only two methods: |
254 | There are two ways to handle timers: based on real time (relative, "fire |
|
|
255 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
|
|
256 | o'clock"). |
|
|
257 | |
|
|
258 | While most event loops expect timers to specified in a relative way, they |
|
|
259 | use absolute time internally. This makes a difference when your clock |
|
|
260 | "jumps", for example, when ntp decides to set your clock backwards from |
|
|
261 | the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to |
|
|
262 | fire "after" a second might actually take six years to finally fire. |
|
|
263 | |
|
|
264 | AnyEvent cannot compensate for this. The only event loop that is conscious |
|
|
265 | about these issues is L<EV>, which offers both relative (ev_timer, based |
|
|
266 | on true relative time) and absolute (ev_periodic, based on wallclock time) |
|
|
267 | timers. |
|
|
268 | |
|
|
269 | AnyEvent always prefers relative timers, if available, matching the |
|
|
270 | AnyEvent API. |
|
|
271 | |
|
|
272 | AnyEvent has two additional methods that return the "current time": |
125 | |
273 | |
126 | =over 4 |
274 | =over 4 |
127 | |
275 | |
128 | =item $cv->wait |
276 | =item AnyEvent->time |
129 | |
277 | |
130 | Wait (blocking if necessary) until the C<< ->broadcast >> method has been |
278 | This returns the "current wallclock time" as a fractional number of |
131 | called on c<$cv>, while servicing other watchers normally. |
279 | seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time> |
|
|
280 | return, and the result is guaranteed to be compatible with those). |
132 | |
281 | |
133 | Not all event models support a blocking wait - some die in that case, so |
282 | It progresses independently of any event loop processing, i.e. each call |
134 | if you are using this from a module, never require a blocking wait, but |
283 | will check the system clock, which usually gets updated frequently. |
135 | let the caller decide wether the call will block or not (for example, |
|
|
136 | by coupling condition variables with some kind of request results and |
|
|
137 | supporting callbacks so the caller knows that getting the result will not |
|
|
138 | block, while still suppporting blockign waits if the caller so desires). |
|
|
139 | |
284 | |
140 | You can only wait once on a condition - additional calls will return |
285 | =item AnyEvent->now |
141 | immediately. |
|
|
142 | |
286 | |
143 | =item $cv->broadcast |
287 | This also returns the "current wallclock time", but unlike C<time>, above, |
|
|
288 | this value might change only once per event loop iteration, depending on |
|
|
289 | the event loop (most return the same time as C<time>, above). This is the |
|
|
290 | time that AnyEvent's timers get scheduled against. |
144 | |
291 | |
145 | Flag the condition as ready - a running C<< ->wait >> and all further |
292 | I<In almost all cases (in all cases if you don't care), this is the |
146 | calls to C<wait> will return after this method has been called. If nobody |
293 | function to call when you want to know the current time.> |
147 | is waiting the broadcast will be remembered.. |
|
|
148 | |
294 | |
149 | Example: |
295 | This function is also often faster then C<< AnyEvent->time >>, and |
|
|
296 | thus the preferred method if you want some timestamp (for example, |
|
|
297 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
|
|
298 | |
|
|
299 | The rest of this section is only of relevance if you try to be very exact |
|
|
300 | with your timing, you can skip it without bad conscience. |
|
|
301 | |
|
|
302 | For a practical example of when these times differ, consider L<Event::Lib> |
|
|
303 | and L<EV> and the following set-up: |
|
|
304 | |
|
|
305 | The event loop is running and has just invoked one of your callback at |
|
|
306 | time=500 (assume no other callbacks delay processing). In your callback, |
|
|
307 | you wait a second by executing C<sleep 1> (blocking the process for a |
|
|
308 | second) and then (at time=501) you create a relative timer that fires |
|
|
309 | after three seconds. |
|
|
310 | |
|
|
311 | With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will |
|
|
312 | both return C<501>, because that is the current time, and the timer will |
|
|
313 | be scheduled to fire at time=504 (C<501> + C<3>). |
|
|
314 | |
|
|
315 | With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current |
|
|
316 | time), but C<< AnyEvent->now >> returns C<500>, as that is the time the |
|
|
317 | last event processing phase started. With L<EV>, your timer gets scheduled |
|
|
318 | to run at time=503 (C<500> + C<3>). |
|
|
319 | |
|
|
320 | In one sense, L<Event::Lib> is more exact, as it uses the current time |
|
|
321 | regardless of any delays introduced by event processing. However, most |
|
|
322 | callbacks do not expect large delays in processing, so this causes a |
|
|
323 | higher drift (and a lot more system calls to get the current time). |
|
|
324 | |
|
|
325 | In another sense, L<EV> is more exact, as your timer will be scheduled at |
|
|
326 | the same time, regardless of how long event processing actually took. |
|
|
327 | |
|
|
328 | In either case, if you care (and in most cases, you don't), then you |
|
|
329 | can get whatever behaviour you want with any event loop, by taking the |
|
|
330 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
|
|
331 | account. |
|
|
332 | |
|
|
333 | =item AnyEvent->now_update |
|
|
334 | |
|
|
335 | Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache |
|
|
336 | the current time for each loop iteration (see the discussion of L<< |
|
|
337 | AnyEvent->now >>, above). |
|
|
338 | |
|
|
339 | When a callback runs for a long time (or when the process sleeps), then |
|
|
340 | this "current" time will differ substantially from the real time, which |
|
|
341 | might affect timers and time-outs. |
|
|
342 | |
|
|
343 | When this is the case, you can call this method, which will update the |
|
|
344 | event loop's idea of "current time". |
|
|
345 | |
|
|
346 | Note that updating the time I<might> cause some events to be handled. |
|
|
347 | |
|
|
348 | =back |
|
|
349 | |
|
|
350 | =head2 SIGNAL WATCHERS |
|
|
351 | |
|
|
352 | You can watch for signals using a signal watcher, C<signal> is the signal |
|
|
353 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
|
|
354 | callback to be invoked whenever a signal occurs. |
|
|
355 | |
|
|
356 | Although the callback might get passed parameters, their value and |
|
|
357 | presence is undefined and you cannot rely on them. Portable AnyEvent |
|
|
358 | callbacks cannot use arguments passed to signal watcher callbacks. |
|
|
359 | |
|
|
360 | Multiple signal occurrences can be clumped together into one callback |
|
|
361 | invocation, and callback invocation will be synchronous. Synchronous means |
|
|
362 | that it might take a while until the signal gets handled by the process, |
|
|
363 | but it is guaranteed not to interrupt any other callbacks. |
|
|
364 | |
|
|
365 | The main advantage of using these watchers is that you can share a signal |
|
|
366 | between multiple watchers, and AnyEvent will ensure that signals will not |
|
|
367 | interrupt your program at bad times. |
|
|
368 | |
|
|
369 | This watcher might use C<%SIG> (depending on the event loop used), |
|
|
370 | so programs overwriting those signals directly will likely not work |
|
|
371 | correctly. |
|
|
372 | |
|
|
373 | Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not |
|
|
374 | support attaching callbacks to signals, which is a pity, as you cannot do |
|
|
375 | race-free signal handling in perl. AnyEvent will try to do it's best, but |
|
|
376 | in some cases, signals will be delayed. The maximum time a signal might |
|
|
377 | be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 |
|
|
378 | seconds). This variable can be changed only before the first signal |
|
|
379 | watcher is created, and should be left alone otherwise. Higher values |
|
|
380 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
381 | saving. All these problems can be avoided by installing the optional |
|
|
382 | L<Async::Interrupt> module. |
|
|
383 | |
|
|
384 | Example: exit on SIGINT |
|
|
385 | |
|
|
386 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
|
|
387 | |
|
|
388 | =head2 CHILD PROCESS WATCHERS |
|
|
389 | |
|
|
390 | You can also watch on a child process exit and catch its exit status. |
|
|
391 | |
|
|
392 | The child process is specified by the C<pid> argument (if set to C<0>, it |
|
|
393 | watches for any child process exit). The watcher will triggered only when |
|
|
394 | the child process has finished and an exit status is available, not on |
|
|
395 | any trace events (stopped/continued). |
|
|
396 | |
|
|
397 | The callback will be called with the pid and exit status (as returned by |
|
|
398 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
|
|
399 | callback arguments. |
|
|
400 | |
|
|
401 | This watcher type works by installing a signal handler for C<SIGCHLD>, |
|
|
402 | and since it cannot be shared, nothing else should use SIGCHLD or reap |
|
|
403 | random child processes (waiting for specific child processes, e.g. inside |
|
|
404 | C<system>, is just fine). |
|
|
405 | |
|
|
406 | There is a slight catch to child watchers, however: you usually start them |
|
|
407 | I<after> the child process was created, and this means the process could |
|
|
408 | have exited already (and no SIGCHLD will be sent anymore). |
|
|
409 | |
|
|
410 | Not all event models handle this correctly (neither POE nor IO::Async do, |
|
|
411 | see their AnyEvent::Impl manpages for details), but even for event models |
|
|
412 | that I<do> handle this correctly, they usually need to be loaded before |
|
|
413 | the process exits (i.e. before you fork in the first place). AnyEvent's |
|
|
414 | pure perl event loop handles all cases correctly regardless of when you |
|
|
415 | start the watcher. |
|
|
416 | |
|
|
417 | This means you cannot create a child watcher as the very first |
|
|
418 | thing in an AnyEvent program, you I<have> to create at least one |
|
|
419 | watcher before you C<fork> the child (alternatively, you can call |
|
|
420 | C<AnyEvent::detect>). |
|
|
421 | |
|
|
422 | As most event loops do not support waiting for child events, they will be |
|
|
423 | emulated by AnyEvent in most cases, in which the latency and race problems |
|
|
424 | mentioned in the description of signal watchers apply. |
|
|
425 | |
|
|
426 | Example: fork a process and wait for it |
|
|
427 | |
|
|
428 | my $done = AnyEvent->condvar; |
|
|
429 | |
|
|
430 | my $pid = fork or exit 5; |
|
|
431 | |
|
|
432 | my $w = AnyEvent->child ( |
|
|
433 | pid => $pid, |
|
|
434 | cb => sub { |
|
|
435 | my ($pid, $status) = @_; |
|
|
436 | warn "pid $pid exited with status $status"; |
|
|
437 | $done->send; |
|
|
438 | }, |
|
|
439 | ); |
|
|
440 | |
|
|
441 | # do something else, then wait for process exit |
|
|
442 | $done->recv; |
|
|
443 | |
|
|
444 | =head2 IDLE WATCHERS |
|
|
445 | |
|
|
446 | Sometimes there is a need to do something, but it is not so important |
|
|
447 | to do it instantly, but only when there is nothing better to do. This |
|
|
448 | "nothing better to do" is usually defined to be "no other events need |
|
|
449 | attention by the event loop". |
|
|
450 | |
|
|
451 | Idle watchers ideally get invoked when the event loop has nothing |
|
|
452 | better to do, just before it would block the process to wait for new |
|
|
453 | events. Instead of blocking, the idle watcher is invoked. |
|
|
454 | |
|
|
455 | Most event loops unfortunately do not really support idle watchers (only |
|
|
456 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
|
|
457 | will simply call the callback "from time to time". |
|
|
458 | |
|
|
459 | Example: read lines from STDIN, but only process them when the |
|
|
460 | program is otherwise idle: |
|
|
461 | |
|
|
462 | my @lines; # read data |
|
|
463 | my $idle_w; |
|
|
464 | my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
|
|
465 | push @lines, scalar <STDIN>; |
|
|
466 | |
|
|
467 | # start an idle watcher, if not already done |
|
|
468 | $idle_w ||= AnyEvent->idle (cb => sub { |
|
|
469 | # handle only one line, when there are lines left |
|
|
470 | if (my $line = shift @lines) { |
|
|
471 | print "handled when idle: $line"; |
|
|
472 | } else { |
|
|
473 | # otherwise disable the idle watcher again |
|
|
474 | undef $idle_w; |
|
|
475 | } |
|
|
476 | }); |
|
|
477 | }); |
|
|
478 | |
|
|
479 | =head2 CONDITION VARIABLES |
|
|
480 | |
|
|
481 | If you are familiar with some event loops you will know that all of them |
|
|
482 | require you to run some blocking "loop", "run" or similar function that |
|
|
483 | will actively watch for new events and call your callbacks. |
|
|
484 | |
|
|
485 | AnyEvent is slightly different: it expects somebody else to run the event |
|
|
486 | loop and will only block when necessary (usually when told by the user). |
|
|
487 | |
|
|
488 | The instrument to do that is called a "condition variable", so called |
|
|
489 | because they represent a condition that must become true. |
|
|
490 | |
|
|
491 | Now is probably a good time to look at the examples further below. |
|
|
492 | |
|
|
493 | Condition variables can be created by calling the C<< AnyEvent->condvar |
|
|
494 | >> method, usually without arguments. The only argument pair allowed is |
|
|
495 | C<cb>, which specifies a callback to be called when the condition variable |
|
|
496 | becomes true, with the condition variable as the first argument (but not |
|
|
497 | the results). |
|
|
498 | |
|
|
499 | After creation, the condition variable is "false" until it becomes "true" |
|
|
500 | by calling the C<send> method (or calling the condition variable as if it |
|
|
501 | were a callback, read about the caveats in the description for the C<< |
|
|
502 | ->send >> method). |
|
|
503 | |
|
|
504 | Condition variables are similar to callbacks, except that you can |
|
|
505 | optionally wait for them. They can also be called merge points - points |
|
|
506 | in time where multiple outstanding events have been processed. And yet |
|
|
507 | another way to call them is transactions - each condition variable can be |
|
|
508 | used to represent a transaction, which finishes at some point and delivers |
|
|
509 | a result. |
|
|
510 | |
|
|
511 | Condition variables are very useful to signal that something has finished, |
|
|
512 | for example, if you write a module that does asynchronous http requests, |
|
|
513 | then a condition variable would be the ideal candidate to signal the |
|
|
514 | availability of results. The user can either act when the callback is |
|
|
515 | called or can synchronously C<< ->recv >> for the results. |
|
|
516 | |
|
|
517 | You can also use them to simulate traditional event loops - for example, |
|
|
518 | you can block your main program until an event occurs - for example, you |
|
|
519 | could C<< ->recv >> in your main program until the user clicks the Quit |
|
|
520 | button of your app, which would C<< ->send >> the "quit" event. |
|
|
521 | |
|
|
522 | Note that condition variables recurse into the event loop - if you have |
|
|
523 | two pieces of code that call C<< ->recv >> in a round-robin fashion, you |
|
|
524 | lose. Therefore, condition variables are good to export to your caller, but |
|
|
525 | you should avoid making a blocking wait yourself, at least in callbacks, |
|
|
526 | as this asks for trouble. |
|
|
527 | |
|
|
528 | Condition variables are represented by hash refs in perl, and the keys |
|
|
529 | used by AnyEvent itself are all named C<_ae_XXX> to make subclassing |
|
|
530 | easy (it is often useful to build your own transaction class on top of |
|
|
531 | AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call |
|
|
532 | it's C<new> method in your own C<new> method. |
|
|
533 | |
|
|
534 | There are two "sides" to a condition variable - the "producer side" which |
|
|
535 | eventually calls C<< -> send >>, and the "consumer side", which waits |
|
|
536 | for the send to occur. |
|
|
537 | |
|
|
538 | Example: wait for a timer. |
150 | |
539 | |
151 | # wait till the result is ready |
540 | # wait till the result is ready |
152 | my $result_ready = AnyEvent->condvar; |
541 | my $result_ready = AnyEvent->condvar; |
153 | |
542 | |
154 | # do something such as adding a timer |
543 | # do something such as adding a timer |
155 | # or socket watcher the calls $result_ready->broadcast |
544 | # or socket watcher the calls $result_ready->send |
156 | # when the "result" is ready. |
545 | # when the "result" is ready. |
|
|
546 | # in this case, we simply use a timer: |
|
|
547 | my $w = AnyEvent->timer ( |
|
|
548 | after => 1, |
|
|
549 | cb => sub { $result_ready->send }, |
|
|
550 | ); |
157 | |
551 | |
|
|
552 | # this "blocks" (while handling events) till the callback |
|
|
553 | # calls -<send |
158 | $result_ready->wait; |
554 | $result_ready->recv; |
|
|
555 | |
|
|
556 | Example: wait for a timer, but take advantage of the fact that condition |
|
|
557 | variables are also callable directly. |
|
|
558 | |
|
|
559 | my $done = AnyEvent->condvar; |
|
|
560 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
|
|
561 | $done->recv; |
|
|
562 | |
|
|
563 | Example: Imagine an API that returns a condvar and doesn't support |
|
|
564 | callbacks. This is how you make a synchronous call, for example from |
|
|
565 | the main program: |
|
|
566 | |
|
|
567 | use AnyEvent::CouchDB; |
|
|
568 | |
|
|
569 | ... |
|
|
570 | |
|
|
571 | my @info = $couchdb->info->recv; |
|
|
572 | |
|
|
573 | And this is how you would just set a callback to be called whenever the |
|
|
574 | results are available: |
|
|
575 | |
|
|
576 | $couchdb->info->cb (sub { |
|
|
577 | my @info = $_[0]->recv; |
|
|
578 | }); |
|
|
579 | |
|
|
580 | =head3 METHODS FOR PRODUCERS |
|
|
581 | |
|
|
582 | These methods should only be used by the producing side, i.e. the |
|
|
583 | code/module that eventually sends the signal. Note that it is also |
|
|
584 | the producer side which creates the condvar in most cases, but it isn't |
|
|
585 | uncommon for the consumer to create it as well. |
|
|
586 | |
|
|
587 | =over 4 |
|
|
588 | |
|
|
589 | =item $cv->send (...) |
|
|
590 | |
|
|
591 | Flag the condition as ready - a running C<< ->recv >> and all further |
|
|
592 | calls to C<recv> will (eventually) return after this method has been |
|
|
593 | called. If nobody is waiting the send will be remembered. |
|
|
594 | |
|
|
595 | If a callback has been set on the condition variable, it is called |
|
|
596 | immediately from within send. |
|
|
597 | |
|
|
598 | Any arguments passed to the C<send> call will be returned by all |
|
|
599 | future C<< ->recv >> calls. |
|
|
600 | |
|
|
601 | Condition variables are overloaded so one can call them directly (as if |
|
|
602 | they were a code reference). Calling them directly is the same as calling |
|
|
603 | C<send>. |
|
|
604 | |
|
|
605 | =item $cv->croak ($error) |
|
|
606 | |
|
|
607 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
|
|
608 | C<Carp::croak> with the given error message/object/scalar. |
|
|
609 | |
|
|
610 | This can be used to signal any errors to the condition variable |
|
|
611 | user/consumer. Doing it this way instead of calling C<croak> directly |
|
|
612 | delays the error detetcion, but has the overwhelmign advantage that it |
|
|
613 | diagnoses the error at the place where the result is expected, and not |
|
|
614 | deep in some event clalback without connection to the actual code causing |
|
|
615 | the problem. |
|
|
616 | |
|
|
617 | =item $cv->begin ([group callback]) |
|
|
618 | |
|
|
619 | =item $cv->end |
|
|
620 | |
|
|
621 | These two methods can be used to combine many transactions/events into |
|
|
622 | one. For example, a function that pings many hosts in parallel might want |
|
|
623 | to use a condition variable for the whole process. |
|
|
624 | |
|
|
625 | Every call to C<< ->begin >> will increment a counter, and every call to |
|
|
626 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
|
|
627 | >>, the (last) callback passed to C<begin> will be executed. That callback |
|
|
628 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
|
|
629 | callback was set, C<send> will be called without any arguments. |
|
|
630 | |
|
|
631 | You can think of C<< $cv->send >> giving you an OR condition (one call |
|
|
632 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
|
|
633 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
|
|
634 | |
|
|
635 | Let's start with a simple example: you have two I/O watchers (for example, |
|
|
636 | STDOUT and STDERR for a program), and you want to wait for both streams to |
|
|
637 | close before activating a condvar: |
|
|
638 | |
|
|
639 | my $cv = AnyEvent->condvar; |
|
|
640 | |
|
|
641 | $cv->begin; # first watcher |
|
|
642 | my $w1 = AnyEvent->io (fh => $fh1, cb => sub { |
|
|
643 | defined sysread $fh1, my $buf, 4096 |
|
|
644 | or $cv->end; |
|
|
645 | }); |
|
|
646 | |
|
|
647 | $cv->begin; # second watcher |
|
|
648 | my $w2 = AnyEvent->io (fh => $fh2, cb => sub { |
|
|
649 | defined sysread $fh2, my $buf, 4096 |
|
|
650 | or $cv->end; |
|
|
651 | }); |
|
|
652 | |
|
|
653 | $cv->recv; |
|
|
654 | |
|
|
655 | This works because for every event source (EOF on file handle), there is |
|
|
656 | one call to C<begin>, so the condvar waits for all calls to C<end> before |
|
|
657 | sending. |
|
|
658 | |
|
|
659 | The ping example mentioned above is slightly more complicated, as the |
|
|
660 | there are results to be passwd back, and the number of tasks that are |
|
|
661 | begung can potentially be zero: |
|
|
662 | |
|
|
663 | my $cv = AnyEvent->condvar; |
|
|
664 | |
|
|
665 | my %result; |
|
|
666 | $cv->begin (sub { $cv->send (\%result) }); |
|
|
667 | |
|
|
668 | for my $host (@list_of_hosts) { |
|
|
669 | $cv->begin; |
|
|
670 | ping_host_then_call_callback $host, sub { |
|
|
671 | $result{$host} = ...; |
|
|
672 | $cv->end; |
|
|
673 | }; |
|
|
674 | } |
|
|
675 | |
|
|
676 | $cv->end; |
|
|
677 | |
|
|
678 | This code fragment supposedly pings a number of hosts and calls |
|
|
679 | C<send> after results for all then have have been gathered - in any |
|
|
680 | order. To achieve this, the code issues a call to C<begin> when it starts |
|
|
681 | each ping request and calls C<end> when it has received some result for |
|
|
682 | it. Since C<begin> and C<end> only maintain a counter, the order in which |
|
|
683 | results arrive is not relevant. |
|
|
684 | |
|
|
685 | There is an additional bracketing call to C<begin> and C<end> outside the |
|
|
686 | loop, which serves two important purposes: first, it sets the callback |
|
|
687 | to be called once the counter reaches C<0>, and second, it ensures that |
|
|
688 | C<send> is called even when C<no> hosts are being pinged (the loop |
|
|
689 | doesn't execute once). |
|
|
690 | |
|
|
691 | This is the general pattern when you "fan out" into multiple (but |
|
|
692 | potentially none) subrequests: use an outer C<begin>/C<end> pair to set |
|
|
693 | the callback and ensure C<end> is called at least once, and then, for each |
|
|
694 | subrequest you start, call C<begin> and for each subrequest you finish, |
|
|
695 | call C<end>. |
159 | |
696 | |
160 | =back |
697 | =back |
161 | |
698 | |
162 | =head2 SIGNAL WATCHERS |
699 | =head3 METHODS FOR CONSUMERS |
163 | |
700 | |
164 | You can listen for signals using a signal watcher, C<signal> is the signal |
701 | These methods should only be used by the consuming side, i.e. the |
165 | I<name> without any C<SIG> prefix. Multiple signals events can be clumped |
702 | code awaits the condition. |
166 | together into one callback invocation, and callback invocation might or |
|
|
167 | might not be asynchronous. |
|
|
168 | |
|
|
169 | These watchers might use C<%SIG>, so programs overwriting those signals |
|
|
170 | directly will likely not work correctly. |
|
|
171 | |
|
|
172 | Example: exit on SIGINT |
|
|
173 | |
|
|
174 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
|
|
175 | |
|
|
176 | =head2 CHILD PROCESS WATCHERS |
|
|
177 | |
|
|
178 | You can also listen for the status of a child process specified by the |
|
|
179 | C<pid> argument. The watcher will only trigger once. This works by |
|
|
180 | installing a signal handler for C<SIGCHLD>. |
|
|
181 | |
|
|
182 | Example: wait for pid 1333 |
|
|
183 | |
|
|
184 | my $w = AnyEvent->child (pid => 1333, cb => sub { warn "exit status $?" }); |
|
|
185 | |
|
|
186 | =head1 GLOBALS |
|
|
187 | |
703 | |
188 | =over 4 |
704 | =over 4 |
189 | |
705 | |
|
|
706 | =item $cv->recv |
|
|
707 | |
|
|
708 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
|
|
709 | >> methods have been called on c<$cv>, while servicing other watchers |
|
|
710 | normally. |
|
|
711 | |
|
|
712 | You can only wait once on a condition - additional calls are valid but |
|
|
713 | will return immediately. |
|
|
714 | |
|
|
715 | If an error condition has been set by calling C<< ->croak >>, then this |
|
|
716 | function will call C<croak>. |
|
|
717 | |
|
|
718 | In list context, all parameters passed to C<send> will be returned, |
|
|
719 | in scalar context only the first one will be returned. |
|
|
720 | |
|
|
721 | Note that doing a blocking wait in a callback is not supported by any |
|
|
722 | event loop, that is, recursive invocation of a blocking C<< ->recv |
|
|
723 | >> is not allowed, and the C<recv> call will C<croak> if such a |
|
|
724 | condition is detected. This condition can be slightly loosened by using |
|
|
725 | L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from |
|
|
726 | any thread that doesn't run the event loop itself. |
|
|
727 | |
|
|
728 | Not all event models support a blocking wait - some die in that case |
|
|
729 | (programs might want to do that to stay interactive), so I<if you are |
|
|
730 | using this from a module, never require a blocking wait>. Instead, let the |
|
|
731 | caller decide whether the call will block or not (for example, by coupling |
|
|
732 | condition variables with some kind of request results and supporting |
|
|
733 | callbacks so the caller knows that getting the result will not block, |
|
|
734 | while still supporting blocking waits if the caller so desires). |
|
|
735 | |
|
|
736 | You can ensure that C<< -recv >> never blocks by setting a callback and |
|
|
737 | only calling C<< ->recv >> from within that callback (or at a later |
|
|
738 | time). This will work even when the event loop does not support blocking |
|
|
739 | waits otherwise. |
|
|
740 | |
|
|
741 | =item $bool = $cv->ready |
|
|
742 | |
|
|
743 | Returns true when the condition is "true", i.e. whether C<send> or |
|
|
744 | C<croak> have been called. |
|
|
745 | |
|
|
746 | =item $cb = $cv->cb ($cb->($cv)) |
|
|
747 | |
|
|
748 | This is a mutator function that returns the callback set and optionally |
|
|
749 | replaces it before doing so. |
|
|
750 | |
|
|
751 | The callback will be called when the condition becomes "true", i.e. when |
|
|
752 | C<send> or C<croak> are called, with the only argument being the condition |
|
|
753 | variable itself. Calling C<recv> inside the callback or at any later time |
|
|
754 | is guaranteed not to block. |
|
|
755 | |
|
|
756 | =back |
|
|
757 | |
|
|
758 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
|
|
759 | |
|
|
760 | The available backend classes are (every class has its own manpage): |
|
|
761 | |
|
|
762 | =over 4 |
|
|
763 | |
|
|
764 | =item Backends that are autoprobed when no other event loop can be found. |
|
|
765 | |
|
|
766 | EV is the preferred backend when no other event loop seems to be in |
|
|
767 | use. If EV is not installed, then AnyEvent will try Event, and, failing |
|
|
768 | that, will fall back to its own pure-perl implementation, which is |
|
|
769 | available everywhere as it comes with AnyEvent itself. |
|
|
770 | |
|
|
771 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
|
|
772 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
773 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
774 | |
|
|
775 | =item Backends that are transparently being picked up when they are used. |
|
|
776 | |
|
|
777 | These will be used when they are currently loaded when the first watcher |
|
|
778 | is created, in which case it is assumed that the application is using |
|
|
779 | them. This means that AnyEvent will automatically pick the right backend |
|
|
780 | when the main program loads an event module before anything starts to |
|
|
781 | create watchers. Nothing special needs to be done by the main program. |
|
|
782 | |
|
|
783 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
|
|
784 | AnyEvent::Impl::Tk based on Tk, very broken. |
|
|
785 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
786 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
787 | |
|
|
788 | =item Backends with special needs. |
|
|
789 | |
|
|
790 | Qt requires the Qt::Application to be instantiated first, but will |
|
|
791 | otherwise be picked up automatically. As long as the main program |
|
|
792 | instantiates the application before any AnyEvent watchers are created, |
|
|
793 | everything should just work. |
|
|
794 | |
|
|
795 | AnyEvent::Impl::Qt based on Qt. |
|
|
796 | |
|
|
797 | Support for IO::Async can only be partial, as it is too broken and |
|
|
798 | architecturally limited to even support the AnyEvent API. It also |
|
|
799 | is the only event loop that needs the loop to be set explicitly, so |
|
|
800 | it can only be used by a main program knowing about AnyEvent. See |
|
|
801 | L<AnyEvent::Impl::Async> for the gory details. |
|
|
802 | |
|
|
803 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
|
|
804 | |
|
|
805 | =item Event loops that are indirectly supported via other backends. |
|
|
806 | |
|
|
807 | Some event loops can be supported via other modules: |
|
|
808 | |
|
|
809 | There is no direct support for WxWidgets (L<Wx>) or L<Prima>. |
|
|
810 | |
|
|
811 | B<WxWidgets> has no support for watching file handles. However, you can |
|
|
812 | use WxWidgets through the POE adaptor, as POE has a Wx backend that simply |
|
|
813 | polls 20 times per second, which was considered to be too horrible to even |
|
|
814 | consider for AnyEvent. |
|
|
815 | |
|
|
816 | B<Prima> is not supported as nobody seems to be using it, but it has a POE |
|
|
817 | backend, so it can be supported through POE. |
|
|
818 | |
|
|
819 | AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to |
|
|
820 | load L<POE> when detecting them, in the hope that POE will pick them up, |
|
|
821 | in which case everything will be automatic. |
|
|
822 | |
|
|
823 | =back |
|
|
824 | |
|
|
825 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
|
|
826 | |
|
|
827 | These are not normally required to use AnyEvent, but can be useful to |
|
|
828 | write AnyEvent extension modules. |
|
|
829 | |
|
|
830 | =over 4 |
|
|
831 | |
190 | =item $AnyEvent::MODEL |
832 | =item $AnyEvent::MODEL |
191 | |
833 | |
192 | Contains C<undef> until the first watcher is being created. Then it |
834 | Contains C<undef> until the first watcher is being created, before the |
|
|
835 | backend has been autodetected. |
|
|
836 | |
193 | contains the event model that is being used, which is the name of the |
837 | Afterwards it contains the event model that is being used, which is the |
194 | Perl class implementing the model. This class is usually one of the |
838 | name of the Perl class implementing the model. This class is usually one |
195 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
839 | of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the |
196 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
840 | case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it |
197 | |
841 | will be C<urxvt::anyevent>). |
198 | The known classes so far are: |
|
|
199 | |
|
|
200 | AnyEvent::Impl::Coro based on Coro::Event, best choise. |
|
|
201 | AnyEvent::Impl::Event based on Event, also best choice :) |
|
|
202 | AnyEvent::Impl::Glib based on Glib, second-best choice. |
|
|
203 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
|
|
204 | AnyEvent::Impl::Perl pure-perl implementation, inefficient. |
|
|
205 | |
842 | |
206 | =item AnyEvent::detect |
843 | =item AnyEvent::detect |
207 | |
844 | |
208 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model if |
845 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
209 | necessary. You should only call this function right before you would have |
846 | if necessary. You should only call this function right before you would |
210 | created an AnyEvent watcher anyway, that is, very late at runtime. |
847 | have created an AnyEvent watcher anyway, that is, as late as possible at |
|
|
848 | runtime, and not e.g. while initialising of your module. |
|
|
849 | |
|
|
850 | If you need to do some initialisation before AnyEvent watchers are |
|
|
851 | created, use C<post_detect>. |
|
|
852 | |
|
|
853 | =item $guard = AnyEvent::post_detect { BLOCK } |
|
|
854 | |
|
|
855 | Arranges for the code block to be executed as soon as the event model is |
|
|
856 | autodetected (or immediately if this has already happened). |
|
|
857 | |
|
|
858 | The block will be executed I<after> the actual backend has been detected |
|
|
859 | (C<$AnyEvent::MODEL> is set), but I<before> any watchers have been |
|
|
860 | created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do |
|
|
861 | other initialisations - see the sources of L<AnyEvent::Strict> or |
|
|
862 | L<AnyEvent::AIO> to see how this is used. |
|
|
863 | |
|
|
864 | The most common usage is to create some global watchers, without forcing |
|
|
865 | event module detection too early, for example, L<AnyEvent::AIO> creates |
|
|
866 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
|
|
867 | avoid autodetecting the event module at load time. |
|
|
868 | |
|
|
869 | If called in scalar or list context, then it creates and returns an object |
|
|
870 | that automatically removes the callback again when it is destroyed. See |
|
|
871 | L<Coro::BDB> for a case where this is useful. |
|
|
872 | |
|
|
873 | =item @AnyEvent::post_detect |
|
|
874 | |
|
|
875 | If there are any code references in this array (you can C<push> to it |
|
|
876 | before or after loading AnyEvent), then they will called directly after |
|
|
877 | the event loop has been chosen. |
|
|
878 | |
|
|
879 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
|
|
880 | if it is defined then the event loop has already been detected, and the |
|
|
881 | array will be ignored. |
|
|
882 | |
|
|
883 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
|
|
884 | it,as it takes care of these details. |
|
|
885 | |
|
|
886 | This variable is mainly useful for modules that can do something useful |
|
|
887 | when AnyEvent is used and thus want to know when it is initialised, but do |
|
|
888 | not need to even load it by default. This array provides the means to hook |
|
|
889 | into AnyEvent passively, without loading it. |
211 | |
890 | |
212 | =back |
891 | =back |
213 | |
892 | |
214 | =head1 WHAT TO DO IN A MODULE |
893 | =head1 WHAT TO DO IN A MODULE |
215 | |
894 | |
216 | As a module author, you should "use AnyEvent" and call AnyEvent methods |
895 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
217 | freely, but you should not load a specific event module or rely on it. |
896 | freely, but you should not load a specific event module or rely on it. |
218 | |
897 | |
219 | Be careful when you create watchers in the module body - Anyevent will |
898 | Be careful when you create watchers in the module body - AnyEvent will |
220 | decide which event module to use as soon as the first method is called, so |
899 | decide which event module to use as soon as the first method is called, so |
221 | by calling AnyEvent in your module body you force the user of your module |
900 | by calling AnyEvent in your module body you force the user of your module |
222 | to load the event module first. |
901 | to load the event module first. |
223 | |
902 | |
|
|
903 | Never call C<< ->recv >> on a condition variable unless you I<know> that |
|
|
904 | the C<< ->send >> method has been called on it already. This is |
|
|
905 | because it will stall the whole program, and the whole point of using |
|
|
906 | events is to stay interactive. |
|
|
907 | |
|
|
908 | It is fine, however, to call C<< ->recv >> when the user of your module |
|
|
909 | requests it (i.e. if you create a http request object ad have a method |
|
|
910 | called C<results> that returns the results, it should call C<< ->recv >> |
|
|
911 | freely, as the user of your module knows what she is doing. always). |
|
|
912 | |
224 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
913 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
225 | |
914 | |
226 | There will always be a single main program - the only place that should |
915 | There will always be a single main program - the only place that should |
227 | dictate which event model to use. |
916 | dictate which event model to use. |
228 | |
917 | |
229 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
918 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
230 | do anything special and let AnyEvent decide which implementation to chose. |
919 | do anything special (it does not need to be event-based) and let AnyEvent |
|
|
920 | decide which implementation to chose if some module relies on it. |
231 | |
921 | |
232 | If the main program relies on a specific event model (for example, in Gtk2 |
922 | If the main program relies on a specific event model - for example, in |
233 | programs you have to rely on either Glib or Glib::Event), you should load |
923 | Gtk2 programs you have to rely on the Glib module - you should load the |
234 | it before loading AnyEvent or any module that uses it, generally, as early |
924 | event module before loading AnyEvent or any module that uses it: generally |
235 | as possible. The reason is that modules might create watchers when they |
925 | speaking, you should load it as early as possible. The reason is that |
236 | are loaded, and AnyEvent will decide on the event model to use as soon as |
926 | modules might create watchers when they are loaded, and AnyEvent will |
237 | it creates watchers, and it might chose the wrong one unless you load the |
927 | decide on the event model to use as soon as it creates watchers, and it |
238 | correct one yourself. |
928 | might chose the wrong one unless you load the correct one yourself. |
239 | |
929 | |
240 | You can chose to use a rather inefficient pure-perl implementation by |
930 | You can chose to use a pure-perl implementation by loading the |
241 | loading the C<AnyEvent::Impl::Perl> module, but letting AnyEvent chose is |
931 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
242 | generally better. |
932 | everywhere, but letting AnyEvent chose the model is generally better. |
|
|
933 | |
|
|
934 | =head2 MAINLOOP EMULATION |
|
|
935 | |
|
|
936 | Sometimes (often for short test scripts, or even standalone programs who |
|
|
937 | only want to use AnyEvent), you do not want to run a specific event loop. |
|
|
938 | |
|
|
939 | In that case, you can use a condition variable like this: |
|
|
940 | |
|
|
941 | AnyEvent->condvar->recv; |
|
|
942 | |
|
|
943 | This has the effect of entering the event loop and looping forever. |
|
|
944 | |
|
|
945 | Note that usually your program has some exit condition, in which case |
|
|
946 | it is better to use the "traditional" approach of storing a condition |
|
|
947 | variable somewhere, waiting for it, and sending it when the program should |
|
|
948 | exit cleanly. |
|
|
949 | |
|
|
950 | |
|
|
951 | =head1 OTHER MODULES |
|
|
952 | |
|
|
953 | The following is a non-exhaustive list of additional modules that use |
|
|
954 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
|
|
955 | modules and other event loops in the same program. Some of the modules |
|
|
956 | come with AnyEvent, most are available via CPAN. |
|
|
957 | |
|
|
958 | =over 4 |
|
|
959 | |
|
|
960 | =item L<AnyEvent::Util> |
|
|
961 | |
|
|
962 | Contains various utility functions that replace often-used but blocking |
|
|
963 | functions such as C<inet_aton> by event-/callback-based versions. |
|
|
964 | |
|
|
965 | =item L<AnyEvent::Socket> |
|
|
966 | |
|
|
967 | Provides various utility functions for (internet protocol) sockets, |
|
|
968 | addresses and name resolution. Also functions to create non-blocking tcp |
|
|
969 | connections or tcp servers, with IPv6 and SRV record support and more. |
|
|
970 | |
|
|
971 | =item L<AnyEvent::Handle> |
|
|
972 | |
|
|
973 | Provide read and write buffers, manages watchers for reads and writes, |
|
|
974 | supports raw and formatted I/O, I/O queued and fully transparent and |
|
|
975 | non-blocking SSL/TLS (via L<AnyEvent::TLS>. |
|
|
976 | |
|
|
977 | =item L<AnyEvent::DNS> |
|
|
978 | |
|
|
979 | Provides rich asynchronous DNS resolver capabilities. |
|
|
980 | |
|
|
981 | =item L<AnyEvent::HTTP> |
|
|
982 | |
|
|
983 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
|
|
984 | HTTP requests. |
|
|
985 | |
|
|
986 | =item L<AnyEvent::HTTPD> |
|
|
987 | |
|
|
988 | Provides a simple web application server framework. |
|
|
989 | |
|
|
990 | =item L<AnyEvent::FastPing> |
|
|
991 | |
|
|
992 | The fastest ping in the west. |
|
|
993 | |
|
|
994 | =item L<AnyEvent::DBI> |
|
|
995 | |
|
|
996 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
997 | |
|
|
998 | =item L<AnyEvent::AIO> |
|
|
999 | |
|
|
1000 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
1001 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
1002 | together. |
|
|
1003 | |
|
|
1004 | =item L<AnyEvent::BDB> |
|
|
1005 | |
|
|
1006 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
1007 | L<BDB> and AnyEvent together. |
|
|
1008 | |
|
|
1009 | =item L<AnyEvent::GPSD> |
|
|
1010 | |
|
|
1011 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
1012 | |
|
|
1013 | =item L<AnyEvent::IRC> |
|
|
1014 | |
|
|
1015 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
1016 | |
|
|
1017 | =item L<AnyEvent::XMPP> |
|
|
1018 | |
|
|
1019 | AnyEvent based XMPP (Jabber protocol) module family (replacing the older |
|
|
1020 | Net::XMPP2>. |
|
|
1021 | |
|
|
1022 | =item L<AnyEvent::IGS> |
|
|
1023 | |
|
|
1024 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
1025 | L<App::IGS>). |
|
|
1026 | |
|
|
1027 | =item L<Net::FCP> |
|
|
1028 | |
|
|
1029 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
|
|
1030 | of AnyEvent. |
|
|
1031 | |
|
|
1032 | =item L<Event::ExecFlow> |
|
|
1033 | |
|
|
1034 | High level API for event-based execution flow control. |
|
|
1035 | |
|
|
1036 | =item L<Coro> |
|
|
1037 | |
|
|
1038 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
|
|
1039 | |
|
|
1040 | =back |
243 | |
1041 | |
244 | =cut |
1042 | =cut |
245 | |
1043 | |
246 | package AnyEvent; |
1044 | package AnyEvent; |
247 | |
1045 | |
|
|
1046 | # basically a tuned-down version of common::sense |
|
|
1047 | sub common_sense { |
248 | no warnings; |
1048 | # no warnings |
249 | use strict; |
1049 | ${^WARNING_BITS} ^= ${^WARNING_BITS}; |
|
|
1050 | # use strict vars subs |
|
|
1051 | $^H |= 0x00000600; |
|
|
1052 | } |
250 | |
1053 | |
|
|
1054 | BEGIN { AnyEvent::common_sense } |
|
|
1055 | |
251 | use Carp; |
1056 | use Carp (); |
252 | |
1057 | |
253 | our $VERSION = '2.54'; |
1058 | our $VERSION = 4.85; |
254 | our $MODEL; |
1059 | our $MODEL; |
255 | |
1060 | |
256 | our $AUTOLOAD; |
1061 | our $AUTOLOAD; |
257 | our @ISA; |
1062 | our @ISA; |
258 | |
1063 | |
259 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
|
|
260 | |
|
|
261 | our @REGISTRY; |
1064 | our @REGISTRY; |
262 | |
1065 | |
|
|
1066 | our $WIN32; |
|
|
1067 | |
|
|
1068 | our $VERBOSE; |
|
|
1069 | |
|
|
1070 | BEGIN { |
|
|
1071 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
|
|
1072 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
|
|
1073 | |
|
|
1074 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
|
|
1075 | if ${^TAINT}; |
|
|
1076 | |
|
|
1077 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
|
|
1078 | |
|
|
1079 | } |
|
|
1080 | |
|
|
1081 | our $MAX_SIGNAL_LATENCY = 10; |
|
|
1082 | |
|
|
1083 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
|
|
1084 | |
|
|
1085 | { |
|
|
1086 | my $idx; |
|
|
1087 | $PROTOCOL{$_} = ++$idx |
|
|
1088 | for reverse split /\s*,\s*/, |
|
|
1089 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
|
|
1090 | } |
|
|
1091 | |
263 | my @models = ( |
1092 | my @models = ( |
264 | [Coro::Event:: => AnyEvent::Impl::Coro::], |
1093 | [EV:: => AnyEvent::Impl::EV::], |
265 | [Event:: => AnyEvent::Impl::Event::], |
1094 | [Event:: => AnyEvent::Impl::Event::], |
266 | [Glib:: => AnyEvent::Impl::Glib::], |
|
|
267 | [Tk:: => AnyEvent::Impl::Tk::], |
|
|
268 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1095 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
|
|
1096 | # everything below here will not be autoprobed |
|
|
1097 | # as the pureperl backend should work everywhere |
|
|
1098 | # and is usually faster |
|
|
1099 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
|
|
1100 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
|
|
1101 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
1102 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
|
|
1103 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
|
|
1104 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
1105 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
1106 | # IO::Async is just too broken - we would need workarounds for its |
|
|
1107 | # byzantine signal and broken child handling, among others. |
|
|
1108 | # IO::Async is rather hard to detect, as it doesn't have any |
|
|
1109 | # obvious default class. |
|
|
1110 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1111 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1112 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
269 | ); |
1113 | ); |
270 | |
1114 | |
271 | our %method = map +($_ => 1), qw(io timer condvar broadcast wait signal one_event DESTROY); |
1115 | our %method = map +($_ => 1), |
|
|
1116 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
|
|
1117 | |
|
|
1118 | our @post_detect; |
|
|
1119 | |
|
|
1120 | sub post_detect(&) { |
|
|
1121 | my ($cb) = @_; |
|
|
1122 | |
|
|
1123 | if ($MODEL) { |
|
|
1124 | $cb->(); |
|
|
1125 | |
|
|
1126 | 1 |
|
|
1127 | } else { |
|
|
1128 | push @post_detect, $cb; |
|
|
1129 | |
|
|
1130 | defined wantarray |
|
|
1131 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1132 | : () |
|
|
1133 | } |
|
|
1134 | } |
|
|
1135 | |
|
|
1136 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1137 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1138 | } |
272 | |
1139 | |
273 | sub detect() { |
1140 | sub detect() { |
274 | unless ($MODEL) { |
1141 | unless ($MODEL) { |
275 | no strict 'refs'; |
1142 | local $SIG{__DIE__}; |
|
|
1143 | |
|
|
1144 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
|
|
1145 | my $model = "AnyEvent::Impl::$1"; |
|
|
1146 | if (eval "require $model") { |
|
|
1147 | $MODEL = $model; |
|
|
1148 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
|
|
1149 | } else { |
|
|
1150 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
|
|
1151 | } |
|
|
1152 | } |
276 | |
1153 | |
277 | # check for already loaded models |
1154 | # check for already loaded models |
|
|
1155 | unless ($MODEL) { |
278 | for (@REGISTRY, @models) { |
1156 | for (@REGISTRY, @models) { |
279 | my ($package, $model) = @$_; |
1157 | my ($package, $model) = @$_; |
280 | if (${"$package\::VERSION"} > 0) { |
1158 | if (${"$package\::VERSION"} > 0) { |
281 | if (eval "require $model") { |
1159 | if (eval "require $model") { |
282 | $MODEL = $model; |
1160 | $MODEL = $model; |
283 | warn "AnyEvent: found model '$model', using it.\n" if $verbose > 1; |
1161 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
284 | last; |
1162 | last; |
|
|
1163 | } |
285 | } |
1164 | } |
286 | } |
1165 | } |
|
|
1166 | |
|
|
1167 | unless ($MODEL) { |
|
|
1168 | # try to load a model |
|
|
1169 | |
|
|
1170 | for (@REGISTRY, @models) { |
|
|
1171 | my ($package, $model) = @$_; |
|
|
1172 | if (eval "require $package" |
|
|
1173 | and ${"$package\::VERSION"} > 0 |
|
|
1174 | and eval "require $model") { |
|
|
1175 | $MODEL = $model; |
|
|
1176 | warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1177 | last; |
|
|
1178 | } |
|
|
1179 | } |
|
|
1180 | |
|
|
1181 | $MODEL |
|
|
1182 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
|
|
1183 | } |
287 | } |
1184 | } |
288 | |
1185 | |
289 | unless ($MODEL) { |
1186 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
290 | # try to load a model |
|
|
291 | |
|
|
292 | for (@REGISTRY, @models) { |
|
|
293 | my ($package, $model) = @$_; |
|
|
294 | if (eval "require $package" |
|
|
295 | and ${"$package\::VERSION"} > 0 |
|
|
296 | and eval "require $model") { |
|
|
297 | $MODEL = $model; |
|
|
298 | warn "AnyEvent: autoprobed and loaded model '$model', using it.\n" if $verbose > 1; |
|
|
299 | last; |
|
|
300 | } |
|
|
301 | } |
|
|
302 | |
|
|
303 | $MODEL |
|
|
304 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: Event (or Coro+Event), Glib or Tk."; |
|
|
305 | } |
|
|
306 | |
1187 | |
307 | unshift @ISA, $MODEL; |
1188 | unshift @ISA, $MODEL; |
308 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1189 | |
|
|
1190 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
|
|
1191 | |
|
|
1192 | (shift @post_detect)->() while @post_detect; |
309 | } |
1193 | } |
310 | |
1194 | |
311 | $MODEL |
1195 | $MODEL |
312 | } |
1196 | } |
313 | |
1197 | |
314 | sub AUTOLOAD { |
1198 | sub AUTOLOAD { |
315 | (my $func = $AUTOLOAD) =~ s/.*://; |
1199 | (my $func = $AUTOLOAD) =~ s/.*://; |
316 | |
1200 | |
317 | $method{$func} |
1201 | $method{$func} |
318 | or croak "$func: not a valid method for AnyEvent objects"; |
1202 | or Carp::croak "$func: not a valid method for AnyEvent objects"; |
319 | |
1203 | |
320 | detect unless $MODEL; |
1204 | detect unless $MODEL; |
321 | |
1205 | |
322 | my $class = shift; |
1206 | my $class = shift; |
323 | $class->$func (@_); |
1207 | $class->$func (@_); |
324 | } |
1208 | } |
325 | |
1209 | |
|
|
1210 | # utility function to dup a filehandle. this is used by many backends |
|
|
1211 | # to support binding more than one watcher per filehandle (they usually |
|
|
1212 | # allow only one watcher per fd, so we dup it to get a different one). |
|
|
1213 | sub _dupfh($$;$$) { |
|
|
1214 | my ($poll, $fh, $r, $w) = @_; |
|
|
1215 | |
|
|
1216 | # cygwin requires the fh mode to be matching, unix doesn't |
|
|
1217 | my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&"); |
|
|
1218 | |
|
|
1219 | open my $fh2, $mode, $fh |
|
|
1220 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
|
|
1221 | |
|
|
1222 | # we assume CLOEXEC is already set by perl in all important cases |
|
|
1223 | |
|
|
1224 | ($fh2, $rw) |
|
|
1225 | } |
|
|
1226 | |
326 | package AnyEvent::Base; |
1227 | package AnyEvent::Base; |
327 | |
1228 | |
|
|
1229 | # default implementations for many methods |
|
|
1230 | |
|
|
1231 | sub _time { |
|
|
1232 | # probe for availability of Time::HiRes |
|
|
1233 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
|
|
1234 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
|
|
1235 | *_time = \&Time::HiRes::time; |
|
|
1236 | # if (eval "use POSIX (); (POSIX::times())... |
|
|
1237 | } else { |
|
|
1238 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
|
|
1239 | *_time = sub { time }; # epic fail |
|
|
1240 | } |
|
|
1241 | |
|
|
1242 | &_time |
|
|
1243 | } |
|
|
1244 | |
|
|
1245 | sub time { _time } |
|
|
1246 | sub now { _time } |
|
|
1247 | sub now_update { } |
|
|
1248 | |
328 | # default implementation for ->condvar, ->wait, ->broadcast |
1249 | # default implementation for ->condvar |
329 | |
1250 | |
330 | sub condvar { |
1251 | sub condvar { |
331 | bless \my $flag, "AnyEvent::Base::CondVar" |
1252 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
332 | } |
|
|
333 | |
|
|
334 | sub AnyEvent::Base::CondVar::broadcast { |
|
|
335 | ${$_[0]}++; |
|
|
336 | } |
|
|
337 | |
|
|
338 | sub AnyEvent::Base::CondVar::wait { |
|
|
339 | AnyEvent->one_event while !${$_[0]}; |
|
|
340 | } |
1253 | } |
341 | |
1254 | |
342 | # default implementation for ->signal |
1255 | # default implementation for ->signal |
343 | |
1256 | |
344 | our %SIG_CB; |
1257 | our $HAVE_ASYNC_INTERRUPT; |
|
|
1258 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
|
|
1259 | our (%SIG_ASY, %SIG_ASY_W); |
|
|
1260 | our ($SIG_COUNT, $SIG_TW); |
345 | |
1261 | |
|
|
1262 | sub _signal_exec { |
|
|
1263 | $HAVE_ASYNC_INTERRUPT |
|
|
1264 | ? $SIGPIPE_R->drain |
|
|
1265 | : sysread $SIGPIPE_R, my $dummy, 9; |
|
|
1266 | |
|
|
1267 | while (%SIG_EV) { |
|
|
1268 | for (keys %SIG_EV) { |
|
|
1269 | delete $SIG_EV{$_}; |
|
|
1270 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1271 | } |
|
|
1272 | } |
|
|
1273 | } |
|
|
1274 | |
346 | sub signal { |
1275 | sub _signal { |
347 | my (undef, %arg) = @_; |
1276 | my (undef, %arg) = @_; |
348 | |
1277 | |
349 | my $signal = uc $arg{signal} |
1278 | my $signal = uc $arg{signal} |
350 | or Carp::croak "required option 'signal' is missing"; |
1279 | or Carp::croak "required option 'signal' is missing"; |
351 | |
1280 | |
352 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1281 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1282 | |
|
|
1283 | if ($HAVE_ASYNC_INTERRUPT) { |
|
|
1284 | # async::interrupt |
|
|
1285 | |
|
|
1286 | $SIG_ASY{$signal} ||= do { |
|
|
1287 | my $asy = new Async::Interrupt |
|
|
1288 | cb => sub { undef $SIG_EV{$signal} }, |
|
|
1289 | signal => $signal, |
|
|
1290 | pipe => [$SIGPIPE_R->filenos], |
|
|
1291 | ; |
|
|
1292 | $asy->pipe_autodrain (0); |
|
|
1293 | |
|
|
1294 | $asy |
|
|
1295 | }; |
|
|
1296 | |
|
|
1297 | } else { |
|
|
1298 | # pure perl |
|
|
1299 | |
353 | $SIG{$signal} ||= sub { |
1300 | $SIG{$signal} ||= sub { |
354 | $_->() for values %{ $SIG_CB{$signal} || {} }; |
1301 | local $!; |
|
|
1302 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1303 | undef $SIG_EV{$signal}; |
|
|
1304 | }; |
|
|
1305 | |
|
|
1306 | # can't do signal processing without introducing races in pure perl, |
|
|
1307 | # so limit the signal latency. |
|
|
1308 | ++$SIG_COUNT; |
|
|
1309 | $SIG_TW ||= AnyEvent->timer ( |
|
|
1310 | after => $MAX_SIGNAL_LATENCY, |
|
|
1311 | interval => $MAX_SIGNAL_LATENCY, |
|
|
1312 | cb => sub { }, # just for the PERL_ASYNC_CHECK |
|
|
1313 | ); |
355 | }; |
1314 | } |
356 | |
1315 | |
357 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1316 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
358 | } |
1317 | } |
359 | |
1318 | |
|
|
1319 | sub signal { |
|
|
1320 | # probe for availability of Async::Interrupt |
|
|
1321 | if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { |
|
|
1322 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
|
|
1323 | |
|
|
1324 | $HAVE_ASYNC_INTERRUPT = 1; |
|
|
1325 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1326 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
|
|
1327 | |
|
|
1328 | } else { |
|
|
1329 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1330 | |
|
|
1331 | require Fcntl; |
|
|
1332 | |
|
|
1333 | if (AnyEvent::WIN32) { |
|
|
1334 | require AnyEvent::Util; |
|
|
1335 | |
|
|
1336 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1337 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1338 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1339 | } else { |
|
|
1340 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1341 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1342 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1343 | |
|
|
1344 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1345 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1346 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1347 | } |
|
|
1348 | |
|
|
1349 | $SIGPIPE_R |
|
|
1350 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1351 | |
|
|
1352 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1353 | } |
|
|
1354 | |
|
|
1355 | *signal = \&_signal; |
|
|
1356 | &signal |
|
|
1357 | } |
|
|
1358 | |
360 | sub AnyEvent::Base::Signal::DESTROY { |
1359 | sub AnyEvent::Base::signal::DESTROY { |
361 | my ($signal, $cb) = @{$_[0]}; |
1360 | my ($signal, $cb) = @{$_[0]}; |
362 | |
1361 | |
|
|
1362 | undef $SIG_TW |
|
|
1363 | unless --$SIG_COUNT; |
|
|
1364 | |
363 | delete $SIG_CB{$signal}{$cb}; |
1365 | delete $SIG_CB{$signal}{$cb}; |
364 | |
1366 | |
365 | $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; |
1367 | $HAVE_ASYNC_INTERRUPT |
|
|
1368 | ? delete $SIG_ASY{$signal} |
|
|
1369 | : # delete doesn't work with older perls - they then |
|
|
1370 | # print weird messages, or just unconditionally exit |
|
|
1371 | # instead of getting the default action. |
|
|
1372 | undef $SIG{$signal} |
|
|
1373 | unless keys %{ $SIG_CB{$signal} }; |
366 | } |
1374 | } |
367 | |
1375 | |
368 | # default implementation for ->child |
1376 | # default implementation for ->child |
369 | |
1377 | |
370 | our %PID_CB; |
1378 | our %PID_CB; |
371 | our $CHLD_W; |
1379 | our $CHLD_W; |
372 | our $PID_IDLE; |
1380 | our $CHLD_DELAY_W; |
373 | our $WNOHANG; |
1381 | our $WNOHANG; |
374 | |
1382 | |
375 | sub _child_wait { |
1383 | sub _sigchld { |
376 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1384 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
|
|
1385 | $_->($pid, $?) |
377 | $_->() for values %{ (delete $PID_CB{$pid}) || {} }; |
1386 | for values %{ $PID_CB{$pid} || {} }, |
|
|
1387 | values %{ $PID_CB{0} || {} }; |
378 | } |
1388 | } |
379 | |
|
|
380 | undef $PID_IDLE; |
|
|
381 | } |
1389 | } |
382 | |
1390 | |
383 | sub child { |
1391 | sub child { |
384 | my (undef, %arg) = @_; |
1392 | my (undef, %arg) = @_; |
385 | |
1393 | |
386 | my $pid = uc $arg{pid} |
1394 | defined (my $pid = $arg{pid} + 0) |
387 | or Carp::croak "required option 'pid' is missing"; |
1395 | or Carp::croak "required option 'pid' is missing"; |
388 | |
1396 | |
389 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1397 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
390 | |
1398 | |
391 | unless ($WNOHANG) { |
1399 | # WNOHANG is almost cetrainly 1 everywhere |
392 | $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; |
1400 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
|
|
1401 | ? 1 |
|
|
1402 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
|
|
1403 | |
|
|
1404 | unless ($CHLD_W) { |
|
|
1405 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
|
|
1406 | # child could be a zombie already, so make at least one round |
|
|
1407 | &_sigchld; |
393 | } |
1408 | } |
394 | |
1409 | |
395 | unless ($CHLD_W) { |
|
|
396 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_child_wait); |
|
|
397 | # child could be a zombie already |
|
|
398 | $PID_IDLE ||= AnyEvent->timer (after => 0, cb => \&_child_wait); |
|
|
399 | } |
|
|
400 | |
|
|
401 | bless [$pid, $arg{cb}], "AnyEvent::Base::Child" |
1410 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
402 | } |
1411 | } |
403 | |
1412 | |
404 | sub AnyEvent::Base::Child::DESTROY { |
1413 | sub AnyEvent::Base::child::DESTROY { |
405 | my ($pid, $cb) = @{$_[0]}; |
1414 | my ($pid, $cb) = @{$_[0]}; |
406 | |
1415 | |
407 | delete $PID_CB{$pid}{$cb}; |
1416 | delete $PID_CB{$pid}{$cb}; |
408 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1417 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
409 | |
1418 | |
410 | undef $CHLD_W unless keys %PID_CB; |
1419 | undef $CHLD_W unless keys %PID_CB; |
411 | } |
1420 | } |
412 | |
1421 | |
|
|
1422 | # idle emulation is done by simply using a timer, regardless |
|
|
1423 | # of whether the process is idle or not, and not letting |
|
|
1424 | # the callback use more than 50% of the time. |
|
|
1425 | sub idle { |
|
|
1426 | my (undef, %arg) = @_; |
|
|
1427 | |
|
|
1428 | my ($cb, $w, $rcb) = $arg{cb}; |
|
|
1429 | |
|
|
1430 | $rcb = sub { |
|
|
1431 | if ($cb) { |
|
|
1432 | $w = _time; |
|
|
1433 | &$cb; |
|
|
1434 | $w = _time - $w; |
|
|
1435 | |
|
|
1436 | # never use more then 50% of the time for the idle watcher, |
|
|
1437 | # within some limits |
|
|
1438 | $w = 0.0001 if $w < 0.0001; |
|
|
1439 | $w = 5 if $w > 5; |
|
|
1440 | |
|
|
1441 | $w = AnyEvent->timer (after => $w, cb => $rcb); |
|
|
1442 | } else { |
|
|
1443 | # clean up... |
|
|
1444 | undef $w; |
|
|
1445 | undef $rcb; |
|
|
1446 | } |
|
|
1447 | }; |
|
|
1448 | |
|
|
1449 | $w = AnyEvent->timer (after => 0.05, cb => $rcb); |
|
|
1450 | |
|
|
1451 | bless \\$cb, "AnyEvent::Base::idle" |
|
|
1452 | } |
|
|
1453 | |
|
|
1454 | sub AnyEvent::Base::idle::DESTROY { |
|
|
1455 | undef $${$_[0]}; |
|
|
1456 | } |
|
|
1457 | |
|
|
1458 | package AnyEvent::CondVar; |
|
|
1459 | |
|
|
1460 | our @ISA = AnyEvent::CondVar::Base::; |
|
|
1461 | |
|
|
1462 | package AnyEvent::CondVar::Base; |
|
|
1463 | |
|
|
1464 | #use overload |
|
|
1465 | # '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
|
|
1466 | # fallback => 1; |
|
|
1467 | |
|
|
1468 | # save 300+ kilobytes by dirtily hardcoding overloading |
|
|
1469 | ${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching. |
|
|
1470 | *{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod." |
|
|
1471 | *{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{} |
|
|
1472 | ${'AnyEvent::CondVar::Base::()'} = 1; # fallback |
|
|
1473 | |
|
|
1474 | our $WAITING; |
|
|
1475 | |
|
|
1476 | sub _send { |
|
|
1477 | # nop |
|
|
1478 | } |
|
|
1479 | |
|
|
1480 | sub send { |
|
|
1481 | my $cv = shift; |
|
|
1482 | $cv->{_ae_sent} = [@_]; |
|
|
1483 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
|
|
1484 | $cv->_send; |
|
|
1485 | } |
|
|
1486 | |
|
|
1487 | sub croak { |
|
|
1488 | $_[0]{_ae_croak} = $_[1]; |
|
|
1489 | $_[0]->send; |
|
|
1490 | } |
|
|
1491 | |
|
|
1492 | sub ready { |
|
|
1493 | $_[0]{_ae_sent} |
|
|
1494 | } |
|
|
1495 | |
|
|
1496 | sub _wait { |
|
|
1497 | $WAITING |
|
|
1498 | and !$_[0]{_ae_sent} |
|
|
1499 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; |
|
|
1500 | |
|
|
1501 | local $WAITING = 1; |
|
|
1502 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
|
|
1503 | } |
|
|
1504 | |
|
|
1505 | sub recv { |
|
|
1506 | $_[0]->_wait; |
|
|
1507 | |
|
|
1508 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
|
|
1509 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
|
|
1510 | } |
|
|
1511 | |
|
|
1512 | sub cb { |
|
|
1513 | $_[0]{_ae_cb} = $_[1] if @_ > 1; |
|
|
1514 | $_[0]{_ae_cb} |
|
|
1515 | } |
|
|
1516 | |
|
|
1517 | sub begin { |
|
|
1518 | ++$_[0]{_ae_counter}; |
|
|
1519 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
|
|
1520 | } |
|
|
1521 | |
|
|
1522 | sub end { |
|
|
1523 | return if --$_[0]{_ae_counter}; |
|
|
1524 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
|
|
1525 | } |
|
|
1526 | |
|
|
1527 | # undocumented/compatibility with pre-3.4 |
|
|
1528 | *broadcast = \&send; |
|
|
1529 | *wait = \&_wait; |
|
|
1530 | |
|
|
1531 | =head1 ERROR AND EXCEPTION HANDLING |
|
|
1532 | |
|
|
1533 | In general, AnyEvent does not do any error handling - it relies on the |
|
|
1534 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
|
|
1535 | the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict |
|
|
1536 | checking of all AnyEvent methods, however, which is highly useful during |
|
|
1537 | development. |
|
|
1538 | |
|
|
1539 | As for exception handling (i.e. runtime errors and exceptions thrown while |
|
|
1540 | executing a callback), this is not only highly event-loop specific, but |
|
|
1541 | also not in any way wrapped by this module, as this is the job of the main |
|
|
1542 | program. |
|
|
1543 | |
|
|
1544 | The pure perl event loop simply re-throws the exception (usually |
|
|
1545 | within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<< |
|
|
1546 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
|
|
1547 | so on. |
|
|
1548 | |
|
|
1549 | =head1 ENVIRONMENT VARIABLES |
|
|
1550 | |
|
|
1551 | The following environment variables are used by this module or its |
|
|
1552 | submodules. |
|
|
1553 | |
|
|
1554 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
1555 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
1556 | enabled. |
|
|
1557 | |
|
|
1558 | =over 4 |
|
|
1559 | |
|
|
1560 | =item C<PERL_ANYEVENT_VERBOSE> |
|
|
1561 | |
|
|
1562 | By default, AnyEvent will be completely silent except in fatal |
|
|
1563 | conditions. You can set this environment variable to make AnyEvent more |
|
|
1564 | talkative. |
|
|
1565 | |
|
|
1566 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
|
|
1567 | conditions, such as not being able to load the event model specified by |
|
|
1568 | C<PERL_ANYEVENT_MODEL>. |
|
|
1569 | |
|
|
1570 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
|
|
1571 | model it chooses. |
|
|
1572 | |
|
|
1573 | When set to C<8> or higher, then AnyEvent will report extra information on |
|
|
1574 | which optional modules it loads and how it implements certain features. |
|
|
1575 | |
|
|
1576 | =item C<PERL_ANYEVENT_STRICT> |
|
|
1577 | |
|
|
1578 | AnyEvent does not do much argument checking by default, as thorough |
|
|
1579 | argument checking is very costly. Setting this variable to a true value |
|
|
1580 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
|
|
1581 | check the arguments passed to most method calls. If it finds any problems, |
|
|
1582 | it will croak. |
|
|
1583 | |
|
|
1584 | In other words, enables "strict" mode. |
|
|
1585 | |
|
|
1586 | Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> |
|
|
1587 | >>, it is definitely recommended to keep it off in production. Keeping |
|
|
1588 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
|
|
1589 | can be very useful, however. |
|
|
1590 | |
|
|
1591 | =item C<PERL_ANYEVENT_MODEL> |
|
|
1592 | |
|
|
1593 | This can be used to specify the event model to be used by AnyEvent, before |
|
|
1594 | auto detection and -probing kicks in. It must be a string consisting |
|
|
1595 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
|
|
1596 | and the resulting module name is loaded and if the load was successful, |
|
|
1597 | used as event model. If it fails to load AnyEvent will proceed with |
|
|
1598 | auto detection and -probing. |
|
|
1599 | |
|
|
1600 | This functionality might change in future versions. |
|
|
1601 | |
|
|
1602 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
|
|
1603 | could start your program like this: |
|
|
1604 | |
|
|
1605 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
1606 | |
|
|
1607 | =item C<PERL_ANYEVENT_PROTOCOLS> |
|
|
1608 | |
|
|
1609 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
|
|
1610 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
|
|
1611 | of auto probing). |
|
|
1612 | |
|
|
1613 | Must be set to a comma-separated list of protocols or address families, |
|
|
1614 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
|
|
1615 | used, and preference will be given to protocols mentioned earlier in the |
|
|
1616 | list. |
|
|
1617 | |
|
|
1618 | This variable can effectively be used for denial-of-service attacks |
|
|
1619 | against local programs (e.g. when setuid), although the impact is likely |
|
|
1620 | small, as the program has to handle conenction and other failures anyways. |
|
|
1621 | |
|
|
1622 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
|
|
1623 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
|
|
1624 | - only support IPv4, never try to resolve or contact IPv6 |
|
|
1625 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
|
|
1626 | IPv6, but prefer IPv6 over IPv4. |
|
|
1627 | |
|
|
1628 | =item C<PERL_ANYEVENT_EDNS0> |
|
|
1629 | |
|
|
1630 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
|
|
1631 | for DNS. This extension is generally useful to reduce DNS traffic, but |
|
|
1632 | some (broken) firewalls drop such DNS packets, which is why it is off by |
|
|
1633 | default. |
|
|
1634 | |
|
|
1635 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
|
|
1636 | EDNS0 in its DNS requests. |
|
|
1637 | |
|
|
1638 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1639 | |
|
|
1640 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1641 | will create in parallel. |
|
|
1642 | |
|
|
1643 | =item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS> |
|
|
1644 | |
|
|
1645 | The default value for the C<max_outstanding> parameter for the default DNS |
|
|
1646 | resolver - this is the maximum number of parallel DNS requests that are |
|
|
1647 | sent to the DNS server. |
|
|
1648 | |
|
|
1649 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
|
|
1650 | |
|
|
1651 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
|
|
1652 | configuration) in the default resolver. When set to the empty string, no |
|
|
1653 | default config will be used. |
|
|
1654 | |
|
|
1655 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
|
|
1656 | |
|
|
1657 | When neither C<ca_file> nor C<ca_path> was specified during |
|
|
1658 | L<AnyEvent::TLS> context creation, and either of these environment |
|
|
1659 | variables exist, they will be used to specify CA certificate locations |
|
|
1660 | instead of a system-dependent default. |
|
|
1661 | |
|
|
1662 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
|
|
1663 | |
|
|
1664 | When these are set to C<1>, then the respective modules are not |
|
|
1665 | loaded. Mostly good for testing AnyEvent itself. |
|
|
1666 | |
|
|
1667 | =back |
|
|
1668 | |
413 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1669 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
|
|
1670 | |
|
|
1671 | This is an advanced topic that you do not normally need to use AnyEvent in |
|
|
1672 | a module. This section is only of use to event loop authors who want to |
|
|
1673 | provide AnyEvent compatibility. |
414 | |
1674 | |
415 | If you need to support another event library which isn't directly |
1675 | If you need to support another event library which isn't directly |
416 | supported by AnyEvent, you can supply your own interface to it by |
1676 | supported by AnyEvent, you can supply your own interface to it by |
417 | pushing, before the first watcher gets created, the package name of |
1677 | pushing, before the first watcher gets created, the package name of |
418 | the event module and the package name of the interface to use onto |
1678 | the event module and the package name of the interface to use onto |
419 | C<@AnyEvent::REGISTRY>. You can do that before and even without loading |
1679 | C<@AnyEvent::REGISTRY>. You can do that before and even without loading |
420 | AnyEvent. |
1680 | AnyEvent, so it is reasonably cheap. |
421 | |
1681 | |
422 | Example: |
1682 | Example: |
423 | |
1683 | |
424 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1684 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
425 | |
1685 | |
426 | This tells AnyEvent to (literally) use the C<urxvt::anyevent::> |
1686 | This tells AnyEvent to (literally) use the C<urxvt::anyevent::> |
427 | package/class when it finds the C<urxvt> package/module is loaded. When |
1687 | package/class when it finds the C<urxvt> package/module is already loaded. |
|
|
1688 | |
428 | AnyEvent is loaded and asked to find a suitable event model, it will |
1689 | When AnyEvent is loaded and asked to find a suitable event model, it |
429 | first check for the presence of urxvt. |
1690 | will first check for the presence of urxvt by trying to C<use> the |
|
|
1691 | C<urxvt::anyevent> module. |
430 | |
1692 | |
431 | The class should provide implementations for all watcher types (see |
1693 | The class should provide implementations for all watcher types. See |
432 | L<AnyEvent::Impl::Event> (source code), L<AnyEvent::Impl::Glib> |
1694 | L<AnyEvent::Impl::EV> (source code), L<AnyEvent::Impl::Glib> (Source code) |
433 | (Source code) and so on for actual examples, use C<perldoc -m |
1695 | and so on for actual examples. Use C<perldoc -m AnyEvent::Impl::Glib> to |
434 | AnyEvent::Impl::Glib> to see the sources). |
1696 | see the sources. |
435 | |
1697 | |
|
|
1698 | If you don't provide C<signal> and C<child> watchers than AnyEvent will |
|
|
1699 | provide suitable (hopefully) replacements. |
|
|
1700 | |
436 | The above isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt) |
1701 | The above example isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt) |
437 | uses the above line as-is. An interface isn't included in AnyEvent |
1702 | terminal emulator uses the above line as-is. An interface isn't included |
438 | because it doesn't make sense outside the embedded interpreter inside |
1703 | in AnyEvent because it doesn't make sense outside the embedded interpreter |
439 | I<rxvt-unicode>, and it is updated and maintained as part of the |
1704 | inside I<rxvt-unicode>, and it is updated and maintained as part of the |
440 | I<rxvt-unicode> distribution. |
1705 | I<rxvt-unicode> distribution. |
441 | |
1706 | |
442 | I<rxvt-unicode> also cheats a bit by not providing blocking access to |
1707 | I<rxvt-unicode> also cheats a bit by not providing blocking access to |
443 | condition variables: code blocking while waiting for a condition will |
1708 | condition variables: code blocking while waiting for a condition will |
444 | C<die>. This still works with most modules/usages, and blocking calls must |
1709 | C<die>. This still works with most modules/usages, and blocking calls must |
445 | not be in an interactive application, so it makes sense. |
1710 | not be done in an interactive application, so it makes sense. |
446 | |
1711 | |
447 | =head1 ENVIRONMENT VARIABLES |
|
|
448 | |
|
|
449 | The following environment variables are used by this module: |
|
|
450 | |
|
|
451 | C<PERL_ANYEVENT_VERBOSE> when set to C<2> or higher, reports which event |
|
|
452 | model gets used. |
|
|
453 | |
|
|
454 | =head1 EXAMPLE |
1712 | =head1 EXAMPLE PROGRAM |
455 | |
1713 | |
456 | The following program uses an io watcher to read data from stdin, a timer |
1714 | The following program uses an I/O watcher to read data from STDIN, a timer |
457 | to display a message once per second, and a condvar to exit the program |
1715 | to display a message once per second, and a condition variable to quit the |
458 | when the user enters quit: |
1716 | program when the user enters quit: |
459 | |
1717 | |
460 | use AnyEvent; |
1718 | use AnyEvent; |
461 | |
1719 | |
462 | my $cv = AnyEvent->condvar; |
1720 | my $cv = AnyEvent->condvar; |
463 | |
1721 | |
464 | my $io_watcher = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
1722 | my $io_watcher = AnyEvent->io ( |
|
|
1723 | fh => \*STDIN, |
|
|
1724 | poll => 'r', |
|
|
1725 | cb => sub { |
465 | warn "io event <$_[0]>\n"; # will always output <r> |
1726 | warn "io event <$_[0]>\n"; # will always output <r> |
466 | chomp (my $input = <STDIN>); # read a line |
1727 | chomp (my $input = <STDIN>); # read a line |
467 | warn "read: $input\n"; # output what has been read |
1728 | warn "read: $input\n"; # output what has been read |
468 | $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i |
1729 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
|
|
1730 | }, |
469 | }); |
1731 | ); |
470 | |
1732 | |
471 | my $time_watcher; # can only be used once |
1733 | my $time_watcher; # can only be used once |
472 | |
1734 | |
473 | sub new_timer { |
1735 | sub new_timer { |
474 | $timer = AnyEvent->timer (after => 1, cb => sub { |
1736 | $timer = AnyEvent->timer (after => 1, cb => sub { |
… | |
… | |
477 | }); |
1739 | }); |
478 | } |
1740 | } |
479 | |
1741 | |
480 | new_timer; # create first timer |
1742 | new_timer; # create first timer |
481 | |
1743 | |
482 | $cv->wait; # wait until user enters /^q/i |
1744 | $cv->recv; # wait until user enters /^q/i |
483 | |
1745 | |
484 | =head1 REAL-WORLD EXAMPLE |
1746 | =head1 REAL-WORLD EXAMPLE |
485 | |
1747 | |
486 | Consider the L<Net::FCP> module. It features (among others) the following |
1748 | Consider the L<Net::FCP> module. It features (among others) the following |
487 | API calls, which are to freenet what HTTP GET requests are to http: |
1749 | API calls, which are to freenet what HTTP GET requests are to http: |
… | |
… | |
537 | syswrite $txn->{fh}, $txn->{request} |
1799 | syswrite $txn->{fh}, $txn->{request} |
538 | or die "connection or write error"; |
1800 | or die "connection or write error"; |
539 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1801 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
540 | |
1802 | |
541 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
1803 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
542 | result and signals any possible waiters that the request ahs finished: |
1804 | result and signals any possible waiters that the request has finished: |
543 | |
1805 | |
544 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1806 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
545 | |
1807 | |
546 | if (end-of-file or data complete) { |
1808 | if (end-of-file or data complete) { |
547 | $txn->{result} = $txn->{buf}; |
1809 | $txn->{result} = $txn->{buf}; |
548 | $txn->{finished}->broadcast; |
1810 | $txn->{finished}->send; |
549 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
1811 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
550 | } |
1812 | } |
551 | |
1813 | |
552 | The C<result> method, finally, just waits for the finished signal (if the |
1814 | The C<result> method, finally, just waits for the finished signal (if the |
553 | request was already finished, it doesn't wait, of course, and returns the |
1815 | request was already finished, it doesn't wait, of course, and returns the |
554 | data: |
1816 | data: |
555 | |
1817 | |
556 | $txn->{finished}->wait; |
1818 | $txn->{finished}->recv; |
557 | return $txn->{result}; |
1819 | return $txn->{result}; |
558 | |
1820 | |
559 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1821 | The actual code goes further and collects all errors (C<die>s, exceptions) |
560 | that occured during request processing. The C<result> method detects |
1822 | that occurred during request processing. The C<result> method detects |
561 | wether an exception as thrown (it is stored inside the $txn object) |
1823 | whether an exception as thrown (it is stored inside the $txn object) |
562 | and just throws the exception, which means connection errors and other |
1824 | and just throws the exception, which means connection errors and other |
563 | problems get reported tot he code that tries to use the result, not in a |
1825 | problems get reported tot he code that tries to use the result, not in a |
564 | random callback. |
1826 | random callback. |
565 | |
1827 | |
566 | All of this enables the following usage styles: |
1828 | All of this enables the following usage styles: |
567 | |
1829 | |
568 | 1. Blocking: |
1830 | 1. Blocking: |
569 | |
1831 | |
570 | my $data = $fcp->client_get ($url); |
1832 | my $data = $fcp->client_get ($url); |
571 | |
1833 | |
572 | 2. Blocking, but parallelizing: |
1834 | 2. Blocking, but running in parallel: |
573 | |
1835 | |
574 | my @datas = map $_->result, |
1836 | my @datas = map $_->result, |
575 | map $fcp->txn_client_get ($_), |
1837 | map $fcp->txn_client_get ($_), |
576 | @urls; |
1838 | @urls; |
577 | |
1839 | |
578 | Both blocking examples work without the module user having to know |
1840 | Both blocking examples work without the module user having to know |
579 | anything about events. |
1841 | anything about events. |
580 | |
1842 | |
581 | 3a. Event-based in a main program, using any support Event module: |
1843 | 3a. Event-based in a main program, using any supported event module: |
582 | |
1844 | |
583 | use Event; |
1845 | use EV; |
584 | |
1846 | |
585 | $fcp->txn_client_get ($url)->cb (sub { |
1847 | $fcp->txn_client_get ($url)->cb (sub { |
586 | my $txn = shift; |
1848 | my $txn = shift; |
587 | my $data = $txn->result; |
1849 | my $data = $txn->result; |
588 | ... |
1850 | ... |
589 | }); |
1851 | }); |
590 | |
1852 | |
591 | Event::loop; |
1853 | EV::loop; |
592 | |
1854 | |
593 | 3b. The module user could use AnyEvent, too: |
1855 | 3b. The module user could use AnyEvent, too: |
594 | |
1856 | |
595 | use AnyEvent; |
1857 | use AnyEvent; |
596 | |
1858 | |
597 | my $quit = AnyEvent->condvar; |
1859 | my $quit = AnyEvent->condvar; |
598 | |
1860 | |
599 | $fcp->txn_client_get ($url)->cb (sub { |
1861 | $fcp->txn_client_get ($url)->cb (sub { |
600 | ... |
1862 | ... |
601 | $quit->broadcast; |
1863 | $quit->send; |
602 | }); |
1864 | }); |
603 | |
1865 | |
604 | $quit->wait; |
1866 | $quit->recv; |
|
|
1867 | |
|
|
1868 | |
|
|
1869 | =head1 BENCHMARKS |
|
|
1870 | |
|
|
1871 | To give you an idea of the performance and overheads that AnyEvent adds |
|
|
1872 | over the event loops themselves and to give you an impression of the speed |
|
|
1873 | of various event loops I prepared some benchmarks. |
|
|
1874 | |
|
|
1875 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
|
|
1876 | |
|
|
1877 | Here is a benchmark of various supported event models used natively and |
|
|
1878 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
|
|
1879 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
|
|
1880 | which it is), lets them fire exactly once and destroys them again. |
|
|
1881 | |
|
|
1882 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
|
|
1883 | distribution. |
|
|
1884 | |
|
|
1885 | =head3 Explanation of the columns |
|
|
1886 | |
|
|
1887 | I<watcher> is the number of event watchers created/destroyed. Since |
|
|
1888 | different event models feature vastly different performances, each event |
|
|
1889 | loop was given a number of watchers so that overall runtime is acceptable |
|
|
1890 | and similar between tested event loop (and keep them from crashing): Glib |
|
|
1891 | would probably take thousands of years if asked to process the same number |
|
|
1892 | of watchers as EV in this benchmark. |
|
|
1893 | |
|
|
1894 | I<bytes> is the number of bytes (as measured by the resident set size, |
|
|
1895 | RSS) consumed by each watcher. This method of measuring captures both C |
|
|
1896 | and Perl-based overheads. |
|
|
1897 | |
|
|
1898 | I<create> is the time, in microseconds (millionths of seconds), that it |
|
|
1899 | takes to create a single watcher. The callback is a closure shared between |
|
|
1900 | all watchers, to avoid adding memory overhead. That means closure creation |
|
|
1901 | and memory usage is not included in the figures. |
|
|
1902 | |
|
|
1903 | I<invoke> is the time, in microseconds, used to invoke a simple |
|
|
1904 | callback. The callback simply counts down a Perl variable and after it was |
|
|
1905 | invoked "watcher" times, it would C<< ->send >> a condvar once to |
|
|
1906 | signal the end of this phase. |
|
|
1907 | |
|
|
1908 | I<destroy> is the time, in microseconds, that it takes to destroy a single |
|
|
1909 | watcher. |
|
|
1910 | |
|
|
1911 | =head3 Results |
|
|
1912 | |
|
|
1913 | name watchers bytes create invoke destroy comment |
|
|
1914 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
|
|
1915 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
|
|
1916 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
|
|
1917 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
|
|
1918 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
|
|
1919 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
|
|
1920 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
|
|
1921 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
|
|
1922 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
|
|
1923 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
|
|
1924 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
|
|
1925 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
|
|
1926 | |
|
|
1927 | =head3 Discussion |
|
|
1928 | |
|
|
1929 | The benchmark does I<not> measure scalability of the event loop very |
|
|
1930 | well. For example, a select-based event loop (such as the pure perl one) |
|
|
1931 | can never compete with an event loop that uses epoll when the number of |
|
|
1932 | file descriptors grows high. In this benchmark, all events become ready at |
|
|
1933 | the same time, so select/poll-based implementations get an unnatural speed |
|
|
1934 | boost. |
|
|
1935 | |
|
|
1936 | Also, note that the number of watchers usually has a nonlinear effect on |
|
|
1937 | overall speed, that is, creating twice as many watchers doesn't take twice |
|
|
1938 | the time - usually it takes longer. This puts event loops tested with a |
|
|
1939 | higher number of watchers at a disadvantage. |
|
|
1940 | |
|
|
1941 | To put the range of results into perspective, consider that on the |
|
|
1942 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
|
|
1943 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
|
|
1944 | cycles with POE. |
|
|
1945 | |
|
|
1946 | C<EV> is the sole leader regarding speed and memory use, which are both |
|
|
1947 | maximal/minimal, respectively. Even when going through AnyEvent, it uses |
|
|
1948 | far less memory than any other event loop and is still faster than Event |
|
|
1949 | natively. |
|
|
1950 | |
|
|
1951 | The pure perl implementation is hit in a few sweet spots (both the |
|
|
1952 | constant timeout and the use of a single fd hit optimisations in the perl |
|
|
1953 | interpreter and the backend itself). Nevertheless this shows that it |
|
|
1954 | adds very little overhead in itself. Like any select-based backend its |
|
|
1955 | performance becomes really bad with lots of file descriptors (and few of |
|
|
1956 | them active), of course, but this was not subject of this benchmark. |
|
|
1957 | |
|
|
1958 | The C<Event> module has a relatively high setup and callback invocation |
|
|
1959 | cost, but overall scores in on the third place. |
|
|
1960 | |
|
|
1961 | C<IO::Async> performs admirably well, about on par with C<Event>, even |
|
|
1962 | when using its pure perl backend. |
|
|
1963 | |
|
|
1964 | C<Glib>'s memory usage is quite a bit higher, but it features a |
|
|
1965 | faster callback invocation and overall ends up in the same class as |
|
|
1966 | C<Event>. However, Glib scales extremely badly, doubling the number of |
|
|
1967 | watchers increases the processing time by more than a factor of four, |
|
|
1968 | making it completely unusable when using larger numbers of watchers |
|
|
1969 | (note that only a single file descriptor was used in the benchmark, so |
|
|
1970 | inefficiencies of C<poll> do not account for this). |
|
|
1971 | |
|
|
1972 | The C<Tk> adaptor works relatively well. The fact that it crashes with |
|
|
1973 | more than 2000 watchers is a big setback, however, as correctness takes |
|
|
1974 | precedence over speed. Nevertheless, its performance is surprising, as the |
|
|
1975 | file descriptor is dup()ed for each watcher. This shows that the dup() |
|
|
1976 | employed by some adaptors is not a big performance issue (it does incur a |
|
|
1977 | hidden memory cost inside the kernel which is not reflected in the figures |
|
|
1978 | above). |
|
|
1979 | |
|
|
1980 | C<POE>, regardless of underlying event loop (whether using its pure perl |
|
|
1981 | select-based backend or the Event module, the POE-EV backend couldn't |
|
|
1982 | be tested because it wasn't working) shows abysmal performance and |
|
|
1983 | memory usage with AnyEvent: Watchers use almost 30 times as much memory |
|
|
1984 | as EV watchers, and 10 times as much memory as Event (the high memory |
|
|
1985 | requirements are caused by requiring a session for each watcher). Watcher |
|
|
1986 | invocation speed is almost 900 times slower than with AnyEvent's pure perl |
|
|
1987 | implementation. |
|
|
1988 | |
|
|
1989 | The design of the POE adaptor class in AnyEvent can not really account |
|
|
1990 | for the performance issues, though, as session creation overhead is |
|
|
1991 | small compared to execution of the state machine, which is coded pretty |
|
|
1992 | optimally within L<AnyEvent::Impl::POE> (and while everybody agrees that |
|
|
1993 | using multiple sessions is not a good approach, especially regarding |
|
|
1994 | memory usage, even the author of POE could not come up with a faster |
|
|
1995 | design). |
|
|
1996 | |
|
|
1997 | =head3 Summary |
|
|
1998 | |
|
|
1999 | =over 4 |
|
|
2000 | |
|
|
2001 | =item * Using EV through AnyEvent is faster than any other event loop |
|
|
2002 | (even when used without AnyEvent), but most event loops have acceptable |
|
|
2003 | performance with or without AnyEvent. |
|
|
2004 | |
|
|
2005 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
|
|
2006 | the actual event loop, only with extremely fast event loops such as EV |
|
|
2007 | adds AnyEvent significant overhead. |
|
|
2008 | |
|
|
2009 | =item * You should avoid POE like the plague if you want performance or |
|
|
2010 | reasonable memory usage. |
|
|
2011 | |
|
|
2012 | =back |
|
|
2013 | |
|
|
2014 | =head2 BENCHMARKING THE LARGE SERVER CASE |
|
|
2015 | |
|
|
2016 | This benchmark actually benchmarks the event loop itself. It works by |
|
|
2017 | creating a number of "servers": each server consists of a socket pair, a |
|
|
2018 | timeout watcher that gets reset on activity (but never fires), and an I/O |
|
|
2019 | watcher waiting for input on one side of the socket. Each time the socket |
|
|
2020 | watcher reads a byte it will write that byte to a random other "server". |
|
|
2021 | |
|
|
2022 | The effect is that there will be a lot of I/O watchers, only part of which |
|
|
2023 | are active at any one point (so there is a constant number of active |
|
|
2024 | fds for each loop iteration, but which fds these are is random). The |
|
|
2025 | timeout is reset each time something is read because that reflects how |
|
|
2026 | most timeouts work (and puts extra pressure on the event loops). |
|
|
2027 | |
|
|
2028 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
|
|
2029 | (1%) are active. This mirrors the activity of large servers with many |
|
|
2030 | connections, most of which are idle at any one point in time. |
|
|
2031 | |
|
|
2032 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
|
|
2033 | distribution. |
|
|
2034 | |
|
|
2035 | =head3 Explanation of the columns |
|
|
2036 | |
|
|
2037 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
|
|
2038 | each server has a read and write socket end). |
|
|
2039 | |
|
|
2040 | I<create> is the time it takes to create a socket pair (which is |
|
|
2041 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
|
|
2042 | |
|
|
2043 | I<request>, the most important value, is the time it takes to handle a |
|
|
2044 | single "request", that is, reading the token from the pipe and forwarding |
|
|
2045 | it to another server. This includes deleting the old timeout and creating |
|
|
2046 | a new one that moves the timeout into the future. |
|
|
2047 | |
|
|
2048 | =head3 Results |
|
|
2049 | |
|
|
2050 | name sockets create request |
|
|
2051 | EV 20000 69.01 11.16 |
|
|
2052 | Perl 20000 73.32 35.87 |
|
|
2053 | IOAsync 20000 157.00 98.14 epoll |
|
|
2054 | IOAsync 20000 159.31 616.06 poll |
|
|
2055 | Event 20000 212.62 257.32 |
|
|
2056 | Glib 20000 651.16 1896.30 |
|
|
2057 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
|
|
2058 | |
|
|
2059 | =head3 Discussion |
|
|
2060 | |
|
|
2061 | This benchmark I<does> measure scalability and overall performance of the |
|
|
2062 | particular event loop. |
|
|
2063 | |
|
|
2064 | EV is again fastest. Since it is using epoll on my system, the setup time |
|
|
2065 | is relatively high, though. |
|
|
2066 | |
|
|
2067 | Perl surprisingly comes second. It is much faster than the C-based event |
|
|
2068 | loops Event and Glib. |
|
|
2069 | |
|
|
2070 | IO::Async performs very well when using its epoll backend, and still quite |
|
|
2071 | good compared to Glib when using its pure perl backend. |
|
|
2072 | |
|
|
2073 | Event suffers from high setup time as well (look at its code and you will |
|
|
2074 | understand why). Callback invocation also has a high overhead compared to |
|
|
2075 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
|
|
2076 | uses select or poll in basically all documented configurations. |
|
|
2077 | |
|
|
2078 | Glib is hit hard by its quadratic behaviour w.r.t. many watchers. It |
|
|
2079 | clearly fails to perform with many filehandles or in busy servers. |
|
|
2080 | |
|
|
2081 | POE is still completely out of the picture, taking over 1000 times as long |
|
|
2082 | as EV, and over 100 times as long as the Perl implementation, even though |
|
|
2083 | it uses a C-based event loop in this case. |
|
|
2084 | |
|
|
2085 | =head3 Summary |
|
|
2086 | |
|
|
2087 | =over 4 |
|
|
2088 | |
|
|
2089 | =item * The pure perl implementation performs extremely well. |
|
|
2090 | |
|
|
2091 | =item * Avoid Glib or POE in large projects where performance matters. |
|
|
2092 | |
|
|
2093 | =back |
|
|
2094 | |
|
|
2095 | =head2 BENCHMARKING SMALL SERVERS |
|
|
2096 | |
|
|
2097 | While event loops should scale (and select-based ones do not...) even to |
|
|
2098 | large servers, most programs we (or I :) actually write have only a few |
|
|
2099 | I/O watchers. |
|
|
2100 | |
|
|
2101 | In this benchmark, I use the same benchmark program as in the large server |
|
|
2102 | case, but it uses only eight "servers", of which three are active at any |
|
|
2103 | one time. This should reflect performance for a small server relatively |
|
|
2104 | well. |
|
|
2105 | |
|
|
2106 | The columns are identical to the previous table. |
|
|
2107 | |
|
|
2108 | =head3 Results |
|
|
2109 | |
|
|
2110 | name sockets create request |
|
|
2111 | EV 16 20.00 6.54 |
|
|
2112 | Perl 16 25.75 12.62 |
|
|
2113 | Event 16 81.27 35.86 |
|
|
2114 | Glib 16 32.63 15.48 |
|
|
2115 | POE 16 261.87 276.28 uses POE::Loop::Event |
|
|
2116 | |
|
|
2117 | =head3 Discussion |
|
|
2118 | |
|
|
2119 | The benchmark tries to test the performance of a typical small |
|
|
2120 | server. While knowing how various event loops perform is interesting, keep |
|
|
2121 | in mind that their overhead in this case is usually not as important, due |
|
|
2122 | to the small absolute number of watchers (that is, you need efficiency and |
|
|
2123 | speed most when you have lots of watchers, not when you only have a few of |
|
|
2124 | them). |
|
|
2125 | |
|
|
2126 | EV is again fastest. |
|
|
2127 | |
|
|
2128 | Perl again comes second. It is noticeably faster than the C-based event |
|
|
2129 | loops Event and Glib, although the difference is too small to really |
|
|
2130 | matter. |
|
|
2131 | |
|
|
2132 | POE also performs much better in this case, but is is still far behind the |
|
|
2133 | others. |
|
|
2134 | |
|
|
2135 | =head3 Summary |
|
|
2136 | |
|
|
2137 | =over 4 |
|
|
2138 | |
|
|
2139 | =item * C-based event loops perform very well with small number of |
|
|
2140 | watchers, as the management overhead dominates. |
|
|
2141 | |
|
|
2142 | =back |
|
|
2143 | |
|
|
2144 | =head2 THE IO::Lambda BENCHMARK |
|
|
2145 | |
|
|
2146 | Recently I was told about the benchmark in the IO::Lambda manpage, which |
|
|
2147 | could be misinterpreted to make AnyEvent look bad. In fact, the benchmark |
|
|
2148 | simply compares IO::Lambda with POE, and IO::Lambda looks better (which |
|
|
2149 | shouldn't come as a surprise to anybody). As such, the benchmark is |
|
|
2150 | fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't |
|
|
2151 | very optimal. But how would AnyEvent compare when used without the extra |
|
|
2152 | baggage? To explore this, I wrote the equivalent benchmark for AnyEvent. |
|
|
2153 | |
|
|
2154 | The benchmark itself creates an echo-server, and then, for 500 times, |
|
|
2155 | connects to the echo server, sends a line, waits for the reply, and then |
|
|
2156 | creates the next connection. This is a rather bad benchmark, as it doesn't |
|
|
2157 | test the efficiency of the framework or much non-blocking I/O, but it is a |
|
|
2158 | benchmark nevertheless. |
|
|
2159 | |
|
|
2160 | name runtime |
|
|
2161 | Lambda/select 0.330 sec |
|
|
2162 | + optimized 0.122 sec |
|
|
2163 | Lambda/AnyEvent 0.327 sec |
|
|
2164 | + optimized 0.138 sec |
|
|
2165 | Raw sockets/select 0.077 sec |
|
|
2166 | POE/select, components 0.662 sec |
|
|
2167 | POE/select, raw sockets 0.226 sec |
|
|
2168 | POE/select, optimized 0.404 sec |
|
|
2169 | |
|
|
2170 | AnyEvent/select/nb 0.085 sec |
|
|
2171 | AnyEvent/EV/nb 0.068 sec |
|
|
2172 | +state machine 0.134 sec |
|
|
2173 | |
|
|
2174 | The benchmark is also a bit unfair (my fault): the IO::Lambda/POE |
|
|
2175 | benchmarks actually make blocking connects and use 100% blocking I/O, |
|
|
2176 | defeating the purpose of an event-based solution. All of the newly |
|
|
2177 | written AnyEvent benchmarks use 100% non-blocking connects (using |
|
|
2178 | AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS |
|
|
2179 | resolver), so AnyEvent is at a disadvantage here, as non-blocking connects |
|
|
2180 | generally require a lot more bookkeeping and event handling than blocking |
|
|
2181 | connects (which involve a single syscall only). |
|
|
2182 | |
|
|
2183 | The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which |
|
|
2184 | offers similar expressive power as POE and IO::Lambda, using conventional |
|
|
2185 | Perl syntax. This means that both the echo server and the client are 100% |
|
|
2186 | non-blocking, further placing it at a disadvantage. |
|
|
2187 | |
|
|
2188 | As you can see, the AnyEvent + EV combination even beats the |
|
|
2189 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
|
|
2190 | backend easily beats IO::Lambda and POE. |
|
|
2191 | |
|
|
2192 | And even the 100% non-blocking version written using the high-level (and |
|
|
2193 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
|
|
2194 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
|
|
2195 | in a non-blocking way. |
|
|
2196 | |
|
|
2197 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
|
|
2198 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
|
|
2199 | part of the IO::lambda distribution and were used without any changes. |
|
|
2200 | |
|
|
2201 | |
|
|
2202 | =head1 SIGNALS |
|
|
2203 | |
|
|
2204 | AnyEvent currently installs handlers for these signals: |
|
|
2205 | |
|
|
2206 | =over 4 |
|
|
2207 | |
|
|
2208 | =item SIGCHLD |
|
|
2209 | |
|
|
2210 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
|
|
2211 | emulation for event loops that do not support them natively. Also, some |
|
|
2212 | event loops install a similar handler. |
|
|
2213 | |
|
|
2214 | Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then |
|
|
2215 | AnyEvent will reset it to default, to avoid losing child exit statuses. |
|
|
2216 | |
|
|
2217 | =item SIGPIPE |
|
|
2218 | |
|
|
2219 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
|
|
2220 | when AnyEvent gets loaded. |
|
|
2221 | |
|
|
2222 | The rationale for this is that AnyEvent users usually do not really depend |
|
|
2223 | on SIGPIPE delivery (which is purely an optimisation for shell use, or |
|
|
2224 | badly-written programs), but C<SIGPIPE> can cause spurious and rare |
|
|
2225 | program exits as a lot of people do not expect C<SIGPIPE> when writing to |
|
|
2226 | some random socket. |
|
|
2227 | |
|
|
2228 | The rationale for installing a no-op handler as opposed to ignoring it is |
|
|
2229 | that this way, the handler will be restored to defaults on exec. |
|
|
2230 | |
|
|
2231 | Feel free to install your own handler, or reset it to defaults. |
|
|
2232 | |
|
|
2233 | =back |
|
|
2234 | |
|
|
2235 | =cut |
|
|
2236 | |
|
|
2237 | undef $SIG{CHLD} |
|
|
2238 | if $SIG{CHLD} eq 'IGNORE'; |
|
|
2239 | |
|
|
2240 | $SIG{PIPE} = sub { } |
|
|
2241 | unless defined $SIG{PIPE}; |
|
|
2242 | |
|
|
2243 | =head1 RECOMMENDED/OPTIONAL MODULES |
|
|
2244 | |
|
|
2245 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
|
|
2246 | it's built-in modules) are required to use it. |
|
|
2247 | |
|
|
2248 | That does not mean that AnyEvent won't take advantage of some additional |
|
|
2249 | modules if they are installed. |
|
|
2250 | |
|
|
2251 | This section epxlains which additional modules will be used, and how they |
|
|
2252 | affect AnyEvent's operetion. |
|
|
2253 | |
|
|
2254 | =over 4 |
|
|
2255 | |
|
|
2256 | =item L<Async::Interrupt> |
|
|
2257 | |
|
|
2258 | This slightly arcane module is used to implement fast signal handling: To |
|
|
2259 | my knowledge, there is no way to do completely race-free and quick |
|
|
2260 | signal handling in pure perl. To ensure that signals still get |
|
|
2261 | delivered, AnyEvent will start an interval timer to wake up perl (and |
|
|
2262 | catch the signals) with soemd elay (default is 10 seconds, look for |
|
|
2263 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
|
|
2264 | |
|
|
2265 | If this module is available, then it will be used to implement signal |
|
|
2266 | catching, which means that signals will not be delayed, and the event loop |
|
|
2267 | will not be interrupted regularly, which is more efficient (And good for |
|
|
2268 | battery life on laptops). |
|
|
2269 | |
|
|
2270 | This affects not just the pure-perl event loop, but also other event loops |
|
|
2271 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
|
|
2272 | |
|
|
2273 | =item L<EV> |
|
|
2274 | |
|
|
2275 | This module isn't really "optional", as it is simply one of the backend |
|
|
2276 | event loops that AnyEvent can use. However, it is simply the best event |
|
|
2277 | loop available in terms of features, speed and stability: It supports |
|
|
2278 | the AnyEvent API optimally, implements all the watcher types in XS, does |
|
|
2279 | automatic timer adjustments even when no monotonic clock is available, |
|
|
2280 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
|
|
2281 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
|
|
2282 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
|
|
2283 | |
|
|
2284 | =item L<Guard> |
|
|
2285 | |
|
|
2286 | The guard module, when used, will be used to implement |
|
|
2287 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
|
|
2288 | lot less memory), but otherwise doesn't affect guard operation much. It is |
|
|
2289 | purely used for performance. |
|
|
2290 | |
|
|
2291 | =item L<JSON> and L<JSON::XS> |
|
|
2292 | |
|
|
2293 | This module is required when you want to read or write JSON data via |
|
|
2294 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
|
|
2295 | advantage of the ulta-high-speed L<JSON::XS> module when it is installed. |
|
|
2296 | |
|
|
2297 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
|
|
2298 | installed. |
|
|
2299 | |
|
|
2300 | =item L<Net::SSLeay> |
|
|
2301 | |
|
|
2302 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
|
|
2303 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
|
|
2304 | the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. |
|
|
2305 | |
|
|
2306 | =item L<Time::HiRes> |
|
|
2307 | |
|
|
2308 | This module is part of perl since release 5.008. It will be used when the |
|
|
2309 | chosen event library does not come with a timing source on it's own. The |
|
|
2310 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
|
|
2311 | try to use a monotonic clock for timing stability. |
|
|
2312 | |
|
|
2313 | =back |
|
|
2314 | |
|
|
2315 | |
|
|
2316 | =head1 FORK |
|
|
2317 | |
|
|
2318 | Most event libraries are not fork-safe. The ones who are usually are |
|
|
2319 | because they rely on inefficient but fork-safe C<select> or C<poll> |
|
|
2320 | calls. Only L<EV> is fully fork-aware. |
|
|
2321 | |
|
|
2322 | If you have to fork, you must either do so I<before> creating your first |
|
|
2323 | watcher OR you must not use AnyEvent at all in the child OR you must do |
|
|
2324 | something completely out of the scope of AnyEvent. |
|
|
2325 | |
|
|
2326 | |
|
|
2327 | =head1 SECURITY CONSIDERATIONS |
|
|
2328 | |
|
|
2329 | AnyEvent can be forced to load any event model via |
|
|
2330 | $ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used to |
|
|
2331 | execute arbitrary code or directly gain access, it can easily be used to |
|
|
2332 | make the program hang or malfunction in subtle ways, as AnyEvent watchers |
|
|
2333 | will not be active when the program uses a different event model than |
|
|
2334 | specified in the variable. |
|
|
2335 | |
|
|
2336 | You can make AnyEvent completely ignore this variable by deleting it |
|
|
2337 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
|
|
2338 | |
|
|
2339 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
|
|
2340 | |
|
|
2341 | use AnyEvent; |
|
|
2342 | |
|
|
2343 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
|
|
2344 | be used to probe what backend is used and gain other information (which is |
|
|
2345 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
|
|
2346 | $ENV{PERL_ANYEVENT_STRICT}. |
|
|
2347 | |
|
|
2348 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
2349 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
2350 | enabled. |
|
|
2351 | |
|
|
2352 | |
|
|
2353 | =head1 BUGS |
|
|
2354 | |
|
|
2355 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
|
|
2356 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
|
|
2357 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
|
|
2358 | memleaks, such as leaking on C<map> and C<grep> but it is usually not as |
|
|
2359 | pronounced). |
|
|
2360 | |
605 | |
2361 | |
606 | =head1 SEE ALSO |
2362 | =head1 SEE ALSO |
607 | |
2363 | |
608 | Event modules: L<Coro::Event>, L<Coro>, L<Event>, L<Glib::Event>, L<Glib>. |
2364 | Utility functions: L<AnyEvent::Util>. |
609 | |
2365 | |
610 | Implementations: L<AnyEvent::Impl::Coro>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>. |
2366 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
|
|
2367 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
611 | |
2368 | |
612 | Nontrivial usage example: L<Net::FCP>. |
2369 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
|
|
2370 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
|
|
2371 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
|
|
2372 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
613 | |
2373 | |
614 | =head1 |
2374 | Non-blocking file handles, sockets, TCP clients and |
|
|
2375 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
|
|
2376 | |
|
|
2377 | Asynchronous DNS: L<AnyEvent::DNS>. |
|
|
2378 | |
|
|
2379 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, |
|
|
2380 | L<Coro::Event>, |
|
|
2381 | |
|
|
2382 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, |
|
|
2383 | L<AnyEvent::HTTP>. |
|
|
2384 | |
|
|
2385 | |
|
|
2386 | =head1 AUTHOR |
|
|
2387 | |
|
|
2388 | Marc Lehmann <schmorp@schmorp.de> |
|
|
2389 | http://home.schmorp.de/ |
615 | |
2390 | |
616 | =cut |
2391 | =cut |
617 | |
2392 | |
618 | 1 |
2393 | 1 |
619 | |
2394 | |