ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/README
(Generate patch)

Comparing AnyEvent/README (file contents):
Revision 1.48 by root, Sun Jul 26 00:17:24 2009 UTC vs.
Revision 1.61 by root, Wed Apr 28 14:15:55 2010 UTC

1NAME 1NAME
2 AnyEvent - the DBI of event loop programming 2 AnyEvent - the DBI of event loop programming
3 3
4 EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, IO::Async, Qt and POE are 4 EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async,
5 various supported event loops/environments. 5 Qt and POE are various supported event loops/environments.
6 6
7SYNOPSIS 7SYNOPSIS
8 use AnyEvent; 8 use AnyEvent;
9 9
10 # if you prefer function calls, look at the L<AE> manpage for
11 # an alternative API.
12
10 # file descriptor readable 13 # file handle or descriptor readable
11 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); 14 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
12 15
13 # one-shot or repeating timers 16 # one-shot or repeating timers
14 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); 17 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
15 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... 18 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
173 Note that "my $w; $w =" combination. This is necessary because in Perl, 176 Note that "my $w; $w =" combination. This is necessary because in Perl,
174 my variables are only visible after the statement in which they are 177 my variables are only visible after the statement in which they are
175 declared. 178 declared.
176 179
177 I/O WATCHERS 180 I/O WATCHERS
181 $w = AnyEvent->io (
182 fh => <filehandle_or_fileno>,
183 poll => <"r" or "w">,
184 cb => <callback>,
185 );
186
178 You can create an I/O watcher by calling the "AnyEvent->io" method with 187 You can create an I/O watcher by calling the "AnyEvent->io" method with
179 the following mandatory key-value pairs as arguments: 188 the following mandatory key-value pairs as arguments:
180 189
181 "fh" is the Perl *file handle* (or a naked file descriptor) to watch for 190 "fh" is the Perl *file handle* (or a naked file descriptor) to watch for
182 events (AnyEvent might or might not keep a reference to this file 191 events (AnyEvent might or might not keep a reference to this file
210 warn "read: $input\n"; 219 warn "read: $input\n";
211 undef $w; 220 undef $w;
212 }); 221 });
213 222
214 TIME WATCHERS 223 TIME WATCHERS
224 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
225
226 $w = AnyEvent->timer (
227 after => <fractional_seconds>,
228 interval => <fractional_seconds>,
229 cb => <callback>,
230 );
231
215 You can create a time watcher by calling the "AnyEvent->timer" method 232 You can create a time watcher by calling the "AnyEvent->timer" method
216 with the following mandatory arguments: 233 with the following mandatory arguments:
217 234
218 "after" specifies after how many seconds (fractional values are 235 "after" specifies after how many seconds (fractional values are
219 supported) the callback should be invoked. "cb" is the callback to 236 supported) the callback should be invoked. "cb" is the callback to
340 time, which might affect timers and time-outs. 357 time, which might affect timers and time-outs.
341 358
342 When this is the case, you can call this method, which will update 359 When this is the case, you can call this method, which will update
343 the event loop's idea of "current time". 360 the event loop's idea of "current time".
344 361
362 A typical example would be a script in a web server (e.g.
363 "mod_perl") - when mod_perl executes the script, then the event loop
364 will have the wrong idea about the "current time" (being potentially
365 far in the past, when the script ran the last time). In that case
366 you should arrange a call to "AnyEvent->now_update" each time the
367 web server process wakes up again (e.g. at the start of your script,
368 or in a handler).
369
345 Note that updating the time *might* cause some events to be handled. 370 Note that updating the time *might* cause some events to be handled.
346 371
347 SIGNAL WATCHERS 372 SIGNAL WATCHERS
373 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
374
348 You can watch for signals using a signal watcher, "signal" is the signal 375 You can watch for signals using a signal watcher, "signal" is the signal
349 *name* in uppercase and without any "SIG" prefix, "cb" is the Perl 376 *name* in uppercase and without any "SIG" prefix, "cb" is the Perl
350 callback to be invoked whenever a signal occurs. 377 callback to be invoked whenever a signal occurs.
351 378
352 Although the callback might get passed parameters, their value and 379 Although the callback might get passed parameters, their value and
368 395
369 Example: exit on SIGINT 396 Example: exit on SIGINT
370 397
371 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 398 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
372 399
400 Restart Behaviour
401 While restart behaviour is up to the event loop implementation, most
402 will not restart syscalls (that includes Async::Interrupt and AnyEvent's
403 pure perl implementation).
404
405 Safe/Unsafe Signals
406 Perl signals can be either "safe" (synchronous to opcode handling) or
407 "unsafe" (asynchronous) - the former might get delayed indefinitely, the
408 latter might corrupt your memory.
409
410 AnyEvent signal handlers are, in addition, synchronous to the event
411 loop, i.e. they will not interrupt your running perl program but will
412 only be called as part of the normal event handling (just like timer,
413 I/O etc. callbacks, too).
414
373 Signal Races, Delays and Workarounds 415 Signal Races, Delays and Workarounds
374 Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 416 Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
375 callbacks to signals in a generic way, which is a pity, as you cannot do 417 callbacks to signals in a generic way, which is a pity, as you cannot do
376 race-free signal handling in perl. AnyEvent will try to do it's best, 418 race-free signal handling in perl, requiring C libraries for this.
377 but in some cases, signals will be delayed. The maximum time a signal 419 AnyEvent will try to do it's best, which means in some cases, signals
378 might be delayed is specified in $AnyEvent::MAX_SIGNAL_LATENCY (default: 420 will be delayed. The maximum time a signal might be delayed is specified
379 10 seconds). This variable can be changed only before the first signal 421 in $AnyEvent::MAX_SIGNAL_LATENCY (default: 10 seconds). This variable
380 watcher is created, and should be left alone otherwise. Higher values 422 can be changed only before the first signal watcher is created, and
423 should be left alone otherwise. This variable determines how often
424 AnyEvent polls for signals (in case a wake-up was missed). Higher values
381 will cause fewer spurious wake-ups, which is better for power and CPU 425 will cause fewer spurious wake-ups, which is better for power and CPU
426 saving.
427
382 saving. All these problems can be avoided by installing the optional 428 All these problems can be avoided by installing the optional
383 Async::Interrupt module. This will not work with inherently broken event 429 Async::Interrupt module, which works with most event loops. It will not
384 loops such as Event or Event::Lib (and not with POE currently, as POE 430 work with inherently broken event loops such as Event or Event::Lib (and
385 does it's own workaround with one-second latency). With those, you just 431 not with POE currently, as POE does it's own workaround with one-second
386 have to suffer the delays. 432 latency). For those, you just have to suffer the delays.
387 433
388 CHILD PROCESS WATCHERS 434 CHILD PROCESS WATCHERS
435 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
436
389 You can also watch on a child process exit and catch its exit status. 437 You can also watch on a child process exit and catch its exit status.
390 438
391 The child process is specified by the "pid" argument (one some backends, 439 The child process is specified by the "pid" argument (one some backends,
392 using 0 watches for any child process exit, on others this will croak). 440 using 0 watches for any child process exit, on others this will croak).
393 The watcher will be triggered only when the child process has finished 441 The watcher will be triggered only when the child process has finished
423 problems mentioned in the description of signal watchers apply. 471 problems mentioned in the description of signal watchers apply.
424 472
425 Example: fork a process and wait for it 473 Example: fork a process and wait for it
426 474
427 my $done = AnyEvent->condvar; 475 my $done = AnyEvent->condvar;
428 476
429 my $pid = fork or exit 5; 477 my $pid = fork or exit 5;
430 478
431 my $w = AnyEvent->child ( 479 my $w = AnyEvent->child (
432 pid => $pid, 480 pid => $pid,
433 cb => sub { 481 cb => sub {
434 my ($pid, $status) = @_; 482 my ($pid, $status) = @_;
435 warn "pid $pid exited with status $status"; 483 warn "pid $pid exited with status $status";
436 $done->send; 484 $done->send;
437 }, 485 },
438 ); 486 );
439 487
440 # do something else, then wait for process exit 488 # do something else, then wait for process exit
441 $done->recv; 489 $done->recv;
442 490
443 IDLE WATCHERS 491 IDLE WATCHERS
444 Sometimes there is a need to do something, but it is not so important to 492 $w = AnyEvent->idle (cb => <callback>);
445 do it instantly, but only when there is nothing better to do. This
446 "nothing better to do" is usually defined to be "no other events need
447 attention by the event loop".
448 493
449 Idle watchers ideally get invoked when the event loop has nothing better 494 Repeatedly invoke the callback after the process becomes idle, until
450 to do, just before it would block the process to wait for new events. 495 either the watcher is destroyed or new events have been detected.
451 Instead of blocking, the idle watcher is invoked.
452 496
453 Most event loops unfortunately do not really support idle watchers (only 497 Idle watchers are useful when there is a need to do something, but it is
498 not so important (or wise) to do it instantly. The callback will be
499 invoked only when there is "nothing better to do", which is usually
500 defined as "all outstanding events have been handled and no new events
501 have been detected". That means that idle watchers ideally get invoked
502 when the event loop has just polled for new events but none have been
503 detected. Instead of blocking to wait for more events, the idle watchers
504 will be invoked.
505
506 Unfortunately, most event loops do not really support idle watchers
454 EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent 507 (only EV, Event and Glib do it in a usable fashion) - for the rest,
455 will simply call the callback "from time to time". 508 AnyEvent will simply call the callback "from time to time".
456 509
457 Example: read lines from STDIN, but only process them when the program 510 Example: read lines from STDIN, but only process them when the program
458 is otherwise idle: 511 is otherwise idle:
459 512
460 my @lines; # read data 513 my @lines; # read data
473 } 526 }
474 }); 527 });
475 }); 528 });
476 529
477 CONDITION VARIABLES 530 CONDITION VARIABLES
531 $cv = AnyEvent->condvar;
532
533 $cv->send (<list>);
534 my @res = $cv->recv;
535
478 If you are familiar with some event loops you will know that all of them 536 If you are familiar with some event loops you will know that all of them
479 require you to run some blocking "loop", "run" or similar function that 537 require you to run some blocking "loop", "run" or similar function that
480 will actively watch for new events and call your callbacks. 538 will actively watch for new events and call your callbacks.
481 539
482 AnyEvent is slightly different: it expects somebody else to run the 540 AnyEvent is slightly different: it expects somebody else to run the
534 which eventually calls "-> send", and the "consumer side", which waits 592 which eventually calls "-> send", and the "consumer side", which waits
535 for the send to occur. 593 for the send to occur.
536 594
537 Example: wait for a timer. 595 Example: wait for a timer.
538 596
539 # wait till the result is ready 597 # condition: "wait till the timer is fired"
540 my $result_ready = AnyEvent->condvar; 598 my $timer_fired = AnyEvent->condvar;
541 599
542 # do something such as adding a timer 600 # create the timer - we could wait for, say
543 # or socket watcher the calls $result_ready->send 601 # a handle becomign ready, or even an
544 # when the "result" is ready. 602 # AnyEvent::HTTP request to finish, but
545 # in this case, we simply use a timer: 603 # in this case, we simply use a timer:
546 my $w = AnyEvent->timer ( 604 my $w = AnyEvent->timer (
547 after => 1, 605 after => 1,
548 cb => sub { $result_ready->send }, 606 cb => sub { $timer_fired->send },
549 ); 607 );
550 608
551 # this "blocks" (while handling events) till the callback 609 # this "blocks" (while handling events) till the callback
552 # calls -<send 610 # calls ->send
553 $result_ready->recv; 611 $timer_fired->recv;
554 612
555 Example: wait for a timer, but take advantage of the fact that condition 613 Example: wait for a timer, but take advantage of the fact that condition
556 variables are also callable directly. 614 variables are also callable directly.
557 615
558 my $done = AnyEvent->condvar; 616 my $done = AnyEvent->condvar;
614 into one. For example, a function that pings many hosts in parallel 672 into one. For example, a function that pings many hosts in parallel
615 might want to use a condition variable for the whole process. 673 might want to use a condition variable for the whole process.
616 674
617 Every call to "->begin" will increment a counter, and every call to 675 Every call to "->begin" will increment a counter, and every call to
618 "->end" will decrement it. If the counter reaches 0 in "->end", the 676 "->end" will decrement it. If the counter reaches 0 in "->end", the
619 (last) callback passed to "begin" will be executed. That callback is 677 (last) callback passed to "begin" will be executed, passing the
620 *supposed* to call "->send", but that is not required. If no 678 condvar as first argument. That callback is *supposed* to call
679 "->send", but that is not required. If no group callback was set,
621 callback was set, "send" will be called without any arguments. 680 "send" will be called without any arguments.
622 681
623 You can think of "$cv->send" giving you an OR condition (one call 682 You can think of "$cv->send" giving you an OR condition (one call
624 sends), while "$cv->begin" and "$cv->end" giving you an AND 683 sends), while "$cv->begin" and "$cv->end" giving you an AND
625 condition (all "begin" calls must be "end"'ed before the condvar 684 condition (all "begin" calls must be "end"'ed before the condvar
626 sends). 685 sends).
654 that are begung can potentially be zero: 713 that are begung can potentially be zero:
655 714
656 my $cv = AnyEvent->condvar; 715 my $cv = AnyEvent->condvar;
657 716
658 my %result; 717 my %result;
659 $cv->begin (sub { $cv->send (\%result) }); 718 $cv->begin (sub { shift->send (\%result) });
660 719
661 for my $host (@list_of_hosts) { 720 for my $host (@list_of_hosts) {
662 $cv->begin; 721 $cv->begin;
663 ping_host_then_call_callback $host, sub { 722 ping_host_then_call_callback $host, sub {
664 $result{$host} = ...; 723 $result{$host} = ...;
731 790
732 $cb = $cv->cb ($cb->($cv)) 791 $cb = $cv->cb ($cb->($cv))
733 This is a mutator function that returns the callback set and 792 This is a mutator function that returns the callback set and
734 optionally replaces it before doing so. 793 optionally replaces it before doing so.
735 794
736 The callback will be called when the condition becomes "true", i.e. 795 The callback will be called when the condition becomes (or already
737 when "send" or "croak" are called, with the only argument being the 796 was) "true", i.e. when "send" or "croak" are called (or were
738 condition variable itself. Calling "recv" inside the callback or at 797 called), with the only argument being the condition variable itself.
798 Calling "recv" inside the callback or at any later time is
739 any later time is guaranteed not to block. 799 guaranteed not to block.
740 800
741SUPPORTED EVENT LOOPS/BACKENDS 801SUPPORTED EVENT LOOPS/BACKENDS
742 The available backend classes are (every class has its own manpage): 802 The available backend classes are (every class has its own manpage):
743 803
744 Backends that are autoprobed when no other event loop can be found. 804 Backends that are autoprobed when no other event loop can be found.
745 EV is the preferred backend when no other event loop seems to be in 805 EV is the preferred backend when no other event loop seems to be in
746 use. If EV is not installed, then AnyEvent will try Event, and, 806 use. If EV is not installed, then AnyEvent will fall back to its own
747 failing that, will fall back to its own pure-perl implementation, 807 pure-perl implementation, which is available everywhere as it comes
748 which is available everywhere as it comes with AnyEvent itself. 808 with AnyEvent itself.
749 809
750 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 810 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
751 AnyEvent::Impl::Event based on Event, very stable, few glitches.
752 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 811 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
753 812
754 Backends that are transparently being picked up when they are used. 813 Backends that are transparently being picked up when they are used.
755 These will be used when they are currently loaded when the first 814 These will be used when they are currently loaded when the first
756 watcher is created, in which case it is assumed that the application 815 watcher is created, in which case it is assumed that the application
757 is using them. This means that AnyEvent will automatically pick the 816 is using them. This means that AnyEvent will automatically pick the
758 right backend when the main program loads an event module before 817 right backend when the main program loads an event module before
759 anything starts to create watchers. Nothing special needs to be done 818 anything starts to create watchers. Nothing special needs to be done
760 by the main program. 819 by the main program.
761 820
821 AnyEvent::Impl::Event based on Event, very stable, few glitches.
762 AnyEvent::Impl::Glib based on Glib, slow but very stable. 822 AnyEvent::Impl::Glib based on Glib, slow but very stable.
763 AnyEvent::Impl::Tk based on Tk, very broken. 823 AnyEvent::Impl::Tk based on Tk, very broken.
764 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 824 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
765 AnyEvent::Impl::POE based on POE, very slow, some limitations. 825 AnyEvent::Impl::POE based on POE, very slow, some limitations.
766 AnyEvent::Impl::Irssi used when running within irssi. 826 AnyEvent::Impl::Irssi used when running within irssi.
865 You should check $AnyEvent::MODEL before adding to this array, 925 You should check $AnyEvent::MODEL before adding to this array,
866 though: if it is defined then the event loop has already been 926 though: if it is defined then the event loop has already been
867 detected, and the array will be ignored. 927 detected, and the array will be ignored.
868 928
869 Best use "AnyEvent::post_detect { BLOCK }" when your application 929 Best use "AnyEvent::post_detect { BLOCK }" when your application
870 allows it,as it takes care of these details. 930 allows it, as it takes care of these details.
871 931
872 This variable is mainly useful for modules that can do something 932 This variable is mainly useful for modules that can do something
873 useful when AnyEvent is used and thus want to know when it is 933 useful when AnyEvent is used and thus want to know when it is
874 initialised, but do not need to even load it by default. This array 934 initialised, but do not need to even load it by default. This array
875 provides the means to hook into AnyEvent passively, without loading 935 provides the means to hook into AnyEvent passively, without loading
876 it. 936 it.
937
938 Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
939 together, you could put this into Coro (this is the actual code used
940 by Coro to accomplish this):
941
942 if (defined $AnyEvent::MODEL) {
943 # AnyEvent already initialised, so load Coro::AnyEvent
944 require Coro::AnyEvent;
945 } else {
946 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
947 # as soon as it is
948 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
949 }
877 950
878WHAT TO DO IN A MODULE 951WHAT TO DO IN A MODULE
879 As a module author, you should "use AnyEvent" and call AnyEvent methods 952 As a module author, you should "use AnyEvent" and call AnyEvent methods
880 freely, but you should not load a specific event module or rely on it. 953 freely, but you should not load a specific event module or rely on it.
881 954
1002 Event::ExecFlow 1075 Event::ExecFlow
1003 High level API for event-based execution flow control. 1076 High level API for event-based execution flow control.
1004 1077
1005 Coro 1078 Coro
1006 Has special support for AnyEvent via Coro::AnyEvent. 1079 Has special support for AnyEvent via Coro::AnyEvent.
1080
1081SIMPLIFIED AE API
1082 Starting with version 5.0, AnyEvent officially supports a second, much
1083 simpler, API that is designed to reduce the calling, typing and memory
1084 overhead by using function call syntax and a fixed number of parameters.
1085
1086 See the AE manpage for details.
1007 1087
1008ERROR AND EXCEPTION HANDLING 1088ERROR AND EXCEPTION HANDLING
1009 In general, AnyEvent does not do any error handling - it relies on the 1089 In general, AnyEvent does not do any error handling - it relies on the
1010 caller to do that if required. The AnyEvent::Strict module (see also the 1090 caller to do that if required. The AnyEvent::Strict module (see also the
1011 "PERL_ANYEVENT_STRICT" environment variable, below) provides strict 1091 "PERL_ANYEVENT_STRICT" environment variable, below) provides strict
1190 warn "read: $input\n"; # output what has been read 1270 warn "read: $input\n"; # output what has been read
1191 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1271 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1192 }, 1272 },
1193 ); 1273 );
1194 1274
1195 my $time_watcher; # can only be used once
1196
1197 sub new_timer {
1198 $timer = AnyEvent->timer (after => 1, cb => sub { 1275 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1199 warn "timeout\n"; # print 'timeout' about every second 1276 warn "timeout\n"; # print 'timeout' at most every second
1200 &new_timer; # and restart the time
1201 });
1202 } 1277 });
1203
1204 new_timer; # create first timer
1205 1278
1206 $cv->recv; # wait until user enters /^q/i 1279 $cv->recv; # wait until user enters /^q/i
1207 1280
1208REAL-WORLD EXAMPLE 1281REAL-WORLD EXAMPLE
1209 Consider the Net::FCP module. It features (among others) the following 1282 Consider the Net::FCP module. It features (among others) the following
1281 1354
1282 The actual code goes further and collects all errors ("die"s, 1355 The actual code goes further and collects all errors ("die"s,
1283 exceptions) that occurred during request processing. The "result" method 1356 exceptions) that occurred during request processing. The "result" method
1284 detects whether an exception as thrown (it is stored inside the $txn 1357 detects whether an exception as thrown (it is stored inside the $txn
1285 object) and just throws the exception, which means connection errors and 1358 object) and just throws the exception, which means connection errors and
1286 other problems get reported tot he code that tries to use the result, 1359 other problems get reported to the code that tries to use the result,
1287 not in a random callback. 1360 not in a random callback.
1288 1361
1289 All of this enables the following usage styles: 1362 All of this enables the following usage styles:
1290 1363
1291 1. Blocking: 1364 1. Blocking:
1336 through AnyEvent. The benchmark creates a lot of timers (with a zero 1409 through AnyEvent. The benchmark creates a lot of timers (with a zero
1337 timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 1410 timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1338 which it is), lets them fire exactly once and destroys them again. 1411 which it is), lets them fire exactly once and destroys them again.
1339 1412
1340 Source code for this benchmark is found as eg/bench in the AnyEvent 1413 Source code for this benchmark is found as eg/bench in the AnyEvent
1341 distribution. 1414 distribution. It uses the AE interface, which makes a real difference
1415 for the EV and Perl backends only.
1342 1416
1343 Explanation of the columns 1417 Explanation of the columns
1344 *watcher* is the number of event watchers created/destroyed. Since 1418 *watcher* is the number of event watchers created/destroyed. Since
1345 different event models feature vastly different performances, each event 1419 different event models feature vastly different performances, each event
1346 loop was given a number of watchers so that overall runtime is 1420 loop was given a number of watchers so that overall runtime is
1365 *destroy* is the time, in microseconds, that it takes to destroy a 1439 *destroy* is the time, in microseconds, that it takes to destroy a
1366 single watcher. 1440 single watcher.
1367 1441
1368 Results 1442 Results
1369 name watchers bytes create invoke destroy comment 1443 name watchers bytes create invoke destroy comment
1370 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 1444 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1371 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 1445 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1372 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 1446 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1373 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 1447 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1374 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 1448 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1375 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 1449 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1376 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 1450 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1377 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 1451 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1378 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 1452 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1379 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 1453 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1380 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 1454 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1381 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 1455 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1382 1456
1383 Discussion 1457 Discussion
1384 The benchmark does *not* measure scalability of the event loop very 1458 The benchmark does *not* measure scalability of the event loop very
1385 well. For example, a select-based event loop (such as the pure perl one) 1459 well. For example, a select-based event loop (such as the pure perl one)
1386 can never compete with an event loop that uses epoll when the number of 1460 can never compete with an event loop that uses epoll when the number of
1397 benchmark machine, handling an event takes roughly 1600 CPU cycles with 1471 benchmark machine, handling an event takes roughly 1600 CPU cycles with
1398 EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 1472 EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000
1399 CPU cycles with POE. 1473 CPU cycles with POE.
1400 1474
1401 "EV" is the sole leader regarding speed and memory use, which are both 1475 "EV" is the sole leader regarding speed and memory use, which are both
1402 maximal/minimal, respectively. Even when going through AnyEvent, it uses 1476 maximal/minimal, respectively. When using the AE API there is zero
1477 overhead (when going through the AnyEvent API create is about 5-6 times
1478 slower, with other times being equal, so still uses far less memory than
1403 far less memory than any other event loop and is still faster than Event 1479 any other event loop and is still faster than Event natively).
1404 natively.
1405 1480
1406 The pure perl implementation is hit in a few sweet spots (both the 1481 The pure perl implementation is hit in a few sweet spots (both the
1407 constant timeout and the use of a single fd hit optimisations in the 1482 constant timeout and the use of a single fd hit optimisations in the
1408 perl interpreter and the backend itself). Nevertheless this shows that 1483 perl interpreter and the backend itself). Nevertheless this shows that
1409 it adds very little overhead in itself. Like any select-based backend 1484 it adds very little overhead in itself. Like any select-based backend
1479 In this benchmark, we use 10000 socket pairs (20000 sockets), of which 1554 In this benchmark, we use 10000 socket pairs (20000 sockets), of which
1480 100 (1%) are active. This mirrors the activity of large servers with 1555 100 (1%) are active. This mirrors the activity of large servers with
1481 many connections, most of which are idle at any one point in time. 1556 many connections, most of which are idle at any one point in time.
1482 1557
1483 Source code for this benchmark is found as eg/bench2 in the AnyEvent 1558 Source code for this benchmark is found as eg/bench2 in the AnyEvent
1484 distribution. 1559 distribution. It uses the AE interface, which makes a real difference
1560 for the EV and Perl backends only.
1485 1561
1486 Explanation of the columns 1562 Explanation of the columns
1487 *sockets* is the number of sockets, and twice the number of "servers" 1563 *sockets* is the number of sockets, and twice the number of "servers"
1488 (as each server has a read and write socket end). 1564 (as each server has a read and write socket end).
1489 1565
1495 forwarding it to another server. This includes deleting the old timeout 1571 forwarding it to another server. This includes deleting the old timeout
1496 and creating a new one that moves the timeout into the future. 1572 and creating a new one that moves the timeout into the future.
1497 1573
1498 Results 1574 Results
1499 name sockets create request 1575 name sockets create request
1500 EV 20000 69.01 11.16 1576 EV 20000 62.66 7.99
1501 Perl 20000 73.32 35.87 1577 Perl 20000 68.32 32.64
1502 IOAsync 20000 157.00 98.14 epoll 1578 IOAsync 20000 174.06 101.15 epoll
1503 IOAsync 20000 159.31 616.06 poll 1579 IOAsync 20000 174.67 610.84 poll
1504 Event 20000 212.62 257.32 1580 Event 20000 202.69 242.91
1505 Glib 20000 651.16 1896.30 1581 Glib 20000 557.01 1689.52
1506 POE 20000 349.67 12317.24 uses POE::Loop::Event 1582 POE 20000 341.54 12086.32 uses POE::Loop::Event
1507 1583
1508 Discussion 1584 Discussion
1509 This benchmark *does* measure scalability and overall performance of the 1585 This benchmark *does* measure scalability and overall performance of the
1510 particular event loop. 1586 particular event loop.
1511 1587
1624 As you can see, the AnyEvent + EV combination even beats the 1700 As you can see, the AnyEvent + EV combination even beats the
1625 hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 1701 hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
1626 backend easily beats IO::Lambda and POE. 1702 backend easily beats IO::Lambda and POE.
1627 1703
1628 And even the 100% non-blocking version written using the high-level (and 1704 And even the 100% non-blocking version written using the high-level (and
1629 slow :) AnyEvent::Handle abstraction beats both POE and IO::Lambda by a 1705 slow :) AnyEvent::Handle abstraction beats both POE and IO::Lambda
1630 large margin, even though it does all of DNS, tcp-connect and socket I/O 1706 higher level ("unoptimised") abstractions by a large margin, even though
1631 in a non-blocking way. 1707 it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
1632 1708
1633 The two AnyEvent benchmarks programs can be found as eg/ae0.pl and 1709 The two AnyEvent benchmarks programs can be found as eg/ae0.pl and
1634 eg/ae2.pl in the AnyEvent distribution, the remaining benchmarks are 1710 eg/ae2.pl in the AnyEvent distribution, the remaining benchmarks are
1635 part of the IO::lambda distribution and were used without any changes. 1711 part of the IO::Lambda distribution and were used without any changes.
1636 1712
1637SIGNALS 1713SIGNALS
1638 AnyEvent currently installs handlers for these signals: 1714 AnyEvent currently installs handlers for these signals:
1639 1715
1640 SIGCHLD 1716 SIGCHLD
1667 it's built-in modules) are required to use it. 1743 it's built-in modules) are required to use it.
1668 1744
1669 That does not mean that AnyEvent won't take advantage of some additional 1745 That does not mean that AnyEvent won't take advantage of some additional
1670 modules if they are installed. 1746 modules if they are installed.
1671 1747
1672 This section epxlains which additional modules will be used, and how 1748 This section explains which additional modules will be used, and how
1673 they affect AnyEvent's operetion. 1749 they affect AnyEvent's operation.
1674 1750
1675 Async::Interrupt 1751 Async::Interrupt
1676 This slightly arcane module is used to implement fast signal 1752 This slightly arcane module is used to implement fast signal
1677 handling: To my knowledge, there is no way to do completely 1753 handling: To my knowledge, there is no way to do completely
1678 race-free and quick signal handling in pure perl. To ensure that 1754 race-free and quick signal handling in pure perl. To ensure that
1681 10 seconds, look for $AnyEvent::MAX_SIGNAL_LATENCY). 1757 10 seconds, look for $AnyEvent::MAX_SIGNAL_LATENCY).
1682 1758
1683 If this module is available, then it will be used to implement 1759 If this module is available, then it will be used to implement
1684 signal catching, which means that signals will not be delayed, and 1760 signal catching, which means that signals will not be delayed, and
1685 the event loop will not be interrupted regularly, which is more 1761 the event loop will not be interrupted regularly, which is more
1686 efficient (And good for battery life on laptops). 1762 efficient (and good for battery life on laptops).
1687 1763
1688 This affects not just the pure-perl event loop, but also other event 1764 This affects not just the pure-perl event loop, but also other event
1689 loops that have no signal handling on their own (e.g. Glib, Tk, Qt). 1765 loops that have no signal handling on their own (e.g. Glib, Tk, Qt).
1690 1766
1691 Some event loops (POE, Event, Event::Lib) offer signal watchers 1767 Some event loops (POE, Event, Event::Lib) offer signal watchers
1701 clock is available, can take avdantage of advanced kernel interfaces 1777 clock is available, can take avdantage of advanced kernel interfaces
1702 such as "epoll" and "kqueue", and is the fastest backend *by far*. 1778 such as "epoll" and "kqueue", and is the fastest backend *by far*.
1703 You can even embed Glib/Gtk2 in it (or vice versa, see EV::Glib and 1779 You can even embed Glib/Gtk2 in it (or vice versa, see EV::Glib and
1704 Glib::EV). 1780 Glib::EV).
1705 1781
1782 If you only use backends that rely on another event loop (e.g.
1783 "Tk"), then this module will do nothing for you.
1784
1706 Guard 1785 Guard
1707 The guard module, when used, will be used to implement 1786 The guard module, when used, will be used to implement
1708 "AnyEvent::Util::guard". This speeds up guards considerably (and 1787 "AnyEvent::Util::guard". This speeds up guards considerably (and
1709 uses a lot less memory), but otherwise doesn't affect guard 1788 uses a lot less memory), but otherwise doesn't affect guard
1710 operation much. It is purely used for performance. 1789 operation much. It is purely used for performance.
1711 1790
1712 JSON and JSON::XS 1791 JSON and JSON::XS
1713 This module is required when you want to read or write JSON data via 1792 One of these modules is required when you want to read or write JSON
1714 AnyEvent::Handle. It is also written in pure-perl, but can take 1793 data via AnyEvent::Handle. JSON is also written in pure-perl, but
1715 advantage of the ultra-high-speed JSON::XS module when it is 1794 can take advantage of the ultra-high-speed JSON::XS module when it
1716 installed. 1795 is installed.
1717
1718 In fact, AnyEvent::Handle will use JSON::XS by default if it is
1719 installed.
1720 1796
1721 Net::SSLeay 1797 Net::SSLeay
1722 Implementing TLS/SSL in Perl is certainly interesting, but not very 1798 Implementing TLS/SSL in Perl is certainly interesting, but not very
1723 worthwhile: If this module is installed, then AnyEvent::Handle (with 1799 worthwhile: If this module is installed, then AnyEvent::Handle (with
1724 the help of AnyEvent::TLS), gains the ability to do TLS/SSL. 1800 the help of AnyEvent::TLS), gains the ability to do TLS/SSL.
1730 additionally use it to try to use a monotonic clock for timing 1806 additionally use it to try to use a monotonic clock for timing
1731 stability. 1807 stability.
1732 1808
1733FORK 1809FORK
1734 Most event libraries are not fork-safe. The ones who are usually are 1810 Most event libraries are not fork-safe. The ones who are usually are
1735 because they rely on inefficient but fork-safe "select" or "poll" calls. 1811 because they rely on inefficient but fork-safe "select" or "poll" calls
1736 Only EV is fully fork-aware. 1812 - higher performance APIs such as BSD's kqueue or the dreaded Linux
1813 epoll are usually badly thought-out hacks that are incompatible with
1814 fork in one way or another. Only EV is fully fork-aware and ensures that
1815 you continue event-processing in both parent and child (or both, if you
1816 know what you are doing).
1817
1818 This means that, in general, you cannot fork and do event processing in
1819 the child if the event library was initialised before the fork (which
1820 usually happens when the first AnyEvent watcher is created, or the
1821 library is loaded).
1737 1822
1738 If you have to fork, you must either do so *before* creating your first 1823 If you have to fork, you must either do so *before* creating your first
1739 watcher OR you must not use AnyEvent at all in the child OR you must do 1824 watcher OR you must not use AnyEvent at all in the child OR you must do
1740 something completely out of the scope of AnyEvent. 1825 something completely out of the scope of AnyEvent.
1826
1827 The problem of doing event processing in the parent *and* the child is
1828 much more complicated: even for backends that *are* fork-aware or
1829 fork-safe, their behaviour is not usually what you want: fork clones all
1830 watchers, that means all timers, I/O watchers etc. are active in both
1831 parent and child, which is almost never what you want. USing "exec" to
1832 start worker children from some kind of manage rprocess is usually
1833 preferred, because it is much easier and cleaner, at the expense of
1834 having to have another binary.
1741 1835
1742SECURITY CONSIDERATIONS 1836SECURITY CONSIDERATIONS
1743 AnyEvent can be forced to load any event model via 1837 AnyEvent can be forced to load any event model via
1744 $ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used 1838 $ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used
1745 to execute arbitrary code or directly gain access, it can easily be used 1839 to execute arbitrary code or directly gain access, it can easily be used
1749 1843
1750 You can make AnyEvent completely ignore this variable by deleting it 1844 You can make AnyEvent completely ignore this variable by deleting it
1751 before the first watcher gets created, e.g. with a "BEGIN" block: 1845 before the first watcher gets created, e.g. with a "BEGIN" block:
1752 1846
1753 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 1847 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1754 1848
1755 use AnyEvent; 1849 use AnyEvent;
1756 1850
1757 Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 1851 Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1758 be used to probe what backend is used and gain other information (which 1852 be used to probe what backend is used and gain other information (which
1759 is probably even less useful to an attacker than PERL_ANYEVENT_MODEL), 1853 is probably even less useful to an attacker than PERL_ANYEVENT_MODEL),
1760 and $ENV{PERL_ANYEVENT_STRICT}. 1854 and $ENV{PERL_ANYEVENT_STRICT}.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines