1 | NAME |
1 | NAME |
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 | |
7 | SYNOPSIS |
7 | SYNOPSIS |
8 | use AnyEvent; |
8 | use AnyEvent; |
9 | |
9 | |
10 | # file descriptor readable |
10 | # file descriptor readable |
… | |
… | |
37 | |
37 | |
38 | INTRODUCTION/TUTORIAL |
38 | INTRODUCTION/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 | |
|
|
43 | SUPPORT |
|
|
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 | |
43 | WHY YOU SHOULD USE THIS MODULE (OR NOT) |
50 | WHY 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* (*not* 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 |
176 | handle). Note that only file handles pointing to things for which |
189 | handle). Note that only file handles pointing to things for which |
177 | non-blocking operation makes sense are allowed. This includes sockets, |
190 | non-blocking operation makes sense are allowed. This includes sockets, |
178 | most character devices, pipes, fifos and so on, but not for example |
191 | most character devices, pipes, fifos and so on, but not for example |
179 | files or block devices. |
192 | files or block devices. |
… | |
… | |
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 |
… | |
… | |
336 | the event loop's idea of "current time". |
357 | the event loop's idea of "current time". |
337 | |
358 | |
338 | 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. |
339 | |
360 | |
340 | SIGNAL WATCHERS |
361 | SIGNAL WATCHERS |
|
|
362 | $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>); |
|
|
363 | |
341 | 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 |
342 | *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 |
343 | callback to be invoked whenever a signal occurs. |
366 | callback to be invoked whenever a signal occurs. |
344 | |
367 | |
345 | Although the callback might get passed parameters, their value and |
368 | Although the callback might get passed parameters, their value and |
… | |
… | |
350 | invocation, and callback invocation will be synchronous. Synchronous |
373 | invocation, and callback invocation will be synchronous. Synchronous |
351 | means that it might take a while until the signal gets handled by the |
374 | 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. |
375 | process, but it is guaranteed not to interrupt any other callbacks. |
353 | |
376 | |
354 | The main advantage of using these watchers is that you can share a |
377 | The main advantage of using these watchers is that you can share a |
355 | signal between multiple watchers. |
378 | signal between multiple watchers, and AnyEvent will ensure that signals |
|
|
379 | will not interrupt your program at bad times. |
356 | |
380 | |
357 | This watcher might use %SIG, so programs overwriting those signals |
381 | This watcher might use %SIG (depending on the event loop used), so |
358 | directly will likely not work correctly. |
382 | programs overwriting those signals directly will likely not work |
|
|
383 | correctly. |
359 | |
384 | |
360 | Example: exit on SIGINT |
385 | Example: exit on SIGINT |
361 | |
386 | |
362 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
387 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
363 | |
388 | |
|
|
389 | Signal Races, Delays and Workarounds |
|
|
390 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
|
|
391 | callbacks to signals in a generic way, which is a pity, as you cannot do |
|
|
392 | race-free signal handling in perl, requiring C libraries for this. |
|
|
393 | AnyEvent will try to do it's best, which means in some cases, signals |
|
|
394 | will be delayed. The maximum time a signal might be delayed is specified |
|
|
395 | in $AnyEvent::MAX_SIGNAL_LATENCY (default: 10 seconds). This variable |
|
|
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 |
|
|
399 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
400 | saving. |
|
|
401 | |
|
|
402 | All these problems can be avoided by installing the optional |
|
|
403 | Async::Interrupt module, which works with most event loops. It will not |
|
|
404 | work with inherently broken event loops such as Event or Event::Lib (and |
|
|
405 | not with POE currently, as POE does it's own workaround with one-second |
|
|
406 | latency). For those, you just have to suffer the delays. |
|
|
407 | |
364 | CHILD PROCESS WATCHERS |
408 | CHILD PROCESS WATCHERS |
|
|
409 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
|
|
410 | |
365 | 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. |
366 | |
412 | |
367 | 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, |
368 | 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). |
369 | 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 |
370 | on any trace events (stopped/continued). |
416 | and an exit status is available, not on any trace events |
|
|
417 | (stopped/continued). |
371 | |
418 | |
372 | 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 |
373 | 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 |
374 | callback arguments. |
421 | callback arguments. |
375 | |
422 | |
… | |
… | |
390 | of when you start the watcher. |
437 | of when you start the watcher. |
391 | |
438 | |
392 | This means you cannot create a child watcher as the very first thing in |
439 | 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 |
440 | an AnyEvent program, you *have* to create at least one watcher before |
394 | you "fork" the child (alternatively, you can call "AnyEvent::detect"). |
441 | you "fork" the child (alternatively, you can call "AnyEvent::detect"). |
|
|
442 | |
|
|
443 | As most event loops do not support waiting for child events, they will |
|
|
444 | be emulated by AnyEvent in most cases, in which the latency and race |
|
|
445 | problems mentioned in the description of signal watchers apply. |
395 | |
446 | |
396 | Example: fork a process and wait for it |
447 | Example: fork a process and wait for it |
397 | |
448 | |
398 | my $done = AnyEvent->condvar; |
449 | my $done = AnyEvent->condvar; |
399 | |
450 | |
… | |
… | |
410 | |
461 | |
411 | # do something else, then wait for process exit |
462 | # do something else, then wait for process exit |
412 | $done->recv; |
463 | $done->recv; |
413 | |
464 | |
414 | IDLE WATCHERS |
465 | IDLE WATCHERS |
|
|
466 | $w = AnyEvent->idle (cb => <callback>); |
|
|
467 | |
415 | 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 |
416 | 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 |
417 | "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 |
418 | attention by the event loop". |
471 | attention by the event loop". |
419 | |
472 | |
… | |
… | |
444 | } |
497 | } |
445 | }); |
498 | }); |
446 | }); |
499 | }); |
447 | |
500 | |
448 | CONDITION VARIABLES |
501 | CONDITION VARIABLES |
|
|
502 | $cv = AnyEvent->condvar; |
|
|
503 | |
|
|
504 | $cv->send (<list>); |
|
|
505 | my @res = $cv->recv; |
|
|
506 | |
449 | 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 |
450 | 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 |
451 | will actively watch for new events and call your callbacks. |
509 | will actively watch for new events and call your callbacks. |
452 | |
510 | |
453 | AnyEvent is different, it expects somebody else to run the event loop |
511 | AnyEvent is slightly different: it expects somebody else to run the |
454 | and will only block when necessary (usually when told by the user). |
512 | event loop and will only block when necessary (usually when told by the |
|
|
513 | user). |
455 | |
514 | |
456 | The instrument to do that is called a "condition variable", so called |
515 | The instrument to do that is called a "condition variable", so called |
457 | because they represent a condition that must become true. |
516 | because they represent a condition that must become true. |
458 | |
517 | |
|
|
518 | Now is probably a good time to look at the examples further below. |
|
|
519 | |
459 | Condition variables can be created by calling the "AnyEvent->condvar" |
520 | Condition variables can be created by calling the "AnyEvent->condvar" |
460 | method, usually without arguments. The only argument pair allowed is |
521 | method, usually without arguments. The only argument pair allowed is |
461 | |
|
|
462 | "cb", which specifies a callback to be called when the condition |
522 | "cb", which specifies a callback to be called when the condition |
463 | variable becomes true, with the condition variable as the first argument |
523 | variable becomes true, with the condition variable as the first argument |
464 | (but not the results). |
524 | (but not the results). |
465 | |
525 | |
466 | After creation, the condition variable is "false" until it becomes |
526 | After creation, the condition variable is "false" until it becomes |
… | |
… | |
471 | Condition variables are similar to callbacks, except that you can |
531 | Condition variables are similar to callbacks, except that you can |
472 | optionally wait for them. They can also be called merge points - points |
532 | optionally wait for them. They can also be called merge points - points |
473 | in time where multiple outstanding events have been processed. And yet |
533 | in time where multiple outstanding events have been processed. And yet |
474 | another way to call them is transactions - each condition variable can |
534 | another way to call them is transactions - each condition variable can |
475 | be used to represent a transaction, which finishes at some point and |
535 | be used to represent a transaction, which finishes at some point and |
476 | delivers a result. |
536 | delivers a result. And yet some people know them as "futures" - a |
|
|
537 | promise to compute/deliver something that you can wait for. |
477 | |
538 | |
478 | Condition variables are very useful to signal that something has |
539 | Condition variables are very useful to signal that something has |
479 | finished, for example, if you write a module that does asynchronous http |
540 | finished, for example, if you write a module that does asynchronous http |
480 | requests, then a condition variable would be the ideal candidate to |
541 | requests, then a condition variable would be the ideal candidate to |
481 | signal the availability of results. The user can either act when the |
542 | signal the availability of results. The user can either act when the |
… | |
… | |
515 | after => 1, |
576 | after => 1, |
516 | cb => sub { $result_ready->send }, |
577 | cb => sub { $result_ready->send }, |
517 | ); |
578 | ); |
518 | |
579 | |
519 | # this "blocks" (while handling events) till the callback |
580 | # this "blocks" (while handling events) till the callback |
520 | # calls send |
581 | # calls ->send |
521 | $result_ready->recv; |
582 | $result_ready->recv; |
522 | |
583 | |
523 | 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 |
524 | variables are also code references. |
585 | variables are also callable directly. |
525 | |
586 | |
526 | my $done = AnyEvent->condvar; |
587 | my $done = AnyEvent->condvar; |
527 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
588 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
528 | $done->recv; |
589 | $done->recv; |
529 | |
590 | |
… | |
… | |
535 | |
596 | |
536 | ... |
597 | ... |
537 | |
598 | |
538 | my @info = $couchdb->info->recv; |
599 | my @info = $couchdb->info->recv; |
539 | |
600 | |
540 | And this is how you would just ste a callback to be called whenever the |
601 | And this is how you would just set a callback to be called whenever the |
541 | results are available: |
602 | results are available: |
542 | |
603 | |
543 | $couchdb->info->cb (sub { |
604 | $couchdb->info->cb (sub { |
544 | my @info = $_[0]->recv; |
605 | my @info = $_[0]->recv; |
545 | }); |
606 | }); |
… | |
… | |
560 | |
621 | |
561 | Any arguments passed to the "send" call will be returned by all |
622 | Any arguments passed to the "send" call will be returned by all |
562 | future "->recv" calls. |
623 | future "->recv" calls. |
563 | |
624 | |
564 | Condition variables are overloaded so one can call them directly (as |
625 | Condition variables are overloaded so one can call them directly (as |
565 | a code reference). Calling them directly is the same as calling |
626 | if they were a code reference). Calling them directly is the same as |
566 | "send". Note, however, that many C-based event loops do not handle |
627 | calling "send". |
567 | overloading, so as tempting as it may be, passing a condition |
|
|
568 | variable instead of a callback does not work. Both the pure perl and |
|
|
569 | EV loops support overloading, however, as well as all functions that |
|
|
570 | use perl to invoke a callback (as in AnyEvent::Socket and |
|
|
571 | AnyEvent::DNS for example). |
|
|
572 | |
628 | |
573 | $cv->croak ($error) |
629 | $cv->croak ($error) |
574 | Similar to send, but causes all call's to "->recv" to invoke |
630 | Similar to send, but causes all call's to "->recv" to invoke |
575 | "Carp::croak" with the given error message/object/scalar. |
631 | "Carp::croak" with the given error message/object/scalar. |
576 | |
632 | |
577 | This can be used to signal any errors to the condition variable |
633 | This can be used to signal any errors to the condition variable |
578 | user/consumer. |
634 | user/consumer. Doing it this way instead of calling "croak" directly |
|
|
635 | delays the error detetcion, but has the overwhelmign advantage that |
|
|
636 | it diagnoses the error at the place where the result is expected, |
|
|
637 | and not deep in some event clalback without connection to the actual |
|
|
638 | code causing the problem. |
579 | |
639 | |
580 | $cv->begin ([group callback]) |
640 | $cv->begin ([group callback]) |
581 | $cv->end |
641 | $cv->end |
582 | These two methods are EXPERIMENTAL and MIGHT CHANGE. |
|
|
583 | |
|
|
584 | These two methods can be used to combine many transactions/events |
642 | These two methods can be used to combine many transactions/events |
585 | 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 |
586 | might want to use a condition variable for the whole process. |
644 | might want to use a condition variable for the whole process. |
587 | |
645 | |
588 | 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 |
589 | "->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 |
590 | (last) callback passed to "begin" will be executed. That callback is |
648 | (last) callback passed to "begin" will be executed, passing the |
591 | *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, |
592 | callback was set, "send" will be called without any arguments. |
651 | "send" will be called without any arguments. |
593 | |
652 | |
594 | Let's clarify this with the ping example: |
653 | You can think of "$cv->send" giving you an OR condition (one call |
|
|
654 | sends), while "$cv->begin" and "$cv->end" giving you an AND |
|
|
655 | condition (all "begin" calls must be "end"'ed before the condvar |
|
|
656 | sends). |
|
|
657 | |
|
|
658 | Let's start with a simple example: you have two I/O watchers (for |
|
|
659 | example, STDOUT and STDERR for a program), and you want to wait for |
|
|
660 | both streams to close before activating a condvar: |
595 | |
661 | |
596 | my $cv = AnyEvent->condvar; |
662 | my $cv = AnyEvent->condvar; |
597 | |
663 | |
|
|
664 | $cv->begin; # first watcher |
|
|
665 | my $w1 = AnyEvent->io (fh => $fh1, cb => sub { |
|
|
666 | defined sysread $fh1, my $buf, 4096 |
|
|
667 | or $cv->end; |
|
|
668 | }); |
|
|
669 | |
|
|
670 | $cv->begin; # second watcher |
|
|
671 | my $w2 = AnyEvent->io (fh => $fh2, cb => sub { |
|
|
672 | defined sysread $fh2, my $buf, 4096 |
|
|
673 | or $cv->end; |
|
|
674 | }); |
|
|
675 | |
|
|
676 | $cv->recv; |
|
|
677 | |
|
|
678 | This works because for every event source (EOF on file handle), |
|
|
679 | there is one call to "begin", so the condvar waits for all calls to |
|
|
680 | "end" before sending. |
|
|
681 | |
|
|
682 | The ping example mentioned above is slightly more complicated, as |
|
|
683 | the there are results to be passwd back, and the number of tasks |
|
|
684 | that are begung can potentially be zero: |
|
|
685 | |
|
|
686 | my $cv = AnyEvent->condvar; |
|
|
687 | |
598 | my %result; |
688 | my %result; |
599 | $cv->begin (sub { $cv->send (\%result) }); |
689 | $cv->begin (sub { shift->send (\%result) }); |
600 | |
690 | |
601 | for my $host (@list_of_hosts) { |
691 | for my $host (@list_of_hosts) { |
602 | $cv->begin; |
692 | $cv->begin; |
603 | ping_host_then_call_callback $host, sub { |
693 | ping_host_then_call_callback $host, sub { |
604 | $result{$host} = ...; |
694 | $result{$host} = ...; |
… | |
… | |
619 | the loop, which serves two important purposes: first, it sets the |
709 | the loop, which serves two important purposes: first, it sets the |
620 | callback to be called once the counter reaches 0, and second, it |
710 | callback to be called once the counter reaches 0, and second, it |
621 | ensures that "send" is called even when "no" hosts are being pinged |
711 | ensures that "send" is called even when "no" hosts are being pinged |
622 | (the loop doesn't execute once). |
712 | (the loop doesn't execute once). |
623 | |
713 | |
624 | This is the general pattern when you "fan out" into multiple |
714 | This is the general pattern when you "fan out" into multiple (but |
625 | subrequests: use an outer "begin"/"end" pair to set the callback and |
715 | potentially none) subrequests: use an outer "begin"/"end" pair to |
626 | ensure "end" is called at least once, and then, for each subrequest |
716 | set the callback and ensure "end" is called at least once, and then, |
627 | you start, call "begin" and for each subrequest you finish, call |
717 | for each subrequest you start, call "begin" and for each subrequest |
628 | "end". |
718 | you finish, call "end". |
629 | |
719 | |
630 | METHODS FOR CONSUMERS |
720 | METHODS FOR CONSUMERS |
631 | These methods should only be used by the consuming side, i.e. the code |
721 | These methods should only be used by the consuming side, i.e. the code |
632 | awaits the condition. |
722 | awaits the condition. |
633 | |
723 | |
… | |
… | |
642 | function will call "croak". |
732 | function will call "croak". |
643 | |
733 | |
644 | In list context, all parameters passed to "send" will be returned, |
734 | In list context, all parameters passed to "send" will be returned, |
645 | in scalar context only the first one will be returned. |
735 | in scalar context only the first one will be returned. |
646 | |
736 | |
|
|
737 | Note that doing a blocking wait in a callback is not supported by |
|
|
738 | any event loop, that is, recursive invocation of a blocking "->recv" |
|
|
739 | is not allowed, and the "recv" call will "croak" if such a condition |
|
|
740 | is detected. This condition can be slightly loosened by using |
|
|
741 | Coro::AnyEvent, which allows you to do a blocking "->recv" from any |
|
|
742 | thread that doesn't run the event loop itself. |
|
|
743 | |
647 | Not all event models support a blocking wait - some die in that case |
744 | Not all event models support a blocking wait - some die in that case |
648 | (programs might want to do that to stay interactive), so *if you are |
745 | (programs might want to do that to stay interactive), so *if you are |
649 | using this from a module, never require a blocking wait*, but let |
746 | using this from a module, never require a blocking wait*. Instead, |
650 | the caller decide whether the call will block or not (for example, |
747 | let the caller decide whether the call will block or not (for |
651 | by coupling condition variables with some kind of request results |
748 | example, by coupling condition variables with some kind of request |
652 | and supporting callbacks so the caller knows that getting the result |
749 | results and supporting callbacks so the caller knows that getting |
653 | will not block, while still supporting blocking waits if the caller |
750 | the result will not block, while still supporting blocking waits if |
654 | so desires). |
751 | the caller so desires). |
655 | |
|
|
656 | Another reason *never* to "->recv" in a module is that you cannot |
|
|
657 | sensibly have two "->recv"'s in parallel, as that would require |
|
|
658 | multiple interpreters or coroutines/threads, none of which |
|
|
659 | "AnyEvent" can supply. |
|
|
660 | |
|
|
661 | The Coro module, however, *can* and *does* supply coroutines and, in |
|
|
662 | fact, Coro::AnyEvent replaces AnyEvent's condvars by coroutine-safe |
|
|
663 | versions and also integrates coroutines into AnyEvent, making |
|
|
664 | blocking "->recv" calls perfectly safe as long as they are done from |
|
|
665 | another coroutine (one that doesn't run the event loop). |
|
|
666 | |
752 | |
667 | You can ensure that "-recv" never blocks by setting a callback and |
753 | You can ensure that "-recv" never blocks by setting a callback and |
668 | only calling "->recv" from within that callback (or at a later |
754 | only calling "->recv" from within that callback (or at a later |
669 | time). This will work even when the event loop does not support |
755 | time). This will work even when the event loop does not support |
670 | blocking waits otherwise. |
756 | blocking waits otherwise. |
… | |
… | |
675 | |
761 | |
676 | $cb = $cv->cb ($cb->($cv)) |
762 | $cb = $cv->cb ($cb->($cv)) |
677 | This is a mutator function that returns the callback set and |
763 | This is a mutator function that returns the callback set and |
678 | optionally replaces it before doing so. |
764 | optionally replaces it before doing so. |
679 | |
765 | |
680 | The callback will be called when the condition becomes "true", i.e. |
766 | The callback will be called when the condition becomes (or already |
681 | 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 |
682 | 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 |
683 | any later time is guaranteed not to block. |
770 | guaranteed not to block. |
|
|
771 | |
|
|
772 | SUPPORTED EVENT LOOPS/BACKENDS |
|
|
773 | The available backend classes are (every class has its own manpage): |
|
|
774 | |
|
|
775 | Backends that are autoprobed when no other event loop can be found. |
|
|
776 | EV is the preferred backend when no other event loop seems to be in |
|
|
777 | use. If EV is not installed, then AnyEvent will fall back to its own |
|
|
778 | pure-perl implementation, which is available everywhere as it comes |
|
|
779 | with AnyEvent itself. |
|
|
780 | |
|
|
781 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
|
|
782 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
783 | |
|
|
784 | Backends that are transparently being picked up when they are used. |
|
|
785 | These will be used when they are currently loaded when the first |
|
|
786 | watcher is created, in which case it is assumed that the application |
|
|
787 | is using them. This means that AnyEvent will automatically pick the |
|
|
788 | right backend when the main program loads an event module before |
|
|
789 | anything starts to create watchers. Nothing special needs to be done |
|
|
790 | by the main program. |
|
|
791 | |
|
|
792 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
793 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
|
|
794 | AnyEvent::Impl::Tk based on Tk, very broken. |
|
|
795 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
796 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
797 | AnyEvent::Impl::Irssi used when running within irssi. |
|
|
798 | |
|
|
799 | Backends with special needs. |
|
|
800 | Qt requires the Qt::Application to be instantiated first, but will |
|
|
801 | otherwise be picked up automatically. As long as the main program |
|
|
802 | instantiates the application before any AnyEvent watchers are |
|
|
803 | created, everything should just work. |
|
|
804 | |
|
|
805 | AnyEvent::Impl::Qt based on Qt. |
|
|
806 | |
|
|
807 | Support for IO::Async can only be partial, as it is too broken and |
|
|
808 | architecturally limited to even support the AnyEvent API. It also is |
|
|
809 | the only event loop that needs the loop to be set explicitly, so it |
|
|
810 | can only be used by a main program knowing about AnyEvent. See |
|
|
811 | AnyEvent::Impl::Async for the gory details. |
|
|
812 | |
|
|
813 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
|
|
814 | |
|
|
815 | Event loops that are indirectly supported via other backends. |
|
|
816 | Some event loops can be supported via other modules: |
|
|
817 | |
|
|
818 | There is no direct support for WxWidgets (Wx) or Prima. |
|
|
819 | |
|
|
820 | WxWidgets has no support for watching file handles. However, you can |
|
|
821 | use WxWidgets through the POE adaptor, as POE has a Wx backend that |
|
|
822 | simply polls 20 times per second, which was considered to be too |
|
|
823 | horrible to even consider for AnyEvent. |
|
|
824 | |
|
|
825 | Prima is not supported as nobody seems to be using it, but it has a |
|
|
826 | POE backend, so it can be supported through POE. |
|
|
827 | |
|
|
828 | AnyEvent knows about both Prima and Wx, however, and will try to |
|
|
829 | load POE when detecting them, in the hope that POE will pick them |
|
|
830 | up, in which case everything will be automatic. |
684 | |
831 | |
685 | GLOBAL VARIABLES AND FUNCTIONS |
832 | GLOBAL VARIABLES AND FUNCTIONS |
|
|
833 | These are not normally required to use AnyEvent, but can be useful to |
|
|
834 | write AnyEvent extension modules. |
|
|
835 | |
686 | $AnyEvent::MODEL |
836 | $AnyEvent::MODEL |
687 | Contains "undef" until the first watcher is being created. Then it |
837 | Contains "undef" until the first watcher is being created, before |
|
|
838 | the backend has been autodetected. |
|
|
839 | |
688 | contains the event model that is being used, which is the name of |
840 | Afterwards it contains the event model that is being used, which is |
689 | the Perl class implementing the model. This class is usually one of |
841 | the name of the Perl class implementing the model. This class is |
690 | the "AnyEvent::Impl:xxx" modules, but can be any other class in the |
842 | usually one of the "AnyEvent::Impl:xxx" modules, but can be any |
691 | case AnyEvent has been extended at runtime (e.g. in *rxvt-unicode*). |
843 | other class in the case AnyEvent has been extended at runtime (e.g. |
692 | |
844 | in *rxvt-unicode* it will be "urxvt::anyevent"). |
693 | The known classes so far are: |
|
|
694 | |
|
|
695 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
|
|
696 | AnyEvent::Impl::Event based on Event, second best choice. |
|
|
697 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
|
|
698 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
|
|
699 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
|
|
700 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
|
|
701 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
|
|
702 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
|
|
703 | |
|
|
704 | # warning, support for IO::Async is only partial, as it is too broken |
|
|
705 | # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async. |
|
|
706 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs). |
|
|
707 | |
|
|
708 | There is no support for WxWidgets, as WxWidgets has no support for |
|
|
709 | watching file handles. However, you can use WxWidgets through the |
|
|
710 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
|
|
711 | second, which was considered to be too horrible to even consider for |
|
|
712 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by |
|
|
713 | using it's adaptor. |
|
|
714 | |
|
|
715 | AnyEvent knows about Prima and Wx and will try to use POE when |
|
|
716 | autodetecting them. |
|
|
717 | |
845 | |
718 | AnyEvent::detect |
846 | AnyEvent::detect |
719 | Returns $AnyEvent::MODEL, forcing autodetection of the event model |
847 | Returns $AnyEvent::MODEL, forcing autodetection of the event model |
720 | if necessary. You should only call this function right before you |
848 | if necessary. You should only call this function right before you |
721 | would have created an AnyEvent watcher anyway, that is, as late as |
849 | would have created an AnyEvent watcher anyway, that is, as late as |
722 | possible at runtime. |
850 | possible at runtime, and not e.g. while initialising of your module. |
|
|
851 | |
|
|
852 | If you need to do some initialisation before AnyEvent watchers are |
|
|
853 | created, use "post_detect". |
723 | |
854 | |
724 | $guard = AnyEvent::post_detect { BLOCK } |
855 | $guard = AnyEvent::post_detect { BLOCK } |
725 | Arranges for the code block to be executed as soon as the event |
856 | Arranges for the code block to be executed as soon as the event |
726 | model is autodetected (or immediately if this has already happened). |
857 | model is autodetected (or immediately if this has already happened). |
727 | |
858 | |
|
|
859 | The block will be executed *after* the actual backend has been |
|
|
860 | detected ($AnyEvent::MODEL is set), but *before* any watchers have |
|
|
861 | been created, so it is possible to e.g. patch @AnyEvent::ISA or do |
|
|
862 | other initialisations - see the sources of AnyEvent::Strict or |
|
|
863 | AnyEvent::AIO to see how this is used. |
|
|
864 | |
|
|
865 | The most common usage is to create some global watchers, without |
|
|
866 | forcing event module detection too early, for example, AnyEvent::AIO |
|
|
867 | creates and installs the global IO::AIO watcher in a "post_detect" |
|
|
868 | block to avoid autodetecting the event module at load time. |
|
|
869 | |
728 | 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 |
729 | 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 |
730 | 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; |
731 | |
890 | |
732 | @AnyEvent::post_detect |
891 | @AnyEvent::post_detect |
733 | 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 |
734 | before or after loading AnyEvent), then they will called directly |
893 | before or after loading AnyEvent), then they will called directly |
735 | after the event loop has been chosen. |
894 | after the event loop has been chosen. |
736 | |
895 | |
737 | You should check $AnyEvent::MODEL before adding to this array, |
896 | You should check $AnyEvent::MODEL before adding to this array, |
738 | though: if it contains a true value then the event loop has already |
897 | though: if it is defined then the event loop has already been |
739 | been detected, and the array will be ignored. |
898 | detected, and the array will be ignored. |
740 | |
899 | |
741 | Best use "AnyEvent::post_detect { BLOCK }" instead. |
900 | Best use "AnyEvent::post_detect { BLOCK }" when your application |
|
|
901 | allows it,as it takes care of these details. |
|
|
902 | |
|
|
903 | This variable is mainly useful for modules that can do something |
|
|
904 | useful when AnyEvent is used and thus want to know when it is |
|
|
905 | initialised, but do not need to even load it by default. This array |
|
|
906 | provides the means to hook into AnyEvent passively, without loading |
|
|
907 | it. |
742 | |
908 | |
743 | WHAT TO DO IN A MODULE |
909 | WHAT TO DO IN A MODULE |
744 | As a module author, you should "use AnyEvent" and call AnyEvent methods |
910 | As a module author, you should "use AnyEvent" and call AnyEvent methods |
745 | freely, but you should not load a specific event module or rely on it. |
911 | freely, but you should not load a specific event module or rely on it. |
746 | |
912 | |
… | |
… | |
797 | variable somewhere, waiting for it, and sending it when the program |
963 | variable somewhere, waiting for it, and sending it when the program |
798 | should exit cleanly. |
964 | should exit cleanly. |
799 | |
965 | |
800 | OTHER MODULES |
966 | OTHER MODULES |
801 | The following is a non-exhaustive list of additional modules that use |
967 | The following is a non-exhaustive list of additional modules that use |
802 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
968 | AnyEvent as a client and can therefore be mixed easily with other |
803 | in the same program. Some of the modules come with AnyEvent, some are |
969 | AnyEvent modules and other event loops in the same program. Some of the |
804 | available via CPAN. |
970 | modules come with AnyEvent, most are available via CPAN. |
805 | |
971 | |
806 | AnyEvent::Util |
972 | AnyEvent::Util |
807 | Contains various utility functions that replace often-used but |
973 | Contains various utility functions that replace often-used but |
808 | blocking functions such as "inet_aton" by event-/callback-based |
974 | blocking functions such as "inet_aton" by event-/callback-based |
809 | versions. |
975 | versions. |
… | |
… | |
815 | more. |
981 | more. |
816 | |
982 | |
817 | AnyEvent::Handle |
983 | AnyEvent::Handle |
818 | Provide read and write buffers, manages watchers for reads and |
984 | Provide read and write buffers, manages watchers for reads and |
819 | writes, supports raw and formatted I/O, I/O queued and fully |
985 | writes, supports raw and formatted I/O, I/O queued and fully |
820 | transparent and non-blocking SSL/TLS. |
986 | transparent and non-blocking SSL/TLS (via AnyEvent::TLS. |
821 | |
987 | |
822 | AnyEvent::DNS |
988 | AnyEvent::DNS |
823 | Provides rich asynchronous DNS resolver capabilities. |
989 | Provides rich asynchronous DNS resolver capabilities. |
824 | |
990 | |
825 | AnyEvent::HTTP |
991 | AnyEvent::HTTP |
… | |
… | |
846 | |
1012 | |
847 | AnyEvent::GPSD |
1013 | AnyEvent::GPSD |
848 | A non-blocking interface to gpsd, a daemon delivering GPS |
1014 | A non-blocking interface to gpsd, a daemon delivering GPS |
849 | information. |
1015 | information. |
850 | |
1016 | |
|
|
1017 | AnyEvent::IRC |
|
|
1018 | AnyEvent based IRC client module family (replacing the older |
|
|
1019 | Net::IRC3). |
|
|
1020 | |
|
|
1021 | AnyEvent::XMPP |
|
|
1022 | AnyEvent based XMPP (Jabber protocol) module family (replacing the |
|
|
1023 | older Net::XMPP2>. |
|
|
1024 | |
851 | AnyEvent::IGS |
1025 | AnyEvent::IGS |
852 | A non-blocking interface to the Internet Go Server protocol (used by |
1026 | A non-blocking interface to the Internet Go Server protocol (used by |
853 | App::IGS). |
1027 | App::IGS). |
854 | |
1028 | |
855 | AnyEvent::IRC |
|
|
856 | AnyEvent based IRC client module family (replacing the older |
|
|
857 | Net::IRC3). |
|
|
858 | |
|
|
859 | Net::XMPP2 |
|
|
860 | AnyEvent based XMPP (Jabber protocol) module family. |
|
|
861 | |
|
|
862 | Net::FCP |
1029 | Net::FCP |
863 | AnyEvent-based implementation of the Freenet Client Protocol, |
1030 | AnyEvent-based implementation of the Freenet Client Protocol, |
864 | birthplace of AnyEvent. |
1031 | birthplace of AnyEvent. |
865 | |
1032 | |
866 | Event::ExecFlow |
1033 | Event::ExecFlow |
867 | High level API for event-based execution flow control. |
1034 | High level API for event-based execution flow control. |
868 | |
1035 | |
869 | Coro |
1036 | Coro |
870 | Has special support for AnyEvent via Coro::AnyEvent. |
1037 | Has special support for AnyEvent via Coro::AnyEvent. |
871 | |
1038 | |
872 | IO::Lambda |
1039 | SIMPLIFIED AE API |
873 | The lambda approach to I/O - don't ask, look there. Can use |
1040 | Starting with version 5.0, AnyEvent officially supports a second, much |
874 | AnyEvent. |
1041 | simpler, API that is designed to reduce the calling, typing and memory |
|
|
1042 | overhead. |
|
|
1043 | |
|
|
1044 | See the AE manpage for details. |
875 | |
1045 | |
876 | ERROR AND EXCEPTION HANDLING |
1046 | ERROR AND EXCEPTION HANDLING |
877 | 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 |
878 | 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 |
879 | "PERL_ANYEVENT_STRICT" environment variable, below) provides strict |
1049 | "PERL_ANYEVENT_STRICT" environment variable, below) provides strict |
… | |
… | |
907 | by "PERL_ANYEVENT_MODEL". |
1077 | by "PERL_ANYEVENT_MODEL". |
908 | |
1078 | |
909 | When set to 2 or higher, cause AnyEvent to report to STDERR which |
1079 | When set to 2 or higher, cause AnyEvent to report to STDERR which |
910 | event model it chooses. |
1080 | event model it chooses. |
911 | |
1081 | |
|
|
1082 | When set to 8 or higher, then AnyEvent will report extra information |
|
|
1083 | on which optional modules it loads and how it implements certain |
|
|
1084 | features. |
|
|
1085 | |
912 | "PERL_ANYEVENT_STRICT" |
1086 | "PERL_ANYEVENT_STRICT" |
913 | AnyEvent does not do much argument checking by default, as thorough |
1087 | AnyEvent does not do much argument checking by default, as thorough |
914 | argument checking is very costly. Setting this variable to a true |
1088 | argument checking is very costly. Setting this variable to a true |
915 | value will cause AnyEvent to load "AnyEvent::Strict" and then to |
1089 | value will cause AnyEvent to load "AnyEvent::Strict" and then to |
916 | thoroughly check the arguments passed to most method calls. If it |
1090 | thoroughly check the arguments passed to most method calls. If it |
917 | finds any problems, it will croak. |
1091 | finds any problems, it will croak. |
918 | |
1092 | |
919 | In other words, enables "strict" mode. |
1093 | In other words, enables "strict" mode. |
920 | |
1094 | |
921 | Unlike "use strict", it is definitely recommended to keep it off in |
1095 | Unlike "use strict" (or it's modern cousin, "use common::sense", it |
922 | production. Keeping "PERL_ANYEVENT_STRICT=1" in your environment |
1096 | is definitely recommended to keep it off in production. Keeping |
|
|
1097 | "PERL_ANYEVENT_STRICT=1" in your environment while developing |
923 | while developing programs can be very useful, however. |
1098 | programs can be very useful, however. |
924 | |
1099 | |
925 | "PERL_ANYEVENT_MODEL" |
1100 | "PERL_ANYEVENT_MODEL" |
926 | This can be used to specify the event model to be used by AnyEvent, |
1101 | This can be used to specify the event model to be used by AnyEvent, |
927 | before auto detection and -probing kicks in. It must be a string |
1102 | before auto detection and -probing kicks in. It must be a string |
928 | consisting entirely of ASCII letters. The string "AnyEvent::Impl::" |
1103 | consisting entirely of ASCII letters. The string "AnyEvent::Impl::" |
… | |
… | |
969 | EDNS0 in its DNS requests. |
1144 | EDNS0 in its DNS requests. |
970 | |
1145 | |
971 | "PERL_ANYEVENT_MAX_FORKS" |
1146 | "PERL_ANYEVENT_MAX_FORKS" |
972 | The maximum number of child processes that |
1147 | The maximum number of child processes that |
973 | "AnyEvent::Util::fork_call" will create in parallel. |
1148 | "AnyEvent::Util::fork_call" will create in parallel. |
|
|
1149 | |
|
|
1150 | "PERL_ANYEVENT_MAX_OUTSTANDING_DNS" |
|
|
1151 | The default value for the "max_outstanding" parameter for the |
|
|
1152 | default DNS resolver - this is the maximum number of parallel DNS |
|
|
1153 | requests that are sent to the DNS server. |
|
|
1154 | |
|
|
1155 | "PERL_ANYEVENT_RESOLV_CONF" |
|
|
1156 | The file to use instead of /etc/resolv.conf (or OS-specific |
|
|
1157 | configuration) in the default resolver. When set to the empty |
|
|
1158 | string, no default config will be used. |
|
|
1159 | |
|
|
1160 | "PERL_ANYEVENT_CA_FILE", "PERL_ANYEVENT_CA_PATH". |
|
|
1161 | When neither "ca_file" nor "ca_path" was specified during |
|
|
1162 | AnyEvent::TLS context creation, and either of these environment |
|
|
1163 | variables exist, they will be used to specify CA certificate |
|
|
1164 | locations instead of a system-dependent default. |
|
|
1165 | |
|
|
1166 | "PERL_ANYEVENT_AVOID_GUARD" and "PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT" |
|
|
1167 | When these are set to 1, then the respective modules are not loaded. |
|
|
1168 | Mostly good for testing AnyEvent itself. |
974 | |
1169 | |
975 | SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1170 | SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
976 | This is an advanced topic that you do not normally need to use AnyEvent |
1171 | This is an advanced topic that you do not normally need to use AnyEvent |
977 | in a module. This section is only of use to event loop authors who want |
1172 | in a module. This section is only of use to event loop authors who want |
978 | to provide AnyEvent compatibility. |
1173 | to provide AnyEvent compatibility. |
… | |
… | |
1179 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1374 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1180 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1375 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1181 | which it is), lets them fire exactly once and destroys them again. |
1376 | which it is), lets them fire exactly once and destroys them again. |
1182 | |
1377 | |
1183 | Source code for this benchmark is found as eg/bench in the AnyEvent |
1378 | Source code for this benchmark is found as eg/bench in the AnyEvent |
1184 | distribution. |
1379 | distribution. It uses the AE interface, which makes a real difference |
|
|
1380 | for the EV and Perl backends only. |
1185 | |
1381 | |
1186 | Explanation of the columns |
1382 | Explanation of the columns |
1187 | *watcher* is the number of event watchers created/destroyed. Since |
1383 | *watcher* is the number of event watchers created/destroyed. Since |
1188 | different event models feature vastly different performances, each event |
1384 | different event models feature vastly different performances, each event |
1189 | loop was given a number of watchers so that overall runtime is |
1385 | loop was given a number of watchers so that overall runtime is |
… | |
… | |
1208 | *destroy* is the time, in microseconds, that it takes to destroy a |
1404 | *destroy* is the time, in microseconds, that it takes to destroy a |
1209 | single watcher. |
1405 | single watcher. |
1210 | |
1406 | |
1211 | Results |
1407 | Results |
1212 | name watchers bytes create invoke destroy comment |
1408 | name watchers bytes create invoke destroy comment |
1213 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
1409 | EV/EV 100000 223 0.47 0.43 0.27 EV native interface |
1214 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
1410 | EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers |
1215 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
1411 | Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal |
1216 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
1412 | Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation |
1217 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
1413 | Event/Event 16000 516 31.16 31.84 0.82 Event native interface |
1218 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
1414 | Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers |
1219 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
1415 | IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll |
1220 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
1416 | IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll |
1221 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
1417 | Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour |
1222 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
1418 | Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers |
1223 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
1419 | POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event |
1224 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1420 | POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select |
1225 | |
1421 | |
1226 | Discussion |
1422 | Discussion |
1227 | The benchmark does *not* measure scalability of the event loop very |
1423 | The benchmark does *not* measure scalability of the event loop very |
1228 | well. For example, a select-based event loop (such as the pure perl one) |
1424 | well. For example, a select-based event loop (such as the pure perl one) |
1229 | can never compete with an event loop that uses epoll when the number of |
1425 | can never compete with an event loop that uses epoll when the number of |
… | |
… | |
1240 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
1436 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
1241 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 |
1437 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 |
1242 | CPU cycles with POE. |
1438 | CPU cycles with POE. |
1243 | |
1439 | |
1244 | "EV" is the sole leader regarding speed and memory use, which are both |
1440 | "EV" is the sole leader regarding speed and memory use, which are both |
1245 | maximal/minimal, respectively. Even when going through AnyEvent, it uses |
1441 | maximal/minimal, respectively. When using the AE API there is zero |
|
|
1442 | overhead (when going through the AnyEvent API create is about 5-6 times |
|
|
1443 | slower, with other times being equal, so still uses far less memory than |
1246 | far less memory than any other event loop and is still faster than Event |
1444 | any other event loop and is still faster than Event natively). |
1247 | natively. |
|
|
1248 | |
1445 | |
1249 | The pure perl implementation is hit in a few sweet spots (both the |
1446 | The pure perl implementation is hit in a few sweet spots (both the |
1250 | constant timeout and the use of a single fd hit optimisations in the |
1447 | constant timeout and the use of a single fd hit optimisations in the |
1251 | perl interpreter and the backend itself). Nevertheless this shows that |
1448 | perl interpreter and the backend itself). Nevertheless this shows that |
1252 | it adds very little overhead in itself. Like any select-based backend |
1449 | it adds very little overhead in itself. Like any select-based backend |
… | |
… | |
1322 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which |
1519 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which |
1323 | 100 (1%) are active. This mirrors the activity of large servers with |
1520 | 100 (1%) are active. This mirrors the activity of large servers with |
1324 | many connections, most of which are idle at any one point in time. |
1521 | many connections, most of which are idle at any one point in time. |
1325 | |
1522 | |
1326 | Source code for this benchmark is found as eg/bench2 in the AnyEvent |
1523 | Source code for this benchmark is found as eg/bench2 in the AnyEvent |
1327 | distribution. |
1524 | distribution. It uses the AE interface, which makes a real difference |
|
|
1525 | for the EV and Perl backends only. |
1328 | |
1526 | |
1329 | Explanation of the columns |
1527 | Explanation of the columns |
1330 | *sockets* is the number of sockets, and twice the number of "servers" |
1528 | *sockets* is the number of sockets, and twice the number of "servers" |
1331 | (as each server has a read and write socket end). |
1529 | (as each server has a read and write socket end). |
1332 | |
1530 | |
… | |
… | |
1338 | forwarding it to another server. This includes deleting the old timeout |
1536 | forwarding it to another server. This includes deleting the old timeout |
1339 | and creating a new one that moves the timeout into the future. |
1537 | and creating a new one that moves the timeout into the future. |
1340 | |
1538 | |
1341 | Results |
1539 | Results |
1342 | name sockets create request |
1540 | name sockets create request |
1343 | EV 20000 69.01 11.16 |
1541 | EV 20000 62.66 7.99 |
1344 | Perl 20000 73.32 35.87 |
1542 | Perl 20000 68.32 32.64 |
1345 | IOAsync 20000 157.00 98.14 epoll |
1543 | IOAsync 20000 174.06 101.15 epoll |
1346 | IOAsync 20000 159.31 616.06 poll |
1544 | IOAsync 20000 174.67 610.84 poll |
1347 | Event 20000 212.62 257.32 |
1545 | Event 20000 202.69 242.91 |
1348 | Glib 20000 651.16 1896.30 |
1546 | Glib 20000 557.01 1689.52 |
1349 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1547 | POE 20000 341.54 12086.32 uses POE::Loop::Event |
1350 | |
1548 | |
1351 | Discussion |
1549 | Discussion |
1352 | This benchmark *does* measure scalability and overall performance of the |
1550 | This benchmark *does* measure scalability and overall performance of the |
1353 | particular event loop. |
1551 | particular event loop. |
1354 | |
1552 | |
… | |
… | |
1483 | SIGCHLD |
1681 | SIGCHLD |
1484 | A handler for "SIGCHLD" is installed by AnyEvent's child watcher |
1682 | A handler for "SIGCHLD" is installed by AnyEvent's child watcher |
1485 | emulation for event loops that do not support them natively. Also, |
1683 | emulation for event loops that do not support them natively. Also, |
1486 | some event loops install a similar handler. |
1684 | some event loops install a similar handler. |
1487 | |
1685 | |
1488 | If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent |
1686 | Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, |
1489 | will reset it to default, to avoid losing child exit statuses. |
1687 | then AnyEvent will reset it to default, to avoid losing child exit |
|
|
1688 | statuses. |
1490 | |
1689 | |
1491 | SIGPIPE |
1690 | SIGPIPE |
1492 | A no-op handler is installed for "SIGPIPE" when $SIG{PIPE} is |
1691 | A no-op handler is installed for "SIGPIPE" when $SIG{PIPE} is |
1493 | "undef" when AnyEvent gets loaded. |
1692 | "undef" when AnyEvent gets loaded. |
1494 | |
1693 | |
… | |
… | |
1502 | it is that this way, the handler will be restored to defaults on |
1701 | it is that this way, the handler will be restored to defaults on |
1503 | exec. |
1702 | exec. |
1504 | |
1703 | |
1505 | Feel free to install your own handler, or reset it to defaults. |
1704 | Feel free to install your own handler, or reset it to defaults. |
1506 | |
1705 | |
|
|
1706 | RECOMMENDED/OPTIONAL MODULES |
|
|
1707 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
|
|
1708 | it's built-in modules) are required to use it. |
|
|
1709 | |
|
|
1710 | That does not mean that AnyEvent won't take advantage of some additional |
|
|
1711 | modules if they are installed. |
|
|
1712 | |
|
|
1713 | This section epxlains which additional modules will be used, and how |
|
|
1714 | they affect AnyEvent's operetion. |
|
|
1715 | |
|
|
1716 | Async::Interrupt |
|
|
1717 | This slightly arcane module is used to implement fast signal |
|
|
1718 | handling: To my knowledge, there is no way to do completely |
|
|
1719 | race-free and quick signal handling in pure perl. To ensure that |
|
|
1720 | signals still get delivered, AnyEvent will start an interval timer |
|
|
1721 | to wake up perl (and catch the signals) with some delay (default is |
|
|
1722 | 10 seconds, look for $AnyEvent::MAX_SIGNAL_LATENCY). |
|
|
1723 | |
|
|
1724 | If this module is available, then it will be used to implement |
|
|
1725 | signal catching, which means that signals will not be delayed, and |
|
|
1726 | the event loop will not be interrupted regularly, which is more |
|
|
1727 | efficient (And good for battery life on laptops). |
|
|
1728 | |
|
|
1729 | This affects not just the pure-perl event loop, but also other event |
|
|
1730 | loops that have no signal handling on their own (e.g. Glib, Tk, Qt). |
|
|
1731 | |
|
|
1732 | Some event loops (POE, Event, Event::Lib) offer signal watchers |
|
|
1733 | natively, and either employ their own workarounds (POE) or use |
|
|
1734 | AnyEvent's workaround (using $AnyEvent::MAX_SIGNAL_LATENCY). |
|
|
1735 | Installing Async::Interrupt does nothing for those backends. |
|
|
1736 | |
|
|
1737 | EV This module isn't really "optional", as it is simply one of the |
|
|
1738 | backend event loops that AnyEvent can use. However, it is simply the |
|
|
1739 | best event loop available in terms of features, speed and stability: |
|
|
1740 | It supports the AnyEvent API optimally, implements all the watcher |
|
|
1741 | types in XS, does automatic timer adjustments even when no monotonic |
|
|
1742 | clock is available, can take avdantage of advanced kernel interfaces |
|
|
1743 | such as "epoll" and "kqueue", and is the fastest backend *by far*. |
|
|
1744 | You can even embed Glib/Gtk2 in it (or vice versa, see EV::Glib and |
|
|
1745 | Glib::EV). |
|
|
1746 | |
|
|
1747 | Guard |
|
|
1748 | The guard module, when used, will be used to implement |
|
|
1749 | "AnyEvent::Util::guard". This speeds up guards considerably (and |
|
|
1750 | uses a lot less memory), but otherwise doesn't affect guard |
|
|
1751 | operation much. It is purely used for performance. |
|
|
1752 | |
|
|
1753 | JSON and JSON::XS |
|
|
1754 | This module is required when you want to read or write JSON data via |
|
|
1755 | AnyEvent::Handle. It is also written in pure-perl, but can take |
|
|
1756 | advantage of the ultra-high-speed JSON::XS module when it is |
|
|
1757 | installed. |
|
|
1758 | |
|
|
1759 | In fact, AnyEvent::Handle will use JSON::XS by default if it is |
|
|
1760 | installed. |
|
|
1761 | |
|
|
1762 | Net::SSLeay |
|
|
1763 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
|
|
1764 | worthwhile: If this module is installed, then AnyEvent::Handle (with |
|
|
1765 | the help of AnyEvent::TLS), gains the ability to do TLS/SSL. |
|
|
1766 | |
|
|
1767 | Time::HiRes |
|
|
1768 | This module is part of perl since release 5.008. It will be used |
|
|
1769 | when the chosen event library does not come with a timing source on |
|
|
1770 | it's own. The pure-perl event loop (AnyEvent::Impl::Perl) will |
|
|
1771 | additionally use it to try to use a monotonic clock for timing |
|
|
1772 | stability. |
|
|
1773 | |
1507 | FORK |
1774 | FORK |
1508 | Most event libraries are not fork-safe. The ones who are usually are |
1775 | Most event libraries are not fork-safe. The ones who are usually are |
1509 | because they rely on inefficient but fork-safe "select" or "poll" calls. |
1776 | because they rely on inefficient but fork-safe "select" or "poll" calls. |
1510 | Only EV is fully fork-aware. |
1777 | Only EV is fully fork-aware. |
1511 | |
1778 | |
1512 | If you have to fork, you must either do so *before* creating your first |
1779 | If you have to fork, you must either do so *before* creating your first |
1513 | watcher OR you must not use AnyEvent at all in the child. |
1780 | watcher OR you must not use AnyEvent at all in the child OR you must do |
|
|
1781 | something completely out of the scope of AnyEvent. |
1514 | |
1782 | |
1515 | SECURITY CONSIDERATIONS |
1783 | SECURITY CONSIDERATIONS |
1516 | AnyEvent can be forced to load any event model via |
1784 | AnyEvent can be forced to load any event model via |
1517 | $ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used |
1785 | $ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used |
1518 | to execute arbitrary code or directly gain access, it can easily be used |
1786 | to execute arbitrary code or directly gain access, it can easily be used |
… | |
… | |
1549 | Event modules: EV, EV::Glib, Glib::EV, Event, Glib::Event, Glib, Tk, |
1817 | Event modules: EV, EV::Glib, Glib::EV, Event, Glib::Event, Glib, Tk, |
1550 | Event::Lib, Qt, POE. |
1818 | Event::Lib, Qt, POE. |
1551 | |
1819 | |
1552 | Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event, |
1820 | Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event, |
1553 | AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, |
1821 | AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, |
1554 | AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE. |
1822 | AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE, |
|
|
1823 | AnyEvent::Impl::IOAsync, Anyevent::Impl::Irssi. |
1555 | |
1824 | |
1556 | Non-blocking file handles, sockets, TCP clients and servers: |
1825 | Non-blocking file handles, sockets, TCP clients and servers: |
1557 | AnyEvent::Handle, AnyEvent::Socket. |
1826 | AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS. |
1558 | |
1827 | |
1559 | Asynchronous DNS: AnyEvent::DNS. |
1828 | Asynchronous DNS: AnyEvent::DNS. |
1560 | |
1829 | |
1561 | Coroutine support: Coro, Coro::AnyEvent, Coro::EV, Coro::Event, |
1830 | Coroutine support: Coro, Coro::AnyEvent, Coro::EV, Coro::Event, |
1562 | |
1831 | |
1563 | Nontrivial usage examples: Net::FCP, Net::XMPP2, AnyEvent::DNS. |
1832 | Nontrivial usage examples: AnyEvent::GPSD, AnyEvent::XMPP, |
|
|
1833 | AnyEvent::HTTP. |
1564 | |
1834 | |
1565 | AUTHOR |
1835 | AUTHOR |
1566 | Marc Lehmann <schmorp@schmorp.de> |
1836 | Marc Lehmann <schmorp@schmorp.de> |
1567 | http://home.schmorp.de/ |
1837 | http://home.schmorp.de/ |
1568 | |
1838 | |