1 | =head1 NAME |
1 | =head1 => NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - provide framework for multiple event loops |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
6 | |
6 | |
… | |
… | |
15 | my $w = AnyEvent->timer (after => $seconds, cb => sub { |
15 | my $w = AnyEvent->timer (after => $seconds, cb => sub { |
16 | ... |
16 | ... |
17 | }); |
17 | }); |
18 | |
18 | |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
|
|
20 | $w->send; # wake up current and all future recv's |
20 | $w->wait; # enters "main loop" till $condvar gets ->send |
21 | $w->recv; # enters "main loop" till $condvar gets ->send |
21 | $w->send; # wake up current and all future wait's |
|
|
22 | |
22 | |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
24 | |
24 | |
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
26 | nowadays. So what is different about AnyEvent? |
26 | nowadays. So what is different about AnyEvent? |
… | |
… | |
279 | |
279 | |
280 | Example: fork a process and wait for it |
280 | Example: fork a process and wait for it |
281 | |
281 | |
282 | my $done = AnyEvent->condvar; |
282 | my $done = AnyEvent->condvar; |
283 | |
283 | |
284 | AnyEvent::detect; # force event module to be initialised |
|
|
285 | |
|
|
286 | my $pid = fork or exit 5; |
284 | my $pid = fork or exit 5; |
287 | |
285 | |
288 | my $w = AnyEvent->child ( |
286 | my $w = AnyEvent->child ( |
289 | pid => $pid, |
287 | pid => $pid, |
290 | cb => sub { |
288 | cb => sub { |
… | |
… | |
293 | $done->send; |
291 | $done->send; |
294 | }, |
292 | }, |
295 | ); |
293 | ); |
296 | |
294 | |
297 | # do something else, then wait for process exit |
295 | # do something else, then wait for process exit |
298 | $done->wait; |
296 | $done->recv; |
299 | |
297 | |
300 | =head2 CONDITION VARIABLES |
298 | =head2 CONDITION VARIABLES |
301 | |
299 | |
302 | If you are familiar with some event loops you will know that all of them |
300 | If you are familiar with some event loops you will know that all of them |
303 | require you to run some blocking "loop", "run" or similar function that |
301 | require you to run some blocking "loop", "run" or similar function that |
… | |
… | |
326 | |
324 | |
327 | Condition variables are very useful to signal that something has finished, |
325 | Condition variables are very useful to signal that something has finished, |
328 | for example, if you write a module that does asynchronous http requests, |
326 | for example, if you write a module that does asynchronous http requests, |
329 | then a condition variable would be the ideal candidate to signal the |
327 | then a condition variable would be the ideal candidate to signal the |
330 | availability of results. The user can either act when the callback is |
328 | availability of results. The user can either act when the callback is |
331 | called or can synchronously C<< ->wait >> for the results. |
329 | called or can synchronously C<< ->recv >> for the results. |
332 | |
330 | |
333 | You can also use them to simulate traditional event loops - for example, |
331 | You can also use them to simulate traditional event loops - for example, |
334 | you can block your main program until an event occurs - for example, you |
332 | you can block your main program until an event occurs - for example, you |
335 | could C<< ->wait >> in your main program until the user clicks the Quit |
333 | could C<< ->recv >> in your main program until the user clicks the Quit |
336 | button of your app, which would C<< ->send >> the "quit" event. |
334 | button of your app, which would C<< ->send >> the "quit" event. |
337 | |
335 | |
338 | Note that condition variables recurse into the event loop - if you have |
336 | Note that condition variables recurse into the event loop - if you have |
339 | two pieces of code that call C<< ->wait >> in a round-robbin fashion, you |
337 | two pieces of code that call C<< ->recv >> in a round-robbin fashion, you |
340 | lose. Therefore, condition variables are good to export to your caller, but |
338 | lose. Therefore, condition variables are good to export to your caller, but |
341 | you should avoid making a blocking wait yourself, at least in callbacks, |
339 | you should avoid making a blocking wait yourself, at least in callbacks, |
342 | as this asks for trouble. |
340 | as this asks for trouble. |
343 | |
341 | |
344 | Condition variables are represented by hash refs in perl, and the keys |
342 | Condition variables are represented by hash refs in perl, and the keys |
… | |
… | |
365 | cb => sub { $result_ready->send }, |
363 | cb => sub { $result_ready->send }, |
366 | ); |
364 | ); |
367 | |
365 | |
368 | # this "blocks" (while handling events) till the callback |
366 | # this "blocks" (while handling events) till the callback |
369 | # calls send |
367 | # calls send |
370 | $result_ready->wait; |
368 | $result_ready->recv; |
371 | |
369 | |
372 | =head3 METHODS FOR PRODUCERS |
370 | =head3 METHODS FOR PRODUCERS |
373 | |
371 | |
374 | These methods should only be used by the producing side, i.e. the |
372 | These methods should only be used by the producing side, i.e. the |
375 | code/module that eventually sends the signal. Note that it is also |
373 | code/module that eventually sends the signal. Note that it is also |
… | |
… | |
378 | |
376 | |
379 | =over 4 |
377 | =over 4 |
380 | |
378 | |
381 | =item $cv->send (...) |
379 | =item $cv->send (...) |
382 | |
380 | |
383 | Flag the condition as ready - a running C<< ->wait >> and all further |
381 | Flag the condition as ready - a running C<< ->recv >> and all further |
384 | calls to C<wait> will (eventually) return after this method has been |
382 | calls to C<recv> will (eventually) return after this method has been |
385 | called. If nobody is waiting the send will be remembered. |
383 | called. If nobody is waiting the send will be remembered. |
386 | |
384 | |
387 | If a callback has been set on the condition variable, it is called |
385 | If a callback has been set on the condition variable, it is called |
388 | immediately from within send. |
386 | immediately from within send. |
389 | |
387 | |
390 | Any arguments passed to the C<send> call will be returned by all |
388 | Any arguments passed to the C<send> call will be returned by all |
391 | future C<< ->wait >> calls. |
389 | future C<< ->recv >> calls. |
392 | |
390 | |
393 | =item $cv->croak ($error) |
391 | =item $cv->croak ($error) |
394 | |
392 | |
395 | Similar to send, but causes all call's wait C<< ->wait >> to invoke |
393 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
396 | C<Carp::croak> with the given error message/object/scalar. |
394 | C<Carp::croak> with the given error message/object/scalar. |
397 | |
395 | |
398 | This can be used to signal any errors to the condition variable |
396 | This can be used to signal any errors to the condition variable |
399 | user/consumer. |
397 | user/consumer. |
400 | |
398 | |
401 | =item $cv->begin ([group callback]) |
399 | =item $cv->begin ([group callback]) |
402 | |
400 | |
403 | =item $cv->end |
401 | =item $cv->end |
|
|
402 | |
|
|
403 | These two methods are EXPERIMENTAL and MIGHT CHANGE. |
404 | |
404 | |
405 | These two methods can be used to combine many transactions/events into |
405 | These two methods can be used to combine many transactions/events into |
406 | one. For example, a function that pings many hosts in parallel might want |
406 | one. For example, a function that pings many hosts in parallel might want |
407 | to use a condition variable for the whole process. |
407 | to use a condition variable for the whole process. |
408 | |
408 | |
… | |
… | |
454 | These methods should only be used by the consuming side, i.e. the |
454 | These methods should only be used by the consuming side, i.e. the |
455 | code awaits the condition. |
455 | code awaits the condition. |
456 | |
456 | |
457 | =over 4 |
457 | =over 4 |
458 | |
458 | |
459 | =item $cv->wait |
459 | =item $cv->recv |
460 | |
460 | |
461 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
461 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
462 | >> methods have been called on c<$cv>, while servicing other watchers |
462 | >> methods have been called on c<$cv>, while servicing other watchers |
463 | normally. |
463 | normally. |
464 | |
464 | |
… | |
… | |
477 | caller decide whether the call will block or not (for example, by coupling |
477 | caller decide whether the call will block or not (for example, by coupling |
478 | condition variables with some kind of request results and supporting |
478 | condition variables with some kind of request results and supporting |
479 | callbacks so the caller knows that getting the result will not block, |
479 | callbacks so the caller knows that getting the result will not block, |
480 | while still suppporting blocking waits if the caller so desires). |
480 | while still suppporting blocking waits if the caller so desires). |
481 | |
481 | |
482 | Another reason I<never> to C<< ->wait >> in a module is that you cannot |
482 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
483 | sensibly have two C<< ->wait >>'s in parallel, as that would require |
483 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
484 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
484 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
485 | can supply. |
485 | can supply. |
486 | |
486 | |
487 | The L<Coro> module, however, I<can> and I<does> supply coroutines and, in |
487 | The L<Coro> module, however, I<can> and I<does> supply coroutines and, in |
488 | fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe |
488 | fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe |
489 | versions and also integrates coroutines into AnyEvent, making blocking |
489 | versions and also integrates coroutines into AnyEvent, making blocking |
490 | C<< ->wait >> calls perfectly safe as long as they are done from another |
490 | C<< ->recv >> calls perfectly safe as long as they are done from another |
491 | coroutine (one that doesn't run the event loop). |
491 | coroutine (one that doesn't run the event loop). |
492 | |
492 | |
493 | You can ensure that C<< -wait >> never blocks by setting a callback and |
493 | You can ensure that C<< -recv >> never blocks by setting a callback and |
494 | only calling C<< ->wait >> from within that callback (or at a later |
494 | only calling C<< ->recv >> from within that callback (or at a later |
495 | time). This will work even when the event loop does not support blocking |
495 | time). This will work even when the event loop does not support blocking |
496 | waits otherwise. |
496 | waits otherwise. |
497 | |
497 | |
498 | =item $bool = $cv->ready |
498 | =item $bool = $cv->ready |
499 | |
499 | |
… | |
… | |
504 | |
504 | |
505 | This is a mutator function that returns the callback set and optionally |
505 | This is a mutator function that returns the callback set and optionally |
506 | replaces it before doing so. |
506 | replaces it before doing so. |
507 | |
507 | |
508 | The callback will be called when the condition becomes "true", i.e. when |
508 | The callback will be called when the condition becomes "true", i.e. when |
509 | C<send> or C<croak> are called. Calling C<wait> inside the callback |
509 | C<send> or C<croak> are called. Calling C<recv> inside the callback |
510 | or at any later time is guaranteed not to block. |
510 | or at any later time is guaranteed not to block. |
511 | |
511 | |
512 | =back |
512 | =back |
513 | |
513 | |
514 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
514 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
… | |
… | |
549 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
549 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
550 | if necessary. You should only call this function right before you would |
550 | if necessary. You should only call this function right before you would |
551 | have created an AnyEvent watcher anyway, that is, as late as possible at |
551 | have created an AnyEvent watcher anyway, that is, as late as possible at |
552 | runtime. |
552 | runtime. |
553 | |
553 | |
554 | =item $guard = AnyEvent::on_detect { BLOCK } |
554 | =item $guard = AnyEvent::post_detect { BLOCK } |
555 | |
555 | |
556 | Arranges for the code block to be executed as soon as the event model is |
556 | Arranges for the code block to be executed as soon as the event model is |
557 | autodetected (or immediately if this has already happened). |
557 | autodetected (or immediately if this has already happened). |
558 | |
558 | |
559 | If called in scalar or list context, then it creates and returns an object |
559 | If called in scalar or list context, then it creates and returns an object |
560 | that automatically removes the callback again when it is destroyed. |
560 | that automatically removes the callback again when it is destroyed. See |
|
|
561 | L<Coro::BDB> for a case where this is useful. |
561 | |
562 | |
562 | =item @AnyEvent::on_detect |
563 | =item @AnyEvent::post_detect |
563 | |
564 | |
564 | If there are any code references in this array (you can C<push> to it |
565 | If there are any code references in this array (you can C<push> to it |
565 | before or after loading AnyEvent), then they will called directly after |
566 | before or after loading AnyEvent), then they will called directly after |
566 | the event loop has been chosen. |
567 | the event loop has been chosen. |
567 | |
568 | |
568 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
569 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
569 | if it contains a true value then the event loop has already been detected, |
570 | if it contains a true value then the event loop has already been detected, |
570 | and the array will be ignored. |
571 | and the array will be ignored. |
571 | |
572 | |
572 | Best use C<AnyEvent::on_detect { BLOCK }> instead. |
573 | Best use C<AnyEvent::post_detect { BLOCK }> instead. |
573 | |
574 | |
574 | =back |
575 | =back |
575 | |
576 | |
576 | =head1 WHAT TO DO IN A MODULE |
577 | =head1 WHAT TO DO IN A MODULE |
577 | |
578 | |
… | |
… | |
581 | Be careful when you create watchers in the module body - AnyEvent will |
582 | Be careful when you create watchers in the module body - AnyEvent will |
582 | decide which event module to use as soon as the first method is called, so |
583 | decide which event module to use as soon as the first method is called, so |
583 | by calling AnyEvent in your module body you force the user of your module |
584 | by calling AnyEvent in your module body you force the user of your module |
584 | to load the event module first. |
585 | to load the event module first. |
585 | |
586 | |
586 | Never call C<< ->wait >> on a condition variable unless you I<know> that |
587 | Never call C<< ->recv >> on a condition variable unless you I<know> that |
587 | the C<< ->send >> method has been called on it already. This is |
588 | the C<< ->send >> method has been called on it already. This is |
588 | because it will stall the whole program, and the whole point of using |
589 | because it will stall the whole program, and the whole point of using |
589 | events is to stay interactive. |
590 | events is to stay interactive. |
590 | |
591 | |
591 | It is fine, however, to call C<< ->wait >> when the user of your module |
592 | It is fine, however, to call C<< ->recv >> when the user of your module |
592 | requests it (i.e. if you create a http request object ad have a method |
593 | requests it (i.e. if you create a http request object ad have a method |
593 | called C<results> that returns the results, it should call C<< ->wait >> |
594 | called C<results> that returns the results, it should call C<< ->recv >> |
594 | freely, as the user of your module knows what she is doing. always). |
595 | freely, as the user of your module knows what she is doing. always). |
595 | |
596 | |
596 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
597 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
597 | |
598 | |
598 | There will always be a single main program - the only place that should |
599 | There will always be a single main program - the only place that should |
… | |
… | |
632 | |
633 | |
633 | Provide read and write buffers and manages watchers for reads and writes. |
634 | Provide read and write buffers and manages watchers for reads and writes. |
634 | |
635 | |
635 | =item L<AnyEvent::Socket> |
636 | =item L<AnyEvent::Socket> |
636 | |
637 | |
637 | Provides a means to do non-blocking connects, accepts etc. |
638 | Provides various utility functions for (internet protocol) sockets, |
|
|
639 | addresses and name resolution. Also functions to create non-blocking tcp |
|
|
640 | connections or tcp servers, with IPv6 and SRV record support and more. |
638 | |
641 | |
639 | =item L<AnyEvent::HTTPD> |
642 | =item L<AnyEvent::HTTPD> |
640 | |
643 | |
641 | Provides a simple web application server framework. |
644 | Provides a simple web application server framework. |
642 | |
645 | |
643 | =item L<AnyEvent::DNS> |
646 | =item L<AnyEvent::DNS> |
644 | |
647 | |
645 | Provides asynchronous DNS resolver capabilities, beyond what |
648 | Provides rich asynchronous DNS resolver capabilities. |
646 | L<AnyEvent::Util> offers. |
|
|
647 | |
649 | |
648 | =item L<AnyEvent::FastPing> |
650 | =item L<AnyEvent::FastPing> |
649 | |
651 | |
650 | The fastest ping in the west. |
652 | The fastest ping in the west. |
651 | |
653 | |
… | |
… | |
668 | |
670 | |
669 | =item L<Coro> |
671 | =item L<Coro> |
670 | |
672 | |
671 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
673 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
672 | |
674 | |
|
|
675 | =item L<AnyEvent::AIO>, L<IO::AIO> |
|
|
676 | |
|
|
677 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
678 | programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent |
|
|
679 | together. |
|
|
680 | |
|
|
681 | =item L<AnyEvent::BDB>, L<BDB> |
|
|
682 | |
|
|
683 | Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses |
|
|
684 | IO::AIO and AnyEvent together. |
|
|
685 | |
673 | =item L<IO::Lambda> |
686 | =item L<IO::Lambda> |
674 | |
687 | |
675 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
688 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
676 | |
|
|
677 | =item L<IO::AIO> |
|
|
678 | |
|
|
679 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
680 | programmer. Can be trivially made to use AnyEvent. |
|
|
681 | |
|
|
682 | =item L<BDB> |
|
|
683 | |
|
|
684 | Truly asynchronous Berkeley DB access. Can be trivially made to use |
|
|
685 | AnyEvent. |
|
|
686 | |
689 | |
687 | =back |
690 | =back |
688 | |
691 | |
689 | =cut |
692 | =cut |
690 | |
693 | |
… | |
… | |
693 | no warnings; |
696 | no warnings; |
694 | use strict; |
697 | use strict; |
695 | |
698 | |
696 | use Carp; |
699 | use Carp; |
697 | |
700 | |
698 | our $VERSION = '3.4'; |
701 | our $VERSION = '3.6'; |
699 | our $MODEL; |
702 | our $MODEL; |
700 | |
703 | |
701 | our $AUTOLOAD; |
704 | our $AUTOLOAD; |
702 | our @ISA; |
705 | our @ISA; |
703 | |
706 | |
… | |
… | |
719 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
722 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
720 | ); |
723 | ); |
721 | |
724 | |
722 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
725 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
723 | |
726 | |
724 | our @on_detect; |
727 | our @post_detect; |
725 | |
728 | |
726 | sub on_detect(&) { |
729 | sub post_detect(&) { |
727 | my ($cb) = @_; |
730 | my ($cb) = @_; |
728 | |
731 | |
729 | if ($MODEL) { |
732 | if ($MODEL) { |
730 | $cb->(); |
733 | $cb->(); |
731 | |
734 | |
732 | 1 |
735 | 1 |
733 | } else { |
736 | } else { |
734 | push @on_detect, $cb; |
737 | push @post_detect, $cb; |
735 | |
738 | |
736 | defined wantarray |
739 | defined wantarray |
737 | ? bless \$cb, "AnyEvent::Util::Guard" |
740 | ? bless \$cb, "AnyEvent::Util::PostDetect" |
738 | : () |
741 | : () |
739 | } |
742 | } |
740 | } |
743 | } |
741 | |
744 | |
742 | sub AnyEvent::Util::Guard::DESTROY { |
745 | sub AnyEvent::Util::PostDetect::DESTROY { |
743 | @on_detect = grep $_ != ${$_[0]}, @on_detect; |
746 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
744 | } |
747 | } |
745 | |
748 | |
746 | sub detect() { |
749 | sub detect() { |
747 | unless ($MODEL) { |
750 | unless ($MODEL) { |
748 | no strict 'refs'; |
751 | no strict 'refs'; |
… | |
… | |
790 | } |
793 | } |
791 | |
794 | |
792 | unshift @ISA, $MODEL; |
795 | unshift @ISA, $MODEL; |
793 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
796 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
794 | |
797 | |
795 | (shift @on_detect)->() while @on_detect; |
798 | (shift @post_detect)->() while @post_detect; |
796 | } |
799 | } |
797 | |
800 | |
798 | $MODEL |
801 | $MODEL |
799 | } |
802 | } |
800 | |
803 | |
… | |
… | |
810 | $class->$func (@_); |
813 | $class->$func (@_); |
811 | } |
814 | } |
812 | |
815 | |
813 | package AnyEvent::Base; |
816 | package AnyEvent::Base; |
814 | |
817 | |
815 | # default implementation for ->condvar, ->wait, ->broadcast |
818 | # default implementation for ->condvar |
816 | |
819 | |
817 | sub condvar { |
820 | sub condvar { |
818 | bless \my $flag, "AnyEvent::Base::CondVar" |
821 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
819 | } |
|
|
820 | |
|
|
821 | sub AnyEvent::Base::CondVar::broadcast { |
|
|
822 | ${$_[0]}++; |
|
|
823 | } |
|
|
824 | |
|
|
825 | sub AnyEvent::Base::CondVar::wait { |
|
|
826 | AnyEvent->one_event while !${$_[0]}; |
|
|
827 | } |
822 | } |
828 | |
823 | |
829 | # default implementation for ->signal |
824 | # default implementation for ->signal |
830 | |
825 | |
831 | our %SIG_CB; |
826 | our %SIG_CB; |
… | |
… | |
905 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
900 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
906 | |
901 | |
907 | undef $CHLD_W unless keys %PID_CB; |
902 | undef $CHLD_W unless keys %PID_CB; |
908 | } |
903 | } |
909 | |
904 | |
|
|
905 | package AnyEvent::CondVar; |
|
|
906 | |
|
|
907 | our @ISA = AnyEvent::CondVar::Base::; |
|
|
908 | |
|
|
909 | package AnyEvent::CondVar::Base; |
|
|
910 | |
|
|
911 | sub _send { |
|
|
912 | # nop |
|
|
913 | } |
|
|
914 | |
|
|
915 | sub send { |
|
|
916 | my $cv = shift; |
|
|
917 | $cv->{_ae_sent} = [@_]; |
|
|
918 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
|
|
919 | $cv->_send; |
|
|
920 | } |
|
|
921 | |
|
|
922 | sub croak { |
|
|
923 | $_[0]{_ae_croak} = $_[1]; |
|
|
924 | $_[0]->send; |
|
|
925 | } |
|
|
926 | |
|
|
927 | sub ready { |
|
|
928 | $_[0]{_ae_sent} |
|
|
929 | } |
|
|
930 | |
|
|
931 | sub _wait { |
|
|
932 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
|
|
933 | } |
|
|
934 | |
|
|
935 | sub recv { |
|
|
936 | $_[0]->_wait; |
|
|
937 | |
|
|
938 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
|
|
939 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
|
|
940 | } |
|
|
941 | |
|
|
942 | sub cb { |
|
|
943 | $_[0]{_ae_cb} = $_[1] if @_ > 1; |
|
|
944 | $_[0]{_ae_cb} |
|
|
945 | } |
|
|
946 | |
|
|
947 | sub begin { |
|
|
948 | ++$_[0]{_ae_counter}; |
|
|
949 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
|
|
950 | } |
|
|
951 | |
|
|
952 | sub end { |
|
|
953 | return if --$_[0]{_ae_counter}; |
|
|
954 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
|
|
955 | } |
|
|
956 | |
|
|
957 | # undocumented/compatibility with pre-3.4 |
|
|
958 | *broadcast = \&send; |
|
|
959 | *wait = \&_wait; |
|
|
960 | |
910 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
961 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
911 | |
962 | |
912 | This is an advanced topic that you do not normally need to use AnyEvent in |
963 | This is an advanced topic that you do not normally need to use AnyEvent in |
913 | a module. This section is only of use to event loop authors who want to |
964 | a module. This section is only of use to event loop authors who want to |
914 | provide AnyEvent compatibility. |
965 | provide AnyEvent compatibility. |
… | |
… | |
982 | |
1033 | |
983 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1034 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
984 | could start your program like this: |
1035 | could start your program like this: |
985 | |
1036 | |
986 | PERL_ANYEVENT_MODEL=Perl perl ... |
1037 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
1038 | |
|
|
1039 | =item C<PERL_ANYEVENT_PROTOCOLS> |
|
|
1040 | |
|
|
1041 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
|
|
1042 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
|
|
1043 | of autoprobing). |
|
|
1044 | |
|
|
1045 | Must be set to a comma-separated list of protocols or address families, |
|
|
1046 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
|
|
1047 | used, and preference will be given to protocols mentioned earlier in the |
|
|
1048 | list. |
|
|
1049 | |
|
|
1050 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
|
|
1051 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
|
|
1052 | - only support IPv4, never try to resolve or contact IPv6 |
|
|
1053 | addressses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
|
|
1054 | IPv6, but prefer IPv6 over IPv4. |
987 | |
1055 | |
988 | =back |
1056 | =back |
989 | |
1057 | |
990 | =head1 EXAMPLE PROGRAM |
1058 | =head1 EXAMPLE PROGRAM |
991 | |
1059 | |
… | |
… | |
1002 | poll => 'r', |
1070 | poll => 'r', |
1003 | cb => sub { |
1071 | cb => sub { |
1004 | warn "io event <$_[0]>\n"; # will always output <r> |
1072 | warn "io event <$_[0]>\n"; # will always output <r> |
1005 | chomp (my $input = <STDIN>); # read a line |
1073 | chomp (my $input = <STDIN>); # read a line |
1006 | warn "read: $input\n"; # output what has been read |
1074 | warn "read: $input\n"; # output what has been read |
1007 | $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i |
1075 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1008 | }, |
1076 | }, |
1009 | ); |
1077 | ); |
1010 | |
1078 | |
1011 | my $time_watcher; # can only be used once |
1079 | my $time_watcher; # can only be used once |
1012 | |
1080 | |
… | |
… | |
1017 | }); |
1085 | }); |
1018 | } |
1086 | } |
1019 | |
1087 | |
1020 | new_timer; # create first timer |
1088 | new_timer; # create first timer |
1021 | |
1089 | |
1022 | $cv->wait; # wait until user enters /^q/i |
1090 | $cv->recv; # wait until user enters /^q/i |
1023 | |
1091 | |
1024 | =head1 REAL-WORLD EXAMPLE |
1092 | =head1 REAL-WORLD EXAMPLE |
1025 | |
1093 | |
1026 | Consider the L<Net::FCP> module. It features (among others) the following |
1094 | Consider the L<Net::FCP> module. It features (among others) the following |
1027 | API calls, which are to freenet what HTTP GET requests are to http: |
1095 | API calls, which are to freenet what HTTP GET requests are to http: |
… | |
… | |
1083 | |
1151 | |
1084 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1152 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1085 | |
1153 | |
1086 | if (end-of-file or data complete) { |
1154 | if (end-of-file or data complete) { |
1087 | $txn->{result} = $txn->{buf}; |
1155 | $txn->{result} = $txn->{buf}; |
1088 | $txn->{finished}->broadcast; |
1156 | $txn->{finished}->send; |
1089 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
1157 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
1090 | } |
1158 | } |
1091 | |
1159 | |
1092 | The C<result> method, finally, just waits for the finished signal (if the |
1160 | The C<result> method, finally, just waits for the finished signal (if the |
1093 | request was already finished, it doesn't wait, of course, and returns the |
1161 | request was already finished, it doesn't wait, of course, and returns the |
1094 | data: |
1162 | data: |
1095 | |
1163 | |
1096 | $txn->{finished}->wait; |
1164 | $txn->{finished}->recv; |
1097 | return $txn->{result}; |
1165 | return $txn->{result}; |
1098 | |
1166 | |
1099 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1167 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1100 | that occured during request processing. The C<result> method detects |
1168 | that occured during request processing. The C<result> method detects |
1101 | whether an exception as thrown (it is stored inside the $txn object) |
1169 | whether an exception as thrown (it is stored inside the $txn object) |
… | |
… | |
1136 | |
1204 | |
1137 | my $quit = AnyEvent->condvar; |
1205 | my $quit = AnyEvent->condvar; |
1138 | |
1206 | |
1139 | $fcp->txn_client_get ($url)->cb (sub { |
1207 | $fcp->txn_client_get ($url)->cb (sub { |
1140 | ... |
1208 | ... |
1141 | $quit->broadcast; |
1209 | $quit->send; |
1142 | }); |
1210 | }); |
1143 | |
1211 | |
1144 | $quit->wait; |
1212 | $quit->recv; |
1145 | |
1213 | |
1146 | |
1214 | |
1147 | =head1 BENCHMARKS |
1215 | =head1 BENCHMARKS |
1148 | |
1216 | |
1149 | To give you an idea of the performance and overheads that AnyEvent adds |
1217 | To give you an idea of the performance and overheads that AnyEvent adds |
… | |
… | |
1178 | all watchers, to avoid adding memory overhead. That means closure creation |
1246 | all watchers, to avoid adding memory overhead. That means closure creation |
1179 | and memory usage is not included in the figures. |
1247 | and memory usage is not included in the figures. |
1180 | |
1248 | |
1181 | I<invoke> is the time, in microseconds, used to invoke a simple |
1249 | I<invoke> is the time, in microseconds, used to invoke a simple |
1182 | callback. The callback simply counts down a Perl variable and after it was |
1250 | callback. The callback simply counts down a Perl variable and after it was |
1183 | invoked "watcher" times, it would C<< ->broadcast >> a condvar once to |
1251 | invoked "watcher" times, it would C<< ->send >> a condvar once to |
1184 | signal the end of this phase. |
1252 | signal the end of this phase. |
1185 | |
1253 | |
1186 | I<destroy> is the time, in microseconds, that it takes to destroy a single |
1254 | I<destroy> is the time, in microseconds, that it takes to destroy a single |
1187 | watcher. |
1255 | watcher. |
1188 | |
1256 | |
… | |
… | |
1441 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1509 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1442 | |
1510 | |
1443 | |
1511 | |
1444 | =head1 SEE ALSO |
1512 | =head1 SEE ALSO |
1445 | |
1513 | |
|
|
1514 | Utility functions: L<AnyEvent::Util>. |
|
|
1515 | |
1446 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
1516 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
1447 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
1517 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
1448 | |
1518 | |
1449 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
1519 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
1450 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
1520 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
1451 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
1521 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
1452 | L<AnyEvent::Impl::POE>. |
1522 | L<AnyEvent::Impl::POE>. |
1453 | |
1523 | |
|
|
1524 | Non-blocking file handles, sockets, TCP clients and |
|
|
1525 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. |
|
|
1526 | |
|
|
1527 | Asynchronous DNS: L<AnyEvent::DNS>. |
|
|
1528 | |
1454 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
1529 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
1455 | |
1530 | |
1456 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
1531 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1457 | |
1532 | |
1458 | |
1533 | |
1459 | =head1 AUTHOR |
1534 | =head1 AUTHOR |
1460 | |
1535 | |
1461 | Marc Lehmann <schmorp@schmorp.de> |
1536 | Marc Lehmann <schmorp@schmorp.de> |