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

Comparing AnyEvent/README (file contents):
Revision 1.45 by root, Fri Jul 17 14:57:03 2009 UTC vs.
Revision 1.56 by root, Thu Nov 19 01:55:57 2009 UTC

1NAME 1NAME
2 AnyEvent - provide framework for multiple event loops 2 AnyEvent - the DBI of event loop programming
3 3
4 EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported 4 EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async,
5 event loops. 5 Qt and POE are various supported event loops/environments.
6 6
7SYNOPSIS 7SYNOPSIS
8 use AnyEvent; 8 use AnyEvent;
9 9
10 # file descriptor readable 10 # file descriptor readable
37 37
38INTRODUCTION/TUTORIAL 38INTRODUCTION/TUTORIAL
39 This manpage is mainly a reference manual. If you are interested in a 39 This manpage is mainly a reference manual. If you are interested in a
40 tutorial or some gentle introduction, have a look at the AnyEvent::Intro 40 tutorial or some gentle introduction, have a look at the AnyEvent::Intro
41 manpage. 41 manpage.
42
43SUPPORT
44 There is a mailinglist for discussing all things AnyEvent, and an IRC
45 channel, too.
46
47 See the AnyEvent project page at the Schmorpforge Ta-Sa Software
48 Repository, at <http://anyevent.schmorp.de>, for more info.
42 49
43WHY YOU SHOULD USE THIS MODULE (OR NOT) 50WHY YOU SHOULD USE THIS MODULE (OR NOT)
44 Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 51 Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
45 nowadays. So what is different about AnyEvent? 52 nowadays. So what is different about AnyEvent?
46 53
166 Note that "my $w; $w =" combination. This is necessary because in Perl, 173 Note that "my $w; $w =" combination. This is necessary because in Perl,
167 my variables are only visible after the statement in which they are 174 my variables are only visible after the statement in which they are
168 declared. 175 declared.
169 176
170 I/O WATCHERS 177 I/O WATCHERS
178 $w = AnyEvent->io (
179 fh => <filehandle_or_fileno>,
180 poll => <"r" or "w">,
181 cb => <callback>,
182 );
183
171 You can create an I/O watcher by calling the "AnyEvent->io" method with 184 You can create an I/O watcher by calling the "AnyEvent->io" method with
172 the following mandatory key-value pairs as arguments: 185 the following mandatory key-value pairs as arguments:
173 186
174 "fh" is the Perl *file handle* (or a naked file descriptor) to watch for 187 "fh" is the Perl *file handle* (or a naked file descriptor) to watch for
175 events (AnyEvent might or might not keep a reference to this file 188 events (AnyEvent might or might not keep a reference to this file
203 warn "read: $input\n"; 216 warn "read: $input\n";
204 undef $w; 217 undef $w;
205 }); 218 });
206 219
207 TIME WATCHERS 220 TIME WATCHERS
221 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
222
223 $w = AnyEvent->timer (
224 after => <fractional_seconds>,
225 interval => <fractional_seconds>,
226 cb => <callback>,
227 );
228
208 You can create a time watcher by calling the "AnyEvent->timer" method 229 You can create a time watcher by calling the "AnyEvent->timer" method
209 with the following mandatory arguments: 230 with the following mandatory arguments:
210 231
211 "after" specifies after how many seconds (fractional values are 232 "after" specifies after how many seconds (fractional values are
212 supported) the callback should be invoked. "cb" is the callback to 233 supported) the callback should be invoked. "cb" is the callback to
333 time, which might affect timers and time-outs. 354 time, which might affect timers and time-outs.
334 355
335 When this is the case, you can call this method, which will update 356 When this is the case, you can call this method, which will update
336 the event loop's idea of "current time". 357 the event loop's idea of "current time".
337 358
359 A typical example would be a script in a web server (e.g.
360 "mod_perl") - when mod_perl executes the script, then the event loop
361 will have the wrong idea about the "current time" (being potentially
362 far in the past, when the script ran the last time). In that case
363 you should arrange a call to "AnyEvent->now_update" each time the
364 web server process wakes up again (e.g. at the start of your script,
365 or in a handler).
366
338 Note that updating the time *might* cause some events to be handled. 367 Note that updating the time *might* cause some events to be handled.
339 368
340 SIGNAL WATCHERS 369 SIGNAL WATCHERS
370 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
371
341 You can watch for signals using a signal watcher, "signal" is the signal 372 You can watch for signals using a signal watcher, "signal" is the signal
342 *name* in uppercase and without any "SIG" prefix, "cb" is the Perl 373 *name* in uppercase and without any "SIG" prefix, "cb" is the Perl
343 callback to be invoked whenever a signal occurs. 374 callback to be invoked whenever a signal occurs.
344 375
345 Although the callback might get passed parameters, their value and 376 Although the callback might get passed parameters, their value and
350 invocation, and callback invocation will be synchronous. Synchronous 381 invocation, and callback invocation will be synchronous. Synchronous
351 means that it might take a while until the signal gets handled by the 382 means that it might take a while until the signal gets handled by the
352 process, but it is guaranteed not to interrupt any other callbacks. 383 process, but it is guaranteed not to interrupt any other callbacks.
353 384
354 The main advantage of using these watchers is that you can share a 385 The main advantage of using these watchers is that you can share a
355 signal between multiple watchers. 386 signal between multiple watchers, and AnyEvent will ensure that signals
387 will not interrupt your program at bad times.
356 388
357 This watcher might use %SIG, so programs overwriting those signals 389 This watcher might use %SIG (depending on the event loop used), so
358 directly will likely not work correctly. 390 programs overwriting those signals directly will likely not work
391 correctly.
359 392
360 Example: exit on SIGINT 393 Example: exit on SIGINT
361 394
362 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 395 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
363 396
397 Signal Races, Delays and Workarounds
398 Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
399 callbacks to signals in a generic way, which is a pity, as you cannot do
400 race-free signal handling in perl, requiring C libraries for this.
401 AnyEvent will try to do it's best, which means in some cases, signals
402 will be delayed. The maximum time a signal might be delayed is specified
403 in $AnyEvent::MAX_SIGNAL_LATENCY (default: 10 seconds). This variable
404 can be changed only before the first signal watcher is created, and
405 should be left alone otherwise. This variable determines how often
406 AnyEvent polls for signals (in case a wake-up was missed). Higher values
407 will cause fewer spurious wake-ups, which is better for power and CPU
408 saving.
409
410 All these problems can be avoided by installing the optional
411 Async::Interrupt module, which works with most event loops. It will not
412 work with inherently broken event loops such as Event or Event::Lib (and
413 not with POE currently, as POE does it's own workaround with one-second
414 latency). For those, you just have to suffer the delays.
415
364 CHILD PROCESS WATCHERS 416 CHILD PROCESS WATCHERS
417 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
418
365 You can also watch on a child process exit and catch its exit status. 419 You can also watch on a child process exit and catch its exit status.
366 420
367 The child process is specified by the "pid" argument (if set to 0, it 421 The child process is specified by the "pid" argument (one some backends,
368 watches for any child process exit). The watcher will triggered only 422 using 0 watches for any child process exit, on others this will croak).
369 when the child process has finished and an exit status is available, not 423 The watcher will be triggered only when the child process has finished
370 on any trace events (stopped/continued). 424 and an exit status is available, not on any trace events
425 (stopped/continued).
371 426
372 The callback will be called with the pid and exit status (as returned by 427 The callback will be called with the pid and exit status (as returned by
373 waitpid), so unlike other watcher types, you *can* rely on child watcher 428 waitpid), so unlike other watcher types, you *can* rely on child watcher
374 callback arguments. 429 callback arguments.
375 430
390 of when you start the watcher. 445 of when you start the watcher.
391 446
392 This means you cannot create a child watcher as the very first thing in 447 This means you cannot create a child watcher as the very first thing in
393 an AnyEvent program, you *have* to create at least one watcher before 448 an AnyEvent program, you *have* to create at least one watcher before
394 you "fork" the child (alternatively, you can call "AnyEvent::detect"). 449 you "fork" the child (alternatively, you can call "AnyEvent::detect").
450
451 As most event loops do not support waiting for child events, they will
452 be emulated by AnyEvent in most cases, in which the latency and race
453 problems mentioned in the description of signal watchers apply.
395 454
396 Example: fork a process and wait for it 455 Example: fork a process and wait for it
397 456
398 my $done = AnyEvent->condvar; 457 my $done = AnyEvent->condvar;
399 458
410 469
411 # do something else, then wait for process exit 470 # do something else, then wait for process exit
412 $done->recv; 471 $done->recv;
413 472
414 IDLE WATCHERS 473 IDLE WATCHERS
474 $w = AnyEvent->idle (cb => <callback>);
475
415 Sometimes there is a need to do something, but it is not so important to 476 Sometimes there is a need to do something, but it is not so important to
416 do it instantly, but only when there is nothing better to do. This 477 do it instantly, but only when there is nothing better to do. This
417 "nothing better to do" is usually defined to be "no other events need 478 "nothing better to do" is usually defined to be "no other events need
418 attention by the event loop". 479 attention by the event loop".
419 480
444 } 505 }
445 }); 506 });
446 }); 507 });
447 508
448 CONDITION VARIABLES 509 CONDITION VARIABLES
510 $cv = AnyEvent->condvar;
511
512 $cv->send (<list>);
513 my @res = $cv->recv;
514
449 If you are familiar with some event loops you will know that all of them 515 If you are familiar with some event loops you will know that all of them
450 require you to run some blocking "loop", "run" or similar function that 516 require you to run some blocking "loop", "run" or similar function that
451 will actively watch for new events and call your callbacks. 517 will actively watch for new events and call your callbacks.
452 518
453 AnyEvent is slightly different: it expects somebody else to run the 519 AnyEvent is slightly different: it expects somebody else to run the
473 Condition variables are similar to callbacks, except that you can 539 Condition variables are similar to callbacks, except that you can
474 optionally wait for them. They can also be called merge points - points 540 optionally wait for them. They can also be called merge points - points
475 in time where multiple outstanding events have been processed. And yet 541 in time where multiple outstanding events have been processed. And yet
476 another way to call them is transactions - each condition variable can 542 another way to call them is transactions - each condition variable can
477 be used to represent a transaction, which finishes at some point and 543 be used to represent a transaction, which finishes at some point and
478 delivers a result. 544 delivers a result. And yet some people know them as "futures" - a
545 promise to compute/deliver something that you can wait for.
479 546
480 Condition variables are very useful to signal that something has 547 Condition variables are very useful to signal that something has
481 finished, for example, if you write a module that does asynchronous http 548 finished, for example, if you write a module that does asynchronous http
482 requests, then a condition variable would be the ideal candidate to 549 requests, then a condition variable would be the ideal candidate to
483 signal the availability of results. The user can either act when the 550 signal the availability of results. The user can either act when the
517 after => 1, 584 after => 1,
518 cb => sub { $result_ready->send }, 585 cb => sub { $result_ready->send },
519 ); 586 );
520 587
521 # this "blocks" (while handling events) till the callback 588 # this "blocks" (while handling events) till the callback
522 # calls -<send 589 # calls ->send
523 $result_ready->recv; 590 $result_ready->recv;
524 591
525 Example: wait for a timer, but take advantage of the fact that condition 592 Example: wait for a timer, but take advantage of the fact that condition
526 variables are also callable directly. 593 variables are also callable directly.
527 594
584 into one. For example, a function that pings many hosts in parallel 651 into one. For example, a function that pings many hosts in parallel
585 might want to use a condition variable for the whole process. 652 might want to use a condition variable for the whole process.
586 653
587 Every call to "->begin" will increment a counter, and every call to 654 Every call to "->begin" will increment a counter, and every call to
588 "->end" will decrement it. If the counter reaches 0 in "->end", the 655 "->end" will decrement it. If the counter reaches 0 in "->end", the
589 (last) callback passed to "begin" will be executed. That callback is 656 (last) callback passed to "begin" will be executed, passing the
590 *supposed* to call "->send", but that is not required. If no 657 condvar as first argument. That callback is *supposed* to call
658 "->send", but that is not required. If no group callback was set,
591 callback was set, "send" will be called without any arguments. 659 "send" will be called without any arguments.
592 660
593 You can think of "$cv->send" giving you an OR condition (one call 661 You can think of "$cv->send" giving you an OR condition (one call
594 sends), while "$cv->begin" and "$cv->end" giving you an AND 662 sends), while "$cv->begin" and "$cv->end" giving you an AND
595 condition (all "begin" calls must be "end"'ed before the condvar 663 condition (all "begin" calls must be "end"'ed before the condvar
596 sends). 664 sends).
624 that are begung can potentially be zero: 692 that are begung can potentially be zero:
625 693
626 my $cv = AnyEvent->condvar; 694 my $cv = AnyEvent->condvar;
627 695
628 my %result; 696 my %result;
629 $cv->begin (sub { $cv->send (\%result) }); 697 $cv->begin (sub { shift->send (\%result) });
630 698
631 for my $host (@list_of_hosts) { 699 for my $host (@list_of_hosts) {
632 $cv->begin; 700 $cv->begin;
633 ping_host_then_call_callback $host, sub { 701 ping_host_then_call_callback $host, sub {
634 $result{$host} = ...; 702 $result{$host} = ...;
701 769
702 $cb = $cv->cb ($cb->($cv)) 770 $cb = $cv->cb ($cb->($cv))
703 This is a mutator function that returns the callback set and 771 This is a mutator function that returns the callback set and
704 optionally replaces it before doing so. 772 optionally replaces it before doing so.
705 773
706 The callback will be called when the condition becomes "true", i.e. 774 The callback will be called when the condition becomes (or already
707 when "send" or "croak" are called, with the only argument being the 775 was) "true", i.e. when "send" or "croak" are called (or were
708 condition variable itself. Calling "recv" inside the callback or at 776 called), with the only argument being the condition variable itself.
777 Calling "recv" inside the callback or at any later time is
709 any later time is guaranteed not to block. 778 guaranteed not to block.
710 779
711SUPPORTED EVENT LOOPS/BACKENDS 780SUPPORTED EVENT LOOPS/BACKENDS
712 The available backend classes are (every class has its own manpage): 781 The available backend classes are (every class has its own manpage):
713 782
714 Backends that are autoprobed when no other event loop can be found. 783 Backends that are autoprobed when no other event loop can be found.
715 EV is the preferred backend when no other event loop seems to be in 784 EV is the preferred backend when no other event loop seems to be in
716 use. If EV is not installed, then AnyEvent will try Event, and, 785 use. If EV is not installed, then AnyEvent will fall back to its own
717 failing that, will fall back to its own pure-perl implementation, 786 pure-perl implementation, which is available everywhere as it comes
718 which is available everywhere as it comes with AnyEvent itself. 787 with AnyEvent itself.
719 788
720 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 789 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
721 AnyEvent::Impl::Event based on Event, very stable, few glitches.
722 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 790 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
723 791
724 Backends that are transparently being picked up when they are used. 792 Backends that are transparently being picked up when they are used.
725 These will be used when they are currently loaded when the first 793 These will be used when they are currently loaded when the first
726 watcher is created, in which case it is assumed that the application 794 watcher is created, in which case it is assumed that the application
727 is using them. This means that AnyEvent will automatically pick the 795 is using them. This means that AnyEvent will automatically pick the
728 right backend when the main program loads an event module before 796 right backend when the main program loads an event module before
729 anything starts to create watchers. Nothing special needs to be done 797 anything starts to create watchers. Nothing special needs to be done
730 by the main program. 798 by the main program.
731 799
800 AnyEvent::Impl::Event based on Event, very stable, few glitches.
732 AnyEvent::Impl::Glib based on Glib, slow but very stable. 801 AnyEvent::Impl::Glib based on Glib, slow but very stable.
733 AnyEvent::Impl::Tk based on Tk, very broken. 802 AnyEvent::Impl::Tk based on Tk, very broken.
734 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 803 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
735 AnyEvent::Impl::POE based on POE, very slow, some limitations. 804 AnyEvent::Impl::POE based on POE, very slow, some limitations.
805 AnyEvent::Impl::Irssi used when running within irssi.
736 806
737 Backends with special needs. 807 Backends with special needs.
738 Qt requires the Qt::Application to be instantiated first, but will 808 Qt requires the Qt::Application to be instantiated first, but will
739 otherwise be picked up automatically. As long as the main program 809 otherwise be picked up automatically. As long as the main program
740 instantiates the application before any AnyEvent watchers are 810 instantiates the application before any AnyEvent watchers are
805 creates and installs the global IO::AIO watcher in a "post_detect" 875 creates and installs the global IO::AIO watcher in a "post_detect"
806 block to avoid autodetecting the event module at load time. 876 block to avoid autodetecting the event module at load time.
807 877
808 If called in scalar or list context, then it creates and returns an 878 If called in scalar or list context, then it creates and returns an
809 object that automatically removes the callback again when it is 879 object that automatically removes the callback again when it is
880 destroyed (or "undef" when the hook was immediately executed). See
810 destroyed. See Coro::BDB for a case where this is useful. 881 AnyEvent::AIO for a case where this is useful.
882
883 Example: Create a watcher for the IO::AIO module and store it in
884 $WATCHER. Only do so after the event loop is initialised, though.
885
886 our WATCHER;
887
888 my $guard = AnyEvent::post_detect {
889 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
890 };
891
892 # the ||= is important in case post_detect immediately runs the block,
893 # as to not clobber the newly-created watcher. assigning both watcher and
894 # post_detect guard to the same variable has the advantage of users being
895 # able to just C<undef $WATCHER> if the watcher causes them grief.
896
897 $WATCHER ||= $guard;
811 898
812 @AnyEvent::post_detect 899 @AnyEvent::post_detect
813 If there are any code references in this array (you can "push" to it 900 If there are any code references in this array (you can "push" to it
814 before or after loading AnyEvent), then they will called directly 901 before or after loading AnyEvent), then they will called directly
815 after the event loop has been chosen. 902 after the event loop has been chosen.
955 High level API for event-based execution flow control. 1042 High level API for event-based execution flow control.
956 1043
957 Coro 1044 Coro
958 Has special support for AnyEvent via Coro::AnyEvent. 1045 Has special support for AnyEvent via Coro::AnyEvent.
959 1046
1047SIMPLIFIED AE API
1048 Starting with version 5.0, AnyEvent officially supports a second, much
1049 simpler, API that is designed to reduce the calling, typing and memory
1050 overhead.
1051
1052 See the AE manpage for details.
1053
960ERROR AND EXCEPTION HANDLING 1054ERROR AND EXCEPTION HANDLING
961 In general, AnyEvent does not do any error handling - it relies on the 1055 In general, AnyEvent does not do any error handling - it relies on the
962 caller to do that if required. The AnyEvent::Strict module (see also the 1056 caller to do that if required. The AnyEvent::Strict module (see also the
963 "PERL_ANYEVENT_STRICT" environment variable, below) provides strict 1057 "PERL_ANYEVENT_STRICT" environment variable, below) provides strict
964 checking of all AnyEvent methods, however, which is highly useful during 1058 checking of all AnyEvent methods, however, which is highly useful during
991 by "PERL_ANYEVENT_MODEL". 1085 by "PERL_ANYEVENT_MODEL".
992 1086
993 When set to 2 or higher, cause AnyEvent to report to STDERR which 1087 When set to 2 or higher, cause AnyEvent to report to STDERR which
994 event model it chooses. 1088 event model it chooses.
995 1089
1090 When set to 8 or higher, then AnyEvent will report extra information
1091 on which optional modules it loads and how it implements certain
1092 features.
1093
996 "PERL_ANYEVENT_STRICT" 1094 "PERL_ANYEVENT_STRICT"
997 AnyEvent does not do much argument checking by default, as thorough 1095 AnyEvent does not do much argument checking by default, as thorough
998 argument checking is very costly. Setting this variable to a true 1096 argument checking is very costly. Setting this variable to a true
999 value will cause AnyEvent to load "AnyEvent::Strict" and then to 1097 value will cause AnyEvent to load "AnyEvent::Strict" and then to
1000 thoroughly check the arguments passed to most method calls. If it 1098 thoroughly check the arguments passed to most method calls. If it
1001 finds any problems, it will croak. 1099 finds any problems, it will croak.
1002 1100
1003 In other words, enables "strict" mode. 1101 In other words, enables "strict" mode.
1004 1102
1005 Unlike "use strict", it is definitely recommended to keep it off in 1103 Unlike "use strict" (or it's modern cousin, "use common::sense", it
1006 production. Keeping "PERL_ANYEVENT_STRICT=1" in your environment 1104 is definitely recommended to keep it off in production. Keeping
1105 "PERL_ANYEVENT_STRICT=1" in your environment while developing
1007 while developing programs can be very useful, however. 1106 programs can be very useful, however.
1008 1107
1009 "PERL_ANYEVENT_MODEL" 1108 "PERL_ANYEVENT_MODEL"
1010 This can be used to specify the event model to be used by AnyEvent, 1109 This can be used to specify the event model to be used by AnyEvent,
1011 before auto detection and -probing kicks in. It must be a string 1110 before auto detection and -probing kicks in. It must be a string
1012 consisting entirely of ASCII letters. The string "AnyEvent::Impl::" 1111 consisting entirely of ASCII letters. The string "AnyEvent::Impl::"
1069 "PERL_ANYEVENT_CA_FILE", "PERL_ANYEVENT_CA_PATH". 1168 "PERL_ANYEVENT_CA_FILE", "PERL_ANYEVENT_CA_PATH".
1070 When neither "ca_file" nor "ca_path" was specified during 1169 When neither "ca_file" nor "ca_path" was specified during
1071 AnyEvent::TLS context creation, and either of these environment 1170 AnyEvent::TLS context creation, and either of these environment
1072 variables exist, they will be used to specify CA certificate 1171 variables exist, they will be used to specify CA certificate
1073 locations instead of a system-dependent default. 1172 locations instead of a system-dependent default.
1173
1174 "PERL_ANYEVENT_AVOID_GUARD" and "PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT"
1175 When these are set to 1, then the respective modules are not loaded.
1176 Mostly good for testing AnyEvent itself.
1074 1177
1075SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1178SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1076 This is an advanced topic that you do not normally need to use AnyEvent 1179 This is an advanced topic that you do not normally need to use AnyEvent
1077 in a module. This section is only of use to event loop authors who want 1180 in a module. This section is only of use to event loop authors who want
1078 to provide AnyEvent compatibility. 1181 to provide AnyEvent compatibility.
1133 warn "read: $input\n"; # output what has been read 1236 warn "read: $input\n"; # output what has been read
1134 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1237 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1135 }, 1238 },
1136 ); 1239 );
1137 1240
1138 my $time_watcher; # can only be used once
1139
1140 sub new_timer {
1141 $timer = AnyEvent->timer (after => 1, cb => sub { 1241 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1142 warn "timeout\n"; # print 'timeout' about every second 1242 warn "timeout\n"; # print 'timeout' at most every second
1143 &new_timer; # and restart the time
1144 });
1145 } 1243 });
1146
1147 new_timer; # create first timer
1148 1244
1149 $cv->recv; # wait until user enters /^q/i 1245 $cv->recv; # wait until user enters /^q/i
1150 1246
1151REAL-WORLD EXAMPLE 1247REAL-WORLD EXAMPLE
1152 Consider the Net::FCP module. It features (among others) the following 1248 Consider the Net::FCP module. It features (among others) the following
1279 through AnyEvent. The benchmark creates a lot of timers (with a zero 1375 through AnyEvent. The benchmark creates a lot of timers (with a zero
1280 timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 1376 timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1281 which it is), lets them fire exactly once and destroys them again. 1377 which it is), lets them fire exactly once and destroys them again.
1282 1378
1283 Source code for this benchmark is found as eg/bench in the AnyEvent 1379 Source code for this benchmark is found as eg/bench in the AnyEvent
1284 distribution. 1380 distribution. It uses the AE interface, which makes a real difference
1381 for the EV and Perl backends only.
1285 1382
1286 Explanation of the columns 1383 Explanation of the columns
1287 *watcher* is the number of event watchers created/destroyed. Since 1384 *watcher* is the number of event watchers created/destroyed. Since
1288 different event models feature vastly different performances, each event 1385 different event models feature vastly different performances, each event
1289 loop was given a number of watchers so that overall runtime is 1386 loop was given a number of watchers so that overall runtime is
1308 *destroy* is the time, in microseconds, that it takes to destroy a 1405 *destroy* is the time, in microseconds, that it takes to destroy a
1309 single watcher. 1406 single watcher.
1310 1407
1311 Results 1408 Results
1312 name watchers bytes create invoke destroy comment 1409 name watchers bytes create invoke destroy comment
1313 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 1410 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1314 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 1411 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1315 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 1412 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1316 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 1413 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1317 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 1414 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1318 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 1415 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1319 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 1416 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1320 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 1417 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1321 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 1418 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1322 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 1419 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1323 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 1420 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1324 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 1421 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1325 1422
1326 Discussion 1423 Discussion
1327 The benchmark does *not* measure scalability of the event loop very 1424 The benchmark does *not* measure scalability of the event loop very
1328 well. For example, a select-based event loop (such as the pure perl one) 1425 well. For example, a select-based event loop (such as the pure perl one)
1329 can never compete with an event loop that uses epoll when the number of 1426 can never compete with an event loop that uses epoll when the number of
1340 benchmark machine, handling an event takes roughly 1600 CPU cycles with 1437 benchmark machine, handling an event takes roughly 1600 CPU cycles with
1341 EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 1438 EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000
1342 CPU cycles with POE. 1439 CPU cycles with POE.
1343 1440
1344 "EV" is the sole leader regarding speed and memory use, which are both 1441 "EV" is the sole leader regarding speed and memory use, which are both
1345 maximal/minimal, respectively. Even when going through AnyEvent, it uses 1442 maximal/minimal, respectively. When using the AE API there is zero
1443 overhead (when going through the AnyEvent API create is about 5-6 times
1444 slower, with other times being equal, so still uses far less memory than
1346 far less memory than any other event loop and is still faster than Event 1445 any other event loop and is still faster than Event natively).
1347 natively.
1348 1446
1349 The pure perl implementation is hit in a few sweet spots (both the 1447 The pure perl implementation is hit in a few sweet spots (both the
1350 constant timeout and the use of a single fd hit optimisations in the 1448 constant timeout and the use of a single fd hit optimisations in the
1351 perl interpreter and the backend itself). Nevertheless this shows that 1449 perl interpreter and the backend itself). Nevertheless this shows that
1352 it adds very little overhead in itself. Like any select-based backend 1450 it adds very little overhead in itself. Like any select-based backend
1422 In this benchmark, we use 10000 socket pairs (20000 sockets), of which 1520 In this benchmark, we use 10000 socket pairs (20000 sockets), of which
1423 100 (1%) are active. This mirrors the activity of large servers with 1521 100 (1%) are active. This mirrors the activity of large servers with
1424 many connections, most of which are idle at any one point in time. 1522 many connections, most of which are idle at any one point in time.
1425 1523
1426 Source code for this benchmark is found as eg/bench2 in the AnyEvent 1524 Source code for this benchmark is found as eg/bench2 in the AnyEvent
1427 distribution. 1525 distribution. It uses the AE interface, which makes a real difference
1526 for the EV and Perl backends only.
1428 1527
1429 Explanation of the columns 1528 Explanation of the columns
1430 *sockets* is the number of sockets, and twice the number of "servers" 1529 *sockets* is the number of sockets, and twice the number of "servers"
1431 (as each server has a read and write socket end). 1530 (as each server has a read and write socket end).
1432 1531
1438 forwarding it to another server. This includes deleting the old timeout 1537 forwarding it to another server. This includes deleting the old timeout
1439 and creating a new one that moves the timeout into the future. 1538 and creating a new one that moves the timeout into the future.
1440 1539
1441 Results 1540 Results
1442 name sockets create request 1541 name sockets create request
1443 EV 20000 69.01 11.16 1542 EV 20000 62.66 7.99
1444 Perl 20000 73.32 35.87 1543 Perl 20000 68.32 32.64
1445 IOAsync 20000 157.00 98.14 epoll 1544 IOAsync 20000 174.06 101.15 epoll
1446 IOAsync 20000 159.31 616.06 poll 1545 IOAsync 20000 174.67 610.84 poll
1447 Event 20000 212.62 257.32 1546 Event 20000 202.69 242.91
1448 Glib 20000 651.16 1896.30 1547 Glib 20000 557.01 1689.52
1449 POE 20000 349.67 12317.24 uses POE::Loop::Event 1548 POE 20000 341.54 12086.32 uses POE::Loop::Event
1450 1549
1451 Discussion 1550 Discussion
1452 This benchmark *does* measure scalability and overall performance of the 1551 This benchmark *does* measure scalability and overall performance of the
1453 particular event loop. 1552 particular event loop.
1454 1553
1567 As you can see, the AnyEvent + EV combination even beats the 1666 As you can see, the AnyEvent + EV combination even beats the
1568 hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 1667 hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
1569 backend easily beats IO::Lambda and POE. 1668 backend easily beats IO::Lambda and POE.
1570 1669
1571 And even the 100% non-blocking version written using the high-level (and 1670 And even the 100% non-blocking version written using the high-level (and
1572 slow :) AnyEvent::Handle abstraction beats both POE and IO::Lambda by a 1671 slow :) AnyEvent::Handle abstraction beats both POE and IO::Lambda
1573 large margin, even though it does all of DNS, tcp-connect and socket I/O 1672 higher level ("unoptimised") abstractions by a large margin, even though
1574 in a non-blocking way. 1673 it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
1575 1674
1576 The two AnyEvent benchmarks programs can be found as eg/ae0.pl and 1675 The two AnyEvent benchmarks programs can be found as eg/ae0.pl and
1577 eg/ae2.pl in the AnyEvent distribution, the remaining benchmarks are 1676 eg/ae2.pl in the AnyEvent distribution, the remaining benchmarks are
1578 part of the IO::lambda distribution and were used without any changes. 1677 part of the IO::Lambda distribution and were used without any changes.
1579 1678
1580SIGNALS 1679SIGNALS
1581 AnyEvent currently installs handlers for these signals: 1680 AnyEvent currently installs handlers for these signals:
1582 1681
1583 SIGCHLD 1682 SIGCHLD
1603 it is that this way, the handler will be restored to defaults on 1702 it is that this way, the handler will be restored to defaults on
1604 exec. 1703 exec.
1605 1704
1606 Feel free to install your own handler, or reset it to defaults. 1705 Feel free to install your own handler, or reset it to defaults.
1607 1706
1707RECOMMENDED/OPTIONAL MODULES
1708 One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
1709 it's built-in modules) are required to use it.
1710
1711 That does not mean that AnyEvent won't take advantage of some additional
1712 modules if they are installed.
1713
1714 This section epxlains which additional modules will be used, and how
1715 they affect AnyEvent's operetion.
1716
1717 Async::Interrupt
1718 This slightly arcane module is used to implement fast signal
1719 handling: To my knowledge, there is no way to do completely
1720 race-free and quick signal handling in pure perl. To ensure that
1721 signals still get delivered, AnyEvent will start an interval timer
1722 to wake up perl (and catch the signals) with some delay (default is
1723 10 seconds, look for $AnyEvent::MAX_SIGNAL_LATENCY).
1724
1725 If this module is available, then it will be used to implement
1726 signal catching, which means that signals will not be delayed, and
1727 the event loop will not be interrupted regularly, which is more
1728 efficient (And good for battery life on laptops).
1729
1730 This affects not just the pure-perl event loop, but also other event
1731 loops that have no signal handling on their own (e.g. Glib, Tk, Qt).
1732
1733 Some event loops (POE, Event, Event::Lib) offer signal watchers
1734 natively, and either employ their own workarounds (POE) or use
1735 AnyEvent's workaround (using $AnyEvent::MAX_SIGNAL_LATENCY).
1736 Installing Async::Interrupt does nothing for those backends.
1737
1738 EV This module isn't really "optional", as it is simply one of the
1739 backend event loops that AnyEvent can use. However, it is simply the
1740 best event loop available in terms of features, speed and stability:
1741 It supports the AnyEvent API optimally, implements all the watcher
1742 types in XS, does automatic timer adjustments even when no monotonic
1743 clock is available, can take avdantage of advanced kernel interfaces
1744 such as "epoll" and "kqueue", and is the fastest backend *by far*.
1745 You can even embed Glib/Gtk2 in it (or vice versa, see EV::Glib and
1746 Glib::EV).
1747
1748 Guard
1749 The guard module, when used, will be used to implement
1750 "AnyEvent::Util::guard". This speeds up guards considerably (and
1751 uses a lot less memory), but otherwise doesn't affect guard
1752 operation much. It is purely used for performance.
1753
1754 JSON and JSON::XS
1755 One of these modules is required when you want to read or write JSON
1756 data via AnyEvent::Handle. It is also written in pure-perl, but can
1757 take advantage of the ultra-high-speed JSON::XS module when it is
1758 installed.
1759
1760 In fact, AnyEvent::Handle will use JSON::XS by default if it is
1761 installed.
1762
1763 Net::SSLeay
1764 Implementing TLS/SSL in Perl is certainly interesting, but not very
1765 worthwhile: If this module is installed, then AnyEvent::Handle (with
1766 the help of AnyEvent::TLS), gains the ability to do TLS/SSL.
1767
1768 Time::HiRes
1769 This module is part of perl since release 5.008. It will be used
1770 when the chosen event library does not come with a timing source on
1771 it's own. The pure-perl event loop (AnyEvent::Impl::Perl) will
1772 additionally use it to try to use a monotonic clock for timing
1773 stability.
1774
1608FORK 1775FORK
1609 Most event libraries are not fork-safe. The ones who are usually are 1776 Most event libraries are not fork-safe. The ones who are usually are
1610 because they rely on inefficient but fork-safe "select" or "poll" calls. 1777 because they rely on inefficient but fork-safe "select" or "poll" calls.
1611 Only EV is fully fork-aware. 1778 Only EV is fully fork-aware.
1612 1779
1613 If you have to fork, you must either do so *before* creating your first 1780 If you have to fork, you must either do so *before* creating your first
1614 watcher OR you must not use AnyEvent at all in the child. 1781 watcher OR you must not use AnyEvent at all in the child OR you must do
1782 something completely out of the scope of AnyEvent.
1615 1783
1616SECURITY CONSIDERATIONS 1784SECURITY CONSIDERATIONS
1617 AnyEvent can be forced to load any event model via 1785 AnyEvent can be forced to load any event model via
1618 $ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used 1786 $ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used
1619 to execute arbitrary code or directly gain access, it can easily be used 1787 to execute arbitrary code or directly gain access, it can easily be used
1651 Event::Lib, Qt, POE. 1819 Event::Lib, Qt, POE.
1652 1820
1653 Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event, 1821 Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event,
1654 AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, 1822 AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl,
1655 AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE, 1823 AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE,
1656 AnyEvent::Impl::IOAsync. 1824 AnyEvent::Impl::IOAsync, Anyevent::Impl::Irssi.
1657 1825
1658 Non-blocking file handles, sockets, TCP clients and servers: 1826 Non-blocking file handles, sockets, TCP clients and servers:
1659 AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS. 1827 AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS.
1660 1828
1661 Asynchronous DNS: AnyEvent::DNS. 1829 Asynchronous DNS: AnyEvent::DNS.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines