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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.113 by root, Sat May 10 20:30:35 2008 UTC vs.
Revision 1.135 by root, Sun May 25 04:49:01 2008 UTC

1=head1 NAME 1=head1 => NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, 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
25Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 25Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26nowadays. So what is different about AnyEvent? 26nowadays. So what is different about AnyEvent?
57as those use one of the supported event loops. It is trivial to add new 57as those use one of the supported event loops. It is trivial to add new
58event loops to AnyEvent, too, so it is future-proof). 58event loops to AnyEvent, too, so it is future-proof).
59 59
60In addition to being free of having to use I<the one and only true event 60In addition to being free of having to use I<the one and only true event
61model>, AnyEvent also is free of bloat and policy: with POE or similar 61model>, AnyEvent also is free of bloat and policy: with POE or similar
62modules, you get an enourmous amount of code and strict rules you have to 62modules, you get an enormous amount of code and strict rules you have to
63follow. AnyEvent, on the other hand, is lean and up to the point, by only 63follow. AnyEvent, on the other hand, is lean and up to the point, by only
64offering the functionality that is necessary, in as thin as a wrapper as 64offering the functionality that is necessary, in as thin as a wrapper as
65technically possible. 65technically possible.
66 66
67Of course, if you want lots of policy (this can arguably be somewhat 67Of course, if you want lots of policy (this can arguably be somewhat
108 108
109=head1 WATCHERS 109=head1 WATCHERS
110 110
111AnyEvent has the central concept of a I<watcher>, which is an object that 111AnyEvent has the central concept of a I<watcher>, which is an object that
112stores relevant data for each kind of event you are waiting for, such as 112stores relevant data for each kind of event you are waiting for, such as
113the callback to call, the filehandle to watch, etc. 113the callback to call, the file handle to watch, etc.
114 114
115These watchers are normal Perl objects with normal Perl lifetime. After 115These watchers are normal Perl objects with normal Perl lifetime. After
116creating a watcher it will immediately "watch" for events and invoke the 116creating a watcher it will immediately "watch" for events and invoke the
117callback when the event occurs (of course, only when the event model 117callback when the event occurs (of course, only when the event model
118is in control). 118is in control).
237 237
238Although the callback might get passed parameters, their value and 238Although the callback might get passed parameters, their value and
239presence is undefined and you cannot rely on them. Portable AnyEvent 239presence is undefined and you cannot rely on them. Portable AnyEvent
240callbacks cannot use arguments passed to signal watcher callbacks. 240callbacks cannot use arguments passed to signal watcher callbacks.
241 241
242Multiple signal occurances can be clumped together into one callback 242Multiple signal occurrences can be clumped together into one callback
243invocation, and callback invocation will be synchronous. synchronous means 243invocation, and callback invocation will be synchronous. Synchronous means
244that it might take a while until the signal gets handled by the process, 244that it might take a while until the signal gets handled by the process,
245but it is guarenteed not to interrupt any other callbacks. 245but it is guaranteed not to interrupt any other callbacks.
246 246
247The main advantage of using these watchers is that you can share a signal 247The main advantage of using these watchers is that you can share a signal
248between multiple watchers. 248between multiple watchers.
249 249
250This watcher might use C<%SIG>, so programs overwriting those signals 250This watcher might use C<%SIG>, so programs overwriting those signals
278C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 278C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
279 279
280Example: fork a process and wait for it 280Example: fork a process and wait for it
281 281
282 my $done = AnyEvent->condvar; 282 my $done = AnyEvent->condvar;
283
284 AnyEvent::detect; # force event module to be initialised
285 283
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,
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
302If you are familiar with some event loops you will know that all of them 300If you are familiar with some event loops you will know that all of them
303require you to run some blocking "loop", "run" or similar function that 301require you to run some blocking "loop", "run" or similar function that
312Condition variables can be created by calling the C<< AnyEvent->condvar 310Condition variables can be created by calling the C<< AnyEvent->condvar
313>> method, usually without arguments. The only argument pair allowed is 311>> method, usually without arguments. The only argument pair allowed is
314C<cb>, which specifies a callback to be called when the condition variable 312C<cb>, which specifies a callback to be called when the condition variable
315becomes true. 313becomes true.
316 314
317After creation, the conditon variable is "false" until it becomes "true" 315After creation, the condition variable is "false" until it becomes "true"
318by calling the C<send> method. 316by calling the C<send> method (or calling the condition variable as if it
317were a callback, read about the caveats in the description for the C<<
318->send >> method).
319 319
320Condition variables are similar to callbacks, except that you can 320Condition variables are similar to callbacks, except that you can
321optionally wait for them. They can also be called merge points - points 321optionally wait for them. They can also be called merge points - points
322in time where multiple outstandign events have been processed. And yet 322in time where multiple outstanding events have been processed. And yet
323another way to call them is transations - each condition variable can be 323another way to call them is transactions - each condition variable can be
324used to represent a transaction, which finishes at some point and delivers 324used to represent a transaction, which finishes at some point and delivers
325a result. 325a result.
326 326
327Condition variables are very useful to signal that something has finished, 327Condition variables are very useful to signal that something has finished,
328for example, if you write a module that does asynchronous http requests, 328for example, if you write a module that does asynchronous http requests,
329then a condition variable would be the ideal candidate to signal the 329then a condition variable would be the ideal candidate to signal the
330availability of results. The user can either act when the callback is 330availability of results. The user can either act when the callback is
331called or can synchronously C<< ->wait >> for the results. 331called or can synchronously C<< ->recv >> for the results.
332 332
333You can also use them to simulate traditional event loops - for example, 333You can also use them to simulate traditional event loops - for example,
334you can block your main program until an event occurs - for example, you 334you can block your main program until an event occurs - for example, you
335could C<< ->wait >> in your main program until the user clicks the Quit 335could C<< ->recv >> in your main program until the user clicks the Quit
336button of your app, which would C<< ->send >> the "quit" event. 336button of your app, which would C<< ->send >> the "quit" event.
337 337
338Note that condition variables recurse into the event loop - if you have 338Note that condition variables recurse into the event loop - if you have
339two pieces of code that call C<< ->wait >> in a round-robbin fashion, you 339two pieces of code that call C<< ->recv >> in a round-robin fashion, you
340lose. Therefore, condition variables are good to export to your caller, but 340lose. Therefore, condition variables are good to export to your caller, but
341you should avoid making a blocking wait yourself, at least in callbacks, 341you should avoid making a blocking wait yourself, at least in callbacks,
342as this asks for trouble. 342as this asks for trouble.
343 343
344Condition variables are represented by hash refs in perl, and the keys 344Condition variables are represented by hash refs in perl, and the keys
349 349
350There are two "sides" to a condition variable - the "producer side" which 350There are two "sides" to a condition variable - the "producer side" which
351eventually calls C<< -> send >>, and the "consumer side", which waits 351eventually calls C<< -> send >>, and the "consumer side", which waits
352for the send to occur. 352for the send to occur.
353 353
354Example: 354Example: wait for a timer.
355 355
356 # wait till the result is ready 356 # wait till the result is ready
357 my $result_ready = AnyEvent->condvar; 357 my $result_ready = AnyEvent->condvar;
358 358
359 # do something such as adding a timer 359 # do something such as adding a timer
365 cb => sub { $result_ready->send }, 365 cb => sub { $result_ready->send },
366 ); 366 );
367 367
368 # this "blocks" (while handling events) till the callback 368 # this "blocks" (while handling events) till the callback
369 # calls send 369 # calls send
370 $result_ready->wait; 370 $result_ready->recv;
371
372Example: wait for a timer, but take advantage of the fact that
373condition variables are also code references.
374
375 my $done = AnyEvent->condvar;
376 my $delay = AnyEvent->timer (after => 5, cb => $done);
377 $done->recv;
371 378
372=head3 METHODS FOR PRODUCERS 379=head3 METHODS FOR PRODUCERS
373 380
374These methods should only be used by the producing side, i.e. the 381These methods should only be used by the producing side, i.e. the
375code/module that eventually sends the signal. Note that it is also 382code/module that eventually sends the signal. Note that it is also
378 385
379=over 4 386=over 4
380 387
381=item $cv->send (...) 388=item $cv->send (...)
382 389
383Flag the condition as ready - a running C<< ->wait >> and all further 390Flag the condition as ready - a running C<< ->recv >> and all further
384calls to C<wait> will (eventually) return after this method has been 391calls to C<recv> will (eventually) return after this method has been
385called. If nobody is waiting the send will be remembered. 392called. If nobody is waiting the send will be remembered.
386 393
387If a callback has been set on the condition variable, it is called 394If a callback has been set on the condition variable, it is called
388immediately from within send. 395immediately from within send.
389 396
390Any arguments passed to the C<send> call will be returned by all 397Any arguments passed to the C<send> call will be returned by all
391future C<< ->wait >> calls. 398future C<< ->recv >> calls.
399
400Condition variables are overloaded so one can call them directly
401(as a code reference). Calling them directly is the same as calling
402C<send>. Note, however, that many C-based event loops do not handle
403overloading, so as tempting as it may be, passing a condition variable
404instead of a callback does not work. Both the pure perl and EV loops
405support overloading, however, as well as all functions that use perl to
406invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
407example).
392 408
393=item $cv->croak ($error) 409=item $cv->croak ($error)
394 410
395Similar to send, but causes all call's wait C<< ->wait >> to invoke 411Similar to send, but causes all call's to C<< ->recv >> to invoke
396C<Carp::croak> with the given error message/object/scalar. 412C<Carp::croak> with the given error message/object/scalar.
397 413
398This can be used to signal any errors to the condition variable 414This can be used to signal any errors to the condition variable
399user/consumer. 415user/consumer.
400 416
401=item $cv->begin ([group callback]) 417=item $cv->begin ([group callback])
402 418
403=item $cv->end 419=item $cv->end
420
421These two methods are EXPERIMENTAL and MIGHT CHANGE.
404 422
405These two methods can be used to combine many transactions/events into 423These two methods can be used to combine many transactions/events into
406one. For example, a function that pings many hosts in parallel might want 424one. For example, a function that pings many hosts in parallel might want
407to use a condition variable for the whole process. 425to use a condition variable for the whole process.
408 426
443doesn't execute once). 461doesn't execute once).
444 462
445This is the general pattern when you "fan out" into multiple subrequests: 463This is the general pattern when you "fan out" into multiple subrequests:
446use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 464use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
447is called at least once, and then, for each subrequest you start, call 465is called at least once, and then, for each subrequest you start, call
448C<begin> and for eahc subrequest you finish, call C<end>. 466C<begin> and for each subrequest you finish, call C<end>.
449 467
450=back 468=back
451 469
452=head3 METHODS FOR CONSUMERS 470=head3 METHODS FOR CONSUMERS
453 471
454These methods should only be used by the consuming side, i.e. the 472These methods should only be used by the consuming side, i.e. the
455code awaits the condition. 473code awaits the condition.
456 474
457=over 4 475=over 4
458 476
459=item $cv->wait 477=item $cv->recv
460 478
461Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 479Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
462>> methods have been called on c<$cv>, while servicing other watchers 480>> methods have been called on c<$cv>, while servicing other watchers
463normally. 481normally.
464 482
475(programs might want to do that to stay interactive), so I<if you are 493(programs might want to do that to stay interactive), so I<if you are
476using this from a module, never require a blocking wait>, but let the 494using this from a module, never require a blocking wait>, but let the
477caller decide whether the call will block or not (for example, by coupling 495caller decide whether the call will block or not (for example, by coupling
478condition variables with some kind of request results and supporting 496condition variables with some kind of request results and supporting
479callbacks so the caller knows that getting the result will not block, 497callbacks so the caller knows that getting the result will not block,
480while still suppporting blocking waits if the caller so desires). 498while still supporting blocking waits if the caller so desires).
481 499
482Another reason I<never> to C<< ->wait >> in a module is that you cannot 500Another reason I<never> to C<< ->recv >> in a module is that you cannot
483sensibly have two C<< ->wait >>'s in parallel, as that would require 501sensibly have two C<< ->recv >>'s in parallel, as that would require
484multiple interpreters or coroutines/threads, none of which C<AnyEvent> 502multiple interpreters or coroutines/threads, none of which C<AnyEvent>
485can supply. 503can supply.
486 504
487The L<Coro> module, however, I<can> and I<does> supply coroutines and, in 505The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
488fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe 506fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
489versions and also integrates coroutines into AnyEvent, making blocking 507versions and also integrates coroutines into AnyEvent, making blocking
490C<< ->wait >> calls perfectly safe as long as they are done from another 508C<< ->recv >> calls perfectly safe as long as they are done from another
491coroutine (one that doesn't run the event loop). 509coroutine (one that doesn't run the event loop).
492 510
493You can ensure that C<< -wait >> never blocks by setting a callback and 511You can ensure that C<< -recv >> never blocks by setting a callback and
494only calling C<< ->wait >> from within that callback (or at a later 512only calling C<< ->recv >> from within that callback (or at a later
495time). This will work even when the event loop does not support blocking 513time). This will work even when the event loop does not support blocking
496waits otherwise. 514waits otherwise.
497 515
498=item $bool = $cv->ready 516=item $bool = $cv->ready
499 517
504 522
505This is a mutator function that returns the callback set and optionally 523This is a mutator function that returns the callback set and optionally
506replaces it before doing so. 524replaces it before doing so.
507 525
508The callback will be called when the condition becomes "true", i.e. when 526The callback will be called when the condition becomes "true", i.e. when
509C<send> or C<croak> are called. Calling C<wait> inside the callback 527C<send> or C<croak> are called. Calling C<recv> inside the callback
510or at any later time is guaranteed not to block. 528or at any later time is guaranteed not to block.
511 529
512=back 530=back
513 531
514=head1 GLOBAL VARIABLES AND FUNCTIONS 532=head1 GLOBAL VARIABLES AND FUNCTIONS
582Be careful when you create watchers in the module body - AnyEvent will 600Be careful when you create watchers in the module body - AnyEvent will
583decide which event module to use as soon as the first method is called, so 601decide which event module to use as soon as the first method is called, so
584by calling AnyEvent in your module body you force the user of your module 602by calling AnyEvent in your module body you force the user of your module
585to load the event module first. 603to load the event module first.
586 604
587Never call C<< ->wait >> on a condition variable unless you I<know> that 605Never call C<< ->recv >> on a condition variable unless you I<know> that
588the C<< ->send >> method has been called on it already. This is 606the C<< ->send >> method has been called on it already. This is
589because it will stall the whole program, and the whole point of using 607because it will stall the whole program, and the whole point of using
590events is to stay interactive. 608events is to stay interactive.
591 609
592It is fine, however, to call C<< ->wait >> when the user of your module 610It is fine, however, to call C<< ->recv >> when the user of your module
593requests it (i.e. if you create a http request object ad have a method 611requests it (i.e. if you create a http request object ad have a method
594called C<results> that returns the results, it should call C<< ->wait >> 612called C<results> that returns the results, it should call C<< ->recv >>
595freely, as the user of your module knows what she is doing. always). 613freely, as the user of your module knows what she is doing. always).
596 614
597=head1 WHAT TO DO IN THE MAIN PROGRAM 615=head1 WHAT TO DO IN THE MAIN PROGRAM
598 616
599There will always be a single main program - the only place that should 617There will always be a single main program - the only place that should
601 619
602If it doesn't care, it can just "use AnyEvent" and use it itself, or not 620If it doesn't care, it can just "use AnyEvent" and use it itself, or not
603do anything special (it does not need to be event-based) and let AnyEvent 621do anything special (it does not need to be event-based) and let AnyEvent
604decide which implementation to chose if some module relies on it. 622decide which implementation to chose if some module relies on it.
605 623
606If the main program relies on a specific event model. For example, in 624If the main program relies on a specific event model - for example, in
607Gtk2 programs you have to rely on the Glib module. You should load the 625Gtk2 programs you have to rely on the Glib module - you should load the
608event module before loading AnyEvent or any module that uses it: generally 626event module before loading AnyEvent or any module that uses it: generally
609speaking, you should load it as early as possible. The reason is that 627speaking, you should load it as early as possible. The reason is that
610modules might create watchers when they are loaded, and AnyEvent will 628modules might create watchers when they are loaded, and AnyEvent will
611decide on the event model to use as soon as it creates watchers, and it 629decide on the event model to use as soon as it creates watchers, and it
612might chose the wrong one unless you load the correct one yourself. 630might chose the wrong one unless you load the correct one yourself.
613 631
614You can chose to use a rather inefficient pure-perl implementation by 632You can chose to use a pure-perl implementation by loading the
615loading the C<AnyEvent::Impl::Perl> module, which gives you similar 633C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
616behaviour everywhere, but letting AnyEvent chose is generally better. 634everywhere, but letting AnyEvent chose the model is generally better.
635
636=head2 MAINLOOP EMULATION
637
638Sometimes (often for short test scripts, or even standalone programs who
639only want to use AnyEvent), you do not want to run a specific event loop.
640
641In that case, you can use a condition variable like this:
642
643 AnyEvent->condvar->recv;
644
645This has the effect of entering the event loop and looping forever.
646
647Note that usually your program has some exit condition, in which case
648it is better to use the "traditional" approach of storing a condition
649variable somewhere, waiting for it, and sending it when the program should
650exit cleanly.
651
617 652
618=head1 OTHER MODULES 653=head1 OTHER MODULES
619 654
620The following is a non-exhaustive list of additional modules that use 655The following is a non-exhaustive list of additional modules that use
621AnyEvent and can therefore be mixed easily with other AnyEvent modules 656AnyEvent and can therefore be mixed easily with other AnyEvent modules
631 666
632=item L<AnyEvent::Handle> 667=item L<AnyEvent::Handle>
633 668
634Provide read and write buffers and manages watchers for reads and writes. 669Provide read and write buffers and manages watchers for reads and writes.
635 670
671=item L<AnyEvent::Socket>
672
673Provides various utility functions for (internet protocol) sockets,
674addresses and name resolution. Also functions to create non-blocking tcp
675connections or tcp servers, with IPv6 and SRV record support and more.
676
677=item L<AnyEvent::DNS>
678
679Provides rich asynchronous DNS resolver capabilities.
680
636=item L<AnyEvent::HTTPD> 681=item L<AnyEvent::HTTPD>
637 682
638Provides a simple web application server framework. 683Provides a simple web application server framework.
639
640=item L<AnyEvent::DNS>
641
642Provides asynchronous DNS resolver capabilities, beyond what
643L<AnyEvent::Util> offers.
644 684
645=item L<AnyEvent::FastPing> 685=item L<AnyEvent::FastPing>
646 686
647The fastest ping in the west. 687The fastest ping in the west.
648 688
691no warnings; 731no warnings;
692use strict; 732use strict;
693 733
694use Carp; 734use Carp;
695 735
696our $VERSION = '3.4'; 736our $VERSION = '4.03';
697our $MODEL; 737our $MODEL;
698 738
699our $AUTOLOAD; 739our $AUTOLOAD;
700our @ISA; 740our @ISA;
701 741
742our @REGISTRY;
743
702our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 744our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
703 745
704our @REGISTRY; 746our %PROTOCOL; # (ipv4|ipv6) => (1|2)
747
748{
749 my $idx;
750 $PROTOCOL{$_} = ++$idx
751 for split /\s*,\s*/, $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
752}
705 753
706my @models = ( 754my @models = (
707 [EV:: => AnyEvent::Impl::EV::], 755 [EV:: => AnyEvent::Impl::EV::],
708 [Event:: => AnyEvent::Impl::Event::], 756 [Event:: => AnyEvent::Impl::Event::],
709 [Tk:: => AnyEvent::Impl::Tk::],
710 [Wx:: => AnyEvent::Impl::POE::],
711 [Prima:: => AnyEvent::Impl::POE::],
712 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 757 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
713 # everything below here will not be autoprobed as the pureperl backend should work everywhere 758 # everything below here will not be autoprobed
714 [Glib:: => AnyEvent::Impl::Glib::], 759 # as the pureperl backend should work everywhere
760 # and is usually faster
761 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
762 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
715 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 763 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
716 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 764 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
717 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 765 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
766 [Wx:: => AnyEvent::Impl::POE::],
767 [Prima:: => AnyEvent::Impl::POE::],
718); 768);
719 769
720our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); 770our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);
721 771
722our @post_detect; 772our @post_detect;
730 1 780 1
731 } else { 781 } else {
732 push @post_detect, $cb; 782 push @post_detect, $cb;
733 783
734 defined wantarray 784 defined wantarray
735 ? bless \$cb, "AnyEvent::Util::Guard" 785 ? bless \$cb, "AnyEvent::Util::PostDetect"
736 : () 786 : ()
737 } 787 }
738} 788}
739 789
740sub AnyEvent::Util::Guard::DESTROY { 790sub AnyEvent::Util::PostDetect::DESTROY {
741 @post_detect = grep $_ != ${$_[0]}, @post_detect; 791 @post_detect = grep $_ != ${$_[0]}, @post_detect;
742} 792}
743 793
744sub detect() { 794sub detect() {
745 unless ($MODEL) { 795 unless ($MODEL) {
808 $class->$func (@_); 858 $class->$func (@_);
809} 859}
810 860
811package AnyEvent::Base; 861package AnyEvent::Base;
812 862
813# default implementation for ->condvar, ->wait, ->broadcast 863# default implementation for ->condvar
814 864
815sub condvar { 865sub condvar {
816 bless \my $flag, "AnyEvent::Base::CondVar" 866 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
817}
818
819sub AnyEvent::Base::CondVar::broadcast {
820 ${$_[0]}++;
821}
822
823sub AnyEvent::Base::CondVar::wait {
824 AnyEvent->one_event while !${$_[0]};
825} 867}
826 868
827# default implementation for ->signal 869# default implementation for ->signal
828 870
829our %SIG_CB; 871our %SIG_CB;
903 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 945 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
904 946
905 undef $CHLD_W unless keys %PID_CB; 947 undef $CHLD_W unless keys %PID_CB;
906} 948}
907 949
950package AnyEvent::CondVar;
951
952our @ISA = AnyEvent::CondVar::Base::;
953
954package AnyEvent::CondVar::Base;
955
956use overload
957 '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
958 fallback => 1;
959
960sub _send {
961 # nop
962}
963
964sub send {
965 my $cv = shift;
966 $cv->{_ae_sent} = [@_];
967 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
968 $cv->_send;
969}
970
971sub croak {
972 $_[0]{_ae_croak} = $_[1];
973 $_[0]->send;
974}
975
976sub ready {
977 $_[0]{_ae_sent}
978}
979
980sub _wait {
981 AnyEvent->one_event while !$_[0]{_ae_sent};
982}
983
984sub recv {
985 $_[0]->_wait;
986
987 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
988 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
989}
990
991sub cb {
992 $_[0]{_ae_cb} = $_[1] if @_ > 1;
993 $_[0]{_ae_cb}
994}
995
996sub begin {
997 ++$_[0]{_ae_counter};
998 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
999}
1000
1001sub end {
1002 return if --$_[0]{_ae_counter};
1003 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1004}
1005
1006# undocumented/compatibility with pre-3.4
1007*broadcast = \&send;
1008*wait = \&_wait;
1009
908=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1010=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
909 1011
910This is an advanced topic that you do not normally need to use AnyEvent in 1012This is an advanced topic that you do not normally need to use AnyEvent in
911a module. This section is only of use to event loop authors who want to 1013a module. This section is only of use to event loop authors who want to
912provide AnyEvent compatibility. 1014provide AnyEvent compatibility.
968model it chooses. 1070model it chooses.
969 1071
970=item C<PERL_ANYEVENT_MODEL> 1072=item C<PERL_ANYEVENT_MODEL>
971 1073
972This can be used to specify the event model to be used by AnyEvent, before 1074This can be used to specify the event model to be used by AnyEvent, before
973autodetection and -probing kicks in. It must be a string consisting 1075auto detection and -probing kicks in. It must be a string consisting
974entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 1076entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
975and the resulting module name is loaded and if the load was successful, 1077and the resulting module name is loaded and if the load was successful,
976used as event model. If it fails to load AnyEvent will proceed with 1078used as event model. If it fails to load AnyEvent will proceed with
977autodetection and -probing. 1079auto detection and -probing.
978 1080
979This functionality might change in future versions. 1081This functionality might change in future versions.
980 1082
981For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1083For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
982could start your program like this: 1084could start your program like this:
983 1085
984 PERL_ANYEVENT_MODEL=Perl perl ... 1086 PERL_ANYEVENT_MODEL=Perl perl ...
1087
1088=item C<PERL_ANYEVENT_PROTOCOLS>
1089
1090Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1091for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1092of auto probing).
1093
1094Must be set to a comma-separated list of protocols or address families,
1095current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1096used, and preference will be given to protocols mentioned earlier in the
1097list.
1098
1099This variable can effectively be used for denial-of-service attacks
1100against local programs (e.g. when setuid), although the impact is likely
1101small, as the program has to handle connection errors already-
1102
1103Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1104but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1105- only support IPv4, never try to resolve or contact IPv6
1106addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1107IPv6, but prefer IPv6 over IPv4.
1108
1109=item C<PERL_ANYEVENT_EDNS0>
1110
1111Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1112for DNS. This extension is generally useful to reduce DNS traffic, but
1113some (broken) firewalls drop such DNS packets, which is why it is off by
1114default.
1115
1116Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1117EDNS0 in its DNS requests.
985 1118
986=back 1119=back
987 1120
988=head1 EXAMPLE PROGRAM 1121=head1 EXAMPLE PROGRAM
989 1122
1000 poll => 'r', 1133 poll => 'r',
1001 cb => sub { 1134 cb => sub {
1002 warn "io event <$_[0]>\n"; # will always output <r> 1135 warn "io event <$_[0]>\n"; # will always output <r>
1003 chomp (my $input = <STDIN>); # read a line 1136 chomp (my $input = <STDIN>); # read a line
1004 warn "read: $input\n"; # output what has been read 1137 warn "read: $input\n"; # output what has been read
1005 $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i 1138 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1006 }, 1139 },
1007 ); 1140 );
1008 1141
1009 my $time_watcher; # can only be used once 1142 my $time_watcher; # can only be used once
1010 1143
1015 }); 1148 });
1016 } 1149 }
1017 1150
1018 new_timer; # create first timer 1151 new_timer; # create first timer
1019 1152
1020 $cv->wait; # wait until user enters /^q/i 1153 $cv->recv; # wait until user enters /^q/i
1021 1154
1022=head1 REAL-WORLD EXAMPLE 1155=head1 REAL-WORLD EXAMPLE
1023 1156
1024Consider the L<Net::FCP> module. It features (among others) the following 1157Consider the L<Net::FCP> module. It features (among others) the following
1025API calls, which are to freenet what HTTP GET requests are to http: 1158API calls, which are to freenet what HTTP GET requests are to http:
1075 syswrite $txn->{fh}, $txn->{request} 1208 syswrite $txn->{fh}, $txn->{request}
1076 or die "connection or write error"; 1209 or die "connection or write error";
1077 $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); 1210 $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
1078 1211
1079Again, C<fh_ready_r> waits till all data has arrived, and then stores the 1212Again, C<fh_ready_r> waits till all data has arrived, and then stores the
1080result and signals any possible waiters that the request ahs finished: 1213result and signals any possible waiters that the request has finished:
1081 1214
1082 sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; 1215 sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
1083 1216
1084 if (end-of-file or data complete) { 1217 if (end-of-file or data complete) {
1085 $txn->{result} = $txn->{buf}; 1218 $txn->{result} = $txn->{buf};
1086 $txn->{finished}->broadcast; 1219 $txn->{finished}->send;
1087 $txb->{cb}->($txn) of $txn->{cb}; # also call callback 1220 $txb->{cb}->($txn) of $txn->{cb}; # also call callback
1088 } 1221 }
1089 1222
1090The C<result> method, finally, just waits for the finished signal (if the 1223The C<result> method, finally, just waits for the finished signal (if the
1091request was already finished, it doesn't wait, of course, and returns the 1224request was already finished, it doesn't wait, of course, and returns the
1092data: 1225data:
1093 1226
1094 $txn->{finished}->wait; 1227 $txn->{finished}->recv;
1095 return $txn->{result}; 1228 return $txn->{result};
1096 1229
1097The actual code goes further and collects all errors (C<die>s, exceptions) 1230The actual code goes further and collects all errors (C<die>s, exceptions)
1098that occured during request processing. The C<result> method detects 1231that occurred during request processing. The C<result> method detects
1099whether an exception as thrown (it is stored inside the $txn object) 1232whether an exception as thrown (it is stored inside the $txn object)
1100and just throws the exception, which means connection errors and other 1233and just throws the exception, which means connection errors and other
1101problems get reported tot he code that tries to use the result, not in a 1234problems get reported tot he code that tries to use the result, not in a
1102random callback. 1235random callback.
1103 1236
1134 1267
1135 my $quit = AnyEvent->condvar; 1268 my $quit = AnyEvent->condvar;
1136 1269
1137 $fcp->txn_client_get ($url)->cb (sub { 1270 $fcp->txn_client_get ($url)->cb (sub {
1138 ... 1271 ...
1139 $quit->broadcast; 1272 $quit->send;
1140 }); 1273 });
1141 1274
1142 $quit->wait; 1275 $quit->recv;
1143 1276
1144 1277
1145=head1 BENCHMARKS 1278=head1 BENCHMARKS
1146 1279
1147To give you an idea of the performance and overheads that AnyEvent adds 1280To give you an idea of the performance and overheads that AnyEvent adds
1149of various event loops I prepared some benchmarks. 1282of various event loops I prepared some benchmarks.
1150 1283
1151=head2 BENCHMARKING ANYEVENT OVERHEAD 1284=head2 BENCHMARKING ANYEVENT OVERHEAD
1152 1285
1153Here is a benchmark of various supported event models used natively and 1286Here is a benchmark of various supported event models used natively and
1154through anyevent. The benchmark creates a lot of timers (with a zero 1287through AnyEvent. The benchmark creates a lot of timers (with a zero
1155timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 1288timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1156which it is), lets them fire exactly once and destroys them again. 1289which it is), lets them fire exactly once and destroys them again.
1157 1290
1158Source code for this benchmark is found as F<eg/bench> in the AnyEvent 1291Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1159distribution. 1292distribution.
1176all watchers, to avoid adding memory overhead. That means closure creation 1309all watchers, to avoid adding memory overhead. That means closure creation
1177and memory usage is not included in the figures. 1310and memory usage is not included in the figures.
1178 1311
1179I<invoke> is the time, in microseconds, used to invoke a simple 1312I<invoke> is the time, in microseconds, used to invoke a simple
1180callback. The callback simply counts down a Perl variable and after it was 1313callback. The callback simply counts down a Perl variable and after it was
1181invoked "watcher" times, it would C<< ->broadcast >> a condvar once to 1314invoked "watcher" times, it would C<< ->send >> a condvar once to
1182signal the end of this phase. 1315signal the end of this phase.
1183 1316
1184I<destroy> is the time, in microseconds, that it takes to destroy a single 1317I<destroy> is the time, in microseconds, that it takes to destroy a single
1185watcher. 1318watcher.
1186 1319
1282 1415
1283=back 1416=back
1284 1417
1285=head2 BENCHMARKING THE LARGE SERVER CASE 1418=head2 BENCHMARKING THE LARGE SERVER CASE
1286 1419
1287This benchmark atcually benchmarks the event loop itself. It works by 1420This benchmark actually benchmarks the event loop itself. It works by
1288creating a number of "servers": each server consists of a socketpair, a 1421creating a number of "servers": each server consists of a socket pair, a
1289timeout watcher that gets reset on activity (but never fires), and an I/O 1422timeout watcher that gets reset on activity (but never fires), and an I/O
1290watcher waiting for input on one side of the socket. Each time the socket 1423watcher waiting for input on one side of the socket. Each time the socket
1291watcher reads a byte it will write that byte to a random other "server". 1424watcher reads a byte it will write that byte to a random other "server".
1292 1425
1293The effect is that there will be a lot of I/O watchers, only part of which 1426The effect is that there will be a lot of I/O watchers, only part of which
1294are active at any one point (so there is a constant number of active 1427are active at any one point (so there is a constant number of active
1295fds for each loop iterstaion, but which fds these are is random). The 1428fds for each loop iteration, but which fds these are is random). The
1296timeout is reset each time something is read because that reflects how 1429timeout is reset each time something is read because that reflects how
1297most timeouts work (and puts extra pressure on the event loops). 1430most timeouts work (and puts extra pressure on the event loops).
1298 1431
1299In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100 1432In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1300(1%) are active. This mirrors the activity of large servers with many 1433(1%) are active. This mirrors the activity of large servers with many
1301connections, most of which are idle at any one point in time. 1434connections, most of which are idle at any one point in time.
1302 1435
1303Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 1436Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1304distribution. 1437distribution.
1306=head3 Explanation of the columns 1439=head3 Explanation of the columns
1307 1440
1308I<sockets> is the number of sockets, and twice the number of "servers" (as 1441I<sockets> is the number of sockets, and twice the number of "servers" (as
1309each server has a read and write socket end). 1442each server has a read and write socket end).
1310 1443
1311I<create> is the time it takes to create a socketpair (which is 1444I<create> is the time it takes to create a socket pair (which is
1312nontrivial) and two watchers: an I/O watcher and a timeout watcher. 1445nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1313 1446
1314I<request>, the most important value, is the time it takes to handle a 1447I<request>, the most important value, is the time it takes to handle a
1315single "request", that is, reading the token from the pipe and forwarding 1448single "request", that is, reading the token from the pipe and forwarding
1316it to another server. This includes deleting the old timeout and creating 1449it to another server. This includes deleting the old timeout and creating
1389speed most when you have lots of watchers, not when you only have a few of 1522speed most when you have lots of watchers, not when you only have a few of
1390them). 1523them).
1391 1524
1392EV is again fastest. 1525EV is again fastest.
1393 1526
1394Perl again comes second. It is noticably faster than the C-based event 1527Perl again comes second. It is noticeably faster than the C-based event
1395loops Event and Glib, although the difference is too small to really 1528loops Event and Glib, although the difference is too small to really
1396matter. 1529matter.
1397 1530
1398POE also performs much better in this case, but is is still far behind the 1531POE also performs much better in this case, but is is still far behind the
1399others. 1532others.
1439probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 1572probably even less useful to an attacker than PERL_ANYEVENT_MODEL).
1440 1573
1441 1574
1442=head1 SEE ALSO 1575=head1 SEE ALSO
1443 1576
1577Utility functions: L<AnyEvent::Util>.
1578
1444Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 1579Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1445L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 1580L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1446 1581
1447Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 1582Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1448L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 1583L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1449L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 1584L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1450L<AnyEvent::Impl::POE>. 1585L<AnyEvent::Impl::POE>.
1451 1586
1587Non-blocking file handles, sockets, TCP clients and
1588servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.
1589
1590Asynchronous DNS: L<AnyEvent::DNS>.
1591
1452Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 1592Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
1453 1593
1454Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. 1594Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1455 1595
1456 1596
1457=head1 AUTHOR 1597=head1 AUTHOR
1458 1598
1459 Marc Lehmann <schmorp@schmorp.de> 1599 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines