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, Coro::EV, Coro::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 |
|
|
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. |
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 enourmous 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 | |
… | |
… | |
78 | The interface itself is vaguely similar, but not identical to the L<Event> |
108 | The interface itself is vaguely similar, but not identical to the L<Event> |
79 | module. |
109 | module. |
80 | |
110 | |
81 | During the first call of any watcher-creation method, the module tries |
111 | During the first call of any watcher-creation method, the module tries |
82 | to detect the currently loaded event loop by probing whether one of the |
112 | to detect the currently loaded event loop by probing whether one of the |
83 | following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>, |
113 | following modules is already loaded: L<EV>, |
84 | L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, |
114 | L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, |
85 | L<POE>. The first one found is used. If none are found, the module tries |
115 | L<POE>. The first one found is used. If none are found, the module tries |
86 | to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl |
116 | to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl |
87 | adaptor should always succeed) in the order given. The first one that can |
117 | adaptor should always succeed) in the order given. The first one that can |
88 | be successfully loaded will be used. If, after this, still none could be |
118 | be successfully loaded will be used. If, after this, still none could be |
… | |
… | |
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 |
113 | the callback to call, the filehandle to watch, etc. |
143 | the callback to call, the file handle to watch, etc. |
114 | |
144 | |
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> (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 | |
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 | |
242 | Multiple signal occurances can be clumped together into one callback |
360 | Multiple signal occurrences can be clumped together into one callback |
243 | invocation, and callback invocation will be synchronous. synchronous means |
361 | invocation, and callback invocation will be synchronous. Synchronous means |
244 | that it might take a while until the signal gets handled by the process, |
362 | that it might take a while until the signal gets handled by the process, |
245 | but it is guarenteed not to interrupt any other callbacks. |
363 | but it is guaranteed not to interrupt any other callbacks. |
246 | |
364 | |
247 | The main advantage of using these watchers is that you can share a signal |
365 | The main advantage of using these watchers is that you can share a signal |
248 | between multiple watchers. |
366 | between multiple watchers. |
249 | |
367 | |
250 | This watcher might use C<%SIG>, so programs overwriting those signals |
368 | This watcher might use C<%SIG>, so programs overwriting those signals |
… | |
… | |
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 | AnyEvent::detect; # force event module to be initialised |
|
|
285 | |
|
|
286 | my $pid = fork or exit 5; |
413 | my $pid = fork or exit 5; |
287 | |
414 | |
288 | my $w = AnyEvent->child ( |
415 | my $w = AnyEvent->child ( |
289 | pid => $pid, |
416 | pid => $pid, |
290 | cb => sub { |
417 | cb => sub { |
291 | my ($pid, $status) = @_; |
418 | my ($pid, $status) = @_; |
292 | warn "pid $pid exited with status $status"; |
419 | warn "pid $pid exited with status $status"; |
293 | $done->broadcast; |
420 | $done->send; |
294 | }, |
421 | }, |
295 | ); |
422 | ); |
296 | |
423 | |
297 | # do something else, then wait for process exit |
424 | # do something else, then wait for process exit |
298 | $done->wait; |
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 | }); |
299 | |
461 | |
300 | =head2 CONDITION VARIABLES |
462 | =head2 CONDITION VARIABLES |
301 | |
463 | |
|
|
464 | If you are familiar with some event loops you will know that all of them |
|
|
465 | require you to run some blocking "loop", "run" or similar function that |
|
|
466 | will actively watch for new events and call your callbacks. |
|
|
467 | |
|
|
468 | AnyEvent is slightly different: it expects somebody else to run the event |
|
|
469 | loop and will only block when necessary (usually when told by the user). |
|
|
470 | |
|
|
471 | The instrument to do that is called a "condition variable", so called |
|
|
472 | because they represent a condition that must become true. |
|
|
473 | |
|
|
474 | Now is probably a good time to look at the examples further below. |
|
|
475 | |
302 | Condition variables can be created by calling the C<< AnyEvent->condvar >> |
476 | Condition variables can be created by calling the C<< AnyEvent->condvar |
303 | method without any arguments. |
477 | >> method, usually without arguments. The only argument pair allowed is |
|
|
478 | C<cb>, which specifies a callback to be called when the condition variable |
|
|
479 | becomes true, with the condition variable as the first argument (but not |
|
|
480 | the results). |
304 | |
481 | |
305 | A condition variable waits for a condition - precisely that the C<< |
482 | After creation, the condition variable is "false" until it becomes "true" |
306 | ->broadcast >> method has been called. |
483 | by calling the C<send> method (or calling the condition variable as if it |
|
|
484 | were a callback, read about the caveats in the description for the C<< |
|
|
485 | ->send >> method). |
307 | |
486 | |
308 | They are very useful to signal that a condition has been fulfilled, for |
487 | Condition variables are similar to callbacks, except that you can |
|
|
488 | optionally wait for them. They can also be called merge points - points |
|
|
489 | in time where multiple outstanding events have been processed. And yet |
|
|
490 | another way to call them is transactions - each condition variable can be |
|
|
491 | used to represent a transaction, which finishes at some point and delivers |
|
|
492 | a result. |
|
|
493 | |
|
|
494 | Condition variables are very useful to signal that something has finished, |
309 | example, if you write a module that does asynchronous http requests, |
495 | for example, if you write a module that does asynchronous http requests, |
310 | then a condition variable would be the ideal candidate to signal the |
496 | then a condition variable would be the ideal candidate to signal the |
311 | availability of results. |
497 | availability of results. The user can either act when the callback is |
|
|
498 | called or can synchronously C<< ->recv >> for the results. |
312 | |
499 | |
313 | You can also use condition variables to block your main program until |
500 | You can also use them to simulate traditional event loops - for example, |
314 | an event occurs - for example, you could C<< ->wait >> in your main |
501 | you can block your main program until an event occurs - for example, you |
315 | program until the user clicks the Quit button in your app, which would C<< |
502 | could C<< ->recv >> in your main program until the user clicks the Quit |
316 | ->broadcast >> the "quit" event. |
503 | button of your app, which would C<< ->send >> the "quit" event. |
317 | |
504 | |
318 | Note that condition variables recurse into the event loop - if you have |
505 | Note that condition variables recurse into the event loop - if you have |
319 | two pirces of code that call C<< ->wait >> in a round-robbin fashion, you |
506 | two pieces of code that call C<< ->recv >> in a round-robin fashion, you |
320 | lose. Therefore, condition variables are good to export to your caller, but |
507 | lose. Therefore, condition variables are good to export to your caller, but |
321 | you should avoid making a blocking wait yourself, at least in callbacks, |
508 | you should avoid making a blocking wait yourself, at least in callbacks, |
322 | as this asks for trouble. |
509 | as this asks for trouble. |
323 | |
510 | |
324 | This object has two methods: |
511 | Condition variables are represented by hash refs in perl, and the keys |
|
|
512 | used by AnyEvent itself are all named C<_ae_XXX> to make subclassing |
|
|
513 | easy (it is often useful to build your own transaction class on top of |
|
|
514 | AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call |
|
|
515 | it's C<new> method in your own C<new> method. |
325 | |
516 | |
326 | =over 4 |
517 | There are two "sides" to a condition variable - the "producer side" which |
|
|
518 | eventually calls C<< -> send >>, and the "consumer side", which waits |
|
|
519 | for the send to occur. |
327 | |
520 | |
328 | =item $cv->wait |
521 | Example: wait for a timer. |
329 | |
|
|
330 | Wait (blocking if necessary) until the C<< ->broadcast >> method has been |
|
|
331 | called on c<$cv>, while servicing other watchers normally. |
|
|
332 | |
|
|
333 | You can only wait once on a condition - additional calls will return |
|
|
334 | immediately. |
|
|
335 | |
|
|
336 | Not all event models support a blocking wait - some die in that case |
|
|
337 | (programs might want to do that to stay interactive), so I<if you are |
|
|
338 | using this from a module, never require a blocking wait>, but let the |
|
|
339 | caller decide whether the call will block or not (for example, by coupling |
|
|
340 | condition variables with some kind of request results and supporting |
|
|
341 | callbacks so the caller knows that getting the result will not block, |
|
|
342 | while still suppporting blocking waits if the caller so desires). |
|
|
343 | |
|
|
344 | Another reason I<never> to C<< ->wait >> in a module is that you cannot |
|
|
345 | sensibly have two C<< ->wait >>'s in parallel, as that would require |
|
|
346 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
|
|
347 | can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and |
|
|
348 | L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s |
|
|
349 | from different coroutines, however). |
|
|
350 | |
|
|
351 | =item $cv->broadcast |
|
|
352 | |
|
|
353 | Flag the condition as ready - a running C<< ->wait >> and all further |
|
|
354 | calls to C<wait> will (eventually) return after this method has been |
|
|
355 | called. If nobody is waiting the broadcast will be remembered.. |
|
|
356 | |
|
|
357 | =back |
|
|
358 | |
|
|
359 | Example: |
|
|
360 | |
522 | |
361 | # wait till the result is ready |
523 | # wait till the result is ready |
362 | my $result_ready = AnyEvent->condvar; |
524 | my $result_ready = AnyEvent->condvar; |
363 | |
525 | |
364 | # do something such as adding a timer |
526 | # do something such as adding a timer |
365 | # or socket watcher the calls $result_ready->broadcast |
527 | # or socket watcher the calls $result_ready->send |
366 | # when the "result" is ready. |
528 | # when the "result" is ready. |
367 | # in this case, we simply use a timer: |
529 | # in this case, we simply use a timer: |
368 | my $w = AnyEvent->timer ( |
530 | my $w = AnyEvent->timer ( |
369 | after => 1, |
531 | after => 1, |
370 | cb => sub { $result_ready->broadcast }, |
532 | cb => sub { $result_ready->send }, |
371 | ); |
533 | ); |
372 | |
534 | |
373 | # this "blocks" (while handling events) till the watcher |
535 | # this "blocks" (while handling events) till the callback |
374 | # calls broadcast |
536 | # calls -<send |
375 | $result_ready->wait; |
537 | $result_ready->recv; |
|
|
538 | |
|
|
539 | Example: wait for a timer, but take advantage of the fact that condition |
|
|
540 | variables are also callable directly. |
|
|
541 | |
|
|
542 | my $done = AnyEvent->condvar; |
|
|
543 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
|
|
544 | $done->recv; |
|
|
545 | |
|
|
546 | Example: Imagine an API that returns a condvar and doesn't support |
|
|
547 | callbacks. This is how you make a synchronous call, for example from |
|
|
548 | the main program: |
|
|
549 | |
|
|
550 | use AnyEvent::CouchDB; |
|
|
551 | |
|
|
552 | ... |
|
|
553 | |
|
|
554 | my @info = $couchdb->info->recv; |
|
|
555 | |
|
|
556 | And this is how you would just set a callback to be called whenever the |
|
|
557 | results are available: |
|
|
558 | |
|
|
559 | $couchdb->info->cb (sub { |
|
|
560 | my @info = $_[0]->recv; |
|
|
561 | }); |
|
|
562 | |
|
|
563 | =head3 METHODS FOR PRODUCERS |
|
|
564 | |
|
|
565 | These methods should only be used by the producing side, i.e. the |
|
|
566 | code/module that eventually sends the signal. Note that it is also |
|
|
567 | the producer side which creates the condvar in most cases, but it isn't |
|
|
568 | uncommon for the consumer to create it as well. |
|
|
569 | |
|
|
570 | =over 4 |
|
|
571 | |
|
|
572 | =item $cv->send (...) |
|
|
573 | |
|
|
574 | Flag the condition as ready - a running C<< ->recv >> and all further |
|
|
575 | calls to C<recv> will (eventually) return after this method has been |
|
|
576 | called. If nobody is waiting the send will be remembered. |
|
|
577 | |
|
|
578 | If a callback has been set on the condition variable, it is called |
|
|
579 | immediately from within send. |
|
|
580 | |
|
|
581 | Any arguments passed to the C<send> call will be returned by all |
|
|
582 | future C<< ->recv >> calls. |
|
|
583 | |
|
|
584 | Condition variables are overloaded so one can call them directly (as if |
|
|
585 | they were a code reference). Calling them directly is the same as calling |
|
|
586 | C<send>. |
|
|
587 | |
|
|
588 | =item $cv->croak ($error) |
|
|
589 | |
|
|
590 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
|
|
591 | C<Carp::croak> with the given error message/object/scalar. |
|
|
592 | |
|
|
593 | This can be used to signal any errors to the condition variable |
|
|
594 | user/consumer. Doing it this way instead of calling C<croak> directly |
|
|
595 | delays the error detetcion, but has the overwhelmign advantage that it |
|
|
596 | diagnoses the error at the place where the result is expected, and not |
|
|
597 | deep in some event clalback without connection to the actual code causing |
|
|
598 | the problem. |
|
|
599 | |
|
|
600 | =item $cv->begin ([group callback]) |
|
|
601 | |
|
|
602 | =item $cv->end |
|
|
603 | |
|
|
604 | These two methods can be used to combine many transactions/events into |
|
|
605 | one. For example, a function that pings many hosts in parallel might want |
|
|
606 | to use a condition variable for the whole process. |
|
|
607 | |
|
|
608 | Every call to C<< ->begin >> will increment a counter, and every call to |
|
|
609 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
|
|
610 | >>, the (last) callback passed to C<begin> will be executed. That callback |
|
|
611 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
|
|
612 | callback was set, C<send> will be called without any arguments. |
|
|
613 | |
|
|
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: |
|
|
645 | |
|
|
646 | my $cv = AnyEvent->condvar; |
|
|
647 | |
|
|
648 | my %result; |
|
|
649 | $cv->begin (sub { $cv->send (\%result) }); |
|
|
650 | |
|
|
651 | for my $host (@list_of_hosts) { |
|
|
652 | $cv->begin; |
|
|
653 | ping_host_then_call_callback $host, sub { |
|
|
654 | $result{$host} = ...; |
|
|
655 | $cv->end; |
|
|
656 | }; |
|
|
657 | } |
|
|
658 | |
|
|
659 | $cv->end; |
|
|
660 | |
|
|
661 | This code fragment supposedly pings a number of hosts and calls |
|
|
662 | C<send> after results for all then have have been gathered - in any |
|
|
663 | order. To achieve this, the code issues a call to C<begin> when it starts |
|
|
664 | each ping request and calls C<end> when it has received some result for |
|
|
665 | it. Since C<begin> and C<end> only maintain a counter, the order in which |
|
|
666 | results arrive is not relevant. |
|
|
667 | |
|
|
668 | There is an additional bracketing call to C<begin> and C<end> outside the |
|
|
669 | loop, which serves two important purposes: first, it sets the callback |
|
|
670 | to be called once the counter reaches C<0>, and second, it ensures that |
|
|
671 | C<send> is called even when C<no> hosts are being pinged (the loop |
|
|
672 | doesn't execute once). |
|
|
673 | |
|
|
674 | This is the general pattern when you "fan out" into multiple (but |
|
|
675 | potentially none) subrequests: use an outer C<begin>/C<end> pair to set |
|
|
676 | the callback and ensure C<end> is called at least once, and then, for each |
|
|
677 | subrequest you start, call C<begin> and for each subrequest you finish, |
|
|
678 | call C<end>. |
|
|
679 | |
|
|
680 | =back |
|
|
681 | |
|
|
682 | =head3 METHODS FOR CONSUMERS |
|
|
683 | |
|
|
684 | These methods should only be used by the consuming side, i.e. the |
|
|
685 | code awaits the condition. |
|
|
686 | |
|
|
687 | =over 4 |
|
|
688 | |
|
|
689 | =item $cv->recv |
|
|
690 | |
|
|
691 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
|
|
692 | >> methods have been called on c<$cv>, while servicing other watchers |
|
|
693 | normally. |
|
|
694 | |
|
|
695 | You can only wait once on a condition - additional calls are valid but |
|
|
696 | will return immediately. |
|
|
697 | |
|
|
698 | If an error condition has been set by calling C<< ->croak >>, then this |
|
|
699 | function will call C<croak>. |
|
|
700 | |
|
|
701 | In list context, all parameters passed to C<send> will be returned, |
|
|
702 | in scalar context only the first one will be returned. |
|
|
703 | |
|
|
704 | Note that doing a blocking wait in a callback is not supported by any |
|
|
705 | event loop, that is, recursive invocation of a blocking C<< ->recv |
|
|
706 | >> is not allowed, and the C<recv> call will C<croak> if such a |
|
|
707 | condition is detected. This condition can be slightly loosened by using |
|
|
708 | L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from |
|
|
709 | any thread that doesn't run the event loop itself. |
|
|
710 | |
|
|
711 | Not all event models support a blocking wait - some die in that case |
|
|
712 | (programs might want to do that to stay interactive), so I<if you are |
|
|
713 | using this from a module, never require a blocking wait>. Instead, let the |
|
|
714 | caller decide whether the call will block or not (for example, by coupling |
|
|
715 | condition variables with some kind of request results and supporting |
|
|
716 | callbacks so the caller knows that getting the result will not block, |
|
|
717 | while still supporting blocking waits if the caller so desires). |
|
|
718 | |
|
|
719 | You can ensure that C<< -recv >> never blocks by setting a callback and |
|
|
720 | only calling C<< ->recv >> from within that callback (or at a later |
|
|
721 | time). This will work even when the event loop does not support blocking |
|
|
722 | waits otherwise. |
|
|
723 | |
|
|
724 | =item $bool = $cv->ready |
|
|
725 | |
|
|
726 | Returns true when the condition is "true", i.e. whether C<send> or |
|
|
727 | C<croak> have been called. |
|
|
728 | |
|
|
729 | =item $cb = $cv->cb ($cb->($cv)) |
|
|
730 | |
|
|
731 | This is a mutator function that returns the callback set and optionally |
|
|
732 | replaces it before doing so. |
|
|
733 | |
|
|
734 | The callback will be called when the condition becomes "true", i.e. when |
|
|
735 | C<send> or C<croak> are called, with the only argument being the condition |
|
|
736 | variable itself. Calling C<recv> inside the callback or at any later time |
|
|
737 | is guaranteed not to block. |
|
|
738 | |
|
|
739 | =back |
|
|
740 | |
|
|
741 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
|
|
742 | |
|
|
743 | The available backend classes are (every class has its own manpage): |
|
|
744 | |
|
|
745 | =over 4 |
|
|
746 | |
|
|
747 | =item Backends that are autoprobed when no other event loop can be found. |
|
|
748 | |
|
|
749 | EV is the preferred backend when no other event loop seems to be in |
|
|
750 | use. If EV is not installed, then AnyEvent will try Event, and, failing |
|
|
751 | that, will fall back to its own pure-perl implementation, which is |
|
|
752 | available everywhere as it comes with AnyEvent itself. |
|
|
753 | |
|
|
754 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
|
|
755 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
756 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
757 | |
|
|
758 | =item Backends that are transparently being picked up when they are used. |
|
|
759 | |
|
|
760 | These will be used when they are currently loaded when the first watcher |
|
|
761 | is created, in which case it is assumed that the application is using |
|
|
762 | them. This means that AnyEvent will automatically pick the right backend |
|
|
763 | when the main program loads an event module before anything starts to |
|
|
764 | create watchers. Nothing special needs to be done by the main program. |
|
|
765 | |
|
|
766 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
|
|
767 | AnyEvent::Impl::Tk based on Tk, very broken. |
|
|
768 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
769 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
770 | |
|
|
771 | =item Backends with special needs. |
|
|
772 | |
|
|
773 | Qt requires the Qt::Application to be instantiated first, but will |
|
|
774 | otherwise be picked up automatically. As long as the main program |
|
|
775 | instantiates the application before any AnyEvent watchers are created, |
|
|
776 | everything should just work. |
|
|
777 | |
|
|
778 | AnyEvent::Impl::Qt based on Qt. |
|
|
779 | |
|
|
780 | Support for IO::Async can only be partial, as it is too broken and |
|
|
781 | architecturally limited to even support the AnyEvent API. It also |
|
|
782 | is the only event loop that needs the loop to be set explicitly, so |
|
|
783 | it can only be used by a main program knowing about AnyEvent. See |
|
|
784 | L<AnyEvent::Impl::Async> for the gory details. |
|
|
785 | |
|
|
786 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
|
|
787 | |
|
|
788 | =item Event loops that are indirectly supported via other backends. |
|
|
789 | |
|
|
790 | Some event loops can be supported via other modules: |
|
|
791 | |
|
|
792 | There is no direct support for WxWidgets (L<Wx>) or L<Prima>. |
|
|
793 | |
|
|
794 | B<WxWidgets> has no support for watching file handles. However, you can |
|
|
795 | use WxWidgets through the POE adaptor, as POE has a Wx backend that simply |
|
|
796 | polls 20 times per second, which was considered to be too horrible to even |
|
|
797 | consider for AnyEvent. |
|
|
798 | |
|
|
799 | B<Prima> is not supported as nobody seems to be using it, but it has a POE |
|
|
800 | backend, so it can be supported through POE. |
|
|
801 | |
|
|
802 | AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to |
|
|
803 | load L<POE> when detecting them, in the hope that POE will pick them up, |
|
|
804 | in which case everything will be automatic. |
|
|
805 | |
|
|
806 | =back |
376 | |
807 | |
377 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
808 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
378 | |
809 | |
|
|
810 | These are not normally required to use AnyEvent, but can be useful to |
|
|
811 | write AnyEvent extension modules. |
|
|
812 | |
379 | =over 4 |
813 | =over 4 |
380 | |
814 | |
381 | =item $AnyEvent::MODEL |
815 | =item $AnyEvent::MODEL |
382 | |
816 | |
383 | Contains C<undef> until the first watcher is being created. Then it |
817 | Contains C<undef> until the first watcher is being created, before the |
|
|
818 | backend has been autodetected. |
|
|
819 | |
384 | contains the event model that is being used, which is the name of the |
820 | Afterwards it contains the event model that is being used, which is the |
385 | Perl class implementing the model. This class is usually one of the |
821 | name of the Perl class implementing the model. This class is usually one |
386 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
822 | of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the |
387 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
823 | case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it |
388 | |
824 | will be C<urxvt::anyevent>). |
389 | The known classes so far are: |
|
|
390 | |
|
|
391 | AnyEvent::Impl::CoroEV based on Coro::EV, best choice. |
|
|
392 | AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice. |
|
|
393 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
|
|
394 | AnyEvent::Impl::Event based on Event, second best choice. |
|
|
395 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
|
|
396 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
|
|
397 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
|
|
398 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
|
|
399 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
400 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
|
|
401 | |
|
|
402 | There is no support for WxWidgets, as WxWidgets has no support for |
|
|
403 | watching file handles. However, you can use WxWidgets through the |
|
|
404 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
|
|
405 | second, which was considered to be too horrible to even consider for |
|
|
406 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
|
|
407 | it's adaptor. |
|
|
408 | |
|
|
409 | AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when |
|
|
410 | autodetecting them. |
|
|
411 | |
825 | |
412 | =item AnyEvent::detect |
826 | =item AnyEvent::detect |
413 | |
827 | |
414 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
828 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
415 | if necessary. You should only call this function right before you would |
829 | if necessary. You should only call this function right before you would |
416 | have created an AnyEvent watcher anyway, that is, as late as possible at |
830 | have created an AnyEvent watcher anyway, that is, as late as possible at |
417 | runtime. |
831 | runtime, and not e.g. while initialising of your module. |
|
|
832 | |
|
|
833 | If you need to do some initialisation before AnyEvent watchers are |
|
|
834 | created, use C<post_detect>. |
|
|
835 | |
|
|
836 | =item $guard = AnyEvent::post_detect { BLOCK } |
|
|
837 | |
|
|
838 | Arranges for the code block to be executed as soon as the event model is |
|
|
839 | autodetected (or immediately if this has already happened). |
|
|
840 | |
|
|
841 | The block will be executed I<after> the actual backend has been detected |
|
|
842 | (C<$AnyEvent::MODEL> is set), but I<before> any watchers have been |
|
|
843 | created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do |
|
|
844 | other initialisations - see the sources of L<AnyEvent::Strict> or |
|
|
845 | L<AnyEvent::AIO> to see how this is used. |
|
|
846 | |
|
|
847 | The most common usage is to create some global watchers, without forcing |
|
|
848 | event module detection too early, for example, L<AnyEvent::AIO> creates |
|
|
849 | and installs the global L<IO::AIO> watcher in a C<post_detect> block to |
|
|
850 | avoid autodetecting the event module at load time. |
|
|
851 | |
|
|
852 | If called in scalar or list context, then it creates and returns an object |
|
|
853 | that automatically removes the callback again when it is destroyed. See |
|
|
854 | L<Coro::BDB> for a case where this is useful. |
|
|
855 | |
|
|
856 | =item @AnyEvent::post_detect |
|
|
857 | |
|
|
858 | If there are any code references in this array (you can C<push> to it |
|
|
859 | before or after loading AnyEvent), then they will called directly after |
|
|
860 | the event loop has been chosen. |
|
|
861 | |
|
|
862 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
|
|
863 | if it is defined then the event loop has already been detected, and the |
|
|
864 | array will be ignored. |
|
|
865 | |
|
|
866 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
|
|
867 | it,as it takes care of these details. |
|
|
868 | |
|
|
869 | This variable is mainly useful for modules that can do something useful |
|
|
870 | when AnyEvent is used and thus want to know when it is initialised, but do |
|
|
871 | not need to even load it by default. This array provides the means to hook |
|
|
872 | into AnyEvent passively, without loading it. |
418 | |
873 | |
419 | =back |
874 | =back |
420 | |
875 | |
421 | =head1 WHAT TO DO IN A MODULE |
876 | =head1 WHAT TO DO IN A MODULE |
422 | |
877 | |
… | |
… | |
426 | Be careful when you create watchers in the module body - AnyEvent will |
881 | Be careful when you create watchers in the module body - AnyEvent will |
427 | decide which event module to use as soon as the first method is called, so |
882 | decide which event module to use as soon as the first method is called, so |
428 | by calling AnyEvent in your module body you force the user of your module |
883 | by calling AnyEvent in your module body you force the user of your module |
429 | to load the event module first. |
884 | to load the event module first. |
430 | |
885 | |
431 | Never call C<< ->wait >> on a condition variable unless you I<know> that |
886 | Never call C<< ->recv >> on a condition variable unless you I<know> that |
432 | the C<< ->broadcast >> method has been called on it already. This is |
887 | the C<< ->send >> method has been called on it already. This is |
433 | because it will stall the whole program, and the whole point of using |
888 | because it will stall the whole program, and the whole point of using |
434 | events is to stay interactive. |
889 | events is to stay interactive. |
435 | |
890 | |
436 | It is fine, however, to call C<< ->wait >> when the user of your module |
891 | It is fine, however, to call C<< ->recv >> when the user of your module |
437 | requests it (i.e. if you create a http request object ad have a method |
892 | requests it (i.e. if you create a http request object ad have a method |
438 | called C<results> that returns the results, it should call C<< ->wait >> |
893 | called C<results> that returns the results, it should call C<< ->recv >> |
439 | freely, as the user of your module knows what she is doing. always). |
894 | freely, as the user of your module knows what she is doing. always). |
440 | |
895 | |
441 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
896 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
442 | |
897 | |
443 | There will always be a single main program - the only place that should |
898 | There will always be a single main program - the only place that should |
… | |
… | |
445 | |
900 | |
446 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
901 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
447 | do anything special (it does not need to be event-based) and let AnyEvent |
902 | do anything special (it does not need to be event-based) and let AnyEvent |
448 | decide which implementation to chose if some module relies on it. |
903 | decide which implementation to chose if some module relies on it. |
449 | |
904 | |
450 | If the main program relies on a specific event model. For example, in |
905 | If the main program relies on a specific event model - for example, in |
451 | Gtk2 programs you have to rely on the Glib module. You should load the |
906 | Gtk2 programs you have to rely on the Glib module - you should load the |
452 | event module before loading AnyEvent or any module that uses it: generally |
907 | event module before loading AnyEvent or any module that uses it: generally |
453 | speaking, you should load it as early as possible. The reason is that |
908 | speaking, you should load it as early as possible. The reason is that |
454 | modules might create watchers when they are loaded, and AnyEvent will |
909 | modules might create watchers when they are loaded, and AnyEvent will |
455 | decide on the event model to use as soon as it creates watchers, and it |
910 | decide on the event model to use as soon as it creates watchers, and it |
456 | might chose the wrong one unless you load the correct one yourself. |
911 | might chose the wrong one unless you load the correct one yourself. |
457 | |
912 | |
458 | You can chose to use a rather inefficient pure-perl implementation by |
913 | You can chose to use a pure-perl implementation by loading the |
459 | loading the C<AnyEvent::Impl::Perl> module, which gives you similar |
914 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
460 | behaviour everywhere, but letting AnyEvent chose is generally better. |
915 | everywhere, but letting AnyEvent chose the model is generally better. |
|
|
916 | |
|
|
917 | =head2 MAINLOOP EMULATION |
|
|
918 | |
|
|
919 | Sometimes (often for short test scripts, or even standalone programs who |
|
|
920 | only want to use AnyEvent), you do not want to run a specific event loop. |
|
|
921 | |
|
|
922 | In that case, you can use a condition variable like this: |
|
|
923 | |
|
|
924 | AnyEvent->condvar->recv; |
|
|
925 | |
|
|
926 | This has the effect of entering the event loop and looping forever. |
|
|
927 | |
|
|
928 | Note that usually your program has some exit condition, in which case |
|
|
929 | it is better to use the "traditional" approach of storing a condition |
|
|
930 | variable somewhere, waiting for it, and sending it when the program should |
|
|
931 | exit cleanly. |
|
|
932 | |
461 | |
933 | |
462 | =head1 OTHER MODULES |
934 | =head1 OTHER MODULES |
463 | |
935 | |
464 | The following is a non-exhaustive list of additional modules that use |
936 | The following is a non-exhaustive list of additional modules that use |
465 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
937 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
466 | in the same program. Some of the modules come with AnyEvent, some are |
938 | modules and other event loops in the same program. Some of the modules |
467 | available via CPAN. |
939 | come with AnyEvent, most are available via CPAN. |
468 | |
940 | |
469 | =over 4 |
941 | =over 4 |
470 | |
942 | |
471 | =item L<AnyEvent::Util> |
943 | =item L<AnyEvent::Util> |
472 | |
944 | |
473 | Contains various utility functions that replace often-used but blocking |
945 | Contains various utility functions that replace often-used but blocking |
474 | functions such as C<inet_aton> by event-/callback-based versions. |
946 | functions such as C<inet_aton> by event-/callback-based versions. |
475 | |
947 | |
|
|
948 | =item L<AnyEvent::Socket> |
|
|
949 | |
|
|
950 | Provides various utility functions for (internet protocol) sockets, |
|
|
951 | addresses and name resolution. Also functions to create non-blocking tcp |
|
|
952 | connections or tcp servers, with IPv6 and SRV record support and more. |
|
|
953 | |
476 | =item L<AnyEvent::Handle> |
954 | =item L<AnyEvent::Handle> |
477 | |
955 | |
478 | Provide read and write buffers and manages watchers for reads and writes. |
956 | Provide read and write buffers, manages watchers for reads and writes, |
|
|
957 | supports raw and formatted I/O, I/O queued and fully transparent and |
|
|
958 | non-blocking SSL/TLS (via L<AnyEvent::TLS>. |
479 | |
959 | |
480 | =item L<AnyEvent::Socket> |
960 | =item L<AnyEvent::DNS> |
481 | |
961 | |
482 | Provides a means to do non-blocking connects, accepts etc. |
962 | Provides rich asynchronous DNS resolver capabilities. |
|
|
963 | |
|
|
964 | =item L<AnyEvent::HTTP> |
|
|
965 | |
|
|
966 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
|
|
967 | HTTP requests. |
483 | |
968 | |
484 | =item L<AnyEvent::HTTPD> |
969 | =item L<AnyEvent::HTTPD> |
485 | |
970 | |
486 | Provides a simple web application server framework. |
971 | Provides a simple web application server framework. |
487 | |
972 | |
488 | =item L<AnyEvent::DNS> |
|
|
489 | |
|
|
490 | Provides asynchronous DNS resolver capabilities, beyond what |
|
|
491 | L<AnyEvent::Util> offers. |
|
|
492 | |
|
|
493 | =item L<AnyEvent::FastPing> |
973 | =item L<AnyEvent::FastPing> |
494 | |
974 | |
495 | The fastest ping in the west. |
975 | The fastest ping in the west. |
496 | |
976 | |
|
|
977 | =item L<AnyEvent::DBI> |
|
|
978 | |
|
|
979 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
980 | |
|
|
981 | =item L<AnyEvent::AIO> |
|
|
982 | |
|
|
983 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
984 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
985 | together. |
|
|
986 | |
|
|
987 | =item L<AnyEvent::BDB> |
|
|
988 | |
|
|
989 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
990 | L<BDB> and AnyEvent together. |
|
|
991 | |
|
|
992 | =item L<AnyEvent::GPSD> |
|
|
993 | |
|
|
994 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
995 | |
497 | =item L<Net::IRC3> |
996 | =item L<AnyEvent::IRC> |
498 | |
997 | |
499 | AnyEvent based IRC client module family. |
998 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
500 | |
999 | |
501 | =item L<Net::XMPP2> |
1000 | =item L<AnyEvent::XMPP> |
502 | |
1001 | |
503 | AnyEvent based XMPP (Jabber protocol) module family. |
1002 | AnyEvent based XMPP (Jabber protocol) module family (replacing the older |
|
|
1003 | Net::XMPP2>. |
|
|
1004 | |
|
|
1005 | =item L<AnyEvent::IGS> |
|
|
1006 | |
|
|
1007 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
1008 | L<App::IGS>). |
504 | |
1009 | |
505 | =item L<Net::FCP> |
1010 | =item L<Net::FCP> |
506 | |
1011 | |
507 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
1012 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
508 | of AnyEvent. |
1013 | of AnyEvent. |
… | |
… | |
511 | |
1016 | |
512 | High level API for event-based execution flow control. |
1017 | High level API for event-based execution flow control. |
513 | |
1018 | |
514 | =item L<Coro> |
1019 | =item L<Coro> |
515 | |
1020 | |
516 | Has special support for AnyEvent. |
1021 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
517 | |
|
|
518 | =item L<IO::Lambda> |
|
|
519 | |
|
|
520 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
|
|
521 | |
|
|
522 | =item L<IO::AIO> |
|
|
523 | |
|
|
524 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
525 | programmer. Can be trivially made to use AnyEvent. |
|
|
526 | |
|
|
527 | =item L<BDB> |
|
|
528 | |
|
|
529 | Truly asynchronous Berkeley DB access. Can be trivially made to use |
|
|
530 | AnyEvent. |
|
|
531 | |
1022 | |
532 | =back |
1023 | =back |
533 | |
1024 | |
534 | =cut |
1025 | =cut |
535 | |
1026 | |
536 | package AnyEvent; |
1027 | package AnyEvent; |
537 | |
1028 | |
538 | no warnings; |
1029 | no warnings; |
539 | use strict; |
1030 | use strict qw(vars subs); |
540 | |
1031 | |
541 | use Carp; |
1032 | use Carp (); |
542 | |
1033 | |
543 | our $VERSION = '3.3'; |
1034 | our $VERSION = 4.83; |
544 | our $MODEL; |
1035 | our $MODEL; |
545 | |
1036 | |
546 | our $AUTOLOAD; |
1037 | our $AUTOLOAD; |
547 | our @ISA; |
1038 | our @ISA; |
548 | |
1039 | |
|
|
1040 | our @REGISTRY; |
|
|
1041 | |
|
|
1042 | our $WIN32; |
|
|
1043 | |
|
|
1044 | BEGIN { |
|
|
1045 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
|
|
1046 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
|
|
1047 | |
|
|
1048 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
|
|
1049 | if ${^TAINT}; |
|
|
1050 | } |
|
|
1051 | |
549 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1052 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
550 | |
1053 | |
551 | our @REGISTRY; |
1054 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
|
|
1055 | |
|
|
1056 | { |
|
|
1057 | my $idx; |
|
|
1058 | $PROTOCOL{$_} = ++$idx |
|
|
1059 | for reverse split /\s*,\s*/, |
|
|
1060 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
|
|
1061 | } |
552 | |
1062 | |
553 | my @models = ( |
1063 | my @models = ( |
554 | [Coro::EV:: => AnyEvent::Impl::CoroEV::], |
|
|
555 | [Coro::Event:: => AnyEvent::Impl::CoroEvent::], |
|
|
556 | [EV:: => AnyEvent::Impl::EV::], |
1064 | [EV:: => AnyEvent::Impl::EV::], |
557 | [Event:: => AnyEvent::Impl::Event::], |
1065 | [Event:: => AnyEvent::Impl::Event::], |
558 | [Glib:: => AnyEvent::Impl::Glib::], |
1066 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
|
|
1067 | # everything below here will not be autoprobed |
|
|
1068 | # as the pureperl backend should work everywhere |
|
|
1069 | # and is usually faster |
|
|
1070 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
|
|
1071 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
559 | [Tk:: => AnyEvent::Impl::Tk::], |
1072 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
1073 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
|
|
1074 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
560 | [Wx:: => AnyEvent::Impl::POE::], |
1075 | [Wx:: => AnyEvent::Impl::POE::], |
561 | [Prima:: => AnyEvent::Impl::POE::], |
1076 | [Prima:: => AnyEvent::Impl::POE::], |
562 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
1077 | # IO::Async is just too broken - we would need workarounds for its |
563 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
1078 | # byzantine signal and broken child handling, among others. |
564 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1079 | # IO::Async is rather hard to detect, as it doesn't have any |
|
|
1080 | # obvious default class. |
565 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1081 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
566 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1082 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1083 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
567 | ); |
1084 | ); |
568 | |
1085 | |
569 | our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY); |
1086 | our %method = map +($_ => 1), |
|
|
1087 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
|
|
1088 | |
|
|
1089 | our @post_detect; |
|
|
1090 | |
|
|
1091 | sub post_detect(&) { |
|
|
1092 | my ($cb) = @_; |
|
|
1093 | |
|
|
1094 | if ($MODEL) { |
|
|
1095 | $cb->(); |
|
|
1096 | |
|
|
1097 | 1 |
|
|
1098 | } else { |
|
|
1099 | push @post_detect, $cb; |
|
|
1100 | |
|
|
1101 | defined wantarray |
|
|
1102 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1103 | : () |
|
|
1104 | } |
|
|
1105 | } |
|
|
1106 | |
|
|
1107 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1108 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1109 | } |
570 | |
1110 | |
571 | sub detect() { |
1111 | sub detect() { |
572 | unless ($MODEL) { |
1112 | unless ($MODEL) { |
573 | no strict 'refs'; |
1113 | no strict 'refs'; |
|
|
1114 | local $SIG{__DIE__}; |
574 | |
1115 | |
575 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1116 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
576 | my $model = "AnyEvent::Impl::$1"; |
1117 | my $model = "AnyEvent::Impl::$1"; |
577 | if (eval "require $model") { |
1118 | if (eval "require $model") { |
578 | $MODEL = $model; |
1119 | $MODEL = $model; |
579 | warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; |
1120 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $verbose > 1; |
580 | } else { |
1121 | } else { |
581 | warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; |
1122 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $verbose; |
582 | } |
1123 | } |
583 | } |
1124 | } |
584 | |
1125 | |
585 | # check for already loaded models |
1126 | # check for already loaded models |
586 | unless ($MODEL) { |
1127 | unless ($MODEL) { |
… | |
… | |
608 | last; |
1149 | last; |
609 | } |
1150 | } |
610 | } |
1151 | } |
611 | |
1152 | |
612 | $MODEL |
1153 | $MODEL |
613 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV (or Coro+EV), Event (or Coro+Event) or Glib."; |
1154 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
614 | } |
1155 | } |
615 | } |
1156 | } |
616 | |
1157 | |
|
|
1158 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1159 | |
617 | unshift @ISA, $MODEL; |
1160 | unshift @ISA, $MODEL; |
618 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1161 | |
|
|
1162 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
|
|
1163 | |
|
|
1164 | (shift @post_detect)->() while @post_detect; |
619 | } |
1165 | } |
620 | |
1166 | |
621 | $MODEL |
1167 | $MODEL |
622 | } |
1168 | } |
623 | |
1169 | |
624 | sub AUTOLOAD { |
1170 | sub AUTOLOAD { |
625 | (my $func = $AUTOLOAD) =~ s/.*://; |
1171 | (my $func = $AUTOLOAD) =~ s/.*://; |
626 | |
1172 | |
627 | $method{$func} |
1173 | $method{$func} |
628 | or croak "$func: not a valid method for AnyEvent objects"; |
1174 | or Carp::croak "$func: not a valid method for AnyEvent objects"; |
629 | |
1175 | |
630 | detect unless $MODEL; |
1176 | detect unless $MODEL; |
631 | |
1177 | |
632 | my $class = shift; |
1178 | my $class = shift; |
633 | $class->$func (@_); |
1179 | $class->$func (@_); |
634 | } |
1180 | } |
635 | |
1181 | |
|
|
1182 | # utility function to dup a filehandle. this is used by many backends |
|
|
1183 | # to support binding more than one watcher per filehandle (they usually |
|
|
1184 | # allow only one watcher per fd, so we dup it to get a different one). |
|
|
1185 | sub _dupfh($$;$$) { |
|
|
1186 | my ($poll, $fh, $r, $w) = @_; |
|
|
1187 | |
|
|
1188 | # cygwin requires the fh mode to be matching, unix doesn't |
|
|
1189 | my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&"); |
|
|
1190 | |
|
|
1191 | open my $fh2, $mode, $fh |
|
|
1192 | or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,"; |
|
|
1193 | |
|
|
1194 | # we assume CLOEXEC is already set by perl in all important cases |
|
|
1195 | |
|
|
1196 | ($fh2, $rw) |
|
|
1197 | } |
|
|
1198 | |
636 | package AnyEvent::Base; |
1199 | package AnyEvent::Base; |
637 | |
1200 | |
|
|
1201 | # default implementations for many methods |
|
|
1202 | |
|
|
1203 | BEGIN { |
|
|
1204 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
|
|
1205 | *_time = \&Time::HiRes::time; |
|
|
1206 | # if (eval "use POSIX (); (POSIX::times())... |
|
|
1207 | } else { |
|
|
1208 | *_time = sub { time }; # epic fail |
|
|
1209 | } |
|
|
1210 | } |
|
|
1211 | |
|
|
1212 | sub time { _time } |
|
|
1213 | sub now { _time } |
|
|
1214 | sub now_update { } |
|
|
1215 | |
638 | # default implementation for ->condvar, ->wait, ->broadcast |
1216 | # default implementation for ->condvar |
639 | |
1217 | |
640 | sub condvar { |
1218 | sub condvar { |
641 | bless \my $flag, "AnyEvent::Base::CondVar" |
1219 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
642 | } |
|
|
643 | |
|
|
644 | sub AnyEvent::Base::CondVar::broadcast { |
|
|
645 | ${$_[0]}++; |
|
|
646 | } |
|
|
647 | |
|
|
648 | sub AnyEvent::Base::CondVar::wait { |
|
|
649 | AnyEvent->one_event while !${$_[0]}; |
|
|
650 | } |
1220 | } |
651 | |
1221 | |
652 | # default implementation for ->signal |
1222 | # default implementation for ->signal |
653 | |
1223 | |
654 | our %SIG_CB; |
1224 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
|
|
1225 | |
|
|
1226 | sub _signal_exec { |
|
|
1227 | sysread $SIGPIPE_R, my $dummy, 4; |
|
|
1228 | |
|
|
1229 | while (%SIG_EV) { |
|
|
1230 | for (keys %SIG_EV) { |
|
|
1231 | delete $SIG_EV{$_}; |
|
|
1232 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1233 | } |
|
|
1234 | } |
|
|
1235 | } |
655 | |
1236 | |
656 | sub signal { |
1237 | sub signal { |
657 | my (undef, %arg) = @_; |
1238 | my (undef, %arg) = @_; |
658 | |
1239 | |
|
|
1240 | unless ($SIGPIPE_R) { |
|
|
1241 | require Fcntl; |
|
|
1242 | |
|
|
1243 | if (AnyEvent::WIN32) { |
|
|
1244 | require AnyEvent::Util; |
|
|
1245 | |
|
|
1246 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1247 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1248 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1249 | } else { |
|
|
1250 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1251 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1252 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1253 | |
|
|
1254 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1255 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1256 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1257 | } |
|
|
1258 | |
|
|
1259 | $SIGPIPE_R |
|
|
1260 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1261 | |
|
|
1262 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1263 | } |
|
|
1264 | |
659 | my $signal = uc $arg{signal} |
1265 | my $signal = uc $arg{signal} |
660 | or Carp::croak "required option 'signal' is missing"; |
1266 | or Carp::croak "required option 'signal' is missing"; |
661 | |
1267 | |
662 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1268 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
663 | $SIG{$signal} ||= sub { |
1269 | $SIG{$signal} ||= sub { |
664 | $_->() for values %{ $SIG_CB{$signal} || {} }; |
1270 | local $!; |
|
|
1271 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1272 | undef $SIG_EV{$signal}; |
665 | }; |
1273 | }; |
666 | |
1274 | |
667 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1275 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
668 | } |
1276 | } |
669 | |
1277 | |
670 | sub AnyEvent::Base::Signal::DESTROY { |
1278 | sub AnyEvent::Base::signal::DESTROY { |
671 | my ($signal, $cb) = @{$_[0]}; |
1279 | my ($signal, $cb) = @{$_[0]}; |
672 | |
1280 | |
673 | delete $SIG_CB{$signal}{$cb}; |
1281 | delete $SIG_CB{$signal}{$cb}; |
674 | |
1282 | |
|
|
1283 | # delete doesn't work with older perls - they then |
|
|
1284 | # print weird messages, or just unconditionally exit |
|
|
1285 | # instead of getting the default action. |
675 | $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; |
1286 | undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
676 | } |
1287 | } |
677 | |
1288 | |
678 | # default implementation for ->child |
1289 | # default implementation for ->child |
679 | |
1290 | |
680 | our %PID_CB; |
1291 | our %PID_CB; |
681 | our $CHLD_W; |
1292 | our $CHLD_W; |
682 | our $CHLD_DELAY_W; |
1293 | our $CHLD_DELAY_W; |
683 | our $PID_IDLE; |
|
|
684 | our $WNOHANG; |
1294 | our $WNOHANG; |
685 | |
1295 | |
686 | sub _child_wait { |
1296 | sub _sigchld { |
687 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1297 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
688 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1298 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
689 | (values %{ $PID_CB{0} || {} }); |
1299 | (values %{ $PID_CB{0} || {} }); |
690 | } |
1300 | } |
691 | |
|
|
692 | undef $PID_IDLE; |
|
|
693 | } |
|
|
694 | |
|
|
695 | sub _sigchld { |
|
|
696 | # make sure we deliver these changes "synchronous" with the event loop. |
|
|
697 | $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub { |
|
|
698 | undef $CHLD_DELAY_W; |
|
|
699 | &_child_wait; |
|
|
700 | }); |
|
|
701 | } |
1301 | } |
702 | |
1302 | |
703 | sub child { |
1303 | sub child { |
704 | my (undef, %arg) = @_; |
1304 | my (undef, %arg) = @_; |
705 | |
1305 | |
706 | defined (my $pid = $arg{pid} + 0) |
1306 | defined (my $pid = $arg{pid} + 0) |
707 | or Carp::croak "required option 'pid' is missing"; |
1307 | or Carp::croak "required option 'pid' is missing"; |
708 | |
1308 | |
709 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1309 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
710 | |
1310 | |
711 | unless ($WNOHANG) { |
|
|
712 | $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; |
1311 | $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
713 | } |
|
|
714 | |
1312 | |
715 | unless ($CHLD_W) { |
1313 | unless ($CHLD_W) { |
716 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1314 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
717 | # child could be a zombie already, so make at least one round |
1315 | # child could be a zombie already, so make at least one round |
718 | &_sigchld; |
1316 | &_sigchld; |
719 | } |
1317 | } |
720 | |
1318 | |
721 | bless [$pid, $arg{cb}], "AnyEvent::Base::Child" |
1319 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
722 | } |
1320 | } |
723 | |
1321 | |
724 | sub AnyEvent::Base::Child::DESTROY { |
1322 | sub AnyEvent::Base::child::DESTROY { |
725 | my ($pid, $cb) = @{$_[0]}; |
1323 | my ($pid, $cb) = @{$_[0]}; |
726 | |
1324 | |
727 | delete $PID_CB{$pid}{$cb}; |
1325 | delete $PID_CB{$pid}{$cb}; |
728 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1326 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
729 | |
1327 | |
730 | undef $CHLD_W unless keys %PID_CB; |
1328 | undef $CHLD_W unless keys %PID_CB; |
731 | } |
1329 | } |
|
|
1330 | |
|
|
1331 | # idle emulation is done by simply using a timer, regardless |
|
|
1332 | # of whether the process is idle or not, and not letting |
|
|
1333 | # the callback use more than 50% of the time. |
|
|
1334 | sub idle { |
|
|
1335 | my (undef, %arg) = @_; |
|
|
1336 | |
|
|
1337 | my ($cb, $w, $rcb) = $arg{cb}; |
|
|
1338 | |
|
|
1339 | $rcb = sub { |
|
|
1340 | if ($cb) { |
|
|
1341 | $w = _time; |
|
|
1342 | &$cb; |
|
|
1343 | $w = _time - $w; |
|
|
1344 | |
|
|
1345 | # never use more then 50% of the time for the idle watcher, |
|
|
1346 | # within some limits |
|
|
1347 | $w = 0.0001 if $w < 0.0001; |
|
|
1348 | $w = 5 if $w > 5; |
|
|
1349 | |
|
|
1350 | $w = AnyEvent->timer (after => $w, cb => $rcb); |
|
|
1351 | } else { |
|
|
1352 | # clean up... |
|
|
1353 | undef $w; |
|
|
1354 | undef $rcb; |
|
|
1355 | } |
|
|
1356 | }; |
|
|
1357 | |
|
|
1358 | $w = AnyEvent->timer (after => 0.05, cb => $rcb); |
|
|
1359 | |
|
|
1360 | bless \\$cb, "AnyEvent::Base::idle" |
|
|
1361 | } |
|
|
1362 | |
|
|
1363 | sub AnyEvent::Base::idle::DESTROY { |
|
|
1364 | undef $${$_[0]}; |
|
|
1365 | } |
|
|
1366 | |
|
|
1367 | package AnyEvent::CondVar; |
|
|
1368 | |
|
|
1369 | our @ISA = AnyEvent::CondVar::Base::; |
|
|
1370 | |
|
|
1371 | package AnyEvent::CondVar::Base; |
|
|
1372 | |
|
|
1373 | use overload |
|
|
1374 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
|
|
1375 | fallback => 1; |
|
|
1376 | |
|
|
1377 | our $WAITING; |
|
|
1378 | |
|
|
1379 | sub _send { |
|
|
1380 | # nop |
|
|
1381 | } |
|
|
1382 | |
|
|
1383 | sub send { |
|
|
1384 | my $cv = shift; |
|
|
1385 | $cv->{_ae_sent} = [@_]; |
|
|
1386 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
|
|
1387 | $cv->_send; |
|
|
1388 | } |
|
|
1389 | |
|
|
1390 | sub croak { |
|
|
1391 | $_[0]{_ae_croak} = $_[1]; |
|
|
1392 | $_[0]->send; |
|
|
1393 | } |
|
|
1394 | |
|
|
1395 | sub ready { |
|
|
1396 | $_[0]{_ae_sent} |
|
|
1397 | } |
|
|
1398 | |
|
|
1399 | sub _wait { |
|
|
1400 | $WAITING |
|
|
1401 | and !$_[0]{_ae_sent} |
|
|
1402 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; |
|
|
1403 | |
|
|
1404 | local $WAITING = 1; |
|
|
1405 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
|
|
1406 | } |
|
|
1407 | |
|
|
1408 | sub recv { |
|
|
1409 | $_[0]->_wait; |
|
|
1410 | |
|
|
1411 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
|
|
1412 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
|
|
1413 | } |
|
|
1414 | |
|
|
1415 | sub cb { |
|
|
1416 | $_[0]{_ae_cb} = $_[1] if @_ > 1; |
|
|
1417 | $_[0]{_ae_cb} |
|
|
1418 | } |
|
|
1419 | |
|
|
1420 | sub begin { |
|
|
1421 | ++$_[0]{_ae_counter}; |
|
|
1422 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
|
|
1423 | } |
|
|
1424 | |
|
|
1425 | sub end { |
|
|
1426 | return if --$_[0]{_ae_counter}; |
|
|
1427 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
|
|
1428 | } |
|
|
1429 | |
|
|
1430 | # undocumented/compatibility with pre-3.4 |
|
|
1431 | *broadcast = \&send; |
|
|
1432 | *wait = \&_wait; |
|
|
1433 | |
|
|
1434 | =head1 ERROR AND EXCEPTION HANDLING |
|
|
1435 | |
|
|
1436 | In general, AnyEvent does not do any error handling - it relies on the |
|
|
1437 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
|
|
1438 | the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict |
|
|
1439 | checking of all AnyEvent methods, however, which is highly useful during |
|
|
1440 | development. |
|
|
1441 | |
|
|
1442 | As for exception handling (i.e. runtime errors and exceptions thrown while |
|
|
1443 | executing a callback), this is not only highly event-loop specific, but |
|
|
1444 | also not in any way wrapped by this module, as this is the job of the main |
|
|
1445 | program. |
|
|
1446 | |
|
|
1447 | The pure perl event loop simply re-throws the exception (usually |
|
|
1448 | within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<< |
|
|
1449 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
|
|
1450 | so on. |
|
|
1451 | |
|
|
1452 | =head1 ENVIRONMENT VARIABLES |
|
|
1453 | |
|
|
1454 | The following environment variables are used by this module or its |
|
|
1455 | submodules. |
|
|
1456 | |
|
|
1457 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
1458 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
1459 | enabled. |
|
|
1460 | |
|
|
1461 | =over 4 |
|
|
1462 | |
|
|
1463 | =item C<PERL_ANYEVENT_VERBOSE> |
|
|
1464 | |
|
|
1465 | By default, AnyEvent will be completely silent except in fatal |
|
|
1466 | conditions. You can set this environment variable to make AnyEvent more |
|
|
1467 | talkative. |
|
|
1468 | |
|
|
1469 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
|
|
1470 | conditions, such as not being able to load the event model specified by |
|
|
1471 | C<PERL_ANYEVENT_MODEL>. |
|
|
1472 | |
|
|
1473 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
|
|
1474 | model it chooses. |
|
|
1475 | |
|
|
1476 | =item C<PERL_ANYEVENT_STRICT> |
|
|
1477 | |
|
|
1478 | AnyEvent does not do much argument checking by default, as thorough |
|
|
1479 | argument checking is very costly. Setting this variable to a true value |
|
|
1480 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
|
|
1481 | check the arguments passed to most method calls. If it finds any problems, |
|
|
1482 | it will croak. |
|
|
1483 | |
|
|
1484 | In other words, enables "strict" mode. |
|
|
1485 | |
|
|
1486 | Unlike C<use strict>, it is definitely recommended to keep it off in |
|
|
1487 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
|
|
1488 | developing programs can be very useful, however. |
|
|
1489 | |
|
|
1490 | =item C<PERL_ANYEVENT_MODEL> |
|
|
1491 | |
|
|
1492 | This can be used to specify the event model to be used by AnyEvent, before |
|
|
1493 | auto detection and -probing kicks in. It must be a string consisting |
|
|
1494 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
|
|
1495 | and the resulting module name is loaded and if the load was successful, |
|
|
1496 | used as event model. If it fails to load AnyEvent will proceed with |
|
|
1497 | auto detection and -probing. |
|
|
1498 | |
|
|
1499 | This functionality might change in future versions. |
|
|
1500 | |
|
|
1501 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
|
|
1502 | could start your program like this: |
|
|
1503 | |
|
|
1504 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
1505 | |
|
|
1506 | =item C<PERL_ANYEVENT_PROTOCOLS> |
|
|
1507 | |
|
|
1508 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
|
|
1509 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
|
|
1510 | of auto probing). |
|
|
1511 | |
|
|
1512 | Must be set to a comma-separated list of protocols or address families, |
|
|
1513 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
|
|
1514 | used, and preference will be given to protocols mentioned earlier in the |
|
|
1515 | list. |
|
|
1516 | |
|
|
1517 | This variable can effectively be used for denial-of-service attacks |
|
|
1518 | against local programs (e.g. when setuid), although the impact is likely |
|
|
1519 | small, as the program has to handle conenction and other failures anyways. |
|
|
1520 | |
|
|
1521 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
|
|
1522 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
|
|
1523 | - only support IPv4, never try to resolve or contact IPv6 |
|
|
1524 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
|
|
1525 | IPv6, but prefer IPv6 over IPv4. |
|
|
1526 | |
|
|
1527 | =item C<PERL_ANYEVENT_EDNS0> |
|
|
1528 | |
|
|
1529 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
|
|
1530 | for DNS. This extension is generally useful to reduce DNS traffic, but |
|
|
1531 | some (broken) firewalls drop such DNS packets, which is why it is off by |
|
|
1532 | default. |
|
|
1533 | |
|
|
1534 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
|
|
1535 | EDNS0 in its DNS requests. |
|
|
1536 | |
|
|
1537 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1538 | |
|
|
1539 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1540 | will create in parallel. |
|
|
1541 | |
|
|
1542 | =item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS> |
|
|
1543 | |
|
|
1544 | The default value for the C<max_outstanding> parameter for the default DNS |
|
|
1545 | resolver - this is the maximum number of parallel DNS requests that are |
|
|
1546 | sent to the DNS server. |
|
|
1547 | |
|
|
1548 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
|
|
1549 | |
|
|
1550 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
|
|
1551 | configuration) in the default resolver. When set to the empty string, no |
|
|
1552 | default config will be used. |
|
|
1553 | |
|
|
1554 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
|
|
1555 | |
|
|
1556 | When neither C<ca_file> nor C<ca_path> was specified during |
|
|
1557 | L<AnyEvent::TLS> context creation, and either of these environment |
|
|
1558 | variables exist, they will be used to specify CA certificate locations |
|
|
1559 | instead of a system-dependent default. |
|
|
1560 | |
|
|
1561 | =back |
732 | |
1562 | |
733 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1563 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
734 | |
1564 | |
735 | This is an advanced topic that you do not normally need to use AnyEvent in |
1565 | This is an advanced topic that you do not normally need to use AnyEvent in |
736 | a module. This section is only of use to event loop authors who want to |
1566 | a module. This section is only of use to event loop authors who want to |
… | |
… | |
770 | |
1600 | |
771 | I<rxvt-unicode> also cheats a bit by not providing blocking access to |
1601 | I<rxvt-unicode> also cheats a bit by not providing blocking access to |
772 | condition variables: code blocking while waiting for a condition will |
1602 | condition variables: code blocking while waiting for a condition will |
773 | C<die>. This still works with most modules/usages, and blocking calls must |
1603 | C<die>. This still works with most modules/usages, and blocking calls must |
774 | not be done in an interactive application, so it makes sense. |
1604 | not be done in an interactive application, so it makes sense. |
775 | |
|
|
776 | =head1 ENVIRONMENT VARIABLES |
|
|
777 | |
|
|
778 | The following environment variables are used by this module: |
|
|
779 | |
|
|
780 | =over 4 |
|
|
781 | |
|
|
782 | =item C<PERL_ANYEVENT_VERBOSE> |
|
|
783 | |
|
|
784 | By default, AnyEvent will be completely silent except in fatal |
|
|
785 | conditions. You can set this environment variable to make AnyEvent more |
|
|
786 | talkative. |
|
|
787 | |
|
|
788 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
|
|
789 | conditions, such as not being able to load the event model specified by |
|
|
790 | C<PERL_ANYEVENT_MODEL>. |
|
|
791 | |
|
|
792 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
|
|
793 | model it chooses. |
|
|
794 | |
|
|
795 | =item C<PERL_ANYEVENT_MODEL> |
|
|
796 | |
|
|
797 | This can be used to specify the event model to be used by AnyEvent, before |
|
|
798 | autodetection and -probing kicks in. It must be a string consisting |
|
|
799 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
|
|
800 | and the resulting module name is loaded and if the load was successful, |
|
|
801 | used as event model. If it fails to load AnyEvent will proceed with |
|
|
802 | autodetection and -probing. |
|
|
803 | |
|
|
804 | This functionality might change in future versions. |
|
|
805 | |
|
|
806 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
|
|
807 | could start your program like this: |
|
|
808 | |
|
|
809 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
810 | |
|
|
811 | =back |
|
|
812 | |
1605 | |
813 | =head1 EXAMPLE PROGRAM |
1606 | =head1 EXAMPLE PROGRAM |
814 | |
1607 | |
815 | The following program uses an I/O watcher to read data from STDIN, a timer |
1608 | The following program uses an I/O watcher to read data from STDIN, a timer |
816 | to display a message once per second, and a condition variable to quit the |
1609 | to display a message once per second, and a condition variable to quit the |
… | |
… | |
825 | poll => 'r', |
1618 | poll => 'r', |
826 | cb => sub { |
1619 | cb => sub { |
827 | warn "io event <$_[0]>\n"; # will always output <r> |
1620 | warn "io event <$_[0]>\n"; # will always output <r> |
828 | chomp (my $input = <STDIN>); # read a line |
1621 | chomp (my $input = <STDIN>); # read a line |
829 | warn "read: $input\n"; # output what has been read |
1622 | warn "read: $input\n"; # output what has been read |
830 | $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i |
1623 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
831 | }, |
1624 | }, |
832 | ); |
1625 | ); |
833 | |
1626 | |
834 | my $time_watcher; # can only be used once |
1627 | my $time_watcher; # can only be used once |
835 | |
1628 | |
… | |
… | |
840 | }); |
1633 | }); |
841 | } |
1634 | } |
842 | |
1635 | |
843 | new_timer; # create first timer |
1636 | new_timer; # create first timer |
844 | |
1637 | |
845 | $cv->wait; # wait until user enters /^q/i |
1638 | $cv->recv; # wait until user enters /^q/i |
846 | |
1639 | |
847 | =head1 REAL-WORLD EXAMPLE |
1640 | =head1 REAL-WORLD EXAMPLE |
848 | |
1641 | |
849 | Consider the L<Net::FCP> module. It features (among others) the following |
1642 | Consider the L<Net::FCP> module. It features (among others) the following |
850 | API calls, which are to freenet what HTTP GET requests are to http: |
1643 | API calls, which are to freenet what HTTP GET requests are to http: |
… | |
… | |
900 | syswrite $txn->{fh}, $txn->{request} |
1693 | syswrite $txn->{fh}, $txn->{request} |
901 | or die "connection or write error"; |
1694 | or die "connection or write error"; |
902 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1695 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
903 | |
1696 | |
904 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
1697 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
905 | result and signals any possible waiters that the request ahs finished: |
1698 | result and signals any possible waiters that the request has finished: |
906 | |
1699 | |
907 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1700 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
908 | |
1701 | |
909 | if (end-of-file or data complete) { |
1702 | if (end-of-file or data complete) { |
910 | $txn->{result} = $txn->{buf}; |
1703 | $txn->{result} = $txn->{buf}; |
911 | $txn->{finished}->broadcast; |
1704 | $txn->{finished}->send; |
912 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
1705 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
913 | } |
1706 | } |
914 | |
1707 | |
915 | The C<result> method, finally, just waits for the finished signal (if the |
1708 | The C<result> method, finally, just waits for the finished signal (if the |
916 | request was already finished, it doesn't wait, of course, and returns the |
1709 | request was already finished, it doesn't wait, of course, and returns the |
917 | data: |
1710 | data: |
918 | |
1711 | |
919 | $txn->{finished}->wait; |
1712 | $txn->{finished}->recv; |
920 | return $txn->{result}; |
1713 | return $txn->{result}; |
921 | |
1714 | |
922 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1715 | The actual code goes further and collects all errors (C<die>s, exceptions) |
923 | that occured during request processing. The C<result> method detects |
1716 | that occurred during request processing. The C<result> method detects |
924 | whether an exception as thrown (it is stored inside the $txn object) |
1717 | whether an exception as thrown (it is stored inside the $txn object) |
925 | and just throws the exception, which means connection errors and other |
1718 | and just throws the exception, which means connection errors and other |
926 | problems get reported tot he code that tries to use the result, not in a |
1719 | problems get reported tot he code that tries to use the result, not in a |
927 | random callback. |
1720 | random callback. |
928 | |
1721 | |
… | |
… | |
959 | |
1752 | |
960 | my $quit = AnyEvent->condvar; |
1753 | my $quit = AnyEvent->condvar; |
961 | |
1754 | |
962 | $fcp->txn_client_get ($url)->cb (sub { |
1755 | $fcp->txn_client_get ($url)->cb (sub { |
963 | ... |
1756 | ... |
964 | $quit->broadcast; |
1757 | $quit->send; |
965 | }); |
1758 | }); |
966 | |
1759 | |
967 | $quit->wait; |
1760 | $quit->recv; |
968 | |
1761 | |
969 | |
1762 | |
970 | =head1 BENCHMARKS |
1763 | =head1 BENCHMARKS |
971 | |
1764 | |
972 | To give you an idea of the performance and overheads that AnyEvent adds |
1765 | To give you an idea of the performance and overheads that AnyEvent adds |
… | |
… | |
974 | of various event loops I prepared some benchmarks. |
1767 | of various event loops I prepared some benchmarks. |
975 | |
1768 | |
976 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
1769 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
977 | |
1770 | |
978 | Here is a benchmark of various supported event models used natively and |
1771 | Here is a benchmark of various supported event models used natively and |
979 | through anyevent. The benchmark creates a lot of timers (with a zero |
1772 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
980 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1773 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
981 | which it is), lets them fire exactly once and destroys them again. |
1774 | which it is), lets them fire exactly once and destroys them again. |
982 | |
1775 | |
983 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1776 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
984 | distribution. |
1777 | distribution. |
… | |
… | |
1001 | all watchers, to avoid adding memory overhead. That means closure creation |
1794 | all watchers, to avoid adding memory overhead. That means closure creation |
1002 | and memory usage is not included in the figures. |
1795 | and memory usage is not included in the figures. |
1003 | |
1796 | |
1004 | I<invoke> is the time, in microseconds, used to invoke a simple |
1797 | I<invoke> is the time, in microseconds, used to invoke a simple |
1005 | callback. The callback simply counts down a Perl variable and after it was |
1798 | callback. The callback simply counts down a Perl variable and after it was |
1006 | invoked "watcher" times, it would C<< ->broadcast >> a condvar once to |
1799 | invoked "watcher" times, it would C<< ->send >> a condvar once to |
1007 | signal the end of this phase. |
1800 | signal the end of this phase. |
1008 | |
1801 | |
1009 | I<destroy> is the time, in microseconds, that it takes to destroy a single |
1802 | I<destroy> is the time, in microseconds, that it takes to destroy a single |
1010 | watcher. |
1803 | watcher. |
1011 | |
1804 | |
1012 | =head3 Results |
1805 | =head3 Results |
1013 | |
1806 | |
1014 | name watchers bytes create invoke destroy comment |
1807 | name watchers bytes create invoke destroy comment |
1015 | EV/EV 400000 244 0.56 0.46 0.31 EV native interface |
1808 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
1016 | EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers |
1809 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
1017 | CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal |
1810 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
1018 | Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation |
1811 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
1019 | Event/Event 16000 516 31.88 31.30 0.85 Event native interface |
1812 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
1020 | Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers |
1813 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
|
|
1814 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
|
|
1815 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
1021 | Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour |
1816 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
1022 | Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers |
1817 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
1023 | POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event |
1818 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
1024 | POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select |
1819 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1025 | |
1820 | |
1026 | =head3 Discussion |
1821 | =head3 Discussion |
1027 | |
1822 | |
1028 | The benchmark does I<not> measure scalability of the event loop very |
1823 | The benchmark does I<not> measure scalability of the event loop very |
1029 | well. For example, a select-based event loop (such as the pure perl one) |
1824 | well. For example, a select-based event loop (such as the pure perl one) |
… | |
… | |
1054 | performance becomes really bad with lots of file descriptors (and few of |
1849 | performance becomes really bad with lots of file descriptors (and few of |
1055 | them active), of course, but this was not subject of this benchmark. |
1850 | them active), of course, but this was not subject of this benchmark. |
1056 | |
1851 | |
1057 | The C<Event> module has a relatively high setup and callback invocation |
1852 | The C<Event> module has a relatively high setup and callback invocation |
1058 | cost, but overall scores in on the third place. |
1853 | cost, but overall scores in on the third place. |
|
|
1854 | |
|
|
1855 | C<IO::Async> performs admirably well, about on par with C<Event>, even |
|
|
1856 | when using its pure perl backend. |
1059 | |
1857 | |
1060 | C<Glib>'s memory usage is quite a bit higher, but it features a |
1858 | C<Glib>'s memory usage is quite a bit higher, but it features a |
1061 | faster callback invocation and overall ends up in the same class as |
1859 | faster callback invocation and overall ends up in the same class as |
1062 | C<Event>. However, Glib scales extremely badly, doubling the number of |
1860 | C<Event>. However, Glib scales extremely badly, doubling the number of |
1063 | watchers increases the processing time by more than a factor of four, |
1861 | watchers increases the processing time by more than a factor of four, |
… | |
… | |
1107 | |
1905 | |
1108 | =back |
1906 | =back |
1109 | |
1907 | |
1110 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1908 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1111 | |
1909 | |
1112 | This benchmark atcually benchmarks the event loop itself. It works by |
1910 | This benchmark actually benchmarks the event loop itself. It works by |
1113 | creating a number of "servers": each server consists of a socketpair, a |
1911 | creating a number of "servers": each server consists of a socket pair, a |
1114 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1912 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1115 | watcher waiting for input on one side of the socket. Each time the socket |
1913 | watcher waiting for input on one side of the socket. Each time the socket |
1116 | watcher reads a byte it will write that byte to a random other "server". |
1914 | watcher reads a byte it will write that byte to a random other "server". |
1117 | |
1915 | |
1118 | The effect is that there will be a lot of I/O watchers, only part of which |
1916 | The effect is that there will be a lot of I/O watchers, only part of which |
1119 | are active at any one point (so there is a constant number of active |
1917 | are active at any one point (so there is a constant number of active |
1120 | fds for each loop iterstaion, but which fds these are is random). The |
1918 | fds for each loop iteration, but which fds these are is random). The |
1121 | timeout is reset each time something is read because that reflects how |
1919 | timeout is reset each time something is read because that reflects how |
1122 | most timeouts work (and puts extra pressure on the event loops). |
1920 | most timeouts work (and puts extra pressure on the event loops). |
1123 | |
1921 | |
1124 | In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100 |
1922 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
1125 | (1%) are active. This mirrors the activity of large servers with many |
1923 | (1%) are active. This mirrors the activity of large servers with many |
1126 | connections, most of which are idle at any one point in time. |
1924 | connections, most of which are idle at any one point in time. |
1127 | |
1925 | |
1128 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1926 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1129 | distribution. |
1927 | distribution. |
… | |
… | |
1131 | =head3 Explanation of the columns |
1929 | =head3 Explanation of the columns |
1132 | |
1930 | |
1133 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1931 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1134 | each server has a read and write socket end). |
1932 | each server has a read and write socket end). |
1135 | |
1933 | |
1136 | I<create> is the time it takes to create a socketpair (which is |
1934 | I<create> is the time it takes to create a socket pair (which is |
1137 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1935 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1138 | |
1936 | |
1139 | I<request>, the most important value, is the time it takes to handle a |
1937 | I<request>, the most important value, is the time it takes to handle a |
1140 | single "request", that is, reading the token from the pipe and forwarding |
1938 | single "request", that is, reading the token from the pipe and forwarding |
1141 | it to another server. This includes deleting the old timeout and creating |
1939 | it to another server. This includes deleting the old timeout and creating |
1142 | a new one that moves the timeout into the future. |
1940 | a new one that moves the timeout into the future. |
1143 | |
1941 | |
1144 | =head3 Results |
1942 | =head3 Results |
1145 | |
1943 | |
1146 | name sockets create request |
1944 | name sockets create request |
1147 | EV 20000 69.01 11.16 |
1945 | EV 20000 69.01 11.16 |
1148 | Perl 20000 73.32 35.87 |
1946 | Perl 20000 73.32 35.87 |
|
|
1947 | IOAsync 20000 157.00 98.14 epoll |
|
|
1948 | IOAsync 20000 159.31 616.06 poll |
1149 | Event 20000 212.62 257.32 |
1949 | Event 20000 212.62 257.32 |
1150 | Glib 20000 651.16 1896.30 |
1950 | Glib 20000 651.16 1896.30 |
1151 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1951 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1152 | |
1952 | |
1153 | =head3 Discussion |
1953 | =head3 Discussion |
1154 | |
1954 | |
1155 | This benchmark I<does> measure scalability and overall performance of the |
1955 | This benchmark I<does> measure scalability and overall performance of the |
1156 | particular event loop. |
1956 | particular event loop. |
… | |
… | |
1158 | EV is again fastest. Since it is using epoll on my system, the setup time |
1958 | EV is again fastest. Since it is using epoll on my system, the setup time |
1159 | is relatively high, though. |
1959 | is relatively high, though. |
1160 | |
1960 | |
1161 | Perl surprisingly comes second. It is much faster than the C-based event |
1961 | Perl surprisingly comes second. It is much faster than the C-based event |
1162 | loops Event and Glib. |
1962 | loops Event and Glib. |
|
|
1963 | |
|
|
1964 | IO::Async performs very well when using its epoll backend, and still quite |
|
|
1965 | good compared to Glib when using its pure perl backend. |
1163 | |
1966 | |
1164 | Event suffers from high setup time as well (look at its code and you will |
1967 | Event suffers from high setup time as well (look at its code and you will |
1165 | understand why). Callback invocation also has a high overhead compared to |
1968 | understand why). Callback invocation also has a high overhead compared to |
1166 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
1969 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
1167 | uses select or poll in basically all documented configurations. |
1970 | uses select or poll in basically all documented configurations. |
… | |
… | |
1214 | speed most when you have lots of watchers, not when you only have a few of |
2017 | speed most when you have lots of watchers, not when you only have a few of |
1215 | them). |
2018 | them). |
1216 | |
2019 | |
1217 | EV is again fastest. |
2020 | EV is again fastest. |
1218 | |
2021 | |
1219 | Perl again comes second. It is noticably faster than the C-based event |
2022 | Perl again comes second. It is noticeably faster than the C-based event |
1220 | loops Event and Glib, although the difference is too small to really |
2023 | loops Event and Glib, although the difference is too small to really |
1221 | matter. |
2024 | matter. |
1222 | |
2025 | |
1223 | POE also performs much better in this case, but is is still far behind the |
2026 | POE also performs much better in this case, but is is still far behind the |
1224 | others. |
2027 | others. |
… | |
… | |
1230 | =item * C-based event loops perform very well with small number of |
2033 | =item * C-based event loops perform very well with small number of |
1231 | watchers, as the management overhead dominates. |
2034 | watchers, as the management overhead dominates. |
1232 | |
2035 | |
1233 | =back |
2036 | =back |
1234 | |
2037 | |
|
|
2038 | =head2 THE IO::Lambda BENCHMARK |
|
|
2039 | |
|
|
2040 | Recently I was told about the benchmark in the IO::Lambda manpage, which |
|
|
2041 | could be misinterpreted to make AnyEvent look bad. In fact, the benchmark |
|
|
2042 | simply compares IO::Lambda with POE, and IO::Lambda looks better (which |
|
|
2043 | shouldn't come as a surprise to anybody). As such, the benchmark is |
|
|
2044 | fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't |
|
|
2045 | very optimal. But how would AnyEvent compare when used without the extra |
|
|
2046 | baggage? To explore this, I wrote the equivalent benchmark for AnyEvent. |
|
|
2047 | |
|
|
2048 | The benchmark itself creates an echo-server, and then, for 500 times, |
|
|
2049 | connects to the echo server, sends a line, waits for the reply, and then |
|
|
2050 | creates the next connection. This is a rather bad benchmark, as it doesn't |
|
|
2051 | test the efficiency of the framework or much non-blocking I/O, but it is a |
|
|
2052 | benchmark nevertheless. |
|
|
2053 | |
|
|
2054 | name runtime |
|
|
2055 | Lambda/select 0.330 sec |
|
|
2056 | + optimized 0.122 sec |
|
|
2057 | Lambda/AnyEvent 0.327 sec |
|
|
2058 | + optimized 0.138 sec |
|
|
2059 | Raw sockets/select 0.077 sec |
|
|
2060 | POE/select, components 0.662 sec |
|
|
2061 | POE/select, raw sockets 0.226 sec |
|
|
2062 | POE/select, optimized 0.404 sec |
|
|
2063 | |
|
|
2064 | AnyEvent/select/nb 0.085 sec |
|
|
2065 | AnyEvent/EV/nb 0.068 sec |
|
|
2066 | +state machine 0.134 sec |
|
|
2067 | |
|
|
2068 | The benchmark is also a bit unfair (my fault): the IO::Lambda/POE |
|
|
2069 | benchmarks actually make blocking connects and use 100% blocking I/O, |
|
|
2070 | defeating the purpose of an event-based solution. All of the newly |
|
|
2071 | written AnyEvent benchmarks use 100% non-blocking connects (using |
|
|
2072 | AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS |
|
|
2073 | resolver), so AnyEvent is at a disadvantage here, as non-blocking connects |
|
|
2074 | generally require a lot more bookkeeping and event handling than blocking |
|
|
2075 | connects (which involve a single syscall only). |
|
|
2076 | |
|
|
2077 | The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which |
|
|
2078 | offers similar expressive power as POE and IO::Lambda, using conventional |
|
|
2079 | Perl syntax. This means that both the echo server and the client are 100% |
|
|
2080 | non-blocking, further placing it at a disadvantage. |
|
|
2081 | |
|
|
2082 | As you can see, the AnyEvent + EV combination even beats the |
|
|
2083 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
|
|
2084 | backend easily beats IO::Lambda and POE. |
|
|
2085 | |
|
|
2086 | And even the 100% non-blocking version written using the high-level (and |
|
|
2087 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
|
|
2088 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
|
|
2089 | in a non-blocking way. |
|
|
2090 | |
|
|
2091 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
|
|
2092 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
|
|
2093 | part of the IO::lambda distribution and were used without any changes. |
|
|
2094 | |
|
|
2095 | |
|
|
2096 | =head1 SIGNALS |
|
|
2097 | |
|
|
2098 | AnyEvent currently installs handlers for these signals: |
|
|
2099 | |
|
|
2100 | =over 4 |
|
|
2101 | |
|
|
2102 | =item SIGCHLD |
|
|
2103 | |
|
|
2104 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
|
|
2105 | emulation for event loops that do not support them natively. Also, some |
|
|
2106 | event loops install a similar handler. |
|
|
2107 | |
|
|
2108 | Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then |
|
|
2109 | AnyEvent will reset it to default, to avoid losing child exit statuses. |
|
|
2110 | |
|
|
2111 | =item SIGPIPE |
|
|
2112 | |
|
|
2113 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
|
|
2114 | when AnyEvent gets loaded. |
|
|
2115 | |
|
|
2116 | The rationale for this is that AnyEvent users usually do not really depend |
|
|
2117 | on SIGPIPE delivery (which is purely an optimisation for shell use, or |
|
|
2118 | badly-written programs), but C<SIGPIPE> can cause spurious and rare |
|
|
2119 | program exits as a lot of people do not expect C<SIGPIPE> when writing to |
|
|
2120 | some random socket. |
|
|
2121 | |
|
|
2122 | The rationale for installing a no-op handler as opposed to ignoring it is |
|
|
2123 | that this way, the handler will be restored to defaults on exec. |
|
|
2124 | |
|
|
2125 | Feel free to install your own handler, or reset it to defaults. |
|
|
2126 | |
|
|
2127 | =back |
|
|
2128 | |
|
|
2129 | =cut |
|
|
2130 | |
|
|
2131 | undef $SIG{CHLD} |
|
|
2132 | if $SIG{CHLD} eq 'IGNORE'; |
|
|
2133 | |
|
|
2134 | $SIG{PIPE} = sub { } |
|
|
2135 | unless defined $SIG{PIPE}; |
1235 | |
2136 | |
1236 | =head1 FORK |
2137 | =head1 FORK |
1237 | |
2138 | |
1238 | Most event libraries are not fork-safe. The ones who are usually are |
2139 | Most event libraries are not fork-safe. The ones who are usually are |
1239 | because they are so inefficient. Only L<EV> is fully fork-aware. |
2140 | because they rely on inefficient but fork-safe C<select> or C<poll> |
|
|
2141 | calls. Only L<EV> is fully fork-aware. |
1240 | |
2142 | |
1241 | If you have to fork, you must either do so I<before> creating your first |
2143 | If you have to fork, you must either do so I<before> creating your first |
1242 | watcher OR you must not use AnyEvent at all in the child. |
2144 | watcher OR you must not use AnyEvent at all in the child. |
1243 | |
2145 | |
1244 | |
2146 | |
… | |
… | |
1252 | specified in the variable. |
2154 | specified in the variable. |
1253 | |
2155 | |
1254 | You can make AnyEvent completely ignore this variable by deleting it |
2156 | You can make AnyEvent completely ignore this variable by deleting it |
1255 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
2157 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1256 | |
2158 | |
1257 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
2159 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1258 | |
2160 | |
1259 | use AnyEvent; |
2161 | use AnyEvent; |
|
|
2162 | |
|
|
2163 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
|
|
2164 | be used to probe what backend is used and gain other information (which is |
|
|
2165 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
|
|
2166 | $ENV{PERL_ANYEVENT_STRICT}. |
|
|
2167 | |
|
|
2168 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
2169 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
2170 | enabled. |
|
|
2171 | |
|
|
2172 | |
|
|
2173 | =head1 BUGS |
|
|
2174 | |
|
|
2175 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
|
|
2176 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
|
|
2177 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
|
|
2178 | memleaks, such as leaking on C<map> and C<grep> but it is usually not as |
|
|
2179 | pronounced). |
1260 | |
2180 | |
1261 | |
2181 | |
1262 | =head1 SEE ALSO |
2182 | =head1 SEE ALSO |
1263 | |
2183 | |
1264 | Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
2184 | Utility functions: L<AnyEvent::Util>. |
1265 | L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>, |
2185 | |
|
|
2186 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
1266 | L<Event::Lib>, L<Qt>, L<POE>. |
2187 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
1267 | |
2188 | |
1268 | Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, |
2189 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
1269 | L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, |
2190 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
1270 | L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>, |
2191 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
1271 | L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>. |
2192 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. |
1272 | |
2193 | |
|
|
2194 | Non-blocking file handles, sockets, TCP clients and |
|
|
2195 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
|
|
2196 | |
|
|
2197 | Asynchronous DNS: L<AnyEvent::DNS>. |
|
|
2198 | |
|
|
2199 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, |
|
|
2200 | L<Coro::Event>, |
|
|
2201 | |
1273 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
2202 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, |
|
|
2203 | L<AnyEvent::HTTP>. |
1274 | |
2204 | |
1275 | |
2205 | |
1276 | =head1 AUTHOR |
2206 | =head1 AUTHOR |
1277 | |
2207 | |
1278 | Marc Lehmann <schmorp@schmorp.de> |
2208 | Marc Lehmann <schmorp@schmorp.de> |
1279 | http://home.schmorp.de/ |
2209 | http://home.schmorp.de/ |
1280 | |
2210 | |
1281 | =cut |
2211 | =cut |
1282 | |
2212 | |
1283 | 1 |
2213 | 1 |
1284 | |
2214 | |