1 | =head1 => NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - provide framework for multiple event loops |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt 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 whether a condition was flagged |
34 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
20 | $w->send; # wake up current and all future recv's |
35 | $w->send; # wake up current and all future recv's |
21 | $w->recv; # enters "main loop" till $condvar gets ->send |
36 | $w->recv; # enters "main loop" till $condvar gets ->send |
|
|
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. |
22 | |
45 | |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
46 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
24 | |
47 | |
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
48 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
26 | nowadays. So what is different about AnyEvent? |
49 | nowadays. So what is different about AnyEvent? |
27 | |
50 | |
28 | Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of |
51 | Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of |
29 | policy> and AnyEvent is I<small and efficient>. |
52 | policy> and AnyEvent is I<small and efficient>. |
30 | |
53 | |
31 | First and foremost, I<AnyEvent is not an event model> itself, it only |
54 | First and foremost, I<AnyEvent is not an event model> itself, it only |
32 | interfaces to whatever event model the main program happens to use in a |
55 | interfaces to whatever event model the main program happens to use, in a |
33 | pragmatic way. For event models and certain classes of immortals alike, |
56 | pragmatic way. For event models and certain classes of immortals alike, |
34 | the statement "there can only be one" is a bitter reality: In general, |
57 | the statement "there can only be one" is a bitter reality: In general, |
35 | only one event loop can be active at the same time in a process. AnyEvent |
58 | only one event loop can be active at the same time in a process. AnyEvent |
36 | helps hiding the differences between those event loops. |
59 | cannot change this, but it can hide the differences between those event |
|
|
60 | loops. |
37 | |
61 | |
38 | The goal of AnyEvent is to offer module authors the ability to do event |
62 | The goal of AnyEvent is to offer module authors the ability to do event |
39 | programming (waiting for I/O or timer events) without subscribing to a |
63 | programming (waiting for I/O or timer events) without subscribing to a |
40 | religion, a way of living, and most importantly: without forcing your |
64 | religion, a way of living, and most importantly: without forcing your |
41 | module users into the same thing by forcing them to use the same event |
65 | module users into the same thing by forcing them to use the same event |
42 | model you use. |
66 | model you use. |
43 | |
67 | |
44 | For modules like POE or IO::Async (which is a total misnomer as it is |
68 | For modules like POE or IO::Async (which is a total misnomer as it is |
45 | actually doing all I/O I<synchronously>...), using them in your module is |
69 | actually doing all I/O I<synchronously>...), using them in your module is |
46 | like joining a cult: After you joined, you are dependent on them and you |
70 | like joining a cult: After you joined, you are dependent on them and you |
47 | cannot use anything else, as it is simply incompatible to everything that |
71 | cannot use anything else, as they are simply incompatible to everything |
48 | isn't itself. What's worse, all the potential users of your module are |
72 | that isn't them. What's worse, all the potential users of your |
49 | I<also> forced to use the same event loop you use. |
73 | module are I<also> forced to use the same event loop you use. |
50 | |
74 | |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
75 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
76 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
53 | with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if |
77 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
54 | your module uses one of those, every user of your module has to use it, |
78 | your module uses one of those, every user of your module has to use it, |
55 | too. But if your module uses AnyEvent, it works transparently with all |
79 | too. But if your module uses AnyEvent, it works transparently with all |
56 | event models it supports (including stuff like POE and IO::Async, as long |
80 | event models it supports (including stuff like IO::Async, as long as those |
57 | as those use one of the supported event loops. It is trivial to add new |
81 | use one of the supported event loops. It is trivial to add new event loops |
58 | event loops to AnyEvent, too, so it is future-proof). |
82 | to AnyEvent, too, so it is future-proof). |
59 | |
83 | |
60 | In addition to being free of having to use I<the one and only true event |
84 | In addition to being free of having to use I<the one and only true event |
61 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
85 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
62 | modules, you get an enormous amount of code and strict rules you have to |
86 | modules, you get an enormous amount of code and strict rules you have to |
63 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
87 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
64 | offering the functionality that is necessary, in as thin as a wrapper as |
88 | offering the functionality that is necessary, in as thin as a wrapper as |
65 | technically possible. |
89 | technically possible. |
66 | |
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 | |
67 | Of course, if you want lots of policy (this can arguably be somewhat |
97 | Now, if you I<do want> lots of policy (this can arguably be somewhat |
68 | useful) and you want to force your users to use the one and only event |
98 | useful) and you want to force your users to use the one and only event |
69 | model, you should I<not> use this module. |
99 | model, you should I<not> use this module. |
70 | |
100 | |
71 | =head1 DESCRIPTION |
101 | =head1 DESCRIPTION |
72 | |
102 | |
… | |
… | |
102 | starts using it, all bets are off. Maybe you should tell their authors to |
132 | starts using it, all bets are off. Maybe you should tell their authors to |
103 | use AnyEvent so their modules work together with others seamlessly... |
133 | use AnyEvent so their modules work together with others seamlessly... |
104 | |
134 | |
105 | The pure-perl implementation of AnyEvent is called |
135 | The pure-perl implementation of AnyEvent is called |
106 | 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 |
107 | explicitly. |
137 | explicitly and enjoy the high availability of that event loop :) |
108 | |
138 | |
109 | =head1 WATCHERS |
139 | =head1 WATCHERS |
110 | |
140 | |
111 | 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 |
112 | 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 |
… | |
… | |
115 | These watchers are normal Perl objects with normal Perl lifetime. After |
145 | These watchers are normal Perl objects with normal Perl lifetime. After |
116 | creating a watcher it will immediately "watch" for events and invoke the |
146 | creating a watcher it will immediately "watch" for events and invoke the |
117 | callback when the event occurs (of course, only when the event model |
147 | callback when the event occurs (of course, only when the event model |
118 | is in control). |
148 | is in control). |
119 | |
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 | |
120 | To disable the watcher you have to destroy it (e.g. by setting the |
156 | To disable the watcher you have to destroy it (e.g. by setting the |
121 | variable you store it in to C<undef> or otherwise deleting all references |
157 | variable you store it in to C<undef> or otherwise deleting all references |
122 | to it). |
158 | to it). |
123 | |
159 | |
124 | 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. |
… | |
… | |
126 | Many watchers either are used with "recursion" (repeating timers for |
162 | Many watchers either are used with "recursion" (repeating timers for |
127 | example), or need to refer to their watcher object in other ways. |
163 | example), or need to refer to their watcher object in other ways. |
128 | |
164 | |
129 | An any way to achieve that is this pattern: |
165 | An any way to achieve that is this pattern: |
130 | |
166 | |
131 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
167 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
132 | # you can use $w here, for example to undef it |
168 | # you can use $w here, for example to undef it |
133 | undef $w; |
169 | undef $w; |
134 | }); |
170 | }); |
135 | |
171 | |
136 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
172 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
137 | my variables are only visible after the statement in which they are |
173 | my variables are only visible after the statement in which they are |
138 | declared. |
174 | declared. |
139 | |
175 | |
140 | =head2 I/O WATCHERS |
176 | =head2 I/O WATCHERS |
141 | |
177 | |
142 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
178 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
143 | with the following mandatory key-value pairs as arguments: |
179 | with the following mandatory key-value pairs as arguments: |
144 | |
180 | |
145 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch |
181 | C<fh> is the Perl I<file handle> (I<not> 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 | |
146 | for events. C<poll> must be a string that is either C<r> or C<w>, |
188 | C<poll> must be a string that is either C<r> or C<w>, which creates a |
147 | which creates a watcher waiting for "r"eadable or "w"ritable events, |
189 | watcher waiting for "r"eadable or "w"ritable events, respectively. |
|
|
190 | |
148 | respectively. C<cb> is the callback to invoke each time the file handle |
191 | C<cb> is the callback to invoke each time the file handle becomes ready. |
149 | becomes ready. |
|
|
150 | |
192 | |
151 | Although the callback might get passed parameters, their value and |
193 | Although the callback might get passed parameters, their value and |
152 | presence is undefined and you cannot rely on them. Portable AnyEvent |
194 | presence is undefined and you cannot rely on them. Portable AnyEvent |
153 | callbacks cannot use arguments passed to I/O watcher callbacks. |
195 | callbacks cannot use arguments passed to I/O watcher callbacks. |
154 | |
196 | |
… | |
… | |
158 | |
200 | |
159 | Some event loops issue spurious readyness notifications, so you should |
201 | Some event loops issue spurious readyness notifications, so you should |
160 | always use non-blocking calls when reading/writing from/to your file |
202 | always use non-blocking calls when reading/writing from/to your file |
161 | handles. |
203 | handles. |
162 | |
204 | |
163 | Example: |
|
|
164 | |
|
|
165 | # 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 | |
166 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
208 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
167 | chomp (my $input = <STDIN>); |
209 | chomp (my $input = <STDIN>); |
168 | warn "read: $input\n"; |
210 | warn "read: $input\n"; |
169 | undef $w; |
211 | undef $w; |
170 | }); |
212 | }); |
… | |
… | |
180 | |
222 | |
181 | Although the callback might get passed parameters, their value and |
223 | Although the callback might get passed parameters, their value and |
182 | presence is undefined and you cannot rely on them. Portable AnyEvent |
224 | presence is undefined and you cannot rely on them. Portable AnyEvent |
183 | callbacks cannot use arguments passed to time watcher callbacks. |
225 | callbacks cannot use arguments passed to time watcher callbacks. |
184 | |
226 | |
185 | The timer callback will be invoked at most once: if you want a repeating |
227 | The callback will normally be invoked once only. If you specify another |
186 | timer you have to create a new watcher (this is a limitation by both Tk |
228 | parameter, C<interval>, as a strictly positive number (> 0), then the |
187 | and Glib). |
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. |
188 | |
232 | |
189 | Example: |
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. |
190 | |
236 | |
191 | # fire an event after 7.7 seconds |
237 | Example: fire an event after 7.7 seconds. |
|
|
238 | |
192 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
239 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
193 | warn "timeout\n"; |
240 | warn "timeout\n"; |
194 | }); |
241 | }); |
195 | |
242 | |
196 | # to cancel the timer: |
243 | # to cancel the timer: |
197 | undef $w; |
244 | undef $w; |
198 | |
245 | |
199 | Example 2: |
|
|
200 | |
|
|
201 | # fire an event after 0.5 seconds, then roughly every second |
246 | Example 2: fire an event after 0.5 seconds, then roughly every second. |
202 | my $w; |
|
|
203 | |
247 | |
204 | my $cb = sub { |
|
|
205 | # cancel the old timer while creating a new one |
|
|
206 | $w = AnyEvent->timer (after => 1, cb => $cb); |
248 | my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { |
|
|
249 | warn "timeout\n"; |
207 | }; |
250 | }; |
208 | |
|
|
209 | # start the "loop" by creating the first watcher |
|
|
210 | $w = AnyEvent->timer (after => 0.5, cb => $cb); |
|
|
211 | |
251 | |
212 | =head3 TIMING ISSUES |
252 | =head3 TIMING ISSUES |
213 | |
253 | |
214 | There are two ways to handle timers: based on real time (relative, "fire |
254 | There are two ways to handle timers: based on real time (relative, "fire |
215 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
255 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
… | |
… | |
227 | timers. |
267 | timers. |
228 | |
268 | |
229 | AnyEvent always prefers relative timers, if available, matching the |
269 | AnyEvent always prefers relative timers, if available, matching the |
230 | AnyEvent API. |
270 | AnyEvent API. |
231 | |
271 | |
|
|
272 | AnyEvent has two additional methods that return the "current time": |
|
|
273 | |
|
|
274 | =over 4 |
|
|
275 | |
|
|
276 | =item AnyEvent->time |
|
|
277 | |
|
|
278 | This returns the "current wallclock time" as a fractional number of |
|
|
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). |
|
|
281 | |
|
|
282 | It progresses independently of any event loop processing, i.e. each call |
|
|
283 | will check the system clock, which usually gets updated frequently. |
|
|
284 | |
|
|
285 | =item AnyEvent->now |
|
|
286 | |
|
|
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. |
|
|
291 | |
|
|
292 | I<In almost all cases (in all cases if you don't care), this is the |
|
|
293 | function to call when you want to know the current time.> |
|
|
294 | |
|
|
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 | |
232 | =head2 SIGNAL WATCHERS |
350 | =head2 SIGNAL WATCHERS |
233 | |
351 | |
234 | You can watch for signals using a signal watcher, C<signal> is the signal |
352 | You can watch for signals using a signal watcher, C<signal> is the signal |
235 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
353 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
236 | be invoked whenever a signal occurs. |
354 | callback to be invoked whenever a signal occurs. |
237 | |
355 | |
238 | Although the callback might get passed parameters, their value and |
356 | Although the callback might get passed parameters, their value and |
239 | presence is undefined and you cannot rely on them. Portable AnyEvent |
357 | presence is undefined and you cannot rely on them. Portable AnyEvent |
240 | callbacks cannot use arguments passed to signal watcher callbacks. |
358 | callbacks cannot use arguments passed to signal watcher callbacks. |
241 | |
359 | |
… | |
… | |
257 | =head2 CHILD PROCESS WATCHERS |
375 | =head2 CHILD PROCESS WATCHERS |
258 | |
376 | |
259 | You can also watch on a child process exit and catch its exit status. |
377 | You can also watch on a child process exit and catch its exit status. |
260 | |
378 | |
261 | The child process is specified by the C<pid> argument (if set to C<0>, it |
379 | The child process is specified by the C<pid> argument (if set to C<0>, it |
262 | watches for any child process exit). The watcher will trigger as often |
380 | watches for any child process exit). The watcher will triggered only when |
263 | as status change for the child are received. This works by installing a |
381 | the child process has finished and an exit status is available, not on |
264 | signal handler for C<SIGCHLD>. The callback will be called with the pid |
382 | any trace events (stopped/continued). |
265 | and exit status (as returned by waitpid), so unlike other watcher types, |
383 | |
266 | you I<can> rely on child watcher callback arguments. |
384 | The callback will be called with the pid and exit status (as returned by |
|
|
385 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
|
|
386 | callback arguments. |
|
|
387 | |
|
|
388 | This watcher type works by installing a signal handler for C<SIGCHLD>, |
|
|
389 | and since it cannot be shared, nothing else should use SIGCHLD or reap |
|
|
390 | random child processes (waiting for specific child processes, e.g. inside |
|
|
391 | C<system>, is just fine). |
267 | |
392 | |
268 | There is a slight catch to child watchers, however: you usually start them |
393 | There is a slight catch to child watchers, however: you usually start them |
269 | I<after> the child process was created, and this means the process could |
394 | I<after> the child process was created, and this means the process could |
270 | have exited already (and no SIGCHLD will be sent anymore). |
395 | have exited already (and no SIGCHLD will be sent anymore). |
271 | |
396 | |
272 | Not all event models handle this correctly (POE doesn't), but even for |
397 | Not all event models handle this correctly (neither POE nor IO::Async do, |
|
|
398 | see their AnyEvent::Impl manpages for details), but even for event models |
273 | event models that I<do> handle this correctly, they usually need to be |
399 | that I<do> handle this correctly, they usually need to be loaded before |
274 | loaded before the process exits (i.e. before you fork in the first place). |
400 | the process exits (i.e. before you fork in the first place). AnyEvent's |
|
|
401 | pure perl event loop handles all cases correctly regardless of when you |
|
|
402 | start the watcher. |
275 | |
403 | |
276 | This means you cannot create a child watcher as the very first thing in an |
404 | This means you cannot create a child watcher as the very first |
277 | AnyEvent program, you I<have> to create at least one watcher before you |
405 | thing in an AnyEvent program, you I<have> to create at least one |
278 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
406 | watcher before you C<fork> the child (alternatively, you can call |
|
|
407 | C<AnyEvent::detect>). |
279 | |
408 | |
280 | Example: fork a process and wait for it |
409 | Example: fork a process and wait for it |
281 | |
410 | |
282 | my $done = AnyEvent->condvar; |
411 | my $done = AnyEvent->condvar; |
283 | |
412 | |
284 | my $pid = fork or exit 5; |
413 | my $pid = fork or exit 5; |
285 | |
414 | |
286 | my $w = AnyEvent->child ( |
415 | my $w = AnyEvent->child ( |
287 | pid => $pid, |
416 | pid => $pid, |
288 | cb => sub { |
417 | cb => sub { |
289 | my ($pid, $status) = @_; |
418 | my ($pid, $status) = @_; |
290 | warn "pid $pid exited with status $status"; |
419 | warn "pid $pid exited with status $status"; |
291 | $done->send; |
420 | $done->send; |
292 | }, |
421 | }, |
293 | ); |
422 | ); |
294 | |
423 | |
295 | # do something else, then wait for process exit |
424 | # do something else, then wait for process exit |
296 | $done->recv; |
425 | $done->recv; |
|
|
426 | |
|
|
427 | =head2 IDLE WATCHERS |
|
|
428 | |
|
|
429 | Sometimes there is a need to do something, but it is not so important |
|
|
430 | to do it instantly, but only when there is nothing better to do. This |
|
|
431 | "nothing better to do" is usually defined to be "no other events need |
|
|
432 | attention by the event loop". |
|
|
433 | |
|
|
434 | Idle watchers ideally get invoked when the event loop has nothing |
|
|
435 | better to do, just before it would block the process to wait for new |
|
|
436 | events. Instead of blocking, the idle watcher is invoked. |
|
|
437 | |
|
|
438 | Most event loops unfortunately do not really support idle watchers (only |
|
|
439 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
|
|
440 | will simply call the callback "from time to time". |
|
|
441 | |
|
|
442 | Example: read lines from STDIN, but only process them when the |
|
|
443 | program is otherwise idle: |
|
|
444 | |
|
|
445 | my @lines; # read data |
|
|
446 | my $idle_w; |
|
|
447 | my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
|
|
448 | push @lines, scalar <STDIN>; |
|
|
449 | |
|
|
450 | # start an idle watcher, if not already done |
|
|
451 | $idle_w ||= AnyEvent->idle (cb => sub { |
|
|
452 | # handle only one line, when there are lines left |
|
|
453 | if (my $line = shift @lines) { |
|
|
454 | print "handled when idle: $line"; |
|
|
455 | } else { |
|
|
456 | # otherwise disable the idle watcher again |
|
|
457 | undef $idle_w; |
|
|
458 | } |
|
|
459 | }); |
|
|
460 | }); |
297 | |
461 | |
298 | =head2 CONDITION VARIABLES |
462 | =head2 CONDITION VARIABLES |
299 | |
463 | |
300 | If you are familiar with some event loops you will know that all of them |
464 | If you are familiar with some event loops you will know that all of them |
301 | require you to run some blocking "loop", "run" or similar function that |
465 | require you to run some blocking "loop", "run" or similar function that |
… | |
… | |
307 | The instrument to do that is called a "condition variable", so called |
471 | The instrument to do that is called a "condition variable", so called |
308 | because they represent a condition that must become true. |
472 | because they represent a condition that must become true. |
309 | |
473 | |
310 | Condition variables can be created by calling the C<< AnyEvent->condvar |
474 | Condition variables can be created by calling the C<< AnyEvent->condvar |
311 | >> method, usually without arguments. The only argument pair allowed is |
475 | >> method, usually without arguments. The only argument pair allowed is |
|
|
476 | |
312 | C<cb>, which specifies a callback to be called when the condition variable |
477 | C<cb>, which specifies a callback to be called when the condition variable |
313 | becomes true. |
478 | becomes true, with the condition variable as the first argument (but not |
|
|
479 | the results). |
314 | |
480 | |
315 | After creation, the condition variable is "false" until it becomes "true" |
481 | After creation, the condition variable is "false" until it becomes "true" |
316 | by calling the C<send> method (or calling the condition variable as if it |
482 | by calling the C<send> method (or calling the condition variable as if it |
317 | were a callback, read about the caveats in the description for the C<< |
483 | were a callback, read about the caveats in the description for the C<< |
318 | ->send >> method). |
484 | ->send >> method). |
… | |
… | |
374 | |
540 | |
375 | my $done = AnyEvent->condvar; |
541 | my $done = AnyEvent->condvar; |
376 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
542 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
377 | $done->recv; |
543 | $done->recv; |
378 | |
544 | |
|
|
545 | Example: Imagine an API that returns a condvar and doesn't support |
|
|
546 | callbacks. This is how you make a synchronous call, for example from |
|
|
547 | the main program: |
|
|
548 | |
|
|
549 | use AnyEvent::CouchDB; |
|
|
550 | |
|
|
551 | ... |
|
|
552 | |
|
|
553 | my @info = $couchdb->info->recv; |
|
|
554 | |
|
|
555 | And this is how you would just ste a callback to be called whenever the |
|
|
556 | results are available: |
|
|
557 | |
|
|
558 | $couchdb->info->cb (sub { |
|
|
559 | my @info = $_[0]->recv; |
|
|
560 | }); |
|
|
561 | |
379 | =head3 METHODS FOR PRODUCERS |
562 | =head3 METHODS FOR PRODUCERS |
380 | |
563 | |
381 | These methods should only be used by the producing side, i.e. the |
564 | These methods should only be used by the producing side, i.e. the |
382 | code/module that eventually sends the signal. Note that it is also |
565 | code/module that eventually sends the signal. Note that it is also |
383 | the producer side which creates the condvar in most cases, but it isn't |
566 | the producer side which creates the condvar in most cases, but it isn't |
… | |
… | |
416 | |
599 | |
417 | =item $cv->begin ([group callback]) |
600 | =item $cv->begin ([group callback]) |
418 | |
601 | |
419 | =item $cv->end |
602 | =item $cv->end |
420 | |
603 | |
421 | These two methods are EXPERIMENTAL and MIGHT CHANGE. |
|
|
422 | |
|
|
423 | These two methods can be used to combine many transactions/events into |
604 | These two methods can be used to combine many transactions/events into |
424 | one. For example, a function that pings many hosts in parallel might want |
605 | one. For example, a function that pings many hosts in parallel might want |
425 | to use a condition variable for the whole process. |
606 | to use a condition variable for the whole process. |
426 | |
607 | |
427 | Every call to C<< ->begin >> will increment a counter, and every call to |
608 | Every call to C<< ->begin >> will increment a counter, and every call to |
428 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
609 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
429 | >>, the (last) callback passed to C<begin> will be executed. That callback |
610 | >>, the (last) callback passed to C<begin> will be executed. That callback |
430 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
611 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
431 | callback was set, C<send> will be called without any arguments. |
612 | callback was set, C<send> will be called without any arguments. |
432 | |
613 | |
433 | Let's clarify this with the ping example: |
614 | You can think of C<< $cv->send >> giving you an OR condition (one call |
|
|
615 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
|
|
616 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
|
|
617 | |
|
|
618 | Let's start with a simple example: you have two I/O watchers (for example, |
|
|
619 | STDOUT and STDERR for a program), and you want to wait for both streams to |
|
|
620 | close before activating a condvar: |
|
|
621 | |
|
|
622 | my $cv = AnyEvent->condvar; |
|
|
623 | |
|
|
624 | $cv->begin; # first watcher |
|
|
625 | my $w1 = AnyEvent->io (fh => $fh1, cb => sub { |
|
|
626 | defined sysread $fh1, my $buf, 4096 |
|
|
627 | or $cv->end; |
|
|
628 | }); |
|
|
629 | |
|
|
630 | $cv->begin; # second watcher |
|
|
631 | my $w2 = AnyEvent->io (fh => $fh2, cb => sub { |
|
|
632 | defined sysread $fh2, my $buf, 4096 |
|
|
633 | or $cv->end; |
|
|
634 | }); |
|
|
635 | |
|
|
636 | $cv->recv; |
|
|
637 | |
|
|
638 | This works because for every event source (EOF on file handle), there is |
|
|
639 | one call to C<begin>, so the condvar waits for all calls to C<end> before |
|
|
640 | sending. |
|
|
641 | |
|
|
642 | The ping example mentioned above is slightly more complicated, as the |
|
|
643 | there are results to be passwd back, and the number of tasks that are |
|
|
644 | begung can potentially be zero: |
434 | |
645 | |
435 | my $cv = AnyEvent->condvar; |
646 | my $cv = AnyEvent->condvar; |
436 | |
647 | |
437 | my %result; |
648 | my %result; |
438 | $cv->begin (sub { $cv->send (\%result) }); |
649 | $cv->begin (sub { $cv->send (\%result) }); |
… | |
… | |
458 | loop, which serves two important purposes: first, it sets the callback |
669 | loop, which serves two important purposes: first, it sets the callback |
459 | to be called once the counter reaches C<0>, and second, it ensures that |
670 | to be called once the counter reaches C<0>, and second, it ensures that |
460 | C<send> is called even when C<no> hosts are being pinged (the loop |
671 | C<send> is called even when C<no> hosts are being pinged (the loop |
461 | doesn't execute once). |
672 | doesn't execute once). |
462 | |
673 | |
463 | This is the general pattern when you "fan out" into multiple subrequests: |
674 | This is the general pattern when you "fan out" into multiple (but |
464 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
675 | potentially none) subrequests: use an outer C<begin>/C<end> pair to set |
465 | is called at least once, and then, for each subrequest you start, call |
676 | the callback and ensure C<end> is called at least once, and then, for each |
466 | C<begin> and for each subrequest you finish, call C<end>. |
677 | subrequest you start, call C<begin> and for each subrequest you finish, |
|
|
678 | call C<end>. |
467 | |
679 | |
468 | =back |
680 | =back |
469 | |
681 | |
470 | =head3 METHODS FOR CONSUMERS |
682 | =head3 METHODS FOR CONSUMERS |
471 | |
683 | |
… | |
… | |
516 | =item $bool = $cv->ready |
728 | =item $bool = $cv->ready |
517 | |
729 | |
518 | Returns true when the condition is "true", i.e. whether C<send> or |
730 | Returns true when the condition is "true", i.e. whether C<send> or |
519 | C<croak> have been called. |
731 | C<croak> have been called. |
520 | |
732 | |
521 | =item $cb = $cv->cb ([new callback]) |
733 | =item $cb = $cv->cb ($cb->($cv)) |
522 | |
734 | |
523 | This is a mutator function that returns the callback set and optionally |
735 | This is a mutator function that returns the callback set and optionally |
524 | replaces it before doing so. |
736 | replaces it before doing so. |
525 | |
737 | |
526 | The callback will be called when the condition becomes "true", i.e. when |
738 | The callback will be called when the condition becomes "true", i.e. when |
527 | C<send> or C<croak> are called. Calling C<recv> inside the callback |
739 | C<send> or C<croak> are called, with the only argument being the condition |
528 | or at any later time is guaranteed not to block. |
740 | variable itself. Calling C<recv> inside the callback or at any later time |
|
|
741 | is guaranteed not to block. |
529 | |
742 | |
530 | =back |
743 | =back |
531 | |
744 | |
532 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
745 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
533 | |
746 | |
… | |
… | |
550 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
763 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
551 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
764 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
552 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
765 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
553 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
766 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
554 | |
767 | |
|
|
768 | # warning, support for IO::Async is only partial, as it is too broken |
|
|
769 | # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async. |
|
|
770 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs). |
|
|
771 | |
555 | There is no support for WxWidgets, as WxWidgets has no support for |
772 | There is no support for WxWidgets, as WxWidgets has no support for |
556 | watching file handles. However, you can use WxWidgets through the |
773 | watching file handles. However, you can use WxWidgets through the |
557 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
774 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
558 | second, which was considered to be too horrible to even consider for |
775 | second, which was considered to be too horrible to even consider for |
559 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
776 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
… | |
… | |
662 | =item L<AnyEvent::Util> |
879 | =item L<AnyEvent::Util> |
663 | |
880 | |
664 | Contains various utility functions that replace often-used but blocking |
881 | Contains various utility functions that replace often-used but blocking |
665 | functions such as C<inet_aton> by event-/callback-based versions. |
882 | functions such as C<inet_aton> by event-/callback-based versions. |
666 | |
883 | |
667 | =item L<AnyEvent::Handle> |
|
|
668 | |
|
|
669 | Provide read and write buffers and manages watchers for reads and writes. |
|
|
670 | |
|
|
671 | =item L<AnyEvent::Socket> |
884 | =item L<AnyEvent::Socket> |
672 | |
885 | |
673 | Provides various utility functions for (internet protocol) sockets, |
886 | Provides various utility functions for (internet protocol) sockets, |
674 | addresses and name resolution. Also functions to create non-blocking tcp |
887 | addresses and name resolution. Also functions to create non-blocking tcp |
675 | connections or tcp servers, with IPv6 and SRV record support and more. |
888 | connections or tcp servers, with IPv6 and SRV record support and more. |
676 | |
889 | |
|
|
890 | =item L<AnyEvent::Handle> |
|
|
891 | |
|
|
892 | Provide read and write buffers, manages watchers for reads and writes, |
|
|
893 | supports raw and formatted I/O, I/O queued and fully transparent and |
|
|
894 | non-blocking SSL/TLS. |
|
|
895 | |
677 | =item L<AnyEvent::DNS> |
896 | =item L<AnyEvent::DNS> |
678 | |
897 | |
679 | Provides rich asynchronous DNS resolver capabilities. |
898 | Provides rich asynchronous DNS resolver capabilities. |
680 | |
899 | |
|
|
900 | =item L<AnyEvent::HTTP> |
|
|
901 | |
|
|
902 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
|
|
903 | HTTP requests. |
|
|
904 | |
681 | =item L<AnyEvent::HTTPD> |
905 | =item L<AnyEvent::HTTPD> |
682 | |
906 | |
683 | Provides a simple web application server framework. |
907 | Provides a simple web application server framework. |
684 | |
908 | |
685 | =item L<AnyEvent::FastPing> |
909 | =item L<AnyEvent::FastPing> |
686 | |
910 | |
687 | The fastest ping in the west. |
911 | The fastest ping in the west. |
688 | |
912 | |
|
|
913 | =item L<AnyEvent::DBI> |
|
|
914 | |
|
|
915 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
916 | |
|
|
917 | =item L<AnyEvent::AIO> |
|
|
918 | |
|
|
919 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
920 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
921 | together. |
|
|
922 | |
|
|
923 | =item L<AnyEvent::BDB> |
|
|
924 | |
|
|
925 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
926 | L<BDB> and AnyEvent together. |
|
|
927 | |
|
|
928 | =item L<AnyEvent::GPSD> |
|
|
929 | |
|
|
930 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
931 | |
|
|
932 | =item L<AnyEvent::IGS> |
|
|
933 | |
|
|
934 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
935 | L<App::IGS>). |
|
|
936 | |
689 | =item L<Net::IRC3> |
937 | =item L<AnyEvent::IRC> |
690 | |
938 | |
691 | AnyEvent based IRC client module family. |
939 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
692 | |
940 | |
693 | =item L<Net::XMPP2> |
941 | =item L<Net::XMPP2> |
694 | |
942 | |
695 | AnyEvent based XMPP (Jabber protocol) module family. |
943 | AnyEvent based XMPP (Jabber protocol) module family. |
696 | |
944 | |
… | |
… | |
705 | |
953 | |
706 | =item L<Coro> |
954 | =item L<Coro> |
707 | |
955 | |
708 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
956 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
709 | |
957 | |
710 | =item L<AnyEvent::AIO>, L<IO::AIO> |
|
|
711 | |
|
|
712 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
713 | programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent |
|
|
714 | together. |
|
|
715 | |
|
|
716 | =item L<AnyEvent::BDB>, L<BDB> |
|
|
717 | |
|
|
718 | Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses |
|
|
719 | IO::AIO and AnyEvent together. |
|
|
720 | |
|
|
721 | =item L<IO::Lambda> |
958 | =item L<IO::Lambda> |
722 | |
959 | |
723 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
960 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
724 | |
961 | |
725 | =back |
962 | =back |
… | |
… | |
727 | =cut |
964 | =cut |
728 | |
965 | |
729 | package AnyEvent; |
966 | package AnyEvent; |
730 | |
967 | |
731 | no warnings; |
968 | no warnings; |
732 | use strict; |
969 | use strict qw(vars subs); |
733 | |
970 | |
734 | use Carp; |
971 | use Carp; |
735 | |
972 | |
736 | our $VERSION = '4.03'; |
973 | our $VERSION = 4.8; |
737 | our $MODEL; |
974 | our $MODEL; |
738 | |
975 | |
739 | our $AUTOLOAD; |
976 | our $AUTOLOAD; |
740 | our @ISA; |
977 | our @ISA; |
741 | |
978 | |
742 | our @REGISTRY; |
979 | our @REGISTRY; |
743 | |
980 | |
744 | our $WIN32; |
981 | our $WIN32; |
745 | |
982 | |
746 | BEGIN { |
983 | BEGIN { |
747 | my $win32 = ! ! ($^O =~ /mswin32/i); |
984 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
748 | eval "sub WIN32(){ $win32 }"; |
985 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
|
|
986 | |
|
|
987 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
|
|
988 | if ${^TAINT}; |
749 | } |
989 | } |
750 | |
990 | |
751 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
991 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
752 | |
992 | |
753 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
993 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
… | |
… | |
755 | { |
995 | { |
756 | my $idx; |
996 | my $idx; |
757 | $PROTOCOL{$_} = ++$idx |
997 | $PROTOCOL{$_} = ++$idx |
758 | for reverse split /\s*,\s*/, |
998 | for reverse split /\s*,\s*/, |
759 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
999 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
760 | } |
|
|
761 | |
|
|
762 | sub import { |
|
|
763 | shift; |
|
|
764 | return unless @_; |
|
|
765 | |
|
|
766 | my $pkg = caller; |
|
|
767 | |
|
|
768 | no strict 'refs'; |
|
|
769 | |
|
|
770 | for (@_) { |
|
|
771 | *{"$pkg\::WIN32"} = *WIN32 if $_ eq "WIN32"; |
|
|
772 | } |
|
|
773 | } |
1000 | } |
774 | |
1001 | |
775 | my @models = ( |
1002 | my @models = ( |
776 | [EV:: => AnyEvent::Impl::EV::], |
1003 | [EV:: => AnyEvent::Impl::EV::], |
777 | [Event:: => AnyEvent::Impl::Event::], |
1004 | [Event:: => AnyEvent::Impl::Event::], |
… | |
… | |
784 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1011 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
785 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1012 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
786 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1013 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
787 | [Wx:: => AnyEvent::Impl::POE::], |
1014 | [Wx:: => AnyEvent::Impl::POE::], |
788 | [Prima:: => AnyEvent::Impl::POE::], |
1015 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
1016 | # IO::Async is just too broken - we would need workaorunds for its |
|
|
1017 | # byzantine signal and broken child handling, among others. |
|
|
1018 | # IO::Async is rather hard to detect, as it doesn't have any |
|
|
1019 | # obvious default class. |
|
|
1020 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1021 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1022 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
789 | ); |
1023 | ); |
790 | |
1024 | |
791 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
1025 | our %method = map +($_ => 1), |
|
|
1026 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
792 | |
1027 | |
793 | our @post_detect; |
1028 | our @post_detect; |
794 | |
1029 | |
795 | sub post_detect(&) { |
1030 | sub post_detect(&) { |
796 | my ($cb) = @_; |
1031 | my ($cb) = @_; |
… | |
… | |
801 | 1 |
1036 | 1 |
802 | } else { |
1037 | } else { |
803 | push @post_detect, $cb; |
1038 | push @post_detect, $cb; |
804 | |
1039 | |
805 | defined wantarray |
1040 | defined wantarray |
806 | ? bless \$cb, "AnyEvent::Util::PostDetect" |
1041 | ? bless \$cb, "AnyEvent::Util::postdetect" |
807 | : () |
1042 | : () |
808 | } |
1043 | } |
809 | } |
1044 | } |
810 | |
1045 | |
811 | sub AnyEvent::Util::PostDetect::DESTROY { |
1046 | sub AnyEvent::Util::postdetect::DESTROY { |
812 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1047 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
813 | } |
1048 | } |
814 | |
1049 | |
815 | sub detect() { |
1050 | sub detect() { |
816 | unless ($MODEL) { |
1051 | unless ($MODEL) { |
… | |
… | |
853 | last; |
1088 | last; |
854 | } |
1089 | } |
855 | } |
1090 | } |
856 | |
1091 | |
857 | $MODEL |
1092 | $MODEL |
858 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
1093 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
859 | } |
1094 | } |
860 | } |
1095 | } |
861 | |
1096 | |
|
|
1097 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1098 | |
862 | unshift @ISA, $MODEL; |
1099 | unshift @ISA, $MODEL; |
863 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1100 | |
|
|
1101 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
864 | |
1102 | |
865 | (shift @post_detect)->() while @post_detect; |
1103 | (shift @post_detect)->() while @post_detect; |
866 | } |
1104 | } |
867 | |
1105 | |
868 | $MODEL |
1106 | $MODEL |
… | |
… | |
878 | |
1116 | |
879 | my $class = shift; |
1117 | my $class = shift; |
880 | $class->$func (@_); |
1118 | $class->$func (@_); |
881 | } |
1119 | } |
882 | |
1120 | |
|
|
1121 | # utility function to dup a filehandle. this is used by many backends |
|
|
1122 | # to support binding more than one watcher per filehandle (they usually |
|
|
1123 | # allow only one watcher per fd, so we dup it to get a different one). |
|
|
1124 | sub _dupfh($$;$$) { |
|
|
1125 | my ($poll, $fh, $r, $w) = @_; |
|
|
1126 | |
|
|
1127 | # cygwin requires the fh mode to be matching, unix doesn't |
|
|
1128 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
|
|
1129 | : $poll eq "w" ? ($w, ">") |
|
|
1130 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
|
|
1131 | |
|
|
1132 | open my $fh2, "$mode&" . fileno $fh |
|
|
1133 | or die "cannot dup() filehandle: $!,"; |
|
|
1134 | |
|
|
1135 | # we assume CLOEXEC is already set by perl in all important cases |
|
|
1136 | |
|
|
1137 | ($fh2, $rw) |
|
|
1138 | } |
|
|
1139 | |
883 | package AnyEvent::Base; |
1140 | package AnyEvent::Base; |
884 | |
1141 | |
|
|
1142 | # default implementations for many methods |
|
|
1143 | |
|
|
1144 | BEGIN { |
|
|
1145 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
|
|
1146 | *_time = \&Time::HiRes::time; |
|
|
1147 | # if (eval "use POSIX (); (POSIX::times())... |
|
|
1148 | } else { |
|
|
1149 | *_time = sub { time }; # epic fail |
|
|
1150 | } |
|
|
1151 | } |
|
|
1152 | |
|
|
1153 | sub time { _time } |
|
|
1154 | sub now { _time } |
|
|
1155 | sub now_update { } |
|
|
1156 | |
885 | # default implementation for ->condvar |
1157 | # default implementation for ->condvar |
886 | |
1158 | |
887 | sub condvar { |
1159 | sub condvar { |
888 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
1160 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
889 | } |
1161 | } |
890 | |
1162 | |
891 | # default implementation for ->signal |
1163 | # default implementation for ->signal |
892 | |
1164 | |
893 | our %SIG_CB; |
1165 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
|
|
1166 | |
|
|
1167 | sub _signal_exec { |
|
|
1168 | sysread $SIGPIPE_R, my $dummy, 4; |
|
|
1169 | |
|
|
1170 | while (%SIG_EV) { |
|
|
1171 | for (keys %SIG_EV) { |
|
|
1172 | delete $SIG_EV{$_}; |
|
|
1173 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1174 | } |
|
|
1175 | } |
|
|
1176 | } |
894 | |
1177 | |
895 | sub signal { |
1178 | sub signal { |
896 | my (undef, %arg) = @_; |
1179 | my (undef, %arg) = @_; |
897 | |
1180 | |
|
|
1181 | unless ($SIGPIPE_R) { |
|
|
1182 | require Fcntl; |
|
|
1183 | |
|
|
1184 | if (AnyEvent::WIN32) { |
|
|
1185 | require AnyEvent::Util; |
|
|
1186 | |
|
|
1187 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1188 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1189 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1190 | } else { |
|
|
1191 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1192 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1193 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1194 | |
|
|
1195 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1196 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1197 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1198 | } |
|
|
1199 | |
|
|
1200 | $SIGPIPE_R |
|
|
1201 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1202 | |
|
|
1203 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1204 | } |
|
|
1205 | |
898 | my $signal = uc $arg{signal} |
1206 | my $signal = uc $arg{signal} |
899 | or Carp::croak "required option 'signal' is missing"; |
1207 | or Carp::croak "required option 'signal' is missing"; |
900 | |
1208 | |
901 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1209 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
902 | $SIG{$signal} ||= sub { |
1210 | $SIG{$signal} ||= sub { |
903 | $_->() for values %{ $SIG_CB{$signal} || {} }; |
1211 | local $!; |
|
|
1212 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1213 | undef $SIG_EV{$signal}; |
904 | }; |
1214 | }; |
905 | |
1215 | |
906 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1216 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
907 | } |
1217 | } |
908 | |
1218 | |
909 | sub AnyEvent::Base::Signal::DESTROY { |
1219 | sub AnyEvent::Base::signal::DESTROY { |
910 | my ($signal, $cb) = @{$_[0]}; |
1220 | my ($signal, $cb) = @{$_[0]}; |
911 | |
1221 | |
912 | delete $SIG_CB{$signal}{$cb}; |
1222 | delete $SIG_CB{$signal}{$cb}; |
913 | |
1223 | |
|
|
1224 | # delete doesn't work with older perls - they then |
|
|
1225 | # print weird messages, or just unconditionally exit |
|
|
1226 | # instead of getting the default action. |
914 | $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; |
1227 | undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
915 | } |
1228 | } |
916 | |
1229 | |
917 | # default implementation for ->child |
1230 | # default implementation for ->child |
918 | |
1231 | |
919 | our %PID_CB; |
1232 | our %PID_CB; |
920 | our $CHLD_W; |
1233 | our $CHLD_W; |
921 | our $CHLD_DELAY_W; |
1234 | our $CHLD_DELAY_W; |
922 | our $PID_IDLE; |
|
|
923 | our $WNOHANG; |
1235 | our $WNOHANG; |
924 | |
1236 | |
925 | sub _child_wait { |
1237 | sub _sigchld { |
926 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1238 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
927 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1239 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
928 | (values %{ $PID_CB{0} || {} }); |
1240 | (values %{ $PID_CB{0} || {} }); |
929 | } |
1241 | } |
930 | |
|
|
931 | undef $PID_IDLE; |
|
|
932 | } |
|
|
933 | |
|
|
934 | sub _sigchld { |
|
|
935 | # make sure we deliver these changes "synchronous" with the event loop. |
|
|
936 | $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub { |
|
|
937 | undef $CHLD_DELAY_W; |
|
|
938 | &_child_wait; |
|
|
939 | }); |
|
|
940 | } |
1242 | } |
941 | |
1243 | |
942 | sub child { |
1244 | sub child { |
943 | my (undef, %arg) = @_; |
1245 | my (undef, %arg) = @_; |
944 | |
1246 | |
945 | defined (my $pid = $arg{pid} + 0) |
1247 | defined (my $pid = $arg{pid} + 0) |
946 | or Carp::croak "required option 'pid' is missing"; |
1248 | or Carp::croak "required option 'pid' is missing"; |
947 | |
1249 | |
948 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1250 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
949 | |
1251 | |
950 | unless ($WNOHANG) { |
|
|
951 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1252 | $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
952 | } |
|
|
953 | |
1253 | |
954 | unless ($CHLD_W) { |
1254 | unless ($CHLD_W) { |
955 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1255 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
956 | # child could be a zombie already, so make at least one round |
1256 | # child could be a zombie already, so make at least one round |
957 | &_sigchld; |
1257 | &_sigchld; |
958 | } |
1258 | } |
959 | |
1259 | |
960 | bless [$pid, $arg{cb}], "AnyEvent::Base::Child" |
1260 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
961 | } |
1261 | } |
962 | |
1262 | |
963 | sub AnyEvent::Base::Child::DESTROY { |
1263 | sub AnyEvent::Base::child::DESTROY { |
964 | my ($pid, $cb) = @{$_[0]}; |
1264 | my ($pid, $cb) = @{$_[0]}; |
965 | |
1265 | |
966 | delete $PID_CB{$pid}{$cb}; |
1266 | delete $PID_CB{$pid}{$cb}; |
967 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1267 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
968 | |
1268 | |
969 | undef $CHLD_W unless keys %PID_CB; |
1269 | undef $CHLD_W unless keys %PID_CB; |
|
|
1270 | } |
|
|
1271 | |
|
|
1272 | # idle emulation is done by simply using a timer, regardless |
|
|
1273 | # of whether the process is idle or not, and not letting |
|
|
1274 | # the callback use more than 50% of the time. |
|
|
1275 | sub idle { |
|
|
1276 | my (undef, %arg) = @_; |
|
|
1277 | |
|
|
1278 | my ($cb, $w, $rcb) = $arg{cb}; |
|
|
1279 | |
|
|
1280 | $rcb = sub { |
|
|
1281 | if ($cb) { |
|
|
1282 | $w = _time; |
|
|
1283 | &$cb; |
|
|
1284 | $w = _time - $w; |
|
|
1285 | |
|
|
1286 | # never use more then 50% of the time for the idle watcher, |
|
|
1287 | # within some limits |
|
|
1288 | $w = 0.0001 if $w < 0.0001; |
|
|
1289 | $w = 5 if $w > 5; |
|
|
1290 | |
|
|
1291 | $w = AnyEvent->timer (after => $w, cb => $rcb); |
|
|
1292 | } else { |
|
|
1293 | # clean up... |
|
|
1294 | undef $w; |
|
|
1295 | undef $rcb; |
|
|
1296 | } |
|
|
1297 | }; |
|
|
1298 | |
|
|
1299 | $w = AnyEvent->timer (after => 0.05, cb => $rcb); |
|
|
1300 | |
|
|
1301 | bless \\$cb, "AnyEvent::Base::idle" |
|
|
1302 | } |
|
|
1303 | |
|
|
1304 | sub AnyEvent::Base::idle::DESTROY { |
|
|
1305 | undef $${$_[0]}; |
970 | } |
1306 | } |
971 | |
1307 | |
972 | package AnyEvent::CondVar; |
1308 | package AnyEvent::CondVar; |
973 | |
1309 | |
974 | our @ISA = AnyEvent::CondVar::Base::; |
1310 | our @ISA = AnyEvent::CondVar::Base::; |
… | |
… | |
1026 | } |
1362 | } |
1027 | |
1363 | |
1028 | # undocumented/compatibility with pre-3.4 |
1364 | # undocumented/compatibility with pre-3.4 |
1029 | *broadcast = \&send; |
1365 | *broadcast = \&send; |
1030 | *wait = \&_wait; |
1366 | *wait = \&_wait; |
|
|
1367 | |
|
|
1368 | =head1 ERROR AND EXCEPTION HANDLING |
|
|
1369 | |
|
|
1370 | In general, AnyEvent does not do any error handling - it relies on the |
|
|
1371 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
|
|
1372 | the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict |
|
|
1373 | checking of all AnyEvent methods, however, which is highly useful during |
|
|
1374 | development. |
|
|
1375 | |
|
|
1376 | As for exception handling (i.e. runtime errors and exceptions thrown while |
|
|
1377 | executing a callback), this is not only highly event-loop specific, but |
|
|
1378 | also not in any way wrapped by this module, as this is the job of the main |
|
|
1379 | program. |
|
|
1380 | |
|
|
1381 | The pure perl event loop simply re-throws the exception (usually |
|
|
1382 | within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<< |
|
|
1383 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
|
|
1384 | so on. |
|
|
1385 | |
|
|
1386 | =head1 ENVIRONMENT VARIABLES |
|
|
1387 | |
|
|
1388 | The following environment variables are used by this module or its |
|
|
1389 | submodules. |
|
|
1390 | |
|
|
1391 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
1392 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
1393 | enabled. |
|
|
1394 | |
|
|
1395 | =over 4 |
|
|
1396 | |
|
|
1397 | =item C<PERL_ANYEVENT_VERBOSE> |
|
|
1398 | |
|
|
1399 | By default, AnyEvent will be completely silent except in fatal |
|
|
1400 | conditions. You can set this environment variable to make AnyEvent more |
|
|
1401 | talkative. |
|
|
1402 | |
|
|
1403 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
|
|
1404 | conditions, such as not being able to load the event model specified by |
|
|
1405 | C<PERL_ANYEVENT_MODEL>. |
|
|
1406 | |
|
|
1407 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
|
|
1408 | model it chooses. |
|
|
1409 | |
|
|
1410 | =item C<PERL_ANYEVENT_STRICT> |
|
|
1411 | |
|
|
1412 | AnyEvent does not do much argument checking by default, as thorough |
|
|
1413 | argument checking is very costly. Setting this variable to a true value |
|
|
1414 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
|
|
1415 | check the arguments passed to most method calls. If it finds any problems, |
|
|
1416 | it will croak. |
|
|
1417 | |
|
|
1418 | In other words, enables "strict" mode. |
|
|
1419 | |
|
|
1420 | Unlike C<use strict>, it is definitely recommended to keep it off in |
|
|
1421 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
|
|
1422 | developing programs can be very useful, however. |
|
|
1423 | |
|
|
1424 | =item C<PERL_ANYEVENT_MODEL> |
|
|
1425 | |
|
|
1426 | This can be used to specify the event model to be used by AnyEvent, before |
|
|
1427 | auto detection and -probing kicks in. It must be a string consisting |
|
|
1428 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
|
|
1429 | and the resulting module name is loaded and if the load was successful, |
|
|
1430 | used as event model. If it fails to load AnyEvent will proceed with |
|
|
1431 | auto detection and -probing. |
|
|
1432 | |
|
|
1433 | This functionality might change in future versions. |
|
|
1434 | |
|
|
1435 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
|
|
1436 | could start your program like this: |
|
|
1437 | |
|
|
1438 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
1439 | |
|
|
1440 | =item C<PERL_ANYEVENT_PROTOCOLS> |
|
|
1441 | |
|
|
1442 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
|
|
1443 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
|
|
1444 | of auto probing). |
|
|
1445 | |
|
|
1446 | Must be set to a comma-separated list of protocols or address families, |
|
|
1447 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
|
|
1448 | used, and preference will be given to protocols mentioned earlier in the |
|
|
1449 | list. |
|
|
1450 | |
|
|
1451 | This variable can effectively be used for denial-of-service attacks |
|
|
1452 | against local programs (e.g. when setuid), although the impact is likely |
|
|
1453 | small, as the program has to handle conenction and other failures anyways. |
|
|
1454 | |
|
|
1455 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
|
|
1456 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
|
|
1457 | - only support IPv4, never try to resolve or contact IPv6 |
|
|
1458 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
|
|
1459 | IPv6, but prefer IPv6 over IPv4. |
|
|
1460 | |
|
|
1461 | =item C<PERL_ANYEVENT_EDNS0> |
|
|
1462 | |
|
|
1463 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
|
|
1464 | for DNS. This extension is generally useful to reduce DNS traffic, but |
|
|
1465 | some (broken) firewalls drop such DNS packets, which is why it is off by |
|
|
1466 | default. |
|
|
1467 | |
|
|
1468 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
|
|
1469 | EDNS0 in its DNS requests. |
|
|
1470 | |
|
|
1471 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1472 | |
|
|
1473 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1474 | will create in parallel. |
|
|
1475 | |
|
|
1476 | =item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS> |
|
|
1477 | |
|
|
1478 | The default value for the C<max_outstanding> parameter for the default DNS |
|
|
1479 | resolver - this is the maximum number of parallel DNS requests that are |
|
|
1480 | sent to the DNS server. |
|
|
1481 | |
|
|
1482 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
|
|
1483 | |
|
|
1484 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
|
|
1485 | configuration) in the default resolver. When set to the empty string, no |
|
|
1486 | default config will be used. |
|
|
1487 | |
|
|
1488 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
|
|
1489 | |
|
|
1490 | When neither C<ca_file> nor C<ca_path> was specified during |
|
|
1491 | L<AnyEvent::TLS> context creation, and either of these environment |
|
|
1492 | variables exist, they will be used to specify CA certificate locations |
|
|
1493 | instead of a system-dependent default. |
|
|
1494 | |
|
|
1495 | =back |
1031 | |
1496 | |
1032 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1497 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1033 | |
1498 | |
1034 | This is an advanced topic that you do not normally need to use AnyEvent in |
1499 | This is an advanced topic that you do not normally need to use AnyEvent in |
1035 | a module. This section is only of use to event loop authors who want to |
1500 | a module. This section is only of use to event loop authors who want to |
… | |
… | |
1069 | |
1534 | |
1070 | I<rxvt-unicode> also cheats a bit by not providing blocking access to |
1535 | I<rxvt-unicode> also cheats a bit by not providing blocking access to |
1071 | condition variables: code blocking while waiting for a condition will |
1536 | condition variables: code blocking while waiting for a condition will |
1072 | C<die>. This still works with most modules/usages, and blocking calls must |
1537 | C<die>. This still works with most modules/usages, and blocking calls must |
1073 | not be done in an interactive application, so it makes sense. |
1538 | not be done in an interactive application, so it makes sense. |
1074 | |
|
|
1075 | =head1 ENVIRONMENT VARIABLES |
|
|
1076 | |
|
|
1077 | The following environment variables are used by this module: |
|
|
1078 | |
|
|
1079 | =over 4 |
|
|
1080 | |
|
|
1081 | =item C<PERL_ANYEVENT_VERBOSE> |
|
|
1082 | |
|
|
1083 | By default, AnyEvent will be completely silent except in fatal |
|
|
1084 | conditions. You can set this environment variable to make AnyEvent more |
|
|
1085 | talkative. |
|
|
1086 | |
|
|
1087 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
|
|
1088 | conditions, such as not being able to load the event model specified by |
|
|
1089 | C<PERL_ANYEVENT_MODEL>. |
|
|
1090 | |
|
|
1091 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
|
|
1092 | model it chooses. |
|
|
1093 | |
|
|
1094 | =item C<PERL_ANYEVENT_MODEL> |
|
|
1095 | |
|
|
1096 | This can be used to specify the event model to be used by AnyEvent, before |
|
|
1097 | auto detection and -probing kicks in. It must be a string consisting |
|
|
1098 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
|
|
1099 | and the resulting module name is loaded and if the load was successful, |
|
|
1100 | used as event model. If it fails to load AnyEvent will proceed with |
|
|
1101 | auto detection and -probing. |
|
|
1102 | |
|
|
1103 | This functionality might change in future versions. |
|
|
1104 | |
|
|
1105 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
|
|
1106 | could start your program like this: |
|
|
1107 | |
|
|
1108 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
1109 | |
|
|
1110 | =item C<PERL_ANYEVENT_PROTOCOLS> |
|
|
1111 | |
|
|
1112 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
|
|
1113 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
|
|
1114 | of auto probing). |
|
|
1115 | |
|
|
1116 | Must be set to a comma-separated list of protocols or address families, |
|
|
1117 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
|
|
1118 | used, and preference will be given to protocols mentioned earlier in the |
|
|
1119 | list. |
|
|
1120 | |
|
|
1121 | This variable can effectively be used for denial-of-service attacks |
|
|
1122 | against local programs (e.g. when setuid), although the impact is likely |
|
|
1123 | small, as the program has to handle connection errors already- |
|
|
1124 | |
|
|
1125 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
|
|
1126 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
|
|
1127 | - only support IPv4, never try to resolve or contact IPv6 |
|
|
1128 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
|
|
1129 | IPv6, but prefer IPv6 over IPv4. |
|
|
1130 | |
|
|
1131 | =item C<PERL_ANYEVENT_EDNS0> |
|
|
1132 | |
|
|
1133 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
|
|
1134 | for DNS. This extension is generally useful to reduce DNS traffic, but |
|
|
1135 | some (broken) firewalls drop such DNS packets, which is why it is off by |
|
|
1136 | default. |
|
|
1137 | |
|
|
1138 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
|
|
1139 | EDNS0 in its DNS requests. |
|
|
1140 | |
|
|
1141 | =back |
|
|
1142 | |
1539 | |
1143 | =head1 EXAMPLE PROGRAM |
1540 | =head1 EXAMPLE PROGRAM |
1144 | |
1541 | |
1145 | The following program uses an I/O watcher to read data from STDIN, a timer |
1542 | The following program uses an I/O watcher to read data from STDIN, a timer |
1146 | to display a message once per second, and a condition variable to quit the |
1543 | to display a message once per second, and a condition variable to quit the |
… | |
… | |
1340 | watcher. |
1737 | watcher. |
1341 | |
1738 | |
1342 | =head3 Results |
1739 | =head3 Results |
1343 | |
1740 | |
1344 | name watchers bytes create invoke destroy comment |
1741 | name watchers bytes create invoke destroy comment |
1345 | EV/EV 400000 244 0.56 0.46 0.31 EV native interface |
1742 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
1346 | EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers |
1743 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
1347 | CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal |
1744 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
1348 | Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation |
1745 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
1349 | Event/Event 16000 516 31.88 31.30 0.85 Event native interface |
1746 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
1350 | Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers |
1747 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
|
|
1748 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
|
|
1749 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
1351 | Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour |
1750 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
1352 | Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers |
1751 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
1353 | POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event |
1752 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
1354 | POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select |
1753 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1355 | |
1754 | |
1356 | =head3 Discussion |
1755 | =head3 Discussion |
1357 | |
1756 | |
1358 | The benchmark does I<not> measure scalability of the event loop very |
1757 | The benchmark does I<not> measure scalability of the event loop very |
1359 | well. For example, a select-based event loop (such as the pure perl one) |
1758 | well. For example, a select-based event loop (such as the pure perl one) |
… | |
… | |
1384 | performance becomes really bad with lots of file descriptors (and few of |
1783 | performance becomes really bad with lots of file descriptors (and few of |
1385 | them active), of course, but this was not subject of this benchmark. |
1784 | them active), of course, but this was not subject of this benchmark. |
1386 | |
1785 | |
1387 | The C<Event> module has a relatively high setup and callback invocation |
1786 | The C<Event> module has a relatively high setup and callback invocation |
1388 | cost, but overall scores in on the third place. |
1787 | cost, but overall scores in on the third place. |
|
|
1788 | |
|
|
1789 | C<IO::Async> performs admirably well, about on par with C<Event>, even |
|
|
1790 | when using its pure perl backend. |
1389 | |
1791 | |
1390 | C<Glib>'s memory usage is quite a bit higher, but it features a |
1792 | C<Glib>'s memory usage is quite a bit higher, but it features a |
1391 | faster callback invocation and overall ends up in the same class as |
1793 | faster callback invocation and overall ends up in the same class as |
1392 | C<Event>. However, Glib scales extremely badly, doubling the number of |
1794 | C<Event>. However, Glib scales extremely badly, doubling the number of |
1393 | watchers increases the processing time by more than a factor of four, |
1795 | watchers increases the processing time by more than a factor of four, |
… | |
… | |
1471 | it to another server. This includes deleting the old timeout and creating |
1873 | it to another server. This includes deleting the old timeout and creating |
1472 | a new one that moves the timeout into the future. |
1874 | a new one that moves the timeout into the future. |
1473 | |
1875 | |
1474 | =head3 Results |
1876 | =head3 Results |
1475 | |
1877 | |
1476 | name sockets create request |
1878 | name sockets create request |
1477 | EV 20000 69.01 11.16 |
1879 | EV 20000 69.01 11.16 |
1478 | Perl 20000 73.32 35.87 |
1880 | Perl 20000 73.32 35.87 |
|
|
1881 | IOAsync 20000 157.00 98.14 epoll |
|
|
1882 | IOAsync 20000 159.31 616.06 poll |
1479 | Event 20000 212.62 257.32 |
1883 | Event 20000 212.62 257.32 |
1480 | Glib 20000 651.16 1896.30 |
1884 | Glib 20000 651.16 1896.30 |
1481 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1885 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1482 | |
1886 | |
1483 | =head3 Discussion |
1887 | =head3 Discussion |
1484 | |
1888 | |
1485 | This benchmark I<does> measure scalability and overall performance of the |
1889 | This benchmark I<does> measure scalability and overall performance of the |
1486 | particular event loop. |
1890 | particular event loop. |
… | |
… | |
1488 | EV is again fastest. Since it is using epoll on my system, the setup time |
1892 | EV is again fastest. Since it is using epoll on my system, the setup time |
1489 | is relatively high, though. |
1893 | is relatively high, though. |
1490 | |
1894 | |
1491 | Perl surprisingly comes second. It is much faster than the C-based event |
1895 | Perl surprisingly comes second. It is much faster than the C-based event |
1492 | loops Event and Glib. |
1896 | loops Event and Glib. |
|
|
1897 | |
|
|
1898 | IO::Async performs very well when using its epoll backend, and still quite |
|
|
1899 | good compared to Glib when using its pure perl backend. |
1493 | |
1900 | |
1494 | Event suffers from high setup time as well (look at its code and you will |
1901 | Event suffers from high setup time as well (look at its code and you will |
1495 | understand why). Callback invocation also has a high overhead compared to |
1902 | understand why). Callback invocation also has a high overhead compared to |
1496 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
1903 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
1497 | uses select or poll in basically all documented configurations. |
1904 | uses select or poll in basically all documented configurations. |
… | |
… | |
1560 | =item * C-based event loops perform very well with small number of |
1967 | =item * C-based event loops perform very well with small number of |
1561 | watchers, as the management overhead dominates. |
1968 | watchers, as the management overhead dominates. |
1562 | |
1969 | |
1563 | =back |
1970 | =back |
1564 | |
1971 | |
|
|
1972 | =head2 THE IO::Lambda BENCHMARK |
|
|
1973 | |
|
|
1974 | Recently I was told about the benchmark in the IO::Lambda manpage, which |
|
|
1975 | could be misinterpreted to make AnyEvent look bad. In fact, the benchmark |
|
|
1976 | simply compares IO::Lambda with POE, and IO::Lambda looks better (which |
|
|
1977 | shouldn't come as a surprise to anybody). As such, the benchmark is |
|
|
1978 | fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't |
|
|
1979 | very optimal. But how would AnyEvent compare when used without the extra |
|
|
1980 | baggage? To explore this, I wrote the equivalent benchmark for AnyEvent. |
|
|
1981 | |
|
|
1982 | The benchmark itself creates an echo-server, and then, for 500 times, |
|
|
1983 | connects to the echo server, sends a line, waits for the reply, and then |
|
|
1984 | creates the next connection. This is a rather bad benchmark, as it doesn't |
|
|
1985 | test the efficiency of the framework or much non-blocking I/O, but it is a |
|
|
1986 | benchmark nevertheless. |
|
|
1987 | |
|
|
1988 | name runtime |
|
|
1989 | Lambda/select 0.330 sec |
|
|
1990 | + optimized 0.122 sec |
|
|
1991 | Lambda/AnyEvent 0.327 sec |
|
|
1992 | + optimized 0.138 sec |
|
|
1993 | Raw sockets/select 0.077 sec |
|
|
1994 | POE/select, components 0.662 sec |
|
|
1995 | POE/select, raw sockets 0.226 sec |
|
|
1996 | POE/select, optimized 0.404 sec |
|
|
1997 | |
|
|
1998 | AnyEvent/select/nb 0.085 sec |
|
|
1999 | AnyEvent/EV/nb 0.068 sec |
|
|
2000 | +state machine 0.134 sec |
|
|
2001 | |
|
|
2002 | The benchmark is also a bit unfair (my fault): the IO::Lambda/POE |
|
|
2003 | benchmarks actually make blocking connects and use 100% blocking I/O, |
|
|
2004 | defeating the purpose of an event-based solution. All of the newly |
|
|
2005 | written AnyEvent benchmarks use 100% non-blocking connects (using |
|
|
2006 | AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS |
|
|
2007 | resolver), so AnyEvent is at a disadvantage here, as non-blocking connects |
|
|
2008 | generally require a lot more bookkeeping and event handling than blocking |
|
|
2009 | connects (which involve a single syscall only). |
|
|
2010 | |
|
|
2011 | The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which |
|
|
2012 | offers similar expressive power as POE and IO::Lambda, using conventional |
|
|
2013 | Perl syntax. This means that both the echo server and the client are 100% |
|
|
2014 | non-blocking, further placing it at a disadvantage. |
|
|
2015 | |
|
|
2016 | As you can see, the AnyEvent + EV combination even beats the |
|
|
2017 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
|
|
2018 | backend easily beats IO::Lambda and POE. |
|
|
2019 | |
|
|
2020 | And even the 100% non-blocking version written using the high-level (and |
|
|
2021 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
|
|
2022 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
|
|
2023 | in a non-blocking way. |
|
|
2024 | |
|
|
2025 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
|
|
2026 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
|
|
2027 | part of the IO::lambda distribution and were used without any changes. |
|
|
2028 | |
|
|
2029 | |
|
|
2030 | =head1 SIGNALS |
|
|
2031 | |
|
|
2032 | AnyEvent currently installs handlers for these signals: |
|
|
2033 | |
|
|
2034 | =over 4 |
|
|
2035 | |
|
|
2036 | =item SIGCHLD |
|
|
2037 | |
|
|
2038 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
|
|
2039 | emulation for event loops that do not support them natively. Also, some |
|
|
2040 | event loops install a similar handler. |
|
|
2041 | |
|
|
2042 | If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will |
|
|
2043 | reset it to default, to avoid losing child exit statuses. |
|
|
2044 | |
|
|
2045 | =item SIGPIPE |
|
|
2046 | |
|
|
2047 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
|
|
2048 | when AnyEvent gets loaded. |
|
|
2049 | |
|
|
2050 | The rationale for this is that AnyEvent users usually do not really depend |
|
|
2051 | on SIGPIPE delivery (which is purely an optimisation for shell use, or |
|
|
2052 | badly-written programs), but C<SIGPIPE> can cause spurious and rare |
|
|
2053 | program exits as a lot of people do not expect C<SIGPIPE> when writing to |
|
|
2054 | some random socket. |
|
|
2055 | |
|
|
2056 | The rationale for installing a no-op handler as opposed to ignoring it is |
|
|
2057 | that this way, the handler will be restored to defaults on exec. |
|
|
2058 | |
|
|
2059 | Feel free to install your own handler, or reset it to defaults. |
|
|
2060 | |
|
|
2061 | =back |
|
|
2062 | |
|
|
2063 | =cut |
|
|
2064 | |
|
|
2065 | undef $SIG{CHLD} |
|
|
2066 | if $SIG{CHLD} eq 'IGNORE'; |
|
|
2067 | |
|
|
2068 | $SIG{PIPE} = sub { } |
|
|
2069 | unless defined $SIG{PIPE}; |
1565 | |
2070 | |
1566 | =head1 FORK |
2071 | =head1 FORK |
1567 | |
2072 | |
1568 | Most event libraries are not fork-safe. The ones who are usually are |
2073 | Most event libraries are not fork-safe. The ones who are usually are |
1569 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2074 | because they rely on inefficient but fork-safe C<select> or C<poll> |
… | |
… | |
1583 | specified in the variable. |
2088 | specified in the variable. |
1584 | |
2089 | |
1585 | You can make AnyEvent completely ignore this variable by deleting it |
2090 | You can make AnyEvent completely ignore this variable by deleting it |
1586 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
2091 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1587 | |
2092 | |
1588 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
2093 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1589 | |
2094 | |
1590 | use AnyEvent; |
2095 | use AnyEvent; |
1591 | |
2096 | |
1592 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
2097 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1593 | be used to probe what backend is used and gain other information (which is |
2098 | be used to probe what backend is used and gain other information (which is |
1594 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
2099 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
|
|
2100 | $ENV{PERL_ANYEVENT_STRICT}. |
|
|
2101 | |
|
|
2102 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
2103 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
2104 | enabled. |
|
|
2105 | |
|
|
2106 | |
|
|
2107 | =head1 BUGS |
|
|
2108 | |
|
|
2109 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
|
|
2110 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
|
|
2111 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
|
|
2112 | memleaks, such as leaking on C<map> and C<grep> but it is usually not as |
|
|
2113 | pronounced). |
1595 | |
2114 | |
1596 | |
2115 | |
1597 | =head1 SEE ALSO |
2116 | =head1 SEE ALSO |
1598 | |
2117 | |
1599 | Utility functions: L<AnyEvent::Util>. |
2118 | Utility functions: L<AnyEvent::Util>. |
… | |
… | |
1616 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
2135 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1617 | |
2136 | |
1618 | |
2137 | |
1619 | =head1 AUTHOR |
2138 | =head1 AUTHOR |
1620 | |
2139 | |
1621 | Marc Lehmann <schmorp@schmorp.de> |
2140 | Marc Lehmann <schmorp@schmorp.de> |
1622 | http://home.schmorp.de/ |
2141 | http://home.schmorp.de/ |
1623 | |
2142 | |
1624 | =cut |
2143 | =cut |
1625 | |
2144 | |
1626 | 1 |
2145 | 1 |
1627 | |
2146 | |