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, POE - various supported event loops |
6 | |
6 | |
7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
8 | |
8 | |
9 | use AnyEvent; |
9 | use AnyEvent; |
10 | |
10 | |
11 | my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { |
11 | my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... }); |
|
|
12 | |
|
|
13 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
|
|
14 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
|
|
15 | |
|
|
16 | print AnyEvent->now; # prints current event loop time |
|
|
17 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
|
|
18 | |
|
|
19 | my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); |
|
|
20 | |
|
|
21 | my $w = AnyEvent->child (pid => $pid, cb => sub { |
|
|
22 | my ($pid, $status) = @_; |
12 | ... |
23 | ... |
13 | }); |
24 | }); |
14 | |
25 | |
15 | my $w = AnyEvent->timer (after => $seconds, cb => sub { |
|
|
16 | ... |
|
|
17 | }); |
|
|
18 | |
|
|
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
26 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
|
|
27 | $w->send; # wake up current and all future recv's |
20 | $w->wait; # enters "main loop" till $condvar gets ->broadcast |
28 | $w->recv; # enters "main loop" till $condvar gets ->send |
21 | $w->broadcast; # wake up current and all future wait's |
29 | # use a condvar in callback mode: |
|
|
30 | $w->cb (sub { $_[0]->recv }); |
|
|
31 | |
|
|
32 | =head1 INTRODUCTION/TUTORIAL |
|
|
33 | |
|
|
34 | This manpage is mainly a reference manual. If you are interested |
|
|
35 | in a tutorial or some gentle introduction, have a look at the |
|
|
36 | L<AnyEvent::Intro> manpage. |
22 | |
37 | |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
38 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
24 | |
39 | |
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
40 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
26 | nowadays. So what is different about AnyEvent? |
41 | nowadays. So what is different about AnyEvent? |
27 | |
42 | |
28 | Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of |
43 | Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of |
29 | policy> and AnyEvent is I<small and efficient>. |
44 | policy> and AnyEvent is I<small and efficient>. |
30 | |
45 | |
31 | First and foremost, I<AnyEvent is not an event model> itself, it only |
46 | 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 |
47 | 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, |
48 | 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, |
49 | 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 |
50 | only one event loop can be active at the same time in a process. AnyEvent |
36 | helps hiding the differences between those event loops. |
51 | cannot change this, but it can hide the differences between those event |
|
|
52 | loops. |
37 | |
53 | |
38 | The goal of AnyEvent is to offer module authors the ability to do event |
54 | 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 |
55 | programming (waiting for I/O or timer events) without subscribing to a |
40 | religion, a way of living, and most importantly: without forcing your |
56 | 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 |
57 | module users into the same thing by forcing them to use the same event |
42 | model you use. |
58 | model you use. |
43 | |
59 | |
44 | For modules like POE or IO::Async (which is a total misnomer as it is |
60 | 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 |
61 | 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 |
62 | 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 |
63 | 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 |
64 | 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. |
65 | module are I<also> forced to use the same event loop you use. |
50 | |
66 | |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
67 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
68 | 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 |
69 | 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, |
70 | 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 |
71 | 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 |
72 | 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 |
73 | 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). |
74 | to AnyEvent, too, so it is future-proof). |
59 | |
75 | |
60 | In addition to being free of having to use I<the one and only true event |
76 | 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 |
77 | 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 |
78 | 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 |
79 | 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 |
80 | offering the functionality that is necessary, in as thin as a wrapper as |
65 | technically possible. |
81 | technically possible. |
66 | |
82 | |
|
|
83 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
|
|
84 | of useful functionality, such as an asynchronous DNS resolver, 100% |
|
|
85 | non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms |
|
|
86 | such as Windows) and lots of real-world knowledge and workarounds for |
|
|
87 | platform bugs and differences. |
|
|
88 | |
67 | Of course, if you want lots of policy (this can arguably be somewhat |
89 | 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 |
90 | useful) and you want to force your users to use the one and only event |
69 | model, you should I<not> use this module. |
91 | model, you should I<not> use this module. |
70 | |
|
|
71 | |
92 | |
72 | =head1 DESCRIPTION |
93 | =head1 DESCRIPTION |
73 | |
94 | |
74 | L<AnyEvent> provides an identical interface to multiple event loops. This |
95 | L<AnyEvent> provides an identical interface to multiple event loops. This |
75 | allows module authors to utilise an event loop without forcing module |
96 | allows module authors to utilise an event loop without forcing module |
… | |
… | |
79 | The interface itself is vaguely similar, but not identical to the L<Event> |
100 | The interface itself is vaguely similar, but not identical to the L<Event> |
80 | module. |
101 | module. |
81 | |
102 | |
82 | During the first call of any watcher-creation method, the module tries |
103 | During the first call of any watcher-creation method, the module tries |
83 | to detect the currently loaded event loop by probing whether one of the |
104 | to detect the currently loaded event loop by probing whether one of the |
84 | following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>, |
105 | following modules is already loaded: L<EV>, |
85 | L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, |
106 | L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, |
86 | L<POE>. The first one found is used. If none are found, the module tries |
107 | L<POE>. The first one found is used. If none are found, the module tries |
87 | to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl |
108 | to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl |
88 | adaptor should always succeed) in the order given. The first one that can |
109 | adaptor should always succeed) in the order given. The first one that can |
89 | be successfully loaded will be used. If, after this, still none could be |
110 | be successfully loaded will be used. If, after this, still none could be |
… | |
… | |
103 | starts using it, all bets are off. Maybe you should tell their authors to |
124 | starts using it, all bets are off. Maybe you should tell their authors to |
104 | use AnyEvent so their modules work together with others seamlessly... |
125 | use AnyEvent so their modules work together with others seamlessly... |
105 | |
126 | |
106 | The pure-perl implementation of AnyEvent is called |
127 | The pure-perl implementation of AnyEvent is called |
107 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
128 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
108 | explicitly. |
129 | explicitly and enjoy the high availability of that event loop :) |
109 | |
130 | |
110 | =head1 WATCHERS |
131 | =head1 WATCHERS |
111 | |
132 | |
112 | AnyEvent has the central concept of a I<watcher>, which is an object that |
133 | AnyEvent has the central concept of a I<watcher>, which is an object that |
113 | stores relevant data for each kind of event you are waiting for, such as |
134 | stores relevant data for each kind of event you are waiting for, such as |
114 | the callback to call, the filehandle to watch, etc. |
135 | the callback to call, the file handle to watch, etc. |
115 | |
136 | |
116 | These watchers are normal Perl objects with normal Perl lifetime. After |
137 | These watchers are normal Perl objects with normal Perl lifetime. After |
117 | creating a watcher it will immediately "watch" for events and invoke the |
138 | creating a watcher it will immediately "watch" for events and invoke the |
118 | callback when the event occurs (of course, only when the event model |
139 | callback when the event occurs (of course, only when the event model |
119 | is in control). |
140 | is in control). |
120 | |
141 | |
|
|
142 | Note that B<callbacks must not permanently change global variables> |
|
|
143 | potentially in use by the event loop (such as C<$_> or C<$[>) and that B<< |
|
|
144 | callbacks must not C<die> >>. The former is good programming practise in |
|
|
145 | Perl and the latter stems from the fact that exception handling differs |
|
|
146 | widely between event loops. |
|
|
147 | |
121 | To disable the watcher you have to destroy it (e.g. by setting the |
148 | To disable the watcher you have to destroy it (e.g. by setting the |
122 | variable you store it in to C<undef> or otherwise deleting all references |
149 | variable you store it in to C<undef> or otherwise deleting all references |
123 | to it). |
150 | to it). |
124 | |
151 | |
125 | All watchers are created by calling a method on the C<AnyEvent> class. |
152 | All watchers are created by calling a method on the C<AnyEvent> class. |
… | |
… | |
127 | Many watchers either are used with "recursion" (repeating timers for |
154 | Many watchers either are used with "recursion" (repeating timers for |
128 | example), or need to refer to their watcher object in other ways. |
155 | example), or need to refer to their watcher object in other ways. |
129 | |
156 | |
130 | An any way to achieve that is this pattern: |
157 | An any way to achieve that is this pattern: |
131 | |
158 | |
132 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
159 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
133 | # you can use $w here, for example to undef it |
160 | # you can use $w here, for example to undef it |
134 | undef $w; |
161 | undef $w; |
135 | }); |
162 | }); |
136 | |
163 | |
137 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
164 | Note that C<my $w; $w => combination. This is necessary because in Perl, |
138 | my variables are only visible after the statement in which they are |
165 | my variables are only visible after the statement in which they are |
139 | declared. |
166 | declared. |
140 | |
167 | |
141 | =head2 I/O WATCHERS |
168 | =head2 I/O WATCHERS |
142 | |
169 | |
143 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
170 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
144 | with the following mandatory key-value pairs as arguments: |
171 | with the following mandatory key-value pairs as arguments: |
145 | |
172 | |
146 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch |
173 | C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch |
|
|
174 | for events (AnyEvent might or might not keep a reference to this file |
|
|
175 | handle). Note that only file handles pointing to things for which |
|
|
176 | non-blocking operation makes sense are allowed. This includes sockets, |
|
|
177 | most character devices, pipes, fifos and so on, but not for example files |
|
|
178 | or block devices. |
|
|
179 | |
147 | for events. C<poll> must be a string that is either C<r> or C<w>, |
180 | C<poll> must be a string that is either C<r> or C<w>, which creates a |
148 | which creates a watcher waiting for "r"eadable or "w"ritable events, |
181 | watcher waiting for "r"eadable or "w"ritable events, respectively. |
|
|
182 | |
149 | respectively. C<cb> is the callback to invoke each time the file handle |
183 | C<cb> is the callback to invoke each time the file handle becomes ready. |
150 | becomes ready. |
|
|
151 | |
184 | |
152 | Although the callback might get passed parameters, their value and |
185 | Although the callback might get passed parameters, their value and |
153 | presence is undefined and you cannot rely on them. Portable AnyEvent |
186 | presence is undefined and you cannot rely on them. Portable AnyEvent |
154 | callbacks cannot use arguments passed to I/O watcher callbacks. |
187 | callbacks cannot use arguments passed to I/O watcher callbacks. |
155 | |
188 | |
… | |
… | |
159 | |
192 | |
160 | Some event loops issue spurious readyness notifications, so you should |
193 | Some event loops issue spurious readyness notifications, so you should |
161 | always use non-blocking calls when reading/writing from/to your file |
194 | always use non-blocking calls when reading/writing from/to your file |
162 | handles. |
195 | handles. |
163 | |
196 | |
164 | Example: |
|
|
165 | |
|
|
166 | # wait for readability of STDIN, then read a line and disable the watcher |
197 | Example: wait for readability of STDIN, then read a line and disable the |
|
|
198 | watcher. |
|
|
199 | |
167 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
200 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
168 | chomp (my $input = <STDIN>); |
201 | chomp (my $input = <STDIN>); |
169 | warn "read: $input\n"; |
202 | warn "read: $input\n"; |
170 | undef $w; |
203 | undef $w; |
171 | }); |
204 | }); |
… | |
… | |
181 | |
214 | |
182 | Although the callback might get passed parameters, their value and |
215 | Although the callback might get passed parameters, their value and |
183 | presence is undefined and you cannot rely on them. Portable AnyEvent |
216 | presence is undefined and you cannot rely on them. Portable AnyEvent |
184 | callbacks cannot use arguments passed to time watcher callbacks. |
217 | callbacks cannot use arguments passed to time watcher callbacks. |
185 | |
218 | |
186 | The timer callback will be invoked at most once: if you want a repeating |
219 | The callback will normally be invoked once only. If you specify another |
187 | timer you have to create a new watcher (this is a limitation by both Tk |
220 | parameter, C<interval>, as a strictly positive number (> 0), then the |
188 | and Glib). |
221 | callback will be invoked regularly at that interval (in fractional |
|
|
222 | seconds) after the first invocation. If C<interval> is specified with a |
|
|
223 | false value, then it is treated as if it were missing. |
189 | |
224 | |
190 | Example: |
225 | The callback will be rescheduled before invoking the callback, but no |
|
|
226 | attempt is done to avoid timer drift in most backends, so the interval is |
|
|
227 | only approximate. |
191 | |
228 | |
192 | # fire an event after 7.7 seconds |
229 | Example: fire an event after 7.7 seconds. |
|
|
230 | |
193 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
231 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
194 | warn "timeout\n"; |
232 | warn "timeout\n"; |
195 | }); |
233 | }); |
196 | |
234 | |
197 | # to cancel the timer: |
235 | # to cancel the timer: |
198 | undef $w; |
236 | undef $w; |
199 | |
237 | |
200 | Example 2: |
|
|
201 | |
|
|
202 | # fire an event after 0.5 seconds, then roughly every second |
238 | Example 2: fire an event after 0.5 seconds, then roughly every second. |
203 | my $w; |
|
|
204 | |
239 | |
205 | my $cb = sub { |
|
|
206 | # cancel the old timer while creating a new one |
|
|
207 | $w = AnyEvent->timer (after => 1, cb => $cb); |
240 | my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { |
|
|
241 | warn "timeout\n"; |
208 | }; |
242 | }; |
209 | |
|
|
210 | # start the "loop" by creating the first watcher |
|
|
211 | $w = AnyEvent->timer (after => 0.5, cb => $cb); |
|
|
212 | |
243 | |
213 | =head3 TIMING ISSUES |
244 | =head3 TIMING ISSUES |
214 | |
245 | |
215 | There are two ways to handle timers: based on real time (relative, "fire |
246 | There are two ways to handle timers: based on real time (relative, "fire |
216 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
247 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
… | |
… | |
228 | timers. |
259 | timers. |
229 | |
260 | |
230 | AnyEvent always prefers relative timers, if available, matching the |
261 | AnyEvent always prefers relative timers, if available, matching the |
231 | AnyEvent API. |
262 | AnyEvent API. |
232 | |
263 | |
|
|
264 | AnyEvent has two additional methods that return the "current time": |
|
|
265 | |
|
|
266 | =over 4 |
|
|
267 | |
|
|
268 | =item AnyEvent->time |
|
|
269 | |
|
|
270 | This returns the "current wallclock time" as a fractional number of |
|
|
271 | seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time> |
|
|
272 | return, and the result is guaranteed to be compatible with those). |
|
|
273 | |
|
|
274 | It progresses independently of any event loop processing, i.e. each call |
|
|
275 | will check the system clock, which usually gets updated frequently. |
|
|
276 | |
|
|
277 | =item AnyEvent->now |
|
|
278 | |
|
|
279 | This also returns the "current wallclock time", but unlike C<time>, above, |
|
|
280 | this value might change only once per event loop iteration, depending on |
|
|
281 | the event loop (most return the same time as C<time>, above). This is the |
|
|
282 | time that AnyEvent's timers get scheduled against. |
|
|
283 | |
|
|
284 | I<In almost all cases (in all cases if you don't care), this is the |
|
|
285 | function to call when you want to know the current time.> |
|
|
286 | |
|
|
287 | This function is also often faster then C<< AnyEvent->time >>, and |
|
|
288 | thus the preferred method if you want some timestamp (for example, |
|
|
289 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
|
|
290 | |
|
|
291 | The rest of this section is only of relevance if you try to be very exact |
|
|
292 | with your timing, you can skip it without bad conscience. |
|
|
293 | |
|
|
294 | For a practical example of when these times differ, consider L<Event::Lib> |
|
|
295 | and L<EV> and the following set-up: |
|
|
296 | |
|
|
297 | The event loop is running and has just invoked one of your callback at |
|
|
298 | time=500 (assume no other callbacks delay processing). In your callback, |
|
|
299 | you wait a second by executing C<sleep 1> (blocking the process for a |
|
|
300 | second) and then (at time=501) you create a relative timer that fires |
|
|
301 | after three seconds. |
|
|
302 | |
|
|
303 | With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will |
|
|
304 | both return C<501>, because that is the current time, and the timer will |
|
|
305 | be scheduled to fire at time=504 (C<501> + C<3>). |
|
|
306 | |
|
|
307 | With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current |
|
|
308 | time), but C<< AnyEvent->now >> returns C<500>, as that is the time the |
|
|
309 | last event processing phase started. With L<EV>, your timer gets scheduled |
|
|
310 | to run at time=503 (C<500> + C<3>). |
|
|
311 | |
|
|
312 | In one sense, L<Event::Lib> is more exact, as it uses the current time |
|
|
313 | regardless of any delays introduced by event processing. However, most |
|
|
314 | callbacks do not expect large delays in processing, so this causes a |
|
|
315 | higher drift (and a lot more system calls to get the current time). |
|
|
316 | |
|
|
317 | In another sense, L<EV> is more exact, as your timer will be scheduled at |
|
|
318 | the same time, regardless of how long event processing actually took. |
|
|
319 | |
|
|
320 | In either case, if you care (and in most cases, you don't), then you |
|
|
321 | can get whatever behaviour you want with any event loop, by taking the |
|
|
322 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
|
|
323 | account. |
|
|
324 | |
|
|
325 | =item AnyEvent->now_update |
|
|
326 | |
|
|
327 | Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache |
|
|
328 | the current time for each loop iteration (see the discussion of L<< |
|
|
329 | AnyEvent->now >>, above). |
|
|
330 | |
|
|
331 | When a callback runs for a long time (or when the process sleeps), then |
|
|
332 | this "current" time will differ substantially from the real time, which |
|
|
333 | might affect timers and time-outs. |
|
|
334 | |
|
|
335 | When this is the case, you can call this method, which will update the |
|
|
336 | event loop's idea of "current time". |
|
|
337 | |
|
|
338 | Note that updating the time I<might> cause some events to be handled. |
|
|
339 | |
|
|
340 | =back |
|
|
341 | |
233 | =head2 SIGNAL WATCHERS |
342 | =head2 SIGNAL WATCHERS |
234 | |
343 | |
235 | You can watch for signals using a signal watcher, C<signal> is the signal |
344 | You can watch for signals using a signal watcher, C<signal> is the signal |
236 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
345 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
237 | be invoked whenever a signal occurs. |
346 | callback to be invoked whenever a signal occurs. |
238 | |
347 | |
239 | Although the callback might get passed parameters, their value and |
348 | Although the callback might get passed parameters, their value and |
240 | presence is undefined and you cannot rely on them. Portable AnyEvent |
349 | presence is undefined and you cannot rely on them. Portable AnyEvent |
241 | callbacks cannot use arguments passed to signal watcher callbacks. |
350 | callbacks cannot use arguments passed to signal watcher callbacks. |
242 | |
351 | |
243 | Multiple signal occurances can be clumped together into one callback |
352 | Multiple signal occurrences can be clumped together into one callback |
244 | invocation, and callback invocation will be synchronous. synchronous means |
353 | invocation, and callback invocation will be synchronous. Synchronous means |
245 | that it might take a while until the signal gets handled by the process, |
354 | that it might take a while until the signal gets handled by the process, |
246 | but it is guarenteed not to interrupt any other callbacks. |
355 | but it is guaranteed not to interrupt any other callbacks. |
247 | |
356 | |
248 | The main advantage of using these watchers is that you can share a signal |
357 | The main advantage of using these watchers is that you can share a signal |
249 | between multiple watchers. |
358 | between multiple watchers. |
250 | |
359 | |
251 | This watcher might use C<%SIG>, so programs overwriting those signals |
360 | This watcher might use C<%SIG>, so programs overwriting those signals |
… | |
… | |
258 | =head2 CHILD PROCESS WATCHERS |
367 | =head2 CHILD PROCESS WATCHERS |
259 | |
368 | |
260 | You can also watch on a child process exit and catch its exit status. |
369 | You can also watch on a child process exit and catch its exit status. |
261 | |
370 | |
262 | The child process is specified by the C<pid> argument (if set to C<0>, it |
371 | The child process is specified by the C<pid> argument (if set to C<0>, it |
263 | watches for any child process exit). The watcher will trigger as often |
372 | watches for any child process exit). The watcher will triggered only when |
264 | as status change for the child are received. This works by installing a |
373 | the child process has finished and an exit status is available, not on |
265 | signal handler for C<SIGCHLD>. The callback will be called with the pid |
374 | any trace events (stopped/continued). |
266 | and exit status (as returned by waitpid), so unlike other watcher types, |
375 | |
267 | you I<can> rely on child watcher callback arguments. |
376 | The callback will be called with the pid and exit status (as returned by |
|
|
377 | waitpid), so unlike other watcher types, you I<can> rely on child watcher |
|
|
378 | callback arguments. |
|
|
379 | |
|
|
380 | This watcher type works by installing a signal handler for C<SIGCHLD>, |
|
|
381 | and since it cannot be shared, nothing else should use SIGCHLD or reap |
|
|
382 | random child processes (waiting for specific child processes, e.g. inside |
|
|
383 | C<system>, is just fine). |
268 | |
384 | |
269 | There is a slight catch to child watchers, however: you usually start them |
385 | There is a slight catch to child watchers, however: you usually start them |
270 | I<after> the child process was created, and this means the process could |
386 | I<after> the child process was created, and this means the process could |
271 | have exited already (and no SIGCHLD will be sent anymore). |
387 | have exited already (and no SIGCHLD will be sent anymore). |
272 | |
388 | |
… | |
… | |
278 | AnyEvent program, you I<have> to create at least one watcher before you |
394 | AnyEvent program, you I<have> to create at least one watcher before you |
279 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
395 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
280 | |
396 | |
281 | Example: fork a process and wait for it |
397 | Example: fork a process and wait for it |
282 | |
398 | |
283 | my $done = AnyEvent->condvar; |
399 | my $done = AnyEvent->condvar; |
284 | |
400 | |
285 | AnyEvent::detect; # force event module to be initialised |
|
|
286 | |
|
|
287 | my $pid = fork or exit 5; |
401 | my $pid = fork or exit 5; |
288 | |
402 | |
289 | my $w = AnyEvent->child ( |
403 | my $w = AnyEvent->child ( |
290 | pid => $pid, |
404 | pid => $pid, |
291 | cb => sub { |
405 | cb => sub { |
292 | my ($pid, $status) = @_; |
406 | my ($pid, $status) = @_; |
293 | warn "pid $pid exited with status $status"; |
407 | warn "pid $pid exited with status $status"; |
294 | $done->broadcast; |
408 | $done->send; |
295 | }, |
409 | }, |
296 | ); |
410 | ); |
297 | |
411 | |
298 | # do something else, then wait for process exit |
412 | # do something else, then wait for process exit |
299 | $done->wait; |
413 | $done->recv; |
300 | |
414 | |
301 | =head2 CONDITION VARIABLES |
415 | =head2 CONDITION VARIABLES |
302 | |
416 | |
|
|
417 | If you are familiar with some event loops you will know that all of them |
|
|
418 | require you to run some blocking "loop", "run" or similar function that |
|
|
419 | will actively watch for new events and call your callbacks. |
|
|
420 | |
|
|
421 | AnyEvent is different, it expects somebody else to run the event loop and |
|
|
422 | will only block when necessary (usually when told by the user). |
|
|
423 | |
|
|
424 | The instrument to do that is called a "condition variable", so called |
|
|
425 | because they represent a condition that must become true. |
|
|
426 | |
303 | Condition variables can be created by calling the C<< AnyEvent->condvar >> |
427 | Condition variables can be created by calling the C<< AnyEvent->condvar |
304 | method without any arguments. |
428 | >> method, usually without arguments. The only argument pair allowed is |
305 | |
429 | |
306 | A condition variable waits for a condition - precisely that the C<< |
430 | C<cb>, which specifies a callback to be called when the condition variable |
307 | ->broadcast >> method has been called. |
431 | becomes true, with the condition variable as the first argument (but not |
|
|
432 | the results). |
308 | |
433 | |
309 | They are very useful to signal that a condition has been fulfilled, for |
434 | After creation, the condition variable is "false" until it becomes "true" |
|
|
435 | by calling the C<send> method (or calling the condition variable as if it |
|
|
436 | were a callback, read about the caveats in the description for the C<< |
|
|
437 | ->send >> method). |
|
|
438 | |
|
|
439 | Condition variables are similar to callbacks, except that you can |
|
|
440 | optionally wait for them. They can also be called merge points - points |
|
|
441 | in time where multiple outstanding events have been processed. And yet |
|
|
442 | another way to call them is transactions - each condition variable can be |
|
|
443 | used to represent a transaction, which finishes at some point and delivers |
|
|
444 | a result. |
|
|
445 | |
|
|
446 | Condition variables are very useful to signal that something has finished, |
310 | example, if you write a module that does asynchronous http requests, |
447 | for example, if you write a module that does asynchronous http requests, |
311 | then a condition variable would be the ideal candidate to signal the |
448 | then a condition variable would be the ideal candidate to signal the |
312 | availability of results. |
449 | availability of results. The user can either act when the callback is |
|
|
450 | called or can synchronously C<< ->recv >> for the results. |
313 | |
451 | |
314 | You can also use condition variables to block your main program until |
452 | You can also use them to simulate traditional event loops - for example, |
315 | an event occurs - for example, you could C<< ->wait >> in your main |
453 | you can block your main program until an event occurs - for example, you |
316 | program until the user clicks the Quit button in your app, which would C<< |
454 | could C<< ->recv >> in your main program until the user clicks the Quit |
317 | ->broadcast >> the "quit" event. |
455 | button of your app, which would C<< ->send >> the "quit" event. |
318 | |
456 | |
319 | Note that condition variables recurse into the event loop - if you have |
457 | Note that condition variables recurse into the event loop - if you have |
320 | two pirces of code that call C<< ->wait >> in a round-robbin fashion, you |
458 | two pieces of code that call C<< ->recv >> in a round-robin fashion, you |
321 | lose. Therefore, condition variables are good to export to your caller, but |
459 | lose. Therefore, condition variables are good to export to your caller, but |
322 | you should avoid making a blocking wait yourself, at least in callbacks, |
460 | you should avoid making a blocking wait yourself, at least in callbacks, |
323 | as this asks for trouble. |
461 | as this asks for trouble. |
324 | |
462 | |
325 | This object has two methods: |
463 | Condition variables are represented by hash refs in perl, and the keys |
|
|
464 | used by AnyEvent itself are all named C<_ae_XXX> to make subclassing |
|
|
465 | easy (it is often useful to build your own transaction class on top of |
|
|
466 | AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call |
|
|
467 | it's C<new> method in your own C<new> method. |
|
|
468 | |
|
|
469 | There are two "sides" to a condition variable - the "producer side" which |
|
|
470 | eventually calls C<< -> send >>, and the "consumer side", which waits |
|
|
471 | for the send to occur. |
|
|
472 | |
|
|
473 | Example: wait for a timer. |
|
|
474 | |
|
|
475 | # wait till the result is ready |
|
|
476 | my $result_ready = AnyEvent->condvar; |
|
|
477 | |
|
|
478 | # do something such as adding a timer |
|
|
479 | # or socket watcher the calls $result_ready->send |
|
|
480 | # when the "result" is ready. |
|
|
481 | # in this case, we simply use a timer: |
|
|
482 | my $w = AnyEvent->timer ( |
|
|
483 | after => 1, |
|
|
484 | cb => sub { $result_ready->send }, |
|
|
485 | ); |
|
|
486 | |
|
|
487 | # this "blocks" (while handling events) till the callback |
|
|
488 | # calls send |
|
|
489 | $result_ready->recv; |
|
|
490 | |
|
|
491 | Example: wait for a timer, but take advantage of the fact that |
|
|
492 | condition variables are also code references. |
|
|
493 | |
|
|
494 | my $done = AnyEvent->condvar; |
|
|
495 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
|
|
496 | $done->recv; |
|
|
497 | |
|
|
498 | Example: Imagine an API that returns a condvar and doesn't support |
|
|
499 | callbacks. This is how you make a synchronous call, for example from |
|
|
500 | the main program: |
|
|
501 | |
|
|
502 | use AnyEvent::CouchDB; |
|
|
503 | |
|
|
504 | ... |
|
|
505 | |
|
|
506 | my @info = $couchdb->info->recv; |
|
|
507 | |
|
|
508 | And this is how you would just ste a callback to be called whenever the |
|
|
509 | results are available: |
|
|
510 | |
|
|
511 | $couchdb->info->cb (sub { |
|
|
512 | my @info = $_[0]->recv; |
|
|
513 | }); |
|
|
514 | |
|
|
515 | =head3 METHODS FOR PRODUCERS |
|
|
516 | |
|
|
517 | These methods should only be used by the producing side, i.e. the |
|
|
518 | code/module that eventually sends the signal. Note that it is also |
|
|
519 | the producer side which creates the condvar in most cases, but it isn't |
|
|
520 | uncommon for the consumer to create it as well. |
326 | |
521 | |
327 | =over 4 |
522 | =over 4 |
328 | |
523 | |
|
|
524 | =item $cv->send (...) |
|
|
525 | |
|
|
526 | Flag the condition as ready - a running C<< ->recv >> and all further |
|
|
527 | calls to C<recv> will (eventually) return after this method has been |
|
|
528 | called. If nobody is waiting the send will be remembered. |
|
|
529 | |
|
|
530 | If a callback has been set on the condition variable, it is called |
|
|
531 | immediately from within send. |
|
|
532 | |
|
|
533 | Any arguments passed to the C<send> call will be returned by all |
|
|
534 | future C<< ->recv >> calls. |
|
|
535 | |
|
|
536 | Condition variables are overloaded so one can call them directly |
|
|
537 | (as a code reference). Calling them directly is the same as calling |
|
|
538 | C<send>. Note, however, that many C-based event loops do not handle |
|
|
539 | overloading, so as tempting as it may be, passing a condition variable |
|
|
540 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
541 | support overloading, however, as well as all functions that use perl to |
|
|
542 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
543 | example). |
|
|
544 | |
|
|
545 | =item $cv->croak ($error) |
|
|
546 | |
|
|
547 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
|
|
548 | C<Carp::croak> with the given error message/object/scalar. |
|
|
549 | |
|
|
550 | This can be used to signal any errors to the condition variable |
|
|
551 | user/consumer. |
|
|
552 | |
|
|
553 | =item $cv->begin ([group callback]) |
|
|
554 | |
329 | =item $cv->wait |
555 | =item $cv->end |
330 | |
556 | |
331 | Wait (blocking if necessary) until the C<< ->broadcast >> method has been |
557 | These two methods are EXPERIMENTAL and MIGHT CHANGE. |
|
|
558 | |
|
|
559 | These two methods can be used to combine many transactions/events into |
|
|
560 | one. For example, a function that pings many hosts in parallel might want |
|
|
561 | to use a condition variable for the whole process. |
|
|
562 | |
|
|
563 | Every call to C<< ->begin >> will increment a counter, and every call to |
|
|
564 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
|
|
565 | >>, the (last) callback passed to C<begin> will be executed. That callback |
|
|
566 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
|
|
567 | callback was set, C<send> will be called without any arguments. |
|
|
568 | |
|
|
569 | Let's clarify this with the ping example: |
|
|
570 | |
|
|
571 | my $cv = AnyEvent->condvar; |
|
|
572 | |
|
|
573 | my %result; |
|
|
574 | $cv->begin (sub { $cv->send (\%result) }); |
|
|
575 | |
|
|
576 | for my $host (@list_of_hosts) { |
|
|
577 | $cv->begin; |
|
|
578 | ping_host_then_call_callback $host, sub { |
|
|
579 | $result{$host} = ...; |
|
|
580 | $cv->end; |
|
|
581 | }; |
|
|
582 | } |
|
|
583 | |
|
|
584 | $cv->end; |
|
|
585 | |
|
|
586 | This code fragment supposedly pings a number of hosts and calls |
|
|
587 | C<send> after results for all then have have been gathered - in any |
|
|
588 | order. To achieve this, the code issues a call to C<begin> when it starts |
|
|
589 | each ping request and calls C<end> when it has received some result for |
|
|
590 | it. Since C<begin> and C<end> only maintain a counter, the order in which |
|
|
591 | results arrive is not relevant. |
|
|
592 | |
|
|
593 | There is an additional bracketing call to C<begin> and C<end> outside the |
|
|
594 | loop, which serves two important purposes: first, it sets the callback |
|
|
595 | to be called once the counter reaches C<0>, and second, it ensures that |
|
|
596 | C<send> is called even when C<no> hosts are being pinged (the loop |
|
|
597 | doesn't execute once). |
|
|
598 | |
|
|
599 | This is the general pattern when you "fan out" into multiple subrequests: |
|
|
600 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
|
|
601 | is called at least once, and then, for each subrequest you start, call |
|
|
602 | C<begin> and for each subrequest you finish, call C<end>. |
|
|
603 | |
|
|
604 | =back |
|
|
605 | |
|
|
606 | =head3 METHODS FOR CONSUMERS |
|
|
607 | |
|
|
608 | These methods should only be used by the consuming side, i.e. the |
|
|
609 | code awaits the condition. |
|
|
610 | |
|
|
611 | =over 4 |
|
|
612 | |
|
|
613 | =item $cv->recv |
|
|
614 | |
|
|
615 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
332 | called on c<$cv>, while servicing other watchers normally. |
616 | >> methods have been called on c<$cv>, while servicing other watchers |
|
|
617 | normally. |
333 | |
618 | |
334 | You can only wait once on a condition - additional calls will return |
619 | You can only wait once on a condition - additional calls are valid but |
335 | immediately. |
620 | will return immediately. |
|
|
621 | |
|
|
622 | If an error condition has been set by calling C<< ->croak >>, then this |
|
|
623 | function will call C<croak>. |
|
|
624 | |
|
|
625 | In list context, all parameters passed to C<send> will be returned, |
|
|
626 | in scalar context only the first one will be returned. |
336 | |
627 | |
337 | Not all event models support a blocking wait - some die in that case |
628 | Not all event models support a blocking wait - some die in that case |
338 | (programs might want to do that to stay interactive), so I<if you are |
629 | (programs might want to do that to stay interactive), so I<if you are |
339 | using this from a module, never require a blocking wait>, but let the |
630 | using this from a module, never require a blocking wait>, but let the |
340 | caller decide whether the call will block or not (for example, by coupling |
631 | caller decide whether the call will block or not (for example, by coupling |
341 | condition variables with some kind of request results and supporting |
632 | condition variables with some kind of request results and supporting |
342 | callbacks so the caller knows that getting the result will not block, |
633 | callbacks so the caller knows that getting the result will not block, |
343 | while still suppporting blocking waits if the caller so desires). |
634 | while still supporting blocking waits if the caller so desires). |
344 | |
635 | |
345 | Another reason I<never> to C<< ->wait >> in a module is that you cannot |
636 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
346 | sensibly have two C<< ->wait >>'s in parallel, as that would require |
637 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
347 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
638 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
348 | can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and |
639 | can supply. |
349 | L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s |
|
|
350 | from different coroutines, however). |
|
|
351 | |
640 | |
352 | =item $cv->broadcast |
641 | The L<Coro> module, however, I<can> and I<does> supply coroutines and, in |
|
|
642 | fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe |
|
|
643 | versions and also integrates coroutines into AnyEvent, making blocking |
|
|
644 | C<< ->recv >> calls perfectly safe as long as they are done from another |
|
|
645 | coroutine (one that doesn't run the event loop). |
353 | |
646 | |
354 | Flag the condition as ready - a running C<< ->wait >> and all further |
647 | You can ensure that C<< -recv >> never blocks by setting a callback and |
355 | calls to C<wait> will (eventually) return after this method has been |
648 | only calling C<< ->recv >> from within that callback (or at a later |
356 | called. If nobody is waiting the broadcast will be remembered.. |
649 | time). This will work even when the event loop does not support blocking |
|
|
650 | waits otherwise. |
|
|
651 | |
|
|
652 | =item $bool = $cv->ready |
|
|
653 | |
|
|
654 | Returns true when the condition is "true", i.e. whether C<send> or |
|
|
655 | C<croak> have been called. |
|
|
656 | |
|
|
657 | =item $cb = $cv->cb ($cb->($cv)) |
|
|
658 | |
|
|
659 | This is a mutator function that returns the callback set and optionally |
|
|
660 | replaces it before doing so. |
|
|
661 | |
|
|
662 | The callback will be called when the condition becomes "true", i.e. when |
|
|
663 | C<send> or C<croak> are called, with the only argument being the condition |
|
|
664 | variable itself. Calling C<recv> inside the callback or at any later time |
|
|
665 | is guaranteed not to block. |
357 | |
666 | |
358 | =back |
667 | =back |
359 | |
|
|
360 | Example: |
|
|
361 | |
|
|
362 | # wait till the result is ready |
|
|
363 | my $result_ready = AnyEvent->condvar; |
|
|
364 | |
|
|
365 | # do something such as adding a timer |
|
|
366 | # or socket watcher the calls $result_ready->broadcast |
|
|
367 | # when the "result" is ready. |
|
|
368 | # in this case, we simply use a timer: |
|
|
369 | my $w = AnyEvent->timer ( |
|
|
370 | after => 1, |
|
|
371 | cb => sub { $result_ready->broadcast }, |
|
|
372 | ); |
|
|
373 | |
|
|
374 | # this "blocks" (while handling events) till the watcher |
|
|
375 | # calls broadcast |
|
|
376 | $result_ready->wait; |
|
|
377 | |
668 | |
378 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
669 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
379 | |
670 | |
380 | =over 4 |
671 | =over 4 |
381 | |
672 | |
… | |
… | |
387 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
678 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
388 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
679 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
389 | |
680 | |
390 | The known classes so far are: |
681 | The known classes so far are: |
391 | |
682 | |
392 | AnyEvent::Impl::CoroEV based on Coro::EV, best choice. |
|
|
393 | AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice. |
|
|
394 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
683 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
395 | AnyEvent::Impl::Event based on Event, second best choice. |
684 | AnyEvent::Impl::Event based on Event, second best choice. |
|
|
685 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
396 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
686 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
397 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
|
|
398 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
687 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
399 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
688 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
400 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
689 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
401 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
690 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
402 | |
691 | |
… | |
… | |
415 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
704 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
416 | if necessary. You should only call this function right before you would |
705 | if necessary. You should only call this function right before you would |
417 | have created an AnyEvent watcher anyway, that is, as late as possible at |
706 | have created an AnyEvent watcher anyway, that is, as late as possible at |
418 | runtime. |
707 | runtime. |
419 | |
708 | |
|
|
709 | =item $guard = AnyEvent::post_detect { BLOCK } |
|
|
710 | |
|
|
711 | Arranges for the code block to be executed as soon as the event model is |
|
|
712 | autodetected (or immediately if this has already happened). |
|
|
713 | |
|
|
714 | If called in scalar or list context, then it creates and returns an object |
|
|
715 | that automatically removes the callback again when it is destroyed. See |
|
|
716 | L<Coro::BDB> for a case where this is useful. |
|
|
717 | |
|
|
718 | =item @AnyEvent::post_detect |
|
|
719 | |
|
|
720 | If there are any code references in this array (you can C<push> to it |
|
|
721 | before or after loading AnyEvent), then they will called directly after |
|
|
722 | the event loop has been chosen. |
|
|
723 | |
|
|
724 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
|
|
725 | if it contains a true value then the event loop has already been detected, |
|
|
726 | and the array will be ignored. |
|
|
727 | |
|
|
728 | Best use C<AnyEvent::post_detect { BLOCK }> instead. |
|
|
729 | |
420 | =back |
730 | =back |
421 | |
731 | |
422 | =head1 WHAT TO DO IN A MODULE |
732 | =head1 WHAT TO DO IN A MODULE |
423 | |
733 | |
424 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
734 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
427 | Be careful when you create watchers in the module body - AnyEvent will |
737 | Be careful when you create watchers in the module body - AnyEvent will |
428 | decide which event module to use as soon as the first method is called, so |
738 | decide which event module to use as soon as the first method is called, so |
429 | by calling AnyEvent in your module body you force the user of your module |
739 | by calling AnyEvent in your module body you force the user of your module |
430 | to load the event module first. |
740 | to load the event module first. |
431 | |
741 | |
432 | Never call C<< ->wait >> on a condition variable unless you I<know> that |
742 | Never call C<< ->recv >> on a condition variable unless you I<know> that |
433 | the C<< ->broadcast >> method has been called on it already. This is |
743 | the C<< ->send >> method has been called on it already. This is |
434 | because it will stall the whole program, and the whole point of using |
744 | because it will stall the whole program, and the whole point of using |
435 | events is to stay interactive. |
745 | events is to stay interactive. |
436 | |
746 | |
437 | It is fine, however, to call C<< ->wait >> when the user of your module |
747 | It is fine, however, to call C<< ->recv >> when the user of your module |
438 | requests it (i.e. if you create a http request object ad have a method |
748 | requests it (i.e. if you create a http request object ad have a method |
439 | called C<results> that returns the results, it should call C<< ->wait >> |
749 | called C<results> that returns the results, it should call C<< ->recv >> |
440 | freely, as the user of your module knows what she is doing. always). |
750 | freely, as the user of your module knows what she is doing. always). |
441 | |
751 | |
442 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
752 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
443 | |
753 | |
444 | There will always be a single main program - the only place that should |
754 | There will always be a single main program - the only place that should |
… | |
… | |
446 | |
756 | |
447 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
757 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
448 | do anything special (it does not need to be event-based) and let AnyEvent |
758 | do anything special (it does not need to be event-based) and let AnyEvent |
449 | decide which implementation to chose if some module relies on it. |
759 | decide which implementation to chose if some module relies on it. |
450 | |
760 | |
451 | If the main program relies on a specific event model. For example, in |
761 | If the main program relies on a specific event model - for example, in |
452 | Gtk2 programs you have to rely on the Glib module. You should load the |
762 | Gtk2 programs you have to rely on the Glib module - you should load the |
453 | event module before loading AnyEvent or any module that uses it: generally |
763 | event module before loading AnyEvent or any module that uses it: generally |
454 | speaking, you should load it as early as possible. The reason is that |
764 | speaking, you should load it as early as possible. The reason is that |
455 | modules might create watchers when they are loaded, and AnyEvent will |
765 | modules might create watchers when they are loaded, and AnyEvent will |
456 | decide on the event model to use as soon as it creates watchers, and it |
766 | decide on the event model to use as soon as it creates watchers, and it |
457 | might chose the wrong one unless you load the correct one yourself. |
767 | might chose the wrong one unless you load the correct one yourself. |
458 | |
768 | |
459 | You can chose to use a rather inefficient pure-perl implementation by |
769 | You can chose to use a pure-perl implementation by loading the |
460 | loading the C<AnyEvent::Impl::Perl> module, which gives you similar |
770 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
461 | behaviour everywhere, but letting AnyEvent chose is generally better. |
771 | everywhere, but letting AnyEvent chose the model is generally better. |
|
|
772 | |
|
|
773 | =head2 MAINLOOP EMULATION |
|
|
774 | |
|
|
775 | Sometimes (often for short test scripts, or even standalone programs who |
|
|
776 | only want to use AnyEvent), you do not want to run a specific event loop. |
|
|
777 | |
|
|
778 | In that case, you can use a condition variable like this: |
|
|
779 | |
|
|
780 | AnyEvent->condvar->recv; |
|
|
781 | |
|
|
782 | This has the effect of entering the event loop and looping forever. |
|
|
783 | |
|
|
784 | Note that usually your program has some exit condition, in which case |
|
|
785 | it is better to use the "traditional" approach of storing a condition |
|
|
786 | variable somewhere, waiting for it, and sending it when the program should |
|
|
787 | exit cleanly. |
|
|
788 | |
|
|
789 | |
|
|
790 | =head1 OTHER MODULES |
|
|
791 | |
|
|
792 | The following is a non-exhaustive list of additional modules that use |
|
|
793 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
|
|
794 | in the same program. Some of the modules come with AnyEvent, some are |
|
|
795 | available via CPAN. |
|
|
796 | |
|
|
797 | =over 4 |
|
|
798 | |
|
|
799 | =item L<AnyEvent::Util> |
|
|
800 | |
|
|
801 | Contains various utility functions that replace often-used but blocking |
|
|
802 | functions such as C<inet_aton> by event-/callback-based versions. |
|
|
803 | |
|
|
804 | =item L<AnyEvent::Socket> |
|
|
805 | |
|
|
806 | Provides various utility functions for (internet protocol) sockets, |
|
|
807 | addresses and name resolution. Also functions to create non-blocking tcp |
|
|
808 | connections or tcp servers, with IPv6 and SRV record support and more. |
|
|
809 | |
|
|
810 | =item L<AnyEvent::Handle> |
|
|
811 | |
|
|
812 | Provide read and write buffers, manages watchers for reads and writes, |
|
|
813 | supports raw and formatted I/O, I/O queued and fully transparent and |
|
|
814 | non-blocking SSL/TLS. |
|
|
815 | |
|
|
816 | =item L<AnyEvent::DNS> |
|
|
817 | |
|
|
818 | Provides rich asynchronous DNS resolver capabilities. |
|
|
819 | |
|
|
820 | =item L<AnyEvent::HTTP> |
|
|
821 | |
|
|
822 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
|
|
823 | HTTP requests. |
|
|
824 | |
|
|
825 | =item L<AnyEvent::HTTPD> |
|
|
826 | |
|
|
827 | Provides a simple web application server framework. |
|
|
828 | |
|
|
829 | =item L<AnyEvent::FastPing> |
|
|
830 | |
|
|
831 | The fastest ping in the west. |
|
|
832 | |
|
|
833 | =item L<AnyEvent::DBI> |
|
|
834 | |
|
|
835 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
836 | |
|
|
837 | =item L<AnyEvent::AIO> |
|
|
838 | |
|
|
839 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
840 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
841 | together. |
|
|
842 | |
|
|
843 | =item L<AnyEvent::BDB> |
|
|
844 | |
|
|
845 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
846 | L<BDB> and AnyEvent together. |
|
|
847 | |
|
|
848 | =item L<AnyEvent::GPSD> |
|
|
849 | |
|
|
850 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
851 | |
|
|
852 | =item L<AnyEvent::IGS> |
|
|
853 | |
|
|
854 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
855 | L<App::IGS>). |
|
|
856 | |
|
|
857 | =item L<AnyEvent::IRC> |
|
|
858 | |
|
|
859 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
860 | |
|
|
861 | =item L<Net::XMPP2> |
|
|
862 | |
|
|
863 | AnyEvent based XMPP (Jabber protocol) module family. |
|
|
864 | |
|
|
865 | =item L<Net::FCP> |
|
|
866 | |
|
|
867 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
|
|
868 | of AnyEvent. |
|
|
869 | |
|
|
870 | =item L<Event::ExecFlow> |
|
|
871 | |
|
|
872 | High level API for event-based execution flow control. |
|
|
873 | |
|
|
874 | =item L<Coro> |
|
|
875 | |
|
|
876 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
|
|
877 | |
|
|
878 | =item L<IO::Lambda> |
|
|
879 | |
|
|
880 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
|
|
881 | |
|
|
882 | =back |
462 | |
883 | |
463 | =cut |
884 | =cut |
464 | |
885 | |
465 | package AnyEvent; |
886 | package AnyEvent; |
466 | |
887 | |
467 | no warnings; |
888 | no warnings; |
468 | use strict; |
889 | use strict qw(vars subs); |
469 | |
890 | |
470 | use Carp; |
891 | use Carp; |
471 | |
892 | |
472 | our $VERSION = '3.3'; |
893 | our $VERSION = 4.351; |
473 | our $MODEL; |
894 | our $MODEL; |
474 | |
895 | |
475 | our $AUTOLOAD; |
896 | our $AUTOLOAD; |
476 | our @ISA; |
897 | our @ISA; |
477 | |
898 | |
|
|
899 | our @REGISTRY; |
|
|
900 | |
|
|
901 | our $WIN32; |
|
|
902 | |
|
|
903 | BEGIN { |
|
|
904 | my $win32 = ! ! ($^O =~ /mswin32/i); |
|
|
905 | eval "sub WIN32(){ $win32 }"; |
|
|
906 | } |
|
|
907 | |
478 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
908 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
479 | |
909 | |
480 | our @REGISTRY; |
910 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
|
|
911 | |
|
|
912 | { |
|
|
913 | my $idx; |
|
|
914 | $PROTOCOL{$_} = ++$idx |
|
|
915 | for reverse split /\s*,\s*/, |
|
|
916 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
|
|
917 | } |
481 | |
918 | |
482 | my @models = ( |
919 | my @models = ( |
483 | [Coro::EV:: => AnyEvent::Impl::CoroEV::], |
|
|
484 | [Coro::Event:: => AnyEvent::Impl::CoroEvent::], |
|
|
485 | [EV:: => AnyEvent::Impl::EV::], |
920 | [EV:: => AnyEvent::Impl::EV::], |
486 | [Event:: => AnyEvent::Impl::Event::], |
921 | [Event:: => AnyEvent::Impl::Event::], |
487 | [Glib:: => AnyEvent::Impl::Glib::], |
|
|
488 | [Tk:: => AnyEvent::Impl::Tk::], |
|
|
489 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
490 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
491 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
922 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
492 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
923 | # everything below here will not be autoprobed |
|
|
924 | # as the pureperl backend should work everywhere |
|
|
925 | # and is usually faster |
|
|
926 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
927 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
493 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
928 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
494 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
929 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
495 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
930 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
|
|
931 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
932 | [Prima:: => AnyEvent::Impl::POE::], |
496 | ); |
933 | ); |
497 | |
934 | |
498 | our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY); |
935 | our %method = map +($_ => 1), |
|
|
936 | qw(io timer time now now_update signal child condvar one_event DESTROY); |
|
|
937 | |
|
|
938 | our @post_detect; |
|
|
939 | |
|
|
940 | sub post_detect(&) { |
|
|
941 | my ($cb) = @_; |
|
|
942 | |
|
|
943 | if ($MODEL) { |
|
|
944 | $cb->(); |
|
|
945 | |
|
|
946 | 1 |
|
|
947 | } else { |
|
|
948 | push @post_detect, $cb; |
|
|
949 | |
|
|
950 | defined wantarray |
|
|
951 | ? bless \$cb, "AnyEvent::Util::PostDetect" |
|
|
952 | : () |
|
|
953 | } |
|
|
954 | } |
|
|
955 | |
|
|
956 | sub AnyEvent::Util::PostDetect::DESTROY { |
|
|
957 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
958 | } |
499 | |
959 | |
500 | sub detect() { |
960 | sub detect() { |
501 | unless ($MODEL) { |
961 | unless ($MODEL) { |
502 | no strict 'refs'; |
962 | no strict 'refs'; |
|
|
963 | local $SIG{__DIE__}; |
503 | |
964 | |
504 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
965 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
505 | my $model = "AnyEvent::Impl::$1"; |
966 | my $model = "AnyEvent::Impl::$1"; |
506 | if (eval "require $model") { |
967 | if (eval "require $model") { |
507 | $MODEL = $model; |
968 | $MODEL = $model; |
… | |
… | |
537 | last; |
998 | last; |
538 | } |
999 | } |
539 | } |
1000 | } |
540 | |
1001 | |
541 | $MODEL |
1002 | $MODEL |
542 | 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."; |
1003 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
543 | } |
1004 | } |
544 | } |
1005 | } |
545 | |
1006 | |
|
|
1007 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1008 | |
546 | unshift @ISA, $MODEL; |
1009 | unshift @ISA, $MODEL; |
547 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1010 | |
|
|
1011 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
|
|
1012 | |
|
|
1013 | (shift @post_detect)->() while @post_detect; |
548 | } |
1014 | } |
549 | |
1015 | |
550 | $MODEL |
1016 | $MODEL |
551 | } |
1017 | } |
552 | |
1018 | |
… | |
… | |
560 | |
1026 | |
561 | my $class = shift; |
1027 | my $class = shift; |
562 | $class->$func (@_); |
1028 | $class->$func (@_); |
563 | } |
1029 | } |
564 | |
1030 | |
|
|
1031 | # utility function to dup a filehandle. this is used by many backends |
|
|
1032 | # to support binding more than one watcher per filehandle (they usually |
|
|
1033 | # allow only one watcher per fd, so we dup it to get a different one). |
|
|
1034 | sub _dupfh($$$$) { |
|
|
1035 | my ($poll, $fh, $r, $w) = @_; |
|
|
1036 | |
|
|
1037 | # cygwin requires the fh mode to be matching, unix doesn't |
|
|
1038 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
|
|
1039 | : $poll eq "w" ? ($w, ">") |
|
|
1040 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
|
|
1041 | |
|
|
1042 | open my $fh2, "$mode&" . fileno $fh |
|
|
1043 | or die "cannot dup() filehandle: $!,"; |
|
|
1044 | |
|
|
1045 | # we assume CLOEXEC is already set by perl in all important cases |
|
|
1046 | |
|
|
1047 | ($fh2, $rw) |
|
|
1048 | } |
|
|
1049 | |
565 | package AnyEvent::Base; |
1050 | package AnyEvent::Base; |
566 | |
1051 | |
|
|
1052 | # default implementations for many methods |
|
|
1053 | |
|
|
1054 | BEGIN { |
|
|
1055 | if (eval "use Time::HiRes (); time (); 1") { |
|
|
1056 | *_time = \&Time::HiRes::time; |
|
|
1057 | # if (eval "use POSIX (); (POSIX::times())... |
|
|
1058 | } else { |
|
|
1059 | *_time = sub { time }; # epic fail |
|
|
1060 | } |
|
|
1061 | } |
|
|
1062 | |
|
|
1063 | sub time { _time } |
|
|
1064 | sub now { _time } |
|
|
1065 | sub now_update { } |
|
|
1066 | |
567 | # default implementation for ->condvar, ->wait, ->broadcast |
1067 | # default implementation for ->condvar |
568 | |
1068 | |
569 | sub condvar { |
1069 | sub condvar { |
570 | bless \my $flag, "AnyEvent::Base::CondVar" |
1070 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
571 | } |
|
|
572 | |
|
|
573 | sub AnyEvent::Base::CondVar::broadcast { |
|
|
574 | ${$_[0]}++; |
|
|
575 | } |
|
|
576 | |
|
|
577 | sub AnyEvent::Base::CondVar::wait { |
|
|
578 | AnyEvent->one_event while !${$_[0]}; |
|
|
579 | } |
1071 | } |
580 | |
1072 | |
581 | # default implementation for ->signal |
1073 | # default implementation for ->signal |
582 | |
1074 | |
583 | our %SIG_CB; |
1075 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
|
|
1076 | |
|
|
1077 | sub _signal_exec { |
|
|
1078 | sysread $SIGPIPE_R, my $dummy, 4; |
|
|
1079 | |
|
|
1080 | while (%SIG_EV) { |
|
|
1081 | for (keys %SIG_EV) { |
|
|
1082 | delete $SIG_EV{$_}; |
|
|
1083 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1084 | } |
|
|
1085 | } |
|
|
1086 | } |
584 | |
1087 | |
585 | sub signal { |
1088 | sub signal { |
586 | my (undef, %arg) = @_; |
1089 | my (undef, %arg) = @_; |
587 | |
1090 | |
|
|
1091 | unless ($SIGPIPE_R) { |
|
|
1092 | require Fcntl; |
|
|
1093 | |
|
|
1094 | if (AnyEvent::WIN32) { |
|
|
1095 | require AnyEvent::Util; |
|
|
1096 | |
|
|
1097 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1098 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1099 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1100 | } else { |
|
|
1101 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1102 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1103 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1104 | } |
|
|
1105 | |
|
|
1106 | $SIGPIPE_R |
|
|
1107 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1108 | |
|
|
1109 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1110 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1111 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1112 | |
|
|
1113 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1114 | } |
|
|
1115 | |
588 | my $signal = uc $arg{signal} |
1116 | my $signal = uc $arg{signal} |
589 | or Carp::croak "required option 'signal' is missing"; |
1117 | or Carp::croak "required option 'signal' is missing"; |
590 | |
1118 | |
591 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1119 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
592 | $SIG{$signal} ||= sub { |
1120 | $SIG{$signal} ||= sub { |
593 | $_->() for values %{ $SIG_CB{$signal} || {} }; |
1121 | local $!; |
|
|
1122 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1123 | undef $SIG_EV{$signal}; |
594 | }; |
1124 | }; |
595 | |
1125 | |
596 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1126 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
597 | } |
1127 | } |
598 | |
1128 | |
599 | sub AnyEvent::Base::Signal::DESTROY { |
1129 | sub AnyEvent::Base::Signal::DESTROY { |
600 | my ($signal, $cb) = @{$_[0]}; |
1130 | my ($signal, $cb) = @{$_[0]}; |
601 | |
1131 | |
602 | delete $SIG_CB{$signal}{$cb}; |
1132 | delete $SIG_CB{$signal}{$cb}; |
603 | |
1133 | |
604 | $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; |
1134 | delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
605 | } |
1135 | } |
606 | |
1136 | |
607 | # default implementation for ->child |
1137 | # default implementation for ->child |
608 | |
1138 | |
609 | our %PID_CB; |
1139 | our %PID_CB; |
… | |
… | |
636 | or Carp::croak "required option 'pid' is missing"; |
1166 | or Carp::croak "required option 'pid' is missing"; |
637 | |
1167 | |
638 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1168 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
639 | |
1169 | |
640 | unless ($WNOHANG) { |
1170 | unless ($WNOHANG) { |
641 | $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; |
1171 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
642 | } |
1172 | } |
643 | |
1173 | |
644 | unless ($CHLD_W) { |
1174 | unless ($CHLD_W) { |
645 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1175 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
646 | # child could be a zombie already, so make at least one round |
1176 | # child could be a zombie already, so make at least one round |
… | |
… | |
656 | delete $PID_CB{$pid}{$cb}; |
1186 | delete $PID_CB{$pid}{$cb}; |
657 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1187 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
658 | |
1188 | |
659 | undef $CHLD_W unless keys %PID_CB; |
1189 | undef $CHLD_W unless keys %PID_CB; |
660 | } |
1190 | } |
|
|
1191 | |
|
|
1192 | package AnyEvent::CondVar; |
|
|
1193 | |
|
|
1194 | our @ISA = AnyEvent::CondVar::Base::; |
|
|
1195 | |
|
|
1196 | package AnyEvent::CondVar::Base; |
|
|
1197 | |
|
|
1198 | use overload |
|
|
1199 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
|
|
1200 | fallback => 1; |
|
|
1201 | |
|
|
1202 | sub _send { |
|
|
1203 | # nop |
|
|
1204 | } |
|
|
1205 | |
|
|
1206 | sub send { |
|
|
1207 | my $cv = shift; |
|
|
1208 | $cv->{_ae_sent} = [@_]; |
|
|
1209 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
|
|
1210 | $cv->_send; |
|
|
1211 | } |
|
|
1212 | |
|
|
1213 | sub croak { |
|
|
1214 | $_[0]{_ae_croak} = $_[1]; |
|
|
1215 | $_[0]->send; |
|
|
1216 | } |
|
|
1217 | |
|
|
1218 | sub ready { |
|
|
1219 | $_[0]{_ae_sent} |
|
|
1220 | } |
|
|
1221 | |
|
|
1222 | sub _wait { |
|
|
1223 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
|
|
1224 | } |
|
|
1225 | |
|
|
1226 | sub recv { |
|
|
1227 | $_[0]->_wait; |
|
|
1228 | |
|
|
1229 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
|
|
1230 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
|
|
1231 | } |
|
|
1232 | |
|
|
1233 | sub cb { |
|
|
1234 | $_[0]{_ae_cb} = $_[1] if @_ > 1; |
|
|
1235 | $_[0]{_ae_cb} |
|
|
1236 | } |
|
|
1237 | |
|
|
1238 | sub begin { |
|
|
1239 | ++$_[0]{_ae_counter}; |
|
|
1240 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
|
|
1241 | } |
|
|
1242 | |
|
|
1243 | sub end { |
|
|
1244 | return if --$_[0]{_ae_counter}; |
|
|
1245 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
|
|
1246 | } |
|
|
1247 | |
|
|
1248 | # undocumented/compatibility with pre-3.4 |
|
|
1249 | *broadcast = \&send; |
|
|
1250 | *wait = \&_wait; |
|
|
1251 | |
|
|
1252 | =head1 ERROR AND EXCEPTION HANDLING |
|
|
1253 | |
|
|
1254 | In general, AnyEvent does not do any error handling - it relies on the |
|
|
1255 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
|
|
1256 | the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict |
|
|
1257 | checking of all AnyEvent methods, however, which is highly useful during |
|
|
1258 | development. |
|
|
1259 | |
|
|
1260 | As for exception handling (i.e. runtime errors and exceptions thrown while |
|
|
1261 | executing a callback), this is not only highly event-loop specific, but |
|
|
1262 | also not in any way wrapped by this module, as this is the job of the main |
|
|
1263 | program. |
|
|
1264 | |
|
|
1265 | The pure perl event loop simply re-throws the exception (usually |
|
|
1266 | within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<< |
|
|
1267 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
|
|
1268 | so on. |
|
|
1269 | |
|
|
1270 | =head1 ENVIRONMENT VARIABLES |
|
|
1271 | |
|
|
1272 | The following environment variables are used by this module or its |
|
|
1273 | submodules: |
|
|
1274 | |
|
|
1275 | =over 4 |
|
|
1276 | |
|
|
1277 | =item C<PERL_ANYEVENT_VERBOSE> |
|
|
1278 | |
|
|
1279 | By default, AnyEvent will be completely silent except in fatal |
|
|
1280 | conditions. You can set this environment variable to make AnyEvent more |
|
|
1281 | talkative. |
|
|
1282 | |
|
|
1283 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
|
|
1284 | conditions, such as not being able to load the event model specified by |
|
|
1285 | C<PERL_ANYEVENT_MODEL>. |
|
|
1286 | |
|
|
1287 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
|
|
1288 | model it chooses. |
|
|
1289 | |
|
|
1290 | =item C<PERL_ANYEVENT_STRICT> |
|
|
1291 | |
|
|
1292 | AnyEvent does not do much argument checking by default, as thorough |
|
|
1293 | argument checking is very costly. Setting this variable to a true value |
|
|
1294 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
|
|
1295 | check the arguments passed to most method calls. If it finds any problems |
|
|
1296 | it will croak. |
|
|
1297 | |
|
|
1298 | In other words, enables "strict" mode. |
|
|
1299 | |
|
|
1300 | Unlike C<use strict>, it is definitely recommended ot keep it off in |
|
|
1301 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
|
|
1302 | developing programs can be very useful, however. |
|
|
1303 | |
|
|
1304 | =item C<PERL_ANYEVENT_MODEL> |
|
|
1305 | |
|
|
1306 | This can be used to specify the event model to be used by AnyEvent, before |
|
|
1307 | auto detection and -probing kicks in. It must be a string consisting |
|
|
1308 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
|
|
1309 | and the resulting module name is loaded and if the load was successful, |
|
|
1310 | used as event model. If it fails to load AnyEvent will proceed with |
|
|
1311 | auto detection and -probing. |
|
|
1312 | |
|
|
1313 | This functionality might change in future versions. |
|
|
1314 | |
|
|
1315 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
|
|
1316 | could start your program like this: |
|
|
1317 | |
|
|
1318 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
1319 | |
|
|
1320 | =item C<PERL_ANYEVENT_PROTOCOLS> |
|
|
1321 | |
|
|
1322 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
|
|
1323 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
|
|
1324 | of auto probing). |
|
|
1325 | |
|
|
1326 | Must be set to a comma-separated list of protocols or address families, |
|
|
1327 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
|
|
1328 | used, and preference will be given to protocols mentioned earlier in the |
|
|
1329 | list. |
|
|
1330 | |
|
|
1331 | This variable can effectively be used for denial-of-service attacks |
|
|
1332 | against local programs (e.g. when setuid), although the impact is likely |
|
|
1333 | small, as the program has to handle conenction and other failures anyways. |
|
|
1334 | |
|
|
1335 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
|
|
1336 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
|
|
1337 | - only support IPv4, never try to resolve or contact IPv6 |
|
|
1338 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
|
|
1339 | IPv6, but prefer IPv6 over IPv4. |
|
|
1340 | |
|
|
1341 | =item C<PERL_ANYEVENT_EDNS0> |
|
|
1342 | |
|
|
1343 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
|
|
1344 | for DNS. This extension is generally useful to reduce DNS traffic, but |
|
|
1345 | some (broken) firewalls drop such DNS packets, which is why it is off by |
|
|
1346 | default. |
|
|
1347 | |
|
|
1348 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
|
|
1349 | EDNS0 in its DNS requests. |
|
|
1350 | |
|
|
1351 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1352 | |
|
|
1353 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1354 | will create in parallel. |
|
|
1355 | |
|
|
1356 | =back |
661 | |
1357 | |
662 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1358 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
663 | |
1359 | |
664 | This is an advanced topic that you do not normally need to use AnyEvent in |
1360 | This is an advanced topic that you do not normally need to use AnyEvent in |
665 | a module. This section is only of use to event loop authors who want to |
1361 | a module. This section is only of use to event loop authors who want to |
… | |
… | |
699 | |
1395 | |
700 | I<rxvt-unicode> also cheats a bit by not providing blocking access to |
1396 | I<rxvt-unicode> also cheats a bit by not providing blocking access to |
701 | condition variables: code blocking while waiting for a condition will |
1397 | condition variables: code blocking while waiting for a condition will |
702 | C<die>. This still works with most modules/usages, and blocking calls must |
1398 | C<die>. This still works with most modules/usages, and blocking calls must |
703 | not be done in an interactive application, so it makes sense. |
1399 | not be done in an interactive application, so it makes sense. |
704 | |
|
|
705 | =head1 ENVIRONMENT VARIABLES |
|
|
706 | |
|
|
707 | The following environment variables are used by this module: |
|
|
708 | |
|
|
709 | =over 4 |
|
|
710 | |
|
|
711 | =item C<PERL_ANYEVENT_VERBOSE> |
|
|
712 | |
|
|
713 | By default, AnyEvent will be completely silent except in fatal |
|
|
714 | conditions. You can set this environment variable to make AnyEvent more |
|
|
715 | talkative. |
|
|
716 | |
|
|
717 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
|
|
718 | conditions, such as not being able to load the event model specified by |
|
|
719 | C<PERL_ANYEVENT_MODEL>. |
|
|
720 | |
|
|
721 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
|
|
722 | model it chooses. |
|
|
723 | |
|
|
724 | =item C<PERL_ANYEVENT_MODEL> |
|
|
725 | |
|
|
726 | This can be used to specify the event model to be used by AnyEvent, before |
|
|
727 | autodetection and -probing kicks in. It must be a string consisting |
|
|
728 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
|
|
729 | and the resulting module name is loaded and if the load was successful, |
|
|
730 | used as event model. If it fails to load AnyEvent will proceed with |
|
|
731 | autodetection and -probing. |
|
|
732 | |
|
|
733 | This functionality might change in future versions. |
|
|
734 | |
|
|
735 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
|
|
736 | could start your program like this: |
|
|
737 | |
|
|
738 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
739 | |
|
|
740 | =back |
|
|
741 | |
1400 | |
742 | =head1 EXAMPLE PROGRAM |
1401 | =head1 EXAMPLE PROGRAM |
743 | |
1402 | |
744 | The following program uses an I/O watcher to read data from STDIN, a timer |
1403 | The following program uses an I/O watcher to read data from STDIN, a timer |
745 | to display a message once per second, and a condition variable to quit the |
1404 | to display a message once per second, and a condition variable to quit the |
… | |
… | |
754 | poll => 'r', |
1413 | poll => 'r', |
755 | cb => sub { |
1414 | cb => sub { |
756 | warn "io event <$_[0]>\n"; # will always output <r> |
1415 | warn "io event <$_[0]>\n"; # will always output <r> |
757 | chomp (my $input = <STDIN>); # read a line |
1416 | chomp (my $input = <STDIN>); # read a line |
758 | warn "read: $input\n"; # output what has been read |
1417 | warn "read: $input\n"; # output what has been read |
759 | $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i |
1418 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
760 | }, |
1419 | }, |
761 | ); |
1420 | ); |
762 | |
1421 | |
763 | my $time_watcher; # can only be used once |
1422 | my $time_watcher; # can only be used once |
764 | |
1423 | |
… | |
… | |
769 | }); |
1428 | }); |
770 | } |
1429 | } |
771 | |
1430 | |
772 | new_timer; # create first timer |
1431 | new_timer; # create first timer |
773 | |
1432 | |
774 | $cv->wait; # wait until user enters /^q/i |
1433 | $cv->recv; # wait until user enters /^q/i |
775 | |
1434 | |
776 | =head1 REAL-WORLD EXAMPLE |
1435 | =head1 REAL-WORLD EXAMPLE |
777 | |
1436 | |
778 | Consider the L<Net::FCP> module. It features (among others) the following |
1437 | Consider the L<Net::FCP> module. It features (among others) the following |
779 | API calls, which are to freenet what HTTP GET requests are to http: |
1438 | API calls, which are to freenet what HTTP GET requests are to http: |
… | |
… | |
829 | syswrite $txn->{fh}, $txn->{request} |
1488 | syswrite $txn->{fh}, $txn->{request} |
830 | or die "connection or write error"; |
1489 | or die "connection or write error"; |
831 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1490 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
832 | |
1491 | |
833 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
1492 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
834 | result and signals any possible waiters that the request ahs finished: |
1493 | result and signals any possible waiters that the request has finished: |
835 | |
1494 | |
836 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1495 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
837 | |
1496 | |
838 | if (end-of-file or data complete) { |
1497 | if (end-of-file or data complete) { |
839 | $txn->{result} = $txn->{buf}; |
1498 | $txn->{result} = $txn->{buf}; |
840 | $txn->{finished}->broadcast; |
1499 | $txn->{finished}->send; |
841 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
1500 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
842 | } |
1501 | } |
843 | |
1502 | |
844 | The C<result> method, finally, just waits for the finished signal (if the |
1503 | The C<result> method, finally, just waits for the finished signal (if the |
845 | request was already finished, it doesn't wait, of course, and returns the |
1504 | request was already finished, it doesn't wait, of course, and returns the |
846 | data: |
1505 | data: |
847 | |
1506 | |
848 | $txn->{finished}->wait; |
1507 | $txn->{finished}->recv; |
849 | return $txn->{result}; |
1508 | return $txn->{result}; |
850 | |
1509 | |
851 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1510 | The actual code goes further and collects all errors (C<die>s, exceptions) |
852 | that occured during request processing. The C<result> method detects |
1511 | that occurred during request processing. The C<result> method detects |
853 | whether an exception as thrown (it is stored inside the $txn object) |
1512 | whether an exception as thrown (it is stored inside the $txn object) |
854 | and just throws the exception, which means connection errors and other |
1513 | and just throws the exception, which means connection errors and other |
855 | problems get reported tot he code that tries to use the result, not in a |
1514 | problems get reported tot he code that tries to use the result, not in a |
856 | random callback. |
1515 | random callback. |
857 | |
1516 | |
… | |
… | |
888 | |
1547 | |
889 | my $quit = AnyEvent->condvar; |
1548 | my $quit = AnyEvent->condvar; |
890 | |
1549 | |
891 | $fcp->txn_client_get ($url)->cb (sub { |
1550 | $fcp->txn_client_get ($url)->cb (sub { |
892 | ... |
1551 | ... |
893 | $quit->broadcast; |
1552 | $quit->send; |
894 | }); |
1553 | }); |
895 | |
1554 | |
896 | $quit->wait; |
1555 | $quit->recv; |
897 | |
1556 | |
898 | |
1557 | |
899 | =head1 BENCHMARKS |
1558 | =head1 BENCHMARKS |
900 | |
1559 | |
901 | To give you an idea of the performance and overheads that AnyEvent adds |
1560 | To give you an idea of the performance and overheads that AnyEvent adds |
… | |
… | |
903 | of various event loops I prepared some benchmarks. |
1562 | of various event loops I prepared some benchmarks. |
904 | |
1563 | |
905 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
1564 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
906 | |
1565 | |
907 | Here is a benchmark of various supported event models used natively and |
1566 | Here is a benchmark of various supported event models used natively and |
908 | through anyevent. The benchmark creates a lot of timers (with a zero |
1567 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
909 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1568 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
910 | which it is), lets them fire exactly once and destroys them again. |
1569 | which it is), lets them fire exactly once and destroys them again. |
911 | |
1570 | |
912 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1571 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
913 | distribution. |
1572 | distribution. |
… | |
… | |
930 | all watchers, to avoid adding memory overhead. That means closure creation |
1589 | all watchers, to avoid adding memory overhead. That means closure creation |
931 | and memory usage is not included in the figures. |
1590 | and memory usage is not included in the figures. |
932 | |
1591 | |
933 | I<invoke> is the time, in microseconds, used to invoke a simple |
1592 | I<invoke> is the time, in microseconds, used to invoke a simple |
934 | callback. The callback simply counts down a Perl variable and after it was |
1593 | callback. The callback simply counts down a Perl variable and after it was |
935 | invoked "watcher" times, it would C<< ->broadcast >> a condvar once to |
1594 | invoked "watcher" times, it would C<< ->send >> a condvar once to |
936 | signal the end of this phase. |
1595 | signal the end of this phase. |
937 | |
1596 | |
938 | I<destroy> is the time, in microseconds, that it takes to destroy a single |
1597 | I<destroy> is the time, in microseconds, that it takes to destroy a single |
939 | watcher. |
1598 | watcher. |
940 | |
1599 | |
941 | =head3 Results |
1600 | =head3 Results |
942 | |
1601 | |
943 | name watchers bytes create invoke destroy comment |
1602 | name watchers bytes create invoke destroy comment |
944 | EV/EV 400000 244 0.56 0.46 0.31 EV native interface |
1603 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
945 | EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers |
1604 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
946 | CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal |
1605 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
947 | Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation |
1606 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
948 | Event/Event 16000 516 31.88 31.30 0.85 Event native interface |
1607 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
949 | Event/Any 16000 936 39.17 33.63 1.43 Event + AnyEvent watchers |
1608 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
950 | Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour |
1609 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
951 | Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers |
1610 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
952 | POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event |
1611 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
953 | POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select |
1612 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
954 | |
1613 | |
955 | =head3 Discussion |
1614 | =head3 Discussion |
956 | |
1615 | |
957 | The benchmark does I<not> measure scalability of the event loop very |
1616 | The benchmark does I<not> measure scalability of the event loop very |
958 | well. For example, a select-based event loop (such as the pure perl one) |
1617 | well. For example, a select-based event loop (such as the pure perl one) |
959 | can never compete with an event loop that uses epoll when the number of |
1618 | can never compete with an event loop that uses epoll when the number of |
960 | file descriptors grows high. In this benchmark, all events become ready at |
1619 | file descriptors grows high. In this benchmark, all events become ready at |
961 | the same time, so select/poll-based implementations get an unnatural speed |
1620 | the same time, so select/poll-based implementations get an unnatural speed |
962 | boost. |
1621 | boost. |
|
|
1622 | |
|
|
1623 | Also, note that the number of watchers usually has a nonlinear effect on |
|
|
1624 | overall speed, that is, creating twice as many watchers doesn't take twice |
|
|
1625 | the time - usually it takes longer. This puts event loops tested with a |
|
|
1626 | higher number of watchers at a disadvantage. |
|
|
1627 | |
|
|
1628 | To put the range of results into perspective, consider that on the |
|
|
1629 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
|
|
1630 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
|
|
1631 | cycles with POE. |
963 | |
1632 | |
964 | C<EV> is the sole leader regarding speed and memory use, which are both |
1633 | C<EV> is the sole leader regarding speed and memory use, which are both |
965 | maximal/minimal, respectively. Even when going through AnyEvent, it uses |
1634 | maximal/minimal, respectively. Even when going through AnyEvent, it uses |
966 | far less memory than any other event loop and is still faster than Event |
1635 | far less memory than any other event loop and is still faster than Event |
967 | natively. |
1636 | natively. |
… | |
… | |
990 | file descriptor is dup()ed for each watcher. This shows that the dup() |
1659 | file descriptor is dup()ed for each watcher. This shows that the dup() |
991 | employed by some adaptors is not a big performance issue (it does incur a |
1660 | employed by some adaptors is not a big performance issue (it does incur a |
992 | hidden memory cost inside the kernel which is not reflected in the figures |
1661 | hidden memory cost inside the kernel which is not reflected in the figures |
993 | above). |
1662 | above). |
994 | |
1663 | |
995 | C<POE>, regardless of underlying event loop (whether using its pure |
1664 | C<POE>, regardless of underlying event loop (whether using its pure perl |
996 | perl select-based backend or the Event module, the POE-EV backend |
1665 | select-based backend or the Event module, the POE-EV backend couldn't |
997 | couldn't be tested because it wasn't working) shows abysmal performance |
1666 | be tested because it wasn't working) shows abysmal performance and |
998 | and memory usage: Watchers use almost 30 times as much memory as |
1667 | memory usage with AnyEvent: Watchers use almost 30 times as much memory |
999 | EV watchers, and 10 times as much memory as Event (the high memory |
1668 | as EV watchers, and 10 times as much memory as Event (the high memory |
1000 | requirements are caused by requiring a session for each watcher). Watcher |
1669 | requirements are caused by requiring a session for each watcher). Watcher |
1001 | invocation speed is almost 900 times slower than with AnyEvent's pure perl |
1670 | invocation speed is almost 900 times slower than with AnyEvent's pure perl |
|
|
1671 | implementation. |
|
|
1672 | |
1002 | implementation. The design of the POE adaptor class in AnyEvent can not |
1673 | The design of the POE adaptor class in AnyEvent can not really account |
1003 | really account for this, as session creation overhead is small compared |
1674 | for the performance issues, though, as session creation overhead is |
1004 | to execution of the state machine, which is coded pretty optimally within |
1675 | small compared to execution of the state machine, which is coded pretty |
1005 | L<AnyEvent::Impl::POE>. POE simply seems to be abysmally slow. |
1676 | optimally within L<AnyEvent::Impl::POE> (and while everybody agrees that |
|
|
1677 | using multiple sessions is not a good approach, especially regarding |
|
|
1678 | memory usage, even the author of POE could not come up with a faster |
|
|
1679 | design). |
1006 | |
1680 | |
1007 | =head3 Summary |
1681 | =head3 Summary |
1008 | |
1682 | |
1009 | =over 4 |
1683 | =over 4 |
1010 | |
1684 | |
… | |
… | |
1021 | |
1695 | |
1022 | =back |
1696 | =back |
1023 | |
1697 | |
1024 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1698 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1025 | |
1699 | |
1026 | This benchmark atcually benchmarks the event loop itself. It works by |
1700 | This benchmark actually benchmarks the event loop itself. It works by |
1027 | creating a number of "servers": each server consists of a socketpair, a |
1701 | creating a number of "servers": each server consists of a socket pair, a |
1028 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1702 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1029 | watcher waiting for input on one side of the socket. Each time the socket |
1703 | watcher waiting for input on one side of the socket. Each time the socket |
1030 | watcher reads a byte it will write that byte to a random other "server". |
1704 | watcher reads a byte it will write that byte to a random other "server". |
1031 | |
1705 | |
1032 | The effect is that there will be a lot of I/O watchers, only part of which |
1706 | The effect is that there will be a lot of I/O watchers, only part of which |
1033 | are active at any one point (so there is a constant number of active |
1707 | are active at any one point (so there is a constant number of active |
1034 | fds for each loop iterstaion, but which fds these are is random). The |
1708 | fds for each loop iteration, but which fds these are is random). The |
1035 | timeout is reset each time something is read because that reflects how |
1709 | timeout is reset each time something is read because that reflects how |
1036 | most timeouts work (and puts extra pressure on the event loops). |
1710 | most timeouts work (and puts extra pressure on the event loops). |
1037 | |
1711 | |
1038 | In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100 |
1712 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
1039 | (1%) are active. This mirrors the activity of large servers with many |
1713 | (1%) are active. This mirrors the activity of large servers with many |
1040 | connections, most of which are idle at any one point in time. |
1714 | connections, most of which are idle at any one point in time. |
1041 | |
1715 | |
1042 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1716 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1043 | distribution. |
1717 | distribution. |
1044 | |
1718 | |
1045 | =head3 Explanation of the columns |
1719 | =head3 Explanation of the columns |
1046 | |
1720 | |
1047 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1721 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1048 | eahc server has a read and write socket end). |
1722 | each server has a read and write socket end). |
1049 | |
1723 | |
1050 | I<create> is the time it takes to create a socketpair (which is |
1724 | I<create> is the time it takes to create a socket pair (which is |
1051 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1725 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1052 | |
1726 | |
1053 | I<request>, the most important value, is the time it takes to handle a |
1727 | I<request>, the most important value, is the time it takes to handle a |
1054 | single "request", that is, reading the token from the pipe and forwarding |
1728 | single "request", that is, reading the token from the pipe and forwarding |
1055 | it to another server. This includes deleting the old timeout and creating |
1729 | it to another server. This includes deleting the old timeout and creating |
… | |
… | |
1057 | |
1731 | |
1058 | =head3 Results |
1732 | =head3 Results |
1059 | |
1733 | |
1060 | name sockets create request |
1734 | name sockets create request |
1061 | EV 20000 69.01 11.16 |
1735 | EV 20000 69.01 11.16 |
1062 | Perl 20000 75.28 112.76 |
1736 | Perl 20000 73.32 35.87 |
1063 | Event 20000 212.62 257.32 |
1737 | Event 20000 212.62 257.32 |
1064 | Glib 20000 651.16 1896.30 |
1738 | Glib 20000 651.16 1896.30 |
1065 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1739 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1066 | |
1740 | |
1067 | =head3 Discussion |
1741 | =head3 Discussion |
… | |
… | |
1089 | |
1763 | |
1090 | =head3 Summary |
1764 | =head3 Summary |
1091 | |
1765 | |
1092 | =over 4 |
1766 | =over 4 |
1093 | |
1767 | |
1094 | =item * The pure perl implementation performs extremely well, considering |
1768 | =item * The pure perl implementation performs extremely well. |
1095 | that it uses select. |
|
|
1096 | |
1769 | |
1097 | =item * Avoid Glib or POE in large projects where performance matters. |
1770 | =item * Avoid Glib or POE in large projects where performance matters. |
1098 | |
1771 | |
1099 | =back |
1772 | =back |
1100 | |
1773 | |
… | |
… | |
1113 | |
1786 | |
1114 | =head3 Results |
1787 | =head3 Results |
1115 | |
1788 | |
1116 | name sockets create request |
1789 | name sockets create request |
1117 | EV 16 20.00 6.54 |
1790 | EV 16 20.00 6.54 |
|
|
1791 | Perl 16 25.75 12.62 |
1118 | Event 16 81.27 35.86 |
1792 | Event 16 81.27 35.86 |
1119 | Glib 16 32.63 15.48 |
1793 | Glib 16 32.63 15.48 |
1120 | Perl 16 24.62 162.37 |
|
|
1121 | POE 16 261.87 276.28 uses POE::Loop::Event |
1794 | POE 16 261.87 276.28 uses POE::Loop::Event |
1122 | |
1795 | |
1123 | =head3 Discussion |
1796 | =head3 Discussion |
1124 | |
1797 | |
1125 | The benchmark tries to test the performance of a typical small |
1798 | The benchmark tries to test the performance of a typical small |
1126 | server. While knowing how various event loops perform is interesting, keep |
1799 | server. While knowing how various event loops perform is interesting, keep |
1127 | in mind that their overhead in this case is usually not as important, due |
1800 | in mind that their overhead in this case is usually not as important, due |
1128 | to the small absolute number of watchers. |
1801 | to the small absolute number of watchers (that is, you need efficiency and |
|
|
1802 | speed most when you have lots of watchers, not when you only have a few of |
|
|
1803 | them). |
1129 | |
1804 | |
1130 | EV is again fastest. |
1805 | EV is again fastest. |
1131 | |
1806 | |
1132 | The C-based event loops Event and Glib come in second this time, as the |
1807 | Perl again comes second. It is noticeably faster than the C-based event |
1133 | overhead of running an iteration is much smaller in C than in Perl (little |
1808 | loops Event and Glib, although the difference is too small to really |
1134 | code to execute in the inner loop, and perl's function calling overhead is |
1809 | matter. |
1135 | high, and updating all the data structures is costly). |
|
|
1136 | |
1810 | |
1137 | The pure perl event loop is much slower, but still competitive. |
|
|
1138 | |
|
|
1139 | POE also performs much better in this case, but is is stillf ar behind the |
1811 | POE also performs much better in this case, but is is still far behind the |
1140 | others. |
1812 | others. |
1141 | |
1813 | |
1142 | =head3 Summary |
1814 | =head3 Summary |
1143 | |
1815 | |
1144 | =over 4 |
1816 | =over 4 |
… | |
… | |
1147 | watchers, as the management overhead dominates. |
1819 | watchers, as the management overhead dominates. |
1148 | |
1820 | |
1149 | =back |
1821 | =back |
1150 | |
1822 | |
1151 | |
1823 | |
|
|
1824 | =head1 SIGNALS |
|
|
1825 | |
|
|
1826 | AnyEvent currently installs handlers for these signals: |
|
|
1827 | |
|
|
1828 | =over 4 |
|
|
1829 | |
|
|
1830 | =item SIGCHLD |
|
|
1831 | |
|
|
1832 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
|
|
1833 | emulation for event loops that do not support them natively. Also, some |
|
|
1834 | event loops install a similar handler. |
|
|
1835 | |
|
|
1836 | =item SIGPIPE |
|
|
1837 | |
|
|
1838 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
|
|
1839 | when AnyEvent gets loaded. |
|
|
1840 | |
|
|
1841 | The rationale for this is that AnyEvent users usually do not really depend |
|
|
1842 | on SIGPIPE delivery (which is purely an optimisation for shell use, or |
|
|
1843 | badly-written programs), but C<SIGPIPE> can cause spurious and rare |
|
|
1844 | program exits as a lot of people do not expect C<SIGPIPE> when writing to |
|
|
1845 | some random socket. |
|
|
1846 | |
|
|
1847 | The rationale for installing a no-op handler as opposed to ignoring it is |
|
|
1848 | that this way, the handler will be restored to defaults on exec. |
|
|
1849 | |
|
|
1850 | Feel free to install your own handler, or reset it to defaults. |
|
|
1851 | |
|
|
1852 | =back |
|
|
1853 | |
|
|
1854 | =cut |
|
|
1855 | |
|
|
1856 | $SIG{PIPE} = sub { } |
|
|
1857 | unless defined $SIG{PIPE}; |
|
|
1858 | |
|
|
1859 | |
1152 | =head1 FORK |
1860 | =head1 FORK |
1153 | |
1861 | |
1154 | Most event libraries are not fork-safe. The ones who are usually are |
1862 | Most event libraries are not fork-safe. The ones who are usually are |
1155 | because they are so inefficient. Only L<EV> is fully fork-aware. |
1863 | because they rely on inefficient but fork-safe C<select> or C<poll> |
|
|
1864 | calls. Only L<EV> is fully fork-aware. |
1156 | |
1865 | |
1157 | If you have to fork, you must either do so I<before> creating your first |
1866 | If you have to fork, you must either do so I<before> creating your first |
1158 | watcher OR you must not use AnyEvent at all in the child. |
1867 | watcher OR you must not use AnyEvent at all in the child. |
1159 | |
1868 | |
1160 | |
1869 | |
… | |
… | |
1168 | specified in the variable. |
1877 | specified in the variable. |
1169 | |
1878 | |
1170 | You can make AnyEvent completely ignore this variable by deleting it |
1879 | You can make AnyEvent completely ignore this variable by deleting it |
1171 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1880 | before the first watcher gets created, e.g. with a C<BEGIN> block: |
1172 | |
1881 | |
1173 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1882 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1174 | |
1883 | |
1175 | use AnyEvent; |
1884 | use AnyEvent; |
|
|
1885 | |
|
|
1886 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
|
|
1887 | be used to probe what backend is used and gain other information (which is |
|
|
1888 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
|
|
1889 | $ENV{PERL_ANYEGENT_STRICT}. |
|
|
1890 | |
|
|
1891 | |
|
|
1892 | =head1 BUGS |
|
|
1893 | |
|
|
1894 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
|
|
1895 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
|
|
1896 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
|
|
1897 | memleaks, such as leaking on C<map> and C<grep> but it is usually not as |
|
|
1898 | pronounced). |
1176 | |
1899 | |
1177 | |
1900 | |
1178 | =head1 SEE ALSO |
1901 | =head1 SEE ALSO |
1179 | |
1902 | |
1180 | Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
1903 | Utility functions: L<AnyEvent::Util>. |
1181 | L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>, |
1904 | |
|
|
1905 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
1182 | L<Event::Lib>, L<Qt>, L<POE>. |
1906 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
1183 | |
1907 | |
1184 | Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, |
1908 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
1185 | L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, |
1909 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
1186 | L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>, |
1910 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
1187 | L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>. |
1911 | L<AnyEvent::Impl::POE>. |
1188 | |
1912 | |
|
|
1913 | Non-blocking file handles, sockets, TCP clients and |
|
|
1914 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. |
|
|
1915 | |
|
|
1916 | Asynchronous DNS: L<AnyEvent::DNS>. |
|
|
1917 | |
|
|
1918 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
|
|
1919 | |
1189 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
1920 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1190 | |
1921 | |
1191 | |
1922 | |
1192 | =head1 AUTHOR |
1923 | =head1 AUTHOR |
1193 | |
1924 | |
1194 | Marc Lehmann <schmorp@schmorp.de> |
1925 | Marc Lehmann <schmorp@schmorp.de> |
1195 | http://home.schmorp.de/ |
1926 | http://home.schmorp.de/ |
1196 | |
1927 | |
1197 | =cut |
1928 | =cut |
1198 | |
1929 | |
1199 | 1 |
1930 | 1 |
1200 | |
1931 | |