ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/README
Revision: 1.30
Committed: Mon Sep 29 02:08:57 2008 UTC (15 years, 7 months ago) by root
Branch: MAIN
CVS Tags: rel-4_234
Changes since 1.29: +75 -50 lines
Log Message:
4.234

File Contents

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