1 | NAME |
1 | NAME |
2 | AnyEvent - events independent of event loop implementation |
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 | |
7 | SYNOPSIS |
7 | SYNOPSIS |
8 | use AnyEvent; |
8 | use AnyEvent; |
9 | |
9 | |
10 | # file descriptor readable |
10 | # file descriptor readable |
… | |
… | |
43 | SUPPORT |
43 | SUPPORT |
44 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
44 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
45 | channel, too. |
45 | channel, too. |
46 | |
46 | |
47 | See the AnyEvent project page at the Schmorpforge Ta-Sa Software |
47 | See the AnyEvent project page at the Schmorpforge Ta-Sa Software |
48 | Respository, at <http://anyevent.schmorp.de>, for more info. |
48 | Repository, at <http://anyevent.schmorp.de>, for more info. |
49 | |
49 | |
50 | WHY YOU SHOULD USE THIS MODULE (OR NOT) |
50 | WHY YOU SHOULD USE THIS MODULE (OR NOT) |
51 | 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 |
52 | nowadays. So what is different about AnyEvent? |
52 | nowadays. So what is different about AnyEvent? |
53 | |
53 | |
… | |
… | |
173 | 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, |
174 | 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 |
175 | declared. |
175 | declared. |
176 | |
176 | |
177 | 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 | |
178 | 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 |
179 | the following mandatory key-value pairs as arguments: |
185 | the following mandatory key-value pairs as arguments: |
180 | |
186 | |
181 | "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 |
182 | 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 |
… | |
… | |
210 | warn "read: $input\n"; |
216 | warn "read: $input\n"; |
211 | undef $w; |
217 | undef $w; |
212 | }); |
218 | }); |
213 | |
219 | |
214 | 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 | |
215 | 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 |
216 | with the following mandatory arguments: |
230 | with the following mandatory arguments: |
217 | |
231 | |
218 | "after" specifies after how many seconds (fractional values are |
232 | "after" specifies after how many seconds (fractional values are |
219 | supported) the callback should be invoked. "cb" is the callback to |
233 | supported) the callback should be invoked. "cb" is the callback to |
… | |
… | |
343 | the event loop's idea of "current time". |
357 | the event loop's idea of "current time". |
344 | |
358 | |
345 | Note that updating the time *might* cause some events to be handled. |
359 | Note that updating the time *might* cause some events to be handled. |
346 | |
360 | |
347 | SIGNAL WATCHERS |
361 | SIGNAL WATCHERS |
|
|
362 | $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>); |
|
|
363 | |
348 | You can watch for signals using a signal watcher, "signal" is the signal |
364 | 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 |
365 | *name* in uppercase and without any "SIG" prefix, "cb" is the Perl |
350 | callback to be invoked whenever a signal occurs. |
366 | callback to be invoked whenever a signal occurs. |
351 | |
367 | |
352 | Although the callback might get passed parameters, their value and |
368 | Although the callback might get passed parameters, their value and |
… | |
… | |
371 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
387 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
372 | |
388 | |
373 | Signal Races, Delays and Workarounds |
389 | Signal Races, Delays and Workarounds |
374 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
390 | 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 |
391 | 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, |
392 | 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 |
393 | 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: |
394 | 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 |
395 | in $AnyEvent::MAX_SIGNAL_LATENCY (default: 10 seconds). This variable |
380 | watcher is created, and should be left alone otherwise. Higher values |
396 | can be changed only before the first signal watcher is created, and |
|
|
397 | should be left alone otherwise. This variable determines how often |
|
|
398 | 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 |
399 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
400 | saving. |
|
|
401 | |
382 | saving. All these problems can be avoided by installing the optional |
402 | All these problems can be avoided by installing the optional |
383 | Async::Interrupt module. This will not work with inherently broken event |
403 | 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 |
404 | 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 |
405 | not with POE currently, as POE does it's own workaround with one-second |
386 | have to suffer the delays. |
406 | latency). For those, you just have to suffer the delays. |
387 | |
407 | |
388 | CHILD PROCESS WATCHERS |
408 | CHILD PROCESS WATCHERS |
|
|
409 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
|
|
410 | |
389 | You can also watch on a child process exit and catch its exit status. |
411 | You can also watch on a child process exit and catch its exit status. |
390 | |
412 | |
391 | The child process is specified by the "pid" argument (if set to 0, it |
413 | The child process is specified by the "pid" argument (one some backends, |
392 | watches for any child process exit). The watcher will triggered only |
414 | using 0 watches for any child process exit, on others this will croak). |
393 | when the child process has finished and an exit status is available, not |
415 | The watcher will be triggered only when the child process has finished |
394 | on any trace events (stopped/continued). |
416 | and an exit status is available, not on any trace events |
|
|
417 | (stopped/continued). |
395 | |
418 | |
396 | The callback will be called with the pid and exit status (as returned by |
419 | The callback will be called with the pid and exit status (as returned by |
397 | waitpid), so unlike other watcher types, you *can* rely on child watcher |
420 | waitpid), so unlike other watcher types, you *can* rely on child watcher |
398 | callback arguments. |
421 | callback arguments. |
399 | |
422 | |
… | |
… | |
438 | |
461 | |
439 | # do something else, then wait for process exit |
462 | # do something else, then wait for process exit |
440 | $done->recv; |
463 | $done->recv; |
441 | |
464 | |
442 | IDLE WATCHERS |
465 | IDLE WATCHERS |
|
|
466 | $w = AnyEvent->idle (cb => <callback>); |
|
|
467 | |
443 | Sometimes there is a need to do something, but it is not so important to |
468 | Sometimes there is a need to do something, but it is not so important to |
444 | do it instantly, but only when there is nothing better to do. This |
469 | do it instantly, but only when there is nothing better to do. This |
445 | "nothing better to do" is usually defined to be "no other events need |
470 | "nothing better to do" is usually defined to be "no other events need |
446 | attention by the event loop". |
471 | attention by the event loop". |
447 | |
472 | |
… | |
… | |
472 | } |
497 | } |
473 | }); |
498 | }); |
474 | }); |
499 | }); |
475 | |
500 | |
476 | CONDITION VARIABLES |
501 | CONDITION VARIABLES |
|
|
502 | $cv = AnyEvent->condvar; |
|
|
503 | |
|
|
504 | $cv->send (<list>); |
|
|
505 | my @res = $cv->recv; |
|
|
506 | |
477 | If you are familiar with some event loops you will know that all of them |
507 | If you are familiar with some event loops you will know that all of them |
478 | require you to run some blocking "loop", "run" or similar function that |
508 | require you to run some blocking "loop", "run" or similar function that |
479 | will actively watch for new events and call your callbacks. |
509 | will actively watch for new events and call your callbacks. |
480 | |
510 | |
481 | AnyEvent is slightly different: it expects somebody else to run the |
511 | AnyEvent is slightly different: it expects somebody else to run the |
… | |
… | |
546 | after => 1, |
576 | after => 1, |
547 | cb => sub { $result_ready->send }, |
577 | cb => sub { $result_ready->send }, |
548 | ); |
578 | ); |
549 | |
579 | |
550 | # this "blocks" (while handling events) till the callback |
580 | # this "blocks" (while handling events) till the callback |
551 | # calls -<send |
581 | # calls ->send |
552 | $result_ready->recv; |
582 | $result_ready->recv; |
553 | |
583 | |
554 | Example: wait for a timer, but take advantage of the fact that condition |
584 | Example: wait for a timer, but take advantage of the fact that condition |
555 | variables are also callable directly. |
585 | variables are also callable directly. |
556 | |
586 | |
… | |
… | |
613 | into one. For example, a function that pings many hosts in parallel |
643 | into one. For example, a function that pings many hosts in parallel |
614 | might want to use a condition variable for the whole process. |
644 | might want to use a condition variable for the whole process. |
615 | |
645 | |
616 | Every call to "->begin" will increment a counter, and every call to |
646 | Every call to "->begin" will increment a counter, and every call to |
617 | "->end" will decrement it. If the counter reaches 0 in "->end", the |
647 | "->end" will decrement it. If the counter reaches 0 in "->end", the |
618 | (last) callback passed to "begin" will be executed. That callback is |
648 | (last) callback passed to "begin" will be executed, passing the |
619 | *supposed* to call "->send", but that is not required. If no |
649 | condvar as first argument. That callback is *supposed* to call |
|
|
650 | "->send", but that is not required. If no group callback was set, |
620 | callback was set, "send" will be called without any arguments. |
651 | "send" will be called without any arguments. |
621 | |
652 | |
622 | You can think of "$cv->send" giving you an OR condition (one call |
653 | You can think of "$cv->send" giving you an OR condition (one call |
623 | sends), while "$cv->begin" and "$cv->end" giving you an AND |
654 | sends), while "$cv->begin" and "$cv->end" giving you an AND |
624 | condition (all "begin" calls must be "end"'ed before the condvar |
655 | condition (all "begin" calls must be "end"'ed before the condvar |
625 | sends). |
656 | sends). |
… | |
… | |
653 | that are begung can potentially be zero: |
684 | that are begung can potentially be zero: |
654 | |
685 | |
655 | my $cv = AnyEvent->condvar; |
686 | my $cv = AnyEvent->condvar; |
656 | |
687 | |
657 | my %result; |
688 | my %result; |
658 | $cv->begin (sub { $cv->send (\%result) }); |
689 | $cv->begin (sub { shift->send (\%result) }); |
659 | |
690 | |
660 | for my $host (@list_of_hosts) { |
691 | for my $host (@list_of_hosts) { |
661 | $cv->begin; |
692 | $cv->begin; |
662 | ping_host_then_call_callback $host, sub { |
693 | ping_host_then_call_callback $host, sub { |
663 | $result{$host} = ...; |
694 | $result{$host} = ...; |
… | |
… | |
730 | |
761 | |
731 | $cb = $cv->cb ($cb->($cv)) |
762 | $cb = $cv->cb ($cb->($cv)) |
732 | This is a mutator function that returns the callback set and |
763 | This is a mutator function that returns the callback set and |
733 | optionally replaces it before doing so. |
764 | optionally replaces it before doing so. |
734 | |
765 | |
735 | The callback will be called when the condition becomes "true", i.e. |
766 | The callback will be called when the condition becomes (or already |
736 | when "send" or "croak" are called, with the only argument being the |
767 | was) "true", i.e. when "send" or "croak" are called (or were |
737 | condition variable itself. Calling "recv" inside the callback or at |
768 | called), with the only argument being the condition variable itself. |
|
|
769 | Calling "recv" inside the callback or at any later time is |
738 | any later time is guaranteed not to block. |
770 | guaranteed not to block. |
739 | |
771 | |
740 | SUPPORTED EVENT LOOPS/BACKENDS |
772 | SUPPORTED EVENT LOOPS/BACKENDS |
741 | The available backend classes are (every class has its own manpage): |
773 | The available backend classes are (every class has its own manpage): |
742 | |
774 | |
743 | Backends that are autoprobed when no other event loop can be found. |
775 | Backends that are autoprobed when no other event loop can be found. |
744 | EV is the preferred backend when no other event loop seems to be in |
776 | EV is the preferred backend when no other event loop seems to be in |
745 | use. If EV is not installed, then AnyEvent will try Event, and, |
777 | use. If EV is not installed, then AnyEvent will fall back to its own |
746 | failing that, will fall back to its own pure-perl implementation, |
778 | pure-perl implementation, which is available everywhere as it comes |
747 | which is available everywhere as it comes with AnyEvent itself. |
779 | with AnyEvent itself. |
748 | |
780 | |
749 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
781 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
750 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
751 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
782 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
752 | |
783 | |
753 | Backends that are transparently being picked up when they are used. |
784 | Backends that are transparently being picked up when they are used. |
754 | These will be used when they are currently loaded when the first |
785 | These will be used when they are currently loaded when the first |
755 | watcher is created, in which case it is assumed that the application |
786 | watcher is created, in which case it is assumed that the application |
756 | is using them. This means that AnyEvent will automatically pick the |
787 | is using them. This means that AnyEvent will automatically pick the |
757 | right backend when the main program loads an event module before |
788 | right backend when the main program loads an event module before |
758 | anything starts to create watchers. Nothing special needs to be done |
789 | anything starts to create watchers. Nothing special needs to be done |
759 | by the main program. |
790 | by the main program. |
760 | |
791 | |
|
|
792 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
761 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
793 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
762 | AnyEvent::Impl::Tk based on Tk, very broken. |
794 | AnyEvent::Impl::Tk based on Tk, very broken. |
763 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
795 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
764 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
796 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
797 | AnyEvent::Impl::Irssi used when running within irssi. |
765 | |
798 | |
766 | Backends with special needs. |
799 | Backends with special needs. |
767 | Qt requires the Qt::Application to be instantiated first, but will |
800 | Qt requires the Qt::Application to be instantiated first, but will |
768 | otherwise be picked up automatically. As long as the main program |
801 | otherwise be picked up automatically. As long as the main program |
769 | instantiates the application before any AnyEvent watchers are |
802 | instantiates the application before any AnyEvent watchers are |
… | |
… | |
834 | creates and installs the global IO::AIO watcher in a "post_detect" |
867 | creates and installs the global IO::AIO watcher in a "post_detect" |
835 | block to avoid autodetecting the event module at load time. |
868 | block to avoid autodetecting the event module at load time. |
836 | |
869 | |
837 | If called in scalar or list context, then it creates and returns an |
870 | If called in scalar or list context, then it creates and returns an |
838 | object that automatically removes the callback again when it is |
871 | object that automatically removes the callback again when it is |
|
|
872 | destroyed (or "undef" when the hook was immediately executed). See |
839 | destroyed. See Coro::BDB for a case where this is useful. |
873 | AnyEvent::AIO for a case where this is useful. |
|
|
874 | |
|
|
875 | Example: Create a watcher for the IO::AIO module and store it in |
|
|
876 | $WATCHER. Only do so after the event loop is initialised, though. |
|
|
877 | |
|
|
878 | our WATCHER; |
|
|
879 | |
|
|
880 | my $guard = AnyEvent::post_detect { |
|
|
881 | $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); |
|
|
882 | }; |
|
|
883 | |
|
|
884 | # the ||= is important in case post_detect immediately runs the block, |
|
|
885 | # as to not clobber the newly-created watcher. assigning both watcher and |
|
|
886 | # post_detect guard to the same variable has the advantage of users being |
|
|
887 | # able to just C<undef $WATCHER> if the watcher causes them grief. |
|
|
888 | |
|
|
889 | $WATCHER ||= $guard; |
840 | |
890 | |
841 | @AnyEvent::post_detect |
891 | @AnyEvent::post_detect |
842 | If there are any code references in this array (you can "push" to it |
892 | If there are any code references in this array (you can "push" to it |
843 | before or after loading AnyEvent), then they will called directly |
893 | before or after loading AnyEvent), then they will called directly |
844 | after the event loop has been chosen. |
894 | after the event loop has been chosen. |
… | |
… | |
983 | Event::ExecFlow |
1033 | Event::ExecFlow |
984 | High level API for event-based execution flow control. |
1034 | High level API for event-based execution flow control. |
985 | |
1035 | |
986 | Coro |
1036 | Coro |
987 | Has special support for AnyEvent via Coro::AnyEvent. |
1037 | Has special support for AnyEvent via Coro::AnyEvent. |
|
|
1038 | |
|
|
1039 | SIMPLIFIED AE API |
|
|
1040 | Starting with version 5.0, AnyEvent officially supports a second, much |
|
|
1041 | simpler, API that is designed to reduce the calling, typing and memory |
|
|
1042 | overhead. |
|
|
1043 | |
|
|
1044 | See the AE manpage for details. |
988 | |
1045 | |
989 | ERROR AND EXCEPTION HANDLING |
1046 | ERROR AND EXCEPTION HANDLING |
990 | In general, AnyEvent does not do any error handling - it relies on the |
1047 | In general, AnyEvent does not do any error handling - it relies on the |
991 | caller to do that if required. The AnyEvent::Strict module (see also the |
1048 | caller to do that if required. The AnyEvent::Strict module (see also the |
992 | "PERL_ANYEVENT_STRICT" environment variable, below) provides strict |
1049 | "PERL_ANYEVENT_STRICT" environment variable, below) provides strict |
… | |
… | |
1171 | warn "read: $input\n"; # output what has been read |
1228 | warn "read: $input\n"; # output what has been read |
1172 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1229 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1173 | }, |
1230 | }, |
1174 | ); |
1231 | ); |
1175 | |
1232 | |
1176 | my $time_watcher; # can only be used once |
|
|
1177 | |
|
|
1178 | sub new_timer { |
|
|
1179 | $timer = AnyEvent->timer (after => 1, cb => sub { |
1233 | my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub { |
1180 | warn "timeout\n"; # print 'timeout' about every second |
1234 | warn "timeout\n"; # print 'timeout' at most every second |
1181 | &new_timer; # and restart the time |
|
|
1182 | }); |
|
|
1183 | } |
1235 | }); |
1184 | |
|
|
1185 | new_timer; # create first timer |
|
|
1186 | |
1236 | |
1187 | $cv->recv; # wait until user enters /^q/i |
1237 | $cv->recv; # wait until user enters /^q/i |
1188 | |
1238 | |
1189 | REAL-WORLD EXAMPLE |
1239 | REAL-WORLD EXAMPLE |
1190 | Consider the Net::FCP module. It features (among others) the following |
1240 | Consider the Net::FCP module. It features (among others) the following |
… | |
… | |
1317 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1367 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1318 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1368 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1319 | which it is), lets them fire exactly once and destroys them again. |
1369 | which it is), lets them fire exactly once and destroys them again. |
1320 | |
1370 | |
1321 | Source code for this benchmark is found as eg/bench in the AnyEvent |
1371 | Source code for this benchmark is found as eg/bench in the AnyEvent |
1322 | distribution. |
1372 | distribution. It uses the AE interface, which makes a real difference |
|
|
1373 | for the EV and Perl backends only. |
1323 | |
1374 | |
1324 | Explanation of the columns |
1375 | Explanation of the columns |
1325 | *watcher* is the number of event watchers created/destroyed. Since |
1376 | *watcher* is the number of event watchers created/destroyed. Since |
1326 | different event models feature vastly different performances, each event |
1377 | different event models feature vastly different performances, each event |
1327 | loop was given a number of watchers so that overall runtime is |
1378 | loop was given a number of watchers so that overall runtime is |
… | |
… | |
1346 | *destroy* is the time, in microseconds, that it takes to destroy a |
1397 | *destroy* is the time, in microseconds, that it takes to destroy a |
1347 | single watcher. |
1398 | single watcher. |
1348 | |
1399 | |
1349 | Results |
1400 | Results |
1350 | name watchers bytes create invoke destroy comment |
1401 | name watchers bytes create invoke destroy comment |
1351 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
1402 | EV/EV 100000 223 0.47 0.43 0.27 EV native interface |
1352 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
1403 | EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers |
1353 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
1404 | Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal |
1354 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
1405 | Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation |
1355 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
1406 | Event/Event 16000 516 31.16 31.84 0.82 Event native interface |
1356 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
1407 | Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers |
1357 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
1408 | IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll |
1358 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
1409 | IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll |
1359 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
1410 | Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour |
1360 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
1411 | Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers |
1361 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
1412 | POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event |
1362 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1413 | POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select |
1363 | |
1414 | |
1364 | Discussion |
1415 | Discussion |
1365 | The benchmark does *not* measure scalability of the event loop very |
1416 | The benchmark does *not* measure scalability of the event loop very |
1366 | well. For example, a select-based event loop (such as the pure perl one) |
1417 | well. For example, a select-based event loop (such as the pure perl one) |
1367 | can never compete with an event loop that uses epoll when the number of |
1418 | can never compete with an event loop that uses epoll when the number of |
… | |
… | |
1378 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
1429 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
1379 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 |
1430 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 |
1380 | CPU cycles with POE. |
1431 | CPU cycles with POE. |
1381 | |
1432 | |
1382 | "EV" is the sole leader regarding speed and memory use, which are both |
1433 | "EV" is the sole leader regarding speed and memory use, which are both |
1383 | maximal/minimal, respectively. Even when going through AnyEvent, it uses |
1434 | maximal/minimal, respectively. When using the AE API there is zero |
|
|
1435 | overhead (when going through the AnyEvent API create is about 5-6 times |
|
|
1436 | slower, with other times being equal, so still uses far less memory than |
1384 | far less memory than any other event loop and is still faster than Event |
1437 | any other event loop and is still faster than Event natively). |
1385 | natively. |
|
|
1386 | |
1438 | |
1387 | The pure perl implementation is hit in a few sweet spots (both the |
1439 | The pure perl implementation is hit in a few sweet spots (both the |
1388 | constant timeout and the use of a single fd hit optimisations in the |
1440 | constant timeout and the use of a single fd hit optimisations in the |
1389 | perl interpreter and the backend itself). Nevertheless this shows that |
1441 | perl interpreter and the backend itself). Nevertheless this shows that |
1390 | it adds very little overhead in itself. Like any select-based backend |
1442 | it adds very little overhead in itself. Like any select-based backend |
… | |
… | |
1460 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which |
1512 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which |
1461 | 100 (1%) are active. This mirrors the activity of large servers with |
1513 | 100 (1%) are active. This mirrors the activity of large servers with |
1462 | many connections, most of which are idle at any one point in time. |
1514 | many connections, most of which are idle at any one point in time. |
1463 | |
1515 | |
1464 | Source code for this benchmark is found as eg/bench2 in the AnyEvent |
1516 | Source code for this benchmark is found as eg/bench2 in the AnyEvent |
1465 | distribution. |
1517 | distribution. It uses the AE interface, which makes a real difference |
|
|
1518 | for the EV and Perl backends only. |
1466 | |
1519 | |
1467 | Explanation of the columns |
1520 | Explanation of the columns |
1468 | *sockets* is the number of sockets, and twice the number of "servers" |
1521 | *sockets* is the number of sockets, and twice the number of "servers" |
1469 | (as each server has a read and write socket end). |
1522 | (as each server has a read and write socket end). |
1470 | |
1523 | |
… | |
… | |
1476 | forwarding it to another server. This includes deleting the old timeout |
1529 | forwarding it to another server. This includes deleting the old timeout |
1477 | and creating a new one that moves the timeout into the future. |
1530 | and creating a new one that moves the timeout into the future. |
1478 | |
1531 | |
1479 | Results |
1532 | Results |
1480 | name sockets create request |
1533 | name sockets create request |
1481 | EV 20000 69.01 11.16 |
1534 | EV 20000 62.66 7.99 |
1482 | Perl 20000 73.32 35.87 |
1535 | Perl 20000 68.32 32.64 |
1483 | IOAsync 20000 157.00 98.14 epoll |
1536 | IOAsync 20000 174.06 101.15 epoll |
1484 | IOAsync 20000 159.31 616.06 poll |
1537 | IOAsync 20000 174.67 610.84 poll |
1485 | Event 20000 212.62 257.32 |
1538 | Event 20000 202.69 242.91 |
1486 | Glib 20000 651.16 1896.30 |
1539 | Glib 20000 557.01 1689.52 |
1487 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1540 | POE 20000 341.54 12086.32 uses POE::Loop::Event |
1488 | |
1541 | |
1489 | Discussion |
1542 | Discussion |
1490 | This benchmark *does* measure scalability and overall performance of the |
1543 | This benchmark *does* measure scalability and overall performance of the |
1491 | particular event loop. |
1544 | particular event loop. |
1492 | |
1545 | |
… | |
… | |
1605 | As you can see, the AnyEvent + EV combination even beats the |
1658 | As you can see, the AnyEvent + EV combination even beats the |
1606 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
1659 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
1607 | backend easily beats IO::Lambda and POE. |
1660 | backend easily beats IO::Lambda and POE. |
1608 | |
1661 | |
1609 | And even the 100% non-blocking version written using the high-level (and |
1662 | And even the 100% non-blocking version written using the high-level (and |
1610 | slow :) AnyEvent::Handle abstraction beats both POE and IO::Lambda by a |
1663 | slow :) AnyEvent::Handle abstraction beats both POE and IO::Lambda |
1611 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
1664 | higher level ("unoptimised") abstractions by a large margin, even though |
1612 | in a non-blocking way. |
1665 | it does all of DNS, tcp-connect and socket I/O in a non-blocking way. |
1613 | |
1666 | |
1614 | The two AnyEvent benchmarks programs can be found as eg/ae0.pl and |
1667 | The two AnyEvent benchmarks programs can be found as eg/ae0.pl and |
1615 | eg/ae2.pl in the AnyEvent distribution, the remaining benchmarks are |
1668 | eg/ae2.pl in the AnyEvent distribution, the remaining benchmarks are |
1616 | part of the IO::lambda distribution and were used without any changes. |
1669 | part of the IO::Lambda distribution and were used without any changes. |
1617 | |
1670 | |
1618 | SIGNALS |
1671 | SIGNALS |
1619 | AnyEvent currently installs handlers for these signals: |
1672 | AnyEvent currently installs handlers for these signals: |
1620 | |
1673 | |
1621 | SIGCHLD |
1674 | SIGCHLD |
… | |
… | |
1758 | Event::Lib, Qt, POE. |
1811 | Event::Lib, Qt, POE. |
1759 | |
1812 | |
1760 | Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event, |
1813 | Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event, |
1761 | AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, |
1814 | AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, |
1762 | AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE, |
1815 | AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE, |
1763 | AnyEvent::Impl::IOAsync. |
1816 | AnyEvent::Impl::IOAsync, Anyevent::Impl::Irssi. |
1764 | |
1817 | |
1765 | Non-blocking file handles, sockets, TCP clients and servers: |
1818 | Non-blocking file handles, sockets, TCP clients and servers: |
1766 | AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS. |
1819 | AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS. |
1767 | |
1820 | |
1768 | Asynchronous DNS: AnyEvent::DNS. |
1821 | Asynchronous DNS: AnyEvent::DNS. |