1 |
root |
1.2 |
NAME |
2 |
|
|
AnyEvent - provide framework for multiple event loops |
3 |
|
|
|
4 |
root |
1.20 |
EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event |
5 |
|
|
loops |
6 |
root |
1.2 |
|
7 |
|
|
SYNOPSIS |
8 |
root |
1.4 |
use AnyEvent; |
9 |
root |
1.2 |
|
10 |
root |
1.6 |
my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { |
11 |
root |
1.2 |
... |
12 |
|
|
}); |
13 |
root |
1.3 |
|
14 |
|
|
my $w = AnyEvent->timer (after => $seconds, cb => sub { |
15 |
root |
1.2 |
... |
16 |
|
|
}); |
17 |
|
|
|
18 |
root |
1.16 |
my $w = AnyEvent->condvar; # stores whether a condition was flagged |
19 |
root |
1.20 |
$w->send; # wake up current and all future recv's |
20 |
|
|
$w->recv; # enters "main loop" till $condvar gets ->send |
21 |
root |
1.3 |
|
22 |
root |
1.14 |
WHY YOU SHOULD USE THIS MODULE (OR NOT) |
23 |
|
|
Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
24 |
|
|
nowadays. So what is different about AnyEvent? |
25 |
|
|
|
26 |
|
|
Executive Summary: AnyEvent is *compatible*, AnyEvent is *free of |
27 |
|
|
policy* and AnyEvent is *small and efficient*. |
28 |
|
|
|
29 |
|
|
First and foremost, *AnyEvent is not an event model* itself, it only |
30 |
|
|
interfaces to whatever event model the main program happens to use in a |
31 |
|
|
pragmatic way. For event models and certain classes of immortals alike, |
32 |
root |
1.16 |
the statement "there can only be one" is a bitter reality: In general, |
33 |
|
|
only one event loop can be active at the same time in a process. |
34 |
|
|
AnyEvent helps hiding the differences between those event loops. |
35 |
root |
1.14 |
|
36 |
|
|
The goal of AnyEvent is to offer module authors the ability to do event |
37 |
|
|
programming (waiting for I/O or timer events) without subscribing to a |
38 |
|
|
religion, a way of living, and most importantly: without forcing your |
39 |
|
|
module users into the same thing by forcing them to use the same event |
40 |
|
|
model you use. |
41 |
|
|
|
42 |
root |
1.16 |
For modules like POE or IO::Async (which is a total misnomer as it is |
43 |
|
|
actually doing all I/O *synchronously*...), using them in your module is |
44 |
|
|
like joining a cult: After you joined, you are dependent on them and you |
45 |
|
|
cannot use anything else, as it is simply incompatible to everything |
46 |
|
|
that isn't itself. What's worse, all the potential users of your module |
47 |
|
|
are *also* forced to use the same event loop you use. |
48 |
|
|
|
49 |
|
|
AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
50 |
|
|
fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
51 |
|
|
with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if your |
52 |
|
|
module uses one of those, every user of your module has to use it, too. |
53 |
|
|
But if your module uses AnyEvent, it works transparently with all event |
54 |
|
|
models it supports (including stuff like POE and IO::Async, as long as |
55 |
|
|
those use one of the supported event loops. It is trivial to add new |
56 |
|
|
event loops to AnyEvent, too, so it is future-proof). |
57 |
root |
1.14 |
|
58 |
root |
1.16 |
In addition to being free of having to use *the one and only true event |
59 |
root |
1.14 |
model*, AnyEvent also is free of bloat and policy: with POE or similar |
60 |
|
|
modules, you get an enourmous amount of code and strict rules you have |
61 |
root |
1.16 |
to follow. AnyEvent, on the other hand, is lean and up to the point, by |
62 |
|
|
only offering the functionality that is necessary, in as thin as a |
63 |
|
|
wrapper as technically possible. |
64 |
root |
1.14 |
|
65 |
|
|
Of course, if you want lots of policy (this can arguably be somewhat |
66 |
|
|
useful) and you want to force your users to use the one and only event |
67 |
|
|
model, you should *not* use this module. |
68 |
|
|
|
69 |
root |
1.2 |
DESCRIPTION |
70 |
|
|
AnyEvent provides an identical interface to multiple event loops. This |
71 |
root |
1.6 |
allows module authors to utilise an event loop without forcing module |
72 |
root |
1.2 |
users to use the same event loop (as only a single event loop can |
73 |
|
|
coexist peacefully at any one time). |
74 |
|
|
|
75 |
root |
1.16 |
The interface itself is vaguely similar, but not identical to the Event |
76 |
root |
1.2 |
module. |
77 |
|
|
|
78 |
root |
1.16 |
During the first call of any watcher-creation method, the module tries |
79 |
|
|
to detect the currently loaded event loop by probing whether one of the |
80 |
root |
1.20 |
following modules is already loaded: EV, Event, Glib, |
81 |
|
|
AnyEvent::Impl::Perl, Tk, Event::Lib, Qt, POE. The first one found is |
82 |
|
|
used. If none are found, the module tries to load these modules |
83 |
root |
1.19 |
(excluding Tk, Event::Lib, Qt and POE as the pure perl adaptor should |
84 |
|
|
always succeed) in the order given. The first one that can be |
85 |
|
|
successfully loaded will be used. If, after this, still none could be |
86 |
|
|
found, AnyEvent will fall back to a pure-perl event loop, which is not |
87 |
|
|
very efficient, but should work everywhere. |
88 |
root |
1.6 |
|
89 |
|
|
Because AnyEvent first checks for modules that are already loaded, |
90 |
root |
1.16 |
loading an event model explicitly before first using AnyEvent will |
91 |
root |
1.6 |
likely make that model the default. For example: |
92 |
|
|
|
93 |
|
|
use Tk; |
94 |
|
|
use AnyEvent; |
95 |
|
|
|
96 |
|
|
# .. AnyEvent will likely default to Tk |
97 |
|
|
|
98 |
root |
1.16 |
The *likely* means that, if any module loads another event model and |
99 |
|
|
starts using it, all bets are off. Maybe you should tell their authors |
100 |
|
|
to use AnyEvent so their modules work together with others seamlessly... |
101 |
|
|
|
102 |
root |
1.6 |
The pure-perl implementation of AnyEvent is called |
103 |
|
|
"AnyEvent::Impl::Perl". Like other event modules you can load it |
104 |
|
|
explicitly. |
105 |
|
|
|
106 |
|
|
WATCHERS |
107 |
|
|
AnyEvent has the central concept of a *watcher*, which is an object that |
108 |
|
|
stores relevant data for each kind of event you are waiting for, such as |
109 |
|
|
the callback to call, the filehandle to watch, etc. |
110 |
|
|
|
111 |
|
|
These watchers are normal Perl objects with normal Perl lifetime. After |
112 |
|
|
creating a watcher it will immediately "watch" for events and invoke the |
113 |
root |
1.16 |
callback when the event occurs (of course, only when the event model is |
114 |
|
|
in control). |
115 |
|
|
|
116 |
|
|
To disable the watcher you have to destroy it (e.g. by setting the |
117 |
|
|
variable you store it in to "undef" or otherwise deleting all references |
118 |
|
|
to it). |
119 |
root |
1.6 |
|
120 |
|
|
All watchers are created by calling a method on the "AnyEvent" class. |
121 |
|
|
|
122 |
root |
1.16 |
Many watchers either are used with "recursion" (repeating timers for |
123 |
|
|
example), or need to refer to their watcher object in other ways. |
124 |
|
|
|
125 |
|
|
An any way to achieve that is this pattern: |
126 |
|
|
|
127 |
|
|
my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
128 |
|
|
# you can use $w here, for example to undef it |
129 |
|
|
undef $w; |
130 |
|
|
}); |
131 |
|
|
|
132 |
|
|
Note that "my $w; $w =" combination. This is necessary because in Perl, |
133 |
|
|
my variables are only visible after the statement in which they are |
134 |
|
|
declared. |
135 |
|
|
|
136 |
root |
1.19 |
I/O WATCHERS |
137 |
root |
1.16 |
You can create an I/O watcher by calling the "AnyEvent->io" method with |
138 |
|
|
the following mandatory key-value pairs as arguments: |
139 |
root |
1.6 |
|
140 |
root |
1.16 |
"fh" the Perl *file handle* (*not* file descriptor) to watch for events. |
141 |
|
|
"poll" must be a string that is either "r" or "w", which creates a |
142 |
|
|
watcher waiting for "r"eadable or "w"ritable events, respectively. "cb" |
143 |
|
|
is the callback to invoke each time the file handle becomes ready. |
144 |
|
|
|
145 |
root |
1.19 |
Although the callback might get passed parameters, their value and |
146 |
|
|
presence is undefined and you cannot rely on them. Portable AnyEvent |
147 |
|
|
callbacks cannot use arguments passed to I/O watcher callbacks. |
148 |
|
|
|
149 |
|
|
The I/O watcher might use the underlying file descriptor or a copy of |
150 |
|
|
it. You must not close a file handle as long as any watcher is active on |
151 |
|
|
the underlying file descriptor. |
152 |
root |
1.16 |
|
153 |
|
|
Some event loops issue spurious readyness notifications, so you should |
154 |
|
|
always use non-blocking calls when reading/writing from/to your file |
155 |
|
|
handles. |
156 |
root |
1.6 |
|
157 |
|
|
Example: |
158 |
|
|
|
159 |
|
|
# wait for readability of STDIN, then read a line and disable the watcher |
160 |
|
|
my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
161 |
|
|
chomp (my $input = <STDIN>); |
162 |
|
|
warn "read: $input\n"; |
163 |
|
|
undef $w; |
164 |
|
|
}); |
165 |
|
|
|
166 |
root |
1.8 |
TIME WATCHERS |
167 |
|
|
You can create a time watcher by calling the "AnyEvent->timer" method |
168 |
root |
1.6 |
with the following mandatory arguments: |
169 |
|
|
|
170 |
root |
1.16 |
"after" specifies after how many seconds (fractional values are |
171 |
root |
1.19 |
supported) the callback should be invoked. "cb" is the callback to |
172 |
|
|
invoke in that case. |
173 |
|
|
|
174 |
|
|
Although the callback might get passed parameters, their value and |
175 |
|
|
presence is undefined and you cannot rely on them. Portable AnyEvent |
176 |
|
|
callbacks cannot use arguments passed to time watcher callbacks. |
177 |
root |
1.6 |
|
178 |
|
|
The timer callback will be invoked at most once: if you want a repeating |
179 |
|
|
timer you have to create a new watcher (this is a limitation by both Tk |
180 |
|
|
and Glib). |
181 |
|
|
|
182 |
|
|
Example: |
183 |
|
|
|
184 |
|
|
# fire an event after 7.7 seconds |
185 |
|
|
my $w = AnyEvent->timer (after => 7.7, cb => sub { |
186 |
|
|
warn "timeout\n"; |
187 |
|
|
}); |
188 |
|
|
|
189 |
|
|
# to cancel the timer: |
190 |
root |
1.13 |
undef $w; |
191 |
root |
1.6 |
|
192 |
root |
1.16 |
Example 2: |
193 |
|
|
|
194 |
|
|
# fire an event after 0.5 seconds, then roughly every second |
195 |
|
|
my $w; |
196 |
|
|
|
197 |
|
|
my $cb = sub { |
198 |
|
|
# cancel the old timer while creating a new one |
199 |
|
|
$w = AnyEvent->timer (after => 1, cb => $cb); |
200 |
|
|
}; |
201 |
|
|
|
202 |
|
|
# start the "loop" by creating the first watcher |
203 |
|
|
$w = AnyEvent->timer (after => 0.5, cb => $cb); |
204 |
|
|
|
205 |
|
|
TIMING ISSUES |
206 |
|
|
There are two ways to handle timers: based on real time (relative, "fire |
207 |
|
|
in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
208 |
|
|
o'clock"). |
209 |
|
|
|
210 |
|
|
While most event loops expect timers to specified in a relative way, |
211 |
|
|
they use absolute time internally. This makes a difference when your |
212 |
|
|
clock "jumps", for example, when ntp decides to set your clock backwards |
213 |
root |
1.18 |
from the wrong date of 2014-01-01 to 2008-01-01, a watcher that is |
214 |
|
|
supposed to fire "after" a second might actually take six years to |
215 |
|
|
finally fire. |
216 |
root |
1.16 |
|
217 |
|
|
AnyEvent cannot compensate for this. The only event loop that is |
218 |
|
|
conscious about these issues is EV, which offers both relative |
219 |
root |
1.18 |
(ev_timer, based on true relative time) and absolute (ev_periodic, based |
220 |
|
|
on wallclock time) timers. |
221 |
root |
1.16 |
|
222 |
|
|
AnyEvent always prefers relative timers, if available, matching the |
223 |
|
|
AnyEvent API. |
224 |
|
|
|
225 |
|
|
SIGNAL WATCHERS |
226 |
|
|
You can watch for signals using a signal watcher, "signal" is the signal |
227 |
|
|
*name* without any "SIG" prefix, "cb" is the Perl callback to be invoked |
228 |
|
|
whenever a signal occurs. |
229 |
|
|
|
230 |
root |
1.19 |
Although the callback might get passed parameters, their value and |
231 |
|
|
presence is undefined and you cannot rely on them. Portable AnyEvent |
232 |
|
|
callbacks cannot use arguments passed to signal watcher callbacks. |
233 |
|
|
|
234 |
root |
1.18 |
Multiple signal occurances can be clumped together into one callback |
235 |
root |
1.16 |
invocation, and callback invocation will be synchronous. synchronous |
236 |
|
|
means that it might take a while until the signal gets handled by the |
237 |
|
|
process, but it is guarenteed not to interrupt any other callbacks. |
238 |
|
|
|
239 |
|
|
The main advantage of using these watchers is that you can share a |
240 |
|
|
signal between multiple watchers. |
241 |
|
|
|
242 |
|
|
This watcher might use %SIG, so programs overwriting those signals |
243 |
|
|
directly will likely not work correctly. |
244 |
|
|
|
245 |
|
|
Example: exit on SIGINT |
246 |
|
|
|
247 |
|
|
my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
248 |
|
|
|
249 |
|
|
CHILD PROCESS WATCHERS |
250 |
|
|
You can also watch on a child process exit and catch its exit status. |
251 |
|
|
|
252 |
|
|
The child process is specified by the "pid" argument (if set to 0, it |
253 |
|
|
watches for any child process exit). The watcher will trigger as often |
254 |
|
|
as status change for the child are received. This works by installing a |
255 |
|
|
signal handler for "SIGCHLD". The callback will be called with the pid |
256 |
root |
1.19 |
and exit status (as returned by waitpid), so unlike other watcher types, |
257 |
|
|
you *can* rely on child watcher callback arguments. |
258 |
|
|
|
259 |
|
|
There is a slight catch to child watchers, however: you usually start |
260 |
|
|
them *after* the child process was created, and this means the process |
261 |
|
|
could have exited already (and no SIGCHLD will be sent anymore). |
262 |
|
|
|
263 |
|
|
Not all event models handle this correctly (POE doesn't), but even for |
264 |
|
|
event models that *do* handle this correctly, they usually need to be |
265 |
|
|
loaded before the process exits (i.e. before you fork in the first |
266 |
|
|
place). |
267 |
|
|
|
268 |
|
|
This means you cannot create a child watcher as the very first thing in |
269 |
|
|
an AnyEvent program, you *have* to create at least one watcher before |
270 |
|
|
you "fork" the child (alternatively, you can call "AnyEvent::detect"). |
271 |
|
|
|
272 |
|
|
Example: fork a process and wait for it |
273 |
|
|
|
274 |
|
|
my $done = AnyEvent->condvar; |
275 |
root |
1.16 |
|
276 |
root |
1.19 |
my $pid = fork or exit 5; |
277 |
root |
1.16 |
|
278 |
|
|
my $w = AnyEvent->child ( |
279 |
root |
1.19 |
pid => $pid, |
280 |
root |
1.16 |
cb => sub { |
281 |
|
|
my ($pid, $status) = @_; |
282 |
|
|
warn "pid $pid exited with status $status"; |
283 |
root |
1.20 |
$done->send; |
284 |
root |
1.16 |
}, |
285 |
|
|
); |
286 |
|
|
|
287 |
root |
1.19 |
# do something else, then wait for process exit |
288 |
root |
1.20 |
$done->recv; |
289 |
root |
1.19 |
|
290 |
root |
1.16 |
CONDITION VARIABLES |
291 |
root |
1.20 |
If you are familiar with some event loops you will know that all of them |
292 |
|
|
require you to run some blocking "loop", "run" or similar function that |
293 |
|
|
will actively watch for new events and call your callbacks. |
294 |
|
|
|
295 |
|
|
AnyEvent is different, it expects somebody else to run the event loop |
296 |
|
|
and will only block when necessary (usually when told by the user). |
297 |
root |
1.6 |
|
298 |
root |
1.20 |
The instrument to do that is called a "condition variable", so called |
299 |
|
|
because they represent a condition that must become true. |
300 |
root |
1.6 |
|
301 |
root |
1.20 |
Condition variables can be created by calling the "AnyEvent->condvar" |
302 |
|
|
method, usually without arguments. The only argument pair allowed is |
303 |
|
|
"cb", which specifies a callback to be called when the condition |
304 |
|
|
variable becomes true. |
305 |
|
|
|
306 |
|
|
After creation, the conditon variable is "false" until it becomes "true" |
307 |
|
|
by calling the "send" method. |
308 |
|
|
|
309 |
|
|
Condition variables are similar to callbacks, except that you can |
310 |
|
|
optionally wait for them. They can also be called merge points - points |
311 |
|
|
in time where multiple outstandign events have been processed. And yet |
312 |
|
|
another way to call them is transations - each condition variable can be |
313 |
|
|
used to represent a transaction, which finishes at some point and |
314 |
|
|
delivers a result. |
315 |
|
|
|
316 |
|
|
Condition variables are very useful to signal that something has |
317 |
|
|
finished, for example, if you write a module that does asynchronous http |
318 |
|
|
requests, then a condition variable would be the ideal candidate to |
319 |
|
|
signal the availability of results. The user can either act when the |
320 |
|
|
callback is called or can synchronously "->recv" for the results. |
321 |
|
|
|
322 |
|
|
You can also use them to simulate traditional event loops - for example, |
323 |
|
|
you can block your main program until an event occurs - for example, you |
324 |
|
|
could "->recv" in your main program until the user clicks the Quit |
325 |
|
|
button of your app, which would "->send" the "quit" event. |
326 |
root |
1.16 |
|
327 |
|
|
Note that condition variables recurse into the event loop - if you have |
328 |
root |
1.20 |
two pieces of code that call "->recv" in a round-robbin fashion, you |
329 |
root |
1.16 |
lose. Therefore, condition variables are good to export to your caller, |
330 |
|
|
but you should avoid making a blocking wait yourself, at least in |
331 |
|
|
callbacks, as this asks for trouble. |
332 |
root |
1.14 |
|
333 |
root |
1.20 |
Condition variables are represented by hash refs in perl, and the keys |
334 |
|
|
used by AnyEvent itself are all named "_ae_XXX" to make subclassing easy |
335 |
|
|
(it is often useful to build your own transaction class on top of |
336 |
|
|
AnyEvent). To subclass, use "AnyEvent::CondVar" as base class and call |
337 |
|
|
it's "new" method in your own "new" method. |
338 |
|
|
|
339 |
|
|
There are two "sides" to a condition variable - the "producer side" |
340 |
|
|
which eventually calls "-> send", and the "consumer side", which waits |
341 |
|
|
for the send to occur. |
342 |
root |
1.6 |
|
343 |
root |
1.20 |
Example: |
344 |
root |
1.6 |
|
345 |
root |
1.20 |
# wait till the result is ready |
346 |
|
|
my $result_ready = AnyEvent->condvar; |
347 |
|
|
|
348 |
|
|
# do something such as adding a timer |
349 |
|
|
# or socket watcher the calls $result_ready->send |
350 |
|
|
# when the "result" is ready. |
351 |
|
|
# in this case, we simply use a timer: |
352 |
|
|
my $w = AnyEvent->timer ( |
353 |
|
|
after => 1, |
354 |
|
|
cb => sub { $result_ready->send }, |
355 |
|
|
); |
356 |
|
|
|
357 |
|
|
# this "blocks" (while handling events) till the callback |
358 |
|
|
# calls send |
359 |
|
|
$result_ready->recv; |
360 |
|
|
|
361 |
|
|
METHODS FOR PRODUCERS |
362 |
|
|
These methods should only be used by the producing side, i.e. the |
363 |
|
|
code/module that eventually sends the signal. Note that it is also the |
364 |
|
|
producer side which creates the condvar in most cases, but it isn't |
365 |
|
|
uncommon for the consumer to create it as well. |
366 |
|
|
|
367 |
|
|
$cv->send (...) |
368 |
|
|
Flag the condition as ready - a running "->recv" and all further |
369 |
|
|
calls to "recv" will (eventually) return after this method has been |
370 |
|
|
called. If nobody is waiting the send will be remembered. |
371 |
|
|
|
372 |
|
|
If a callback has been set on the condition variable, it is called |
373 |
|
|
immediately from within send. |
374 |
|
|
|
375 |
|
|
Any arguments passed to the "send" call will be returned by all |
376 |
|
|
future "->recv" calls. |
377 |
|
|
|
378 |
|
|
$cv->croak ($error) |
379 |
|
|
Similar to send, but causes all call's to "->recv" to invoke |
380 |
|
|
"Carp::croak" with the given error message/object/scalar. |
381 |
|
|
|
382 |
|
|
This can be used to signal any errors to the condition variable |
383 |
|
|
user/consumer. |
384 |
|
|
|
385 |
|
|
$cv->begin ([group callback]) |
386 |
|
|
$cv->end |
387 |
|
|
These two methods are EXPERIMENTAL and MIGHT CHANGE. |
388 |
|
|
|
389 |
|
|
These two methods can be used to combine many transactions/events |
390 |
|
|
into one. For example, a function that pings many hosts in parallel |
391 |
|
|
might want to use a condition variable for the whole process. |
392 |
|
|
|
393 |
|
|
Every call to "->begin" will increment a counter, and every call to |
394 |
|
|
"->end" will decrement it. If the counter reaches 0 in "->end", the |
395 |
|
|
(last) callback passed to "begin" will be executed. That callback is |
396 |
|
|
*supposed* to call "->send", but that is not required. If no |
397 |
|
|
callback was set, "send" will be called without any arguments. |
398 |
|
|
|
399 |
|
|
Let's clarify this with the ping example: |
400 |
|
|
|
401 |
|
|
my $cv = AnyEvent->condvar; |
402 |
|
|
|
403 |
|
|
my %result; |
404 |
|
|
$cv->begin (sub { $cv->send (\%result) }); |
405 |
|
|
|
406 |
|
|
for my $host (@list_of_hosts) { |
407 |
|
|
$cv->begin; |
408 |
|
|
ping_host_then_call_callback $host, sub { |
409 |
|
|
$result{$host} = ...; |
410 |
|
|
$cv->end; |
411 |
|
|
}; |
412 |
|
|
} |
413 |
|
|
|
414 |
|
|
$cv->end; |
415 |
|
|
|
416 |
|
|
This code fragment supposedly pings a number of hosts and calls |
417 |
|
|
"send" after results for all then have have been gathered - in any |
418 |
|
|
order. To achieve this, the code issues a call to "begin" when it |
419 |
|
|
starts each ping request and calls "end" when it has received some |
420 |
|
|
result for it. Since "begin" and "end" only maintain a counter, the |
421 |
|
|
order in which results arrive is not relevant. |
422 |
|
|
|
423 |
|
|
There is an additional bracketing call to "begin" and "end" outside |
424 |
|
|
the loop, which serves two important purposes: first, it sets the |
425 |
|
|
callback to be called once the counter reaches 0, and second, it |
426 |
|
|
ensures that "send" is called even when "no" hosts are being pinged |
427 |
|
|
(the loop doesn't execute once). |
428 |
|
|
|
429 |
|
|
This is the general pattern when you "fan out" into multiple |
430 |
|
|
subrequests: use an outer "begin"/"end" pair to set the callback and |
431 |
|
|
ensure "end" is called at least once, and then, for each subrequest |
432 |
|
|
you start, call "begin" and for eahc subrequest you finish, call |
433 |
|
|
"end". |
434 |
|
|
|
435 |
|
|
METHODS FOR CONSUMERS |
436 |
|
|
These methods should only be used by the consuming side, i.e. the code |
437 |
|
|
awaits the condition. |
438 |
|
|
|
439 |
|
|
$cv->recv |
440 |
|
|
Wait (blocking if necessary) until the "->send" or "->croak" methods |
441 |
|
|
have been called on c<$cv>, while servicing other watchers normally. |
442 |
|
|
|
443 |
|
|
You can only wait once on a condition - additional calls are valid |
444 |
|
|
but will return immediately. |
445 |
|
|
|
446 |
|
|
If an error condition has been set by calling "->croak", then this |
447 |
|
|
function will call "croak". |
448 |
|
|
|
449 |
|
|
In list context, all parameters passed to "send" will be returned, |
450 |
|
|
in scalar context only the first one will be returned. |
451 |
root |
1.6 |
|
452 |
root |
1.15 |
Not all event models support a blocking wait - some die in that case |
453 |
root |
1.16 |
(programs might want to do that to stay interactive), so *if you are |
454 |
|
|
using this from a module, never require a blocking wait*, but let |
455 |
|
|
the caller decide whether the call will block or not (for example, |
456 |
|
|
by coupling condition variables with some kind of request results |
457 |
|
|
and supporting callbacks so the caller knows that getting the result |
458 |
|
|
will not block, while still suppporting blocking waits if the caller |
459 |
|
|
so desires). |
460 |
root |
1.15 |
|
461 |
root |
1.20 |
Another reason *never* to "->recv" in a module is that you cannot |
462 |
|
|
sensibly have two "->recv"'s in parallel, as that would require |
463 |
root |
1.15 |
multiple interpreters or coroutines/threads, none of which |
464 |
root |
1.20 |
"AnyEvent" can supply. |
465 |
root |
1.8 |
|
466 |
root |
1.20 |
The Coro module, however, *can* and *does* supply coroutines and, in |
467 |
|
|
fact, Coro::AnyEvent replaces AnyEvent's condvars by coroutine-safe |
468 |
|
|
versions and also integrates coroutines into AnyEvent, making |
469 |
|
|
blocking "->recv" calls perfectly safe as long as they are done from |
470 |
|
|
another coroutine (one that doesn't run the event loop). |
471 |
|
|
|
472 |
|
|
You can ensure that "-recv" never blocks by setting a callback and |
473 |
|
|
only calling "->recv" from within that callback (or at a later |
474 |
|
|
time). This will work even when the event loop does not support |
475 |
|
|
blocking waits otherwise. |
476 |
|
|
|
477 |
|
|
$bool = $cv->ready |
478 |
|
|
Returns true when the condition is "true", i.e. whether "send" or |
479 |
|
|
"croak" have been called. |
480 |
|
|
|
481 |
|
|
$cb = $cv->cb ([new callback]) |
482 |
|
|
This is a mutator function that returns the callback set and |
483 |
|
|
optionally replaces it before doing so. |
484 |
|
|
|
485 |
|
|
The callback will be called when the condition becomes "true", i.e. |
486 |
|
|
when "send" or "croak" are called. Calling "recv" inside the |
487 |
|
|
callback or at any later time is guaranteed not to block. |
488 |
root |
1.8 |
|
489 |
root |
1.16 |
GLOBAL VARIABLES AND FUNCTIONS |
490 |
root |
1.7 |
$AnyEvent::MODEL |
491 |
|
|
Contains "undef" until the first watcher is being created. Then it |
492 |
|
|
contains the event model that is being used, which is the name of |
493 |
|
|
the Perl class implementing the model. This class is usually one of |
494 |
|
|
the "AnyEvent::Impl:xxx" modules, but can be any other class in the |
495 |
|
|
case AnyEvent has been extended at runtime (e.g. in *rxvt-unicode*). |
496 |
|
|
|
497 |
|
|
The known classes so far are: |
498 |
|
|
|
499 |
root |
1.18 |
AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
500 |
|
|
AnyEvent::Impl::Event based on Event, second best choice. |
501 |
root |
1.20 |
AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
502 |
root |
1.15 |
AnyEvent::Impl::Glib based on Glib, third-best choice. |
503 |
root |
1.7 |
AnyEvent::Impl::Tk based on Tk, very bad choice. |
504 |
root |
1.18 |
AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
505 |
|
|
AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
506 |
root |
1.19 |
AnyEvent::Impl::POE based on POE, not generic enough for full support. |
507 |
|
|
|
508 |
|
|
There is no support for WxWidgets, as WxWidgets has no support for |
509 |
|
|
watching file handles. However, you can use WxWidgets through the |
510 |
|
|
POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
511 |
|
|
second, which was considered to be too horrible to even consider for |
512 |
|
|
AnyEvent. Likewise, other POE backends can be used by AnyEvent by |
513 |
|
|
using it's adaptor. |
514 |
|
|
|
515 |
|
|
AnyEvent knows about Prima and Wx and will try to use POE when |
516 |
|
|
autodetecting them. |
517 |
root |
1.7 |
|
518 |
root |
1.8 |
AnyEvent::detect |
519 |
|
|
Returns $AnyEvent::MODEL, forcing autodetection of the event model |
520 |
|
|
if necessary. You should only call this function right before you |
521 |
root |
1.16 |
would have created an AnyEvent watcher anyway, that is, as late as |
522 |
|
|
possible at runtime. |
523 |
root |
1.8 |
|
524 |
root |
1.20 |
$guard = AnyEvent::post_detect { BLOCK } |
525 |
|
|
Arranges for the code block to be executed as soon as the event |
526 |
|
|
model is autodetected (or immediately if this has already happened). |
527 |
|
|
|
528 |
|
|
If called in scalar or list context, then it creates and returns an |
529 |
|
|
object that automatically removes the callback again when it is |
530 |
|
|
destroyed. See Coro::BDB for a case where this is useful. |
531 |
|
|
|
532 |
|
|
@AnyEvent::post_detect |
533 |
|
|
If there are any code references in this array (you can "push" to it |
534 |
|
|
before or after loading AnyEvent), then they will called directly |
535 |
|
|
after the event loop has been chosen. |
536 |
|
|
|
537 |
|
|
You should check $AnyEvent::MODEL before adding to this array, |
538 |
|
|
though: if it contains a true value then the event loop has already |
539 |
|
|
been detected, and the array will be ignored. |
540 |
|
|
|
541 |
|
|
Best use "AnyEvent::post_detect { BLOCK }" instead. |
542 |
|
|
|
543 |
root |
1.6 |
WHAT TO DO IN A MODULE |
544 |
|
|
As a module author, you should "use AnyEvent" and call AnyEvent methods |
545 |
|
|
freely, but you should not load a specific event module or rely on it. |
546 |
|
|
|
547 |
root |
1.16 |
Be careful when you create watchers in the module body - AnyEvent will |
548 |
root |
1.6 |
decide which event module to use as soon as the first method is called, |
549 |
|
|
so by calling AnyEvent in your module body you force the user of your |
550 |
|
|
module to load the event module first. |
551 |
|
|
|
552 |
root |
1.20 |
Never call "->recv" on a condition variable unless you *know* that the |
553 |
|
|
"->send" method has been called on it already. This is because it will |
554 |
|
|
stall the whole program, and the whole point of using events is to stay |
555 |
|
|
interactive. |
556 |
root |
1.16 |
|
557 |
root |
1.20 |
It is fine, however, to call "->recv" when the user of your module |
558 |
root |
1.16 |
requests it (i.e. if you create a http request object ad have a method |
559 |
root |
1.20 |
called "results" that returns the results, it should call "->recv" |
560 |
root |
1.16 |
freely, as the user of your module knows what she is doing. always). |
561 |
|
|
|
562 |
root |
1.6 |
WHAT TO DO IN THE MAIN PROGRAM |
563 |
|
|
There will always be a single main program - the only place that should |
564 |
|
|
dictate which event model to use. |
565 |
|
|
|
566 |
|
|
If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
567 |
root |
1.16 |
do anything special (it does not need to be event-based) and let |
568 |
|
|
AnyEvent decide which implementation to chose if some module relies on |
569 |
|
|
it. |
570 |
|
|
|
571 |
|
|
If the main program relies on a specific event model. For example, in |
572 |
|
|
Gtk2 programs you have to rely on the Glib module. You should load the |
573 |
|
|
event module before loading AnyEvent or any module that uses it: |
574 |
|
|
generally speaking, you should load it as early as possible. The reason |
575 |
|
|
is that modules might create watchers when they are loaded, and AnyEvent |
576 |
|
|
will decide on the event model to use as soon as it creates watchers, |
577 |
|
|
and it might chose the wrong one unless you load the correct one |
578 |
|
|
yourself. |
579 |
root |
1.6 |
|
580 |
|
|
You can chose to use a rather inefficient pure-perl implementation by |
581 |
root |
1.16 |
loading the "AnyEvent::Impl::Perl" module, which gives you similar |
582 |
|
|
behaviour everywhere, but letting AnyEvent chose is generally better. |
583 |
root |
1.2 |
|
584 |
root |
1.19 |
OTHER MODULES |
585 |
|
|
The following is a non-exhaustive list of additional modules that use |
586 |
|
|
AnyEvent and can therefore be mixed easily with other AnyEvent modules |
587 |
|
|
in the same program. Some of the modules come with AnyEvent, some are |
588 |
|
|
available via CPAN. |
589 |
|
|
|
590 |
|
|
AnyEvent::Util |
591 |
|
|
Contains various utility functions that replace often-used but |
592 |
|
|
blocking functions such as "inet_aton" by event-/callback-based |
593 |
|
|
versions. |
594 |
|
|
|
595 |
|
|
AnyEvent::Handle |
596 |
|
|
Provide read and write buffers and manages watchers for reads and |
597 |
|
|
writes. |
598 |
|
|
|
599 |
|
|
AnyEvent::HTTPD |
600 |
|
|
Provides a simple web application server framework. |
601 |
|
|
|
602 |
|
|
AnyEvent::DNS |
603 |
|
|
Provides asynchronous DNS resolver capabilities, beyond what |
604 |
|
|
AnyEvent::Util offers. |
605 |
|
|
|
606 |
|
|
AnyEvent::FastPing |
607 |
|
|
The fastest ping in the west. |
608 |
|
|
|
609 |
|
|
Net::IRC3 |
610 |
|
|
AnyEvent based IRC client module family. |
611 |
|
|
|
612 |
|
|
Net::XMPP2 |
613 |
|
|
AnyEvent based XMPP (Jabber protocol) module family. |
614 |
|
|
|
615 |
|
|
Net::FCP |
616 |
|
|
AnyEvent-based implementation of the Freenet Client Protocol, |
617 |
|
|
birthplace of AnyEvent. |
618 |
|
|
|
619 |
|
|
Event::ExecFlow |
620 |
|
|
High level API for event-based execution flow control. |
621 |
|
|
|
622 |
|
|
Coro |
623 |
root |
1.20 |
Has special support for AnyEvent via Coro::AnyEvent. |
624 |
|
|
|
625 |
|
|
AnyEvent::AIO, IO::AIO |
626 |
|
|
Truly asynchronous I/O, should be in the toolbox of every event |
627 |
|
|
programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent |
628 |
|
|
together. |
629 |
|
|
|
630 |
|
|
AnyEvent::BDB, BDB |
631 |
|
|
Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently |
632 |
|
|
fuses IO::AIO and AnyEvent together. |
633 |
root |
1.19 |
|
634 |
|
|
IO::Lambda |
635 |
|
|
The lambda approach to I/O - don't ask, look there. Can use |
636 |
|
|
AnyEvent. |
637 |
|
|
|
638 |
root |
1.5 |
SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
639 |
root |
1.16 |
This is an advanced topic that you do not normally need to use AnyEvent |
640 |
|
|
in a module. This section is only of use to event loop authors who want |
641 |
|
|
to provide AnyEvent compatibility. |
642 |
|
|
|
643 |
root |
1.5 |
If you need to support another event library which isn't directly |
644 |
|
|
supported by AnyEvent, you can supply your own interface to it by |
645 |
root |
1.6 |
pushing, before the first watcher gets created, the package name of the |
646 |
root |
1.5 |
event module and the package name of the interface to use onto |
647 |
|
|
@AnyEvent::REGISTRY. You can do that before and even without loading |
648 |
root |
1.16 |
AnyEvent, so it is reasonably cheap. |
649 |
root |
1.5 |
|
650 |
|
|
Example: |
651 |
|
|
|
652 |
|
|
push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
653 |
|
|
|
654 |
root |
1.6 |
This tells AnyEvent to (literally) use the "urxvt::anyevent::" |
655 |
root |
1.16 |
package/class when it finds the "urxvt" package/module is already |
656 |
|
|
loaded. |
657 |
|
|
|
658 |
|
|
When AnyEvent is loaded and asked to find a suitable event model, it |
659 |
|
|
will first check for the presence of urxvt by trying to "use" the |
660 |
|
|
"urxvt::anyevent" module. |
661 |
|
|
|
662 |
|
|
The class should provide implementations for all watcher types. See |
663 |
|
|
AnyEvent::Impl::EV (source code), AnyEvent::Impl::Glib (Source code) and |
664 |
|
|
so on for actual examples. Use "perldoc -m AnyEvent::Impl::Glib" to see |
665 |
|
|
the sources. |
666 |
|
|
|
667 |
|
|
If you don't provide "signal" and "child" watchers than AnyEvent will |
668 |
|
|
provide suitable (hopefully) replacements. |
669 |
|
|
|
670 |
|
|
The above example isn't fictitious, the *rxvt-unicode* (a.k.a. urxvt) |
671 |
|
|
terminal emulator uses the above line as-is. An interface isn't included |
672 |
|
|
in AnyEvent because it doesn't make sense outside the embedded |
673 |
|
|
interpreter inside *rxvt-unicode*, and it is updated and maintained as |
674 |
|
|
part of the *rxvt-unicode* distribution. |
675 |
root |
1.5 |
|
676 |
root |
1.6 |
*rxvt-unicode* also cheats a bit by not providing blocking access to |
677 |
|
|
condition variables: code blocking while waiting for a condition will |
678 |
|
|
"die". This still works with most modules/usages, and blocking calls |
679 |
root |
1.16 |
must not be done in an interactive application, so it makes sense. |
680 |
root |
1.6 |
|
681 |
root |
1.4 |
ENVIRONMENT VARIABLES |
682 |
|
|
The following environment variables are used by this module: |
683 |
|
|
|
684 |
root |
1.18 |
"PERL_ANYEVENT_VERBOSE" |
685 |
root |
1.19 |
By default, AnyEvent will be completely silent except in fatal |
686 |
|
|
conditions. You can set this environment variable to make AnyEvent |
687 |
|
|
more talkative. |
688 |
|
|
|
689 |
|
|
When set to 1 or higher, causes AnyEvent to warn about unexpected |
690 |
|
|
conditions, such as not being able to load the event model specified |
691 |
|
|
by "PERL_ANYEVENT_MODEL". |
692 |
|
|
|
693 |
root |
1.18 |
When set to 2 or higher, cause AnyEvent to report to STDERR which |
694 |
|
|
event model it chooses. |
695 |
|
|
|
696 |
|
|
"PERL_ANYEVENT_MODEL" |
697 |
|
|
This can be used to specify the event model to be used by AnyEvent, |
698 |
|
|
before autodetection and -probing kicks in. It must be a string |
699 |
|
|
consisting entirely of ASCII letters. The string "AnyEvent::Impl::" |
700 |
|
|
gets prepended and the resulting module name is loaded and if the |
701 |
|
|
load was successful, used as event model. If it fails to load |
702 |
|
|
AnyEvent will proceed with autodetection and -probing. |
703 |
|
|
|
704 |
|
|
This functionality might change in future versions. |
705 |
|
|
|
706 |
|
|
For example, to force the pure perl model (AnyEvent::Impl::Perl) you |
707 |
|
|
could start your program like this: |
708 |
|
|
|
709 |
|
|
PERL_ANYEVENT_MODEL=Perl perl ... |
710 |
root |
1.4 |
|
711 |
root |
1.16 |
EXAMPLE PROGRAM |
712 |
root |
1.19 |
The following program uses an I/O watcher to read data from STDIN, a |
713 |
root |
1.16 |
timer to display a message once per second, and a condition variable to |
714 |
|
|
quit the program when the user enters quit: |
715 |
root |
1.2 |
|
716 |
|
|
use AnyEvent; |
717 |
|
|
|
718 |
|
|
my $cv = AnyEvent->condvar; |
719 |
|
|
|
720 |
root |
1.16 |
my $io_watcher = AnyEvent->io ( |
721 |
|
|
fh => \*STDIN, |
722 |
|
|
poll => 'r', |
723 |
|
|
cb => sub { |
724 |
|
|
warn "io event <$_[0]>\n"; # will always output <r> |
725 |
|
|
chomp (my $input = <STDIN>); # read a line |
726 |
|
|
warn "read: $input\n"; # output what has been read |
727 |
|
|
$cv->broadcast if $input =~ /^q/i; # quit program if /^q/i |
728 |
|
|
}, |
729 |
|
|
); |
730 |
root |
1.2 |
|
731 |
|
|
my $time_watcher; # can only be used once |
732 |
|
|
|
733 |
|
|
sub new_timer { |
734 |
|
|
$timer = AnyEvent->timer (after => 1, cb => sub { |
735 |
|
|
warn "timeout\n"; # print 'timeout' about every second |
736 |
|
|
&new_timer; # and restart the time |
737 |
|
|
}); |
738 |
|
|
} |
739 |
|
|
|
740 |
|
|
new_timer; # create first timer |
741 |
|
|
|
742 |
|
|
$cv->wait; # wait until user enters /^q/i |
743 |
|
|
|
744 |
root |
1.3 |
REAL-WORLD EXAMPLE |
745 |
|
|
Consider the Net::FCP module. It features (among others) the following |
746 |
|
|
API calls, which are to freenet what HTTP GET requests are to http: |
747 |
|
|
|
748 |
|
|
my $data = $fcp->client_get ($url); # blocks |
749 |
|
|
|
750 |
|
|
my $transaction = $fcp->txn_client_get ($url); # does not block |
751 |
|
|
$transaction->cb ( sub { ... } ); # set optional result callback |
752 |
|
|
my $data = $transaction->result; # possibly blocks |
753 |
|
|
|
754 |
|
|
The "client_get" method works like "LWP::Simple::get": it requests the |
755 |
|
|
given URL and waits till the data has arrived. It is defined to be: |
756 |
|
|
|
757 |
|
|
sub client_get { $_[0]->txn_client_get ($_[1])->result } |
758 |
|
|
|
759 |
|
|
And in fact is automatically generated. This is the blocking API of |
760 |
|
|
Net::FCP, and it works as simple as in any other, similar, module. |
761 |
|
|
|
762 |
|
|
More complicated is "txn_client_get": It only creates a transaction |
763 |
|
|
(completion, result, ...) object and initiates the transaction. |
764 |
|
|
|
765 |
|
|
my $txn = bless { }, Net::FCP::Txn::; |
766 |
|
|
|
767 |
|
|
It also creates a condition variable that is used to signal the |
768 |
|
|
completion of the request: |
769 |
|
|
|
770 |
|
|
$txn->{finished} = AnyAvent->condvar; |
771 |
|
|
|
772 |
|
|
It then creates a socket in non-blocking mode. |
773 |
|
|
|
774 |
|
|
socket $txn->{fh}, ...; |
775 |
|
|
fcntl $txn->{fh}, F_SETFL, O_NONBLOCK; |
776 |
|
|
connect $txn->{fh}, ... |
777 |
|
|
and !$!{EWOULDBLOCK} |
778 |
|
|
and !$!{EINPROGRESS} |
779 |
|
|
and Carp::croak "unable to connect: $!\n"; |
780 |
|
|
|
781 |
root |
1.4 |
Then it creates a write-watcher which gets called whenever an error |
782 |
root |
1.3 |
occurs or the connection succeeds: |
783 |
|
|
|
784 |
|
|
$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'w', cb => sub { $txn->fh_ready_w }); |
785 |
|
|
|
786 |
|
|
And returns this transaction object. The "fh_ready_w" callback gets |
787 |
|
|
called as soon as the event loop detects that the socket is ready for |
788 |
|
|
writing. |
789 |
|
|
|
790 |
|
|
The "fh_ready_w" method makes the socket blocking again, writes the |
791 |
|
|
request data and replaces the watcher by a read watcher (waiting for |
792 |
|
|
reply data). The actual code is more complicated, but that doesn't |
793 |
|
|
matter for this example: |
794 |
|
|
|
795 |
|
|
fcntl $txn->{fh}, F_SETFL, 0; |
796 |
|
|
syswrite $txn->{fh}, $txn->{request} |
797 |
|
|
or die "connection or write error"; |
798 |
|
|
$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
799 |
|
|
|
800 |
|
|
Again, "fh_ready_r" waits till all data has arrived, and then stores the |
801 |
|
|
result and signals any possible waiters that the request ahs finished: |
802 |
|
|
|
803 |
|
|
sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
804 |
|
|
|
805 |
|
|
if (end-of-file or data complete) { |
806 |
|
|
$txn->{result} = $txn->{buf}; |
807 |
|
|
$txn->{finished}->broadcast; |
808 |
root |
1.4 |
$txb->{cb}->($txn) of $txn->{cb}; # also call callback |
809 |
root |
1.3 |
} |
810 |
|
|
|
811 |
|
|
The "result" method, finally, just waits for the finished signal (if the |
812 |
|
|
request was already finished, it doesn't wait, of course, and returns |
813 |
|
|
the data: |
814 |
|
|
|
815 |
|
|
$txn->{finished}->wait; |
816 |
root |
1.4 |
return $txn->{result}; |
817 |
root |
1.3 |
|
818 |
|
|
The actual code goes further and collects all errors ("die"s, |
819 |
|
|
exceptions) that occured during request processing. The "result" method |
820 |
root |
1.16 |
detects whether an exception as thrown (it is stored inside the $txn |
821 |
root |
1.3 |
object) and just throws the exception, which means connection errors and |
822 |
|
|
other problems get reported tot he code that tries to use the result, |
823 |
|
|
not in a random callback. |
824 |
|
|
|
825 |
|
|
All of this enables the following usage styles: |
826 |
|
|
|
827 |
|
|
1. Blocking: |
828 |
|
|
|
829 |
|
|
my $data = $fcp->client_get ($url); |
830 |
|
|
|
831 |
root |
1.15 |
2. Blocking, but running in parallel: |
832 |
root |
1.3 |
|
833 |
|
|
my @datas = map $_->result, |
834 |
|
|
map $fcp->txn_client_get ($_), |
835 |
|
|
@urls; |
836 |
|
|
|
837 |
|
|
Both blocking examples work without the module user having to know |
838 |
|
|
anything about events. |
839 |
|
|
|
840 |
root |
1.15 |
3a. Event-based in a main program, using any supported event module: |
841 |
root |
1.3 |
|
842 |
root |
1.15 |
use EV; |
843 |
root |
1.3 |
|
844 |
|
|
$fcp->txn_client_get ($url)->cb (sub { |
845 |
|
|
my $txn = shift; |
846 |
|
|
my $data = $txn->result; |
847 |
|
|
... |
848 |
|
|
}); |
849 |
|
|
|
850 |
root |
1.15 |
EV::loop; |
851 |
root |
1.3 |
|
852 |
|
|
3b. The module user could use AnyEvent, too: |
853 |
|
|
|
854 |
|
|
use AnyEvent; |
855 |
|
|
|
856 |
|
|
my $quit = AnyEvent->condvar; |
857 |
|
|
|
858 |
|
|
$fcp->txn_client_get ($url)->cb (sub { |
859 |
|
|
... |
860 |
|
|
$quit->broadcast; |
861 |
|
|
}); |
862 |
|
|
|
863 |
|
|
$quit->wait; |
864 |
|
|
|
865 |
root |
1.19 |
BENCHMARKS |
866 |
|
|
To give you an idea of the performance and overheads that AnyEvent adds |
867 |
|
|
over the event loops themselves and to give you an impression of the |
868 |
|
|
speed of various event loops I prepared some benchmarks. |
869 |
|
|
|
870 |
|
|
BENCHMARKING ANYEVENT OVERHEAD |
871 |
|
|
Here is a benchmark of various supported event models used natively and |
872 |
|
|
through anyevent. The benchmark creates a lot of timers (with a zero |
873 |
|
|
timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
874 |
|
|
which it is), lets them fire exactly once and destroys them again. |
875 |
|
|
|
876 |
|
|
Source code for this benchmark is found as eg/bench in the AnyEvent |
877 |
|
|
distribution. |
878 |
|
|
|
879 |
|
|
Explanation of the columns |
880 |
|
|
*watcher* is the number of event watchers created/destroyed. Since |
881 |
|
|
different event models feature vastly different performances, each event |
882 |
|
|
loop was given a number of watchers so that overall runtime is |
883 |
|
|
acceptable and similar between tested event loop (and keep them from |
884 |
|
|
crashing): Glib would probably take thousands of years if asked to |
885 |
|
|
process the same number of watchers as EV in this benchmark. |
886 |
|
|
|
887 |
|
|
*bytes* is the number of bytes (as measured by the resident set size, |
888 |
|
|
RSS) consumed by each watcher. This method of measuring captures both C |
889 |
|
|
and Perl-based overheads. |
890 |
|
|
|
891 |
|
|
*create* is the time, in microseconds (millionths of seconds), that it |
892 |
|
|
takes to create a single watcher. The callback is a closure shared |
893 |
|
|
between all watchers, to avoid adding memory overhead. That means |
894 |
|
|
closure creation and memory usage is not included in the figures. |
895 |
|
|
|
896 |
|
|
*invoke* is the time, in microseconds, used to invoke a simple callback. |
897 |
|
|
The callback simply counts down a Perl variable and after it was invoked |
898 |
|
|
"watcher" times, it would "->broadcast" a condvar once to signal the end |
899 |
|
|
of this phase. |
900 |
|
|
|
901 |
|
|
*destroy* is the time, in microseconds, that it takes to destroy a |
902 |
|
|
single watcher. |
903 |
|
|
|
904 |
|
|
Results |
905 |
|
|
name watchers bytes create invoke destroy comment |
906 |
|
|
EV/EV 400000 244 0.56 0.46 0.31 EV native interface |
907 |
|
|
EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers |
908 |
|
|
CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal |
909 |
|
|
Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation |
910 |
|
|
Event/Event 16000 516 31.88 31.30 0.85 Event native interface |
911 |
|
|
Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers |
912 |
|
|
Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour |
913 |
|
|
Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers |
914 |
|
|
POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event |
915 |
|
|
POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select |
916 |
|
|
|
917 |
|
|
Discussion |
918 |
|
|
The benchmark does *not* measure scalability of the event loop very |
919 |
|
|
well. For example, a select-based event loop (such as the pure perl one) |
920 |
|
|
can never compete with an event loop that uses epoll when the number of |
921 |
|
|
file descriptors grows high. In this benchmark, all events become ready |
922 |
|
|
at the same time, so select/poll-based implementations get an unnatural |
923 |
|
|
speed boost. |
924 |
|
|
|
925 |
|
|
Also, note that the number of watchers usually has a nonlinear effect on |
926 |
|
|
overall speed, that is, creating twice as many watchers doesn't take |
927 |
|
|
twice the time - usually it takes longer. This puts event loops tested |
928 |
|
|
with a higher number of watchers at a disadvantage. |
929 |
|
|
|
930 |
|
|
To put the range of results into perspective, consider that on the |
931 |
|
|
benchmark machine, handling an event takes roughly 1600 CPU cycles with |
932 |
|
|
EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 |
933 |
|
|
CPU cycles with POE. |
934 |
|
|
|
935 |
|
|
"EV" is the sole leader regarding speed and memory use, which are both |
936 |
|
|
maximal/minimal, respectively. Even when going through AnyEvent, it uses |
937 |
|
|
far less memory than any other event loop and is still faster than Event |
938 |
|
|
natively. |
939 |
|
|
|
940 |
|
|
The pure perl implementation is hit in a few sweet spots (both the |
941 |
|
|
constant timeout and the use of a single fd hit optimisations in the |
942 |
|
|
perl interpreter and the backend itself). Nevertheless this shows that |
943 |
|
|
it adds very little overhead in itself. Like any select-based backend |
944 |
|
|
its performance becomes really bad with lots of file descriptors (and |
945 |
|
|
few of them active), of course, but this was not subject of this |
946 |
|
|
benchmark. |
947 |
|
|
|
948 |
|
|
The "Event" module has a relatively high setup and callback invocation |
949 |
|
|
cost, but overall scores in on the third place. |
950 |
|
|
|
951 |
|
|
"Glib"'s memory usage is quite a bit higher, but it features a faster |
952 |
|
|
callback invocation and overall ends up in the same class as "Event". |
953 |
|
|
However, Glib scales extremely badly, doubling the number of watchers |
954 |
|
|
increases the processing time by more than a factor of four, making it |
955 |
|
|
completely unusable when using larger numbers of watchers (note that |
956 |
|
|
only a single file descriptor was used in the benchmark, so |
957 |
|
|
inefficiencies of "poll" do not account for this). |
958 |
|
|
|
959 |
|
|
The "Tk" adaptor works relatively well. The fact that it crashes with |
960 |
|
|
more than 2000 watchers is a big setback, however, as correctness takes |
961 |
|
|
precedence over speed. Nevertheless, its performance is surprising, as |
962 |
|
|
the file descriptor is dup()ed for each watcher. This shows that the |
963 |
|
|
dup() employed by some adaptors is not a big performance issue (it does |
964 |
|
|
incur a hidden memory cost inside the kernel which is not reflected in |
965 |
|
|
the figures above). |
966 |
|
|
|
967 |
|
|
"POE", regardless of underlying event loop (whether using its pure perl |
968 |
|
|
select-based backend or the Event module, the POE-EV backend couldn't be |
969 |
|
|
tested because it wasn't working) shows abysmal performance and memory |
970 |
root |
1.20 |
usage with AnyEvent: Watchers use almost 30 times as much memory as EV |
971 |
|
|
watchers, and 10 times as much memory as Event (the high memory |
972 |
|
|
requirements are caused by requiring a session for each watcher). |
973 |
|
|
Watcher invocation speed is almost 900 times slower than with AnyEvent's |
974 |
|
|
pure perl implementation. |
975 |
|
|
|
976 |
|
|
The design of the POE adaptor class in AnyEvent can not really account |
977 |
|
|
for the performance issues, though, as session creation overhead is |
978 |
|
|
small compared to execution of the state machine, which is coded pretty |
979 |
|
|
optimally within AnyEvent::Impl::POE (and while everybody agrees that |
980 |
|
|
using multiple sessions is not a good approach, especially regarding |
981 |
|
|
memory usage, even the author of POE could not come up with a faster |
982 |
|
|
design). |
983 |
root |
1.19 |
|
984 |
|
|
Summary |
985 |
|
|
* Using EV through AnyEvent is faster than any other event loop (even |
986 |
|
|
when used without AnyEvent), but most event loops have acceptable |
987 |
|
|
performance with or without AnyEvent. |
988 |
|
|
|
989 |
|
|
* The overhead AnyEvent adds is usually much smaller than the overhead |
990 |
|
|
of the actual event loop, only with extremely fast event loops such |
991 |
|
|
as EV adds AnyEvent significant overhead. |
992 |
|
|
|
993 |
|
|
* You should avoid POE like the plague if you want performance or |
994 |
|
|
reasonable memory usage. |
995 |
|
|
|
996 |
|
|
BENCHMARKING THE LARGE SERVER CASE |
997 |
|
|
This benchmark atcually benchmarks the event loop itself. It works by |
998 |
|
|
creating a number of "servers": each server consists of a socketpair, a |
999 |
|
|
timeout watcher that gets reset on activity (but never fires), and an |
1000 |
|
|
I/O watcher waiting for input on one side of the socket. Each time the |
1001 |
|
|
socket watcher reads a byte it will write that byte to a random other |
1002 |
|
|
"server". |
1003 |
|
|
|
1004 |
|
|
The effect is that there will be a lot of I/O watchers, only part of |
1005 |
|
|
which are active at any one point (so there is a constant number of |
1006 |
|
|
active fds for each loop iterstaion, but which fds these are is random). |
1007 |
|
|
The timeout is reset each time something is read because that reflects |
1008 |
|
|
how most timeouts work (and puts extra pressure on the event loops). |
1009 |
|
|
|
1010 |
|
|
In this benchmark, we use 10000 socketpairs (20000 sockets), of which |
1011 |
|
|
100 (1%) are active. This mirrors the activity of large servers with |
1012 |
|
|
many connections, most of which are idle at any one point in time. |
1013 |
|
|
|
1014 |
|
|
Source code for this benchmark is found as eg/bench2 in the AnyEvent |
1015 |
|
|
distribution. |
1016 |
|
|
|
1017 |
|
|
Explanation of the columns |
1018 |
|
|
*sockets* is the number of sockets, and twice the number of "servers" |
1019 |
|
|
(as each server has a read and write socket end). |
1020 |
|
|
|
1021 |
|
|
*create* is the time it takes to create a socketpair (which is |
1022 |
|
|
nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1023 |
|
|
|
1024 |
|
|
*request*, the most important value, is the time it takes to handle a |
1025 |
|
|
single "request", that is, reading the token from the pipe and |
1026 |
|
|
forwarding it to another server. This includes deleting the old timeout |
1027 |
|
|
and creating a new one that moves the timeout into the future. |
1028 |
|
|
|
1029 |
|
|
Results |
1030 |
|
|
name sockets create request |
1031 |
|
|
EV 20000 69.01 11.16 |
1032 |
|
|
Perl 20000 73.32 35.87 |
1033 |
|
|
Event 20000 212.62 257.32 |
1034 |
|
|
Glib 20000 651.16 1896.30 |
1035 |
|
|
POE 20000 349.67 12317.24 uses POE::Loop::Event |
1036 |
|
|
|
1037 |
|
|
Discussion |
1038 |
|
|
This benchmark *does* measure scalability and overall performance of the |
1039 |
|
|
particular event loop. |
1040 |
|
|
|
1041 |
|
|
EV is again fastest. Since it is using epoll on my system, the setup |
1042 |
|
|
time is relatively high, though. |
1043 |
|
|
|
1044 |
|
|
Perl surprisingly comes second. It is much faster than the C-based event |
1045 |
|
|
loops Event and Glib. |
1046 |
|
|
|
1047 |
|
|
Event suffers from high setup time as well (look at its code and you |
1048 |
|
|
will understand why). Callback invocation also has a high overhead |
1049 |
|
|
compared to the "$_->() for .."-style loop that the Perl event loop |
1050 |
|
|
uses. Event uses select or poll in basically all documented |
1051 |
|
|
configurations. |
1052 |
|
|
|
1053 |
|
|
Glib is hit hard by its quadratic behaviour w.r.t. many watchers. It |
1054 |
|
|
clearly fails to perform with many filehandles or in busy servers. |
1055 |
|
|
|
1056 |
|
|
POE is still completely out of the picture, taking over 1000 times as |
1057 |
|
|
long as EV, and over 100 times as long as the Perl implementation, even |
1058 |
|
|
though it uses a C-based event loop in this case. |
1059 |
|
|
|
1060 |
|
|
Summary |
1061 |
root |
1.20 |
* The pure perl implementation performs extremely well. |
1062 |
root |
1.19 |
|
1063 |
|
|
* Avoid Glib or POE in large projects where performance matters. |
1064 |
|
|
|
1065 |
|
|
BENCHMARKING SMALL SERVERS |
1066 |
|
|
While event loops should scale (and select-based ones do not...) even to |
1067 |
|
|
large servers, most programs we (or I :) actually write have only a few |
1068 |
|
|
I/O watchers. |
1069 |
|
|
|
1070 |
|
|
In this benchmark, I use the same benchmark program as in the large |
1071 |
|
|
server case, but it uses only eight "servers", of which three are active |
1072 |
|
|
at any one time. This should reflect performance for a small server |
1073 |
|
|
relatively well. |
1074 |
|
|
|
1075 |
|
|
The columns are identical to the previous table. |
1076 |
|
|
|
1077 |
|
|
Results |
1078 |
|
|
name sockets create request |
1079 |
|
|
EV 16 20.00 6.54 |
1080 |
|
|
Perl 16 25.75 12.62 |
1081 |
|
|
Event 16 81.27 35.86 |
1082 |
|
|
Glib 16 32.63 15.48 |
1083 |
|
|
POE 16 261.87 276.28 uses POE::Loop::Event |
1084 |
|
|
|
1085 |
|
|
Discussion |
1086 |
|
|
The benchmark tries to test the performance of a typical small server. |
1087 |
|
|
While knowing how various event loops perform is interesting, keep in |
1088 |
|
|
mind that their overhead in this case is usually not as important, due |
1089 |
|
|
to the small absolute number of watchers (that is, you need efficiency |
1090 |
|
|
and speed most when you have lots of watchers, not when you only have a |
1091 |
|
|
few of them). |
1092 |
|
|
|
1093 |
|
|
EV is again fastest. |
1094 |
|
|
|
1095 |
|
|
Perl again comes second. It is noticably faster than the C-based event |
1096 |
|
|
loops Event and Glib, although the difference is too small to really |
1097 |
|
|
matter. |
1098 |
|
|
|
1099 |
|
|
POE also performs much better in this case, but is is still far behind |
1100 |
|
|
the others. |
1101 |
|
|
|
1102 |
|
|
Summary |
1103 |
|
|
* C-based event loops perform very well with small number of watchers, |
1104 |
|
|
as the management overhead dominates. |
1105 |
|
|
|
1106 |
root |
1.18 |
FORK |
1107 |
|
|
Most event libraries are not fork-safe. The ones who are usually are |
1108 |
root |
1.20 |
because they rely on inefficient but fork-safe "select" or "poll" calls. |
1109 |
|
|
Only EV is fully fork-aware. |
1110 |
root |
1.18 |
|
1111 |
|
|
If you have to fork, you must either do so *before* creating your first |
1112 |
|
|
watcher OR you must not use AnyEvent at all in the child. |
1113 |
|
|
|
1114 |
|
|
SECURITY CONSIDERATIONS |
1115 |
|
|
AnyEvent can be forced to load any event model via |
1116 |
|
|
$ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used |
1117 |
|
|
to execute arbitrary code or directly gain access, it can easily be used |
1118 |
|
|
to make the program hang or malfunction in subtle ways, as AnyEvent |
1119 |
|
|
watchers will not be active when the program uses a different event |
1120 |
|
|
model than specified in the variable. |
1121 |
|
|
|
1122 |
|
|
You can make AnyEvent completely ignore this variable by deleting it |
1123 |
|
|
before the first watcher gets created, e.g. with a "BEGIN" block: |
1124 |
|
|
|
1125 |
|
|
BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1126 |
|
|
|
1127 |
|
|
use AnyEvent; |
1128 |
|
|
|
1129 |
root |
1.20 |
Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1130 |
|
|
be used to probe what backend is used and gain other information (which |
1131 |
|
|
is probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1132 |
|
|
|
1133 |
root |
1.2 |
SEE ALSO |
1134 |
root |
1.20 |
Event modules: EV, EV::Glib, Glib::EV, Event, Glib::Event, Glib, Tk, |
1135 |
|
|
Event::Lib, Qt, POE. |
1136 |
|
|
|
1137 |
|
|
Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event, |
1138 |
|
|
AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, |
1139 |
|
|
AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE. |
1140 |
root |
1.3 |
|
1141 |
root |
1.20 |
Coroutine support: Coro, Coro::AnyEvent, Coro::EV, Coro::Event, |
1142 |
root |
1.3 |
|
1143 |
root |
1.15 |
Nontrivial usage examples: Net::FCP, Net::XMPP2. |
1144 |
root |
1.2 |
|
1145 |
root |
1.17 |
AUTHOR |
1146 |
|
|
Marc Lehmann <schmorp@schmorp.de> |
1147 |
|
|
http://home.schmorp.de/ |
1148 |
root |
1.2 |
|