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.228 by root, Wed Jul 8 01:11:12 2009 UTC vs.
Revision 1.267 by root, Thu Jul 30 03:46:12 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6event loops. 6and POE are various supported event loops/environments.
7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
40=head1 INTRODUCTION/TUTORIAL 40=head1 INTRODUCTION/TUTORIAL
41 41
42This manpage is mainly a reference manual. If you are interested 42This manpage is mainly a reference manual. If you are interested
43in a tutorial or some gentle introduction, have a look at the 43in a tutorial or some gentle introduction, have a look at the
44L<AnyEvent::Intro> manpage. 44L<AnyEvent::Intro> manpage.
45
46=head1 SUPPORT
47
48There is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too.
50
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Repository>, at L<http://anyevent.schmorp.de>, for more info.
45 53
46=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47 55
48Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49nowadays. So what is different about AnyEvent? 57nowadays. So what is different about AnyEvent?
173my variables are only visible after the statement in which they are 181my variables are only visible after the statement in which they are
174declared. 182declared.
175 183
176=head2 I/O WATCHERS 184=head2 I/O WATCHERS
177 185
186 $w = AnyEvent->io (
187 fh => <filehandle_or_fileno>,
188 poll => <"r" or "w">,
189 cb => <callback>,
190 );
191
178You can create an I/O watcher by calling the C<< AnyEvent->io >> method 192You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179with the following mandatory key-value pairs as arguments: 193with the following mandatory key-value pairs as arguments:
180 194
181C<fh> is the Perl I<file handle> (I<not> file descriptor, see below) to 195C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182watch for events (AnyEvent might or might not keep a reference to this 196for events (AnyEvent might or might not keep a reference to this file
183file handle). Note that only file handles pointing to things for which 197handle). Note that only file handles pointing to things for which
184non-blocking operation makes sense are allowed. This includes sockets, 198non-blocking operation makes sense are allowed. This includes sockets,
185most character devices, pipes, fifos and so on, but not for example files 199most character devices, pipes, fifos and so on, but not for example files
186or block devices. 200or block devices.
187 201
188C<poll> must be a string that is either C<r> or C<w>, which creates a 202C<poll> must be a string that is either C<r> or C<w>, which creates a
209 chomp (my $input = <STDIN>); 223 chomp (my $input = <STDIN>);
210 warn "read: $input\n"; 224 warn "read: $input\n";
211 undef $w; 225 undef $w;
212 }); 226 });
213 227
214=head3 GETTING A FILE HANDLE FROM A FILE DESCRIPTOR
215
216It is not uncommon to only have a file descriptor, while AnyEvent requires
217a Perl file handle.
218
219There are basically two methods to convert a file descriptor into a file handle. If you own
220the file descriptor, you can open it with C<&=>, as in:
221
222 open my $fh, "<&=$fileno" or die "xxx: ยง!";
223
224This will "own" the file descriptor, meaning that when C<$fh> is
225destroyed, it will automatically close the C<$fileno>. Also, note that
226the open mode (read, write, read/write) must correspond with how the
227underlying file descriptor was opened.
228
229In many cases, taking over the file descriptor is now what you want, in
230which case the only alternative is to dup the file descriptor:
231
232 open my $fh, "<&$fileno" or die "xxx: $!";
233
234This has the advantage of not closing the file descriptor and the
235disadvantage of making a slow copy.
236
237=head2 TIME WATCHERS 228=head2 TIME WATCHERS
229
230 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
231
232 $w = AnyEvent->timer (
233 after => <fractional_seconds>,
234 interval => <fractional_seconds>,
235 cb => <callback>,
236 );
238 237
239You can create a time watcher by calling the C<< AnyEvent->timer >> 238You can create a time watcher by calling the C<< AnyEvent->timer >>
240method with the following mandatory arguments: 239method with the following mandatory arguments:
241 240
242C<after> specifies after how many seconds (fractional values are 241C<after> specifies after how many seconds (fractional values are
370 369
371=back 370=back
372 371
373=head2 SIGNAL WATCHERS 372=head2 SIGNAL WATCHERS
374 373
374 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
375
375You can watch for signals using a signal watcher, C<signal> is the signal 376You can watch for signals using a signal watcher, C<signal> is the signal
376I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl 377I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
377callback to be invoked whenever a signal occurs. 378callback to be invoked whenever a signal occurs.
378 379
379Although the callback might get passed parameters, their value and 380Although the callback might get passed parameters, their value and
384invocation, and callback invocation will be synchronous. Synchronous means 385invocation, and callback invocation will be synchronous. Synchronous means
385that it might take a while until the signal gets handled by the process, 386that it might take a while until the signal gets handled by the process,
386but it is guaranteed not to interrupt any other callbacks. 387but it is guaranteed not to interrupt any other callbacks.
387 388
388The main advantage of using these watchers is that you can share a signal 389The main advantage of using these watchers is that you can share a signal
389between multiple watchers. 390between multiple watchers, and AnyEvent will ensure that signals will not
391interrupt your program at bad times.
390 392
391This watcher might use C<%SIG>, so programs overwriting those signals 393This watcher might use C<%SIG> (depending on the event loop used),
392directly will likely not work correctly. 394so programs overwriting those signals directly will likely not work
395correctly.
393 396
394Example: exit on SIGINT 397Example: exit on SIGINT
395 398
396 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 399 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
397 400
401=head3 Signal Races, Delays and Workarounds
402
403Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
404callbacks to signals in a generic way, which is a pity, as you cannot
405do race-free signal handling in perl, requiring C libraries for
406this. AnyEvent will try to do it's best, which means in some cases,
407signals will be delayed. The maximum time a signal might be delayed is
408specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
409variable can be changed only before the first signal watcher is created,
410and should be left alone otherwise. This variable determines how often
411AnyEvent polls for signals (in case a wake-up was missed). Higher values
412will cause fewer spurious wake-ups, which is better for power and CPU
413saving.
414
415All these problems can be avoided by installing the optional
416L<Async::Interrupt> module, which works with most event loops. It will not
417work with inherently broken event loops such as L<Event> or L<Event::Lib>
418(and not with L<POE> currently, as POE does it's own workaround with
419one-second latency). For those, you just have to suffer the delays.
420
398=head2 CHILD PROCESS WATCHERS 421=head2 CHILD PROCESS WATCHERS
399 422
423 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
424
400You can also watch on a child process exit and catch its exit status. 425You can also watch on a child process exit and catch its exit status.
401 426
402The child process is specified by the C<pid> argument (if set to C<0>, it 427The child process is specified by the C<pid> argument (one some backends,
403watches for any child process exit). The watcher will triggered only when 428using C<0> watches for any child process exit, on others this will
404the child process has finished and an exit status is available, not on 429croak). The watcher will be triggered only when the child process has
405any trace events (stopped/continued). 430finished and an exit status is available, not on any trace events
431(stopped/continued).
406 432
407The callback will be called with the pid and exit status (as returned by 433The callback will be called with the pid and exit status (as returned by
408waitpid), so unlike other watcher types, you I<can> rely on child watcher 434waitpid), so unlike other watcher types, you I<can> rely on child watcher
409callback arguments. 435callback arguments.
410 436
426 452
427This means you cannot create a child watcher as the very first 453This means you cannot create a child watcher as the very first
428thing in an AnyEvent program, you I<have> to create at least one 454thing in an AnyEvent program, you I<have> to create at least one
429watcher before you C<fork> the child (alternatively, you can call 455watcher before you C<fork> the child (alternatively, you can call
430C<AnyEvent::detect>). 456C<AnyEvent::detect>).
457
458As most event loops do not support waiting for child events, they will be
459emulated by AnyEvent in most cases, in which the latency and race problems
460mentioned in the description of signal watchers apply.
431 461
432Example: fork a process and wait for it 462Example: fork a process and wait for it
433 463
434 my $done = AnyEvent->condvar; 464 my $done = AnyEvent->condvar;
435 465
447 # do something else, then wait for process exit 477 # do something else, then wait for process exit
448 $done->recv; 478 $done->recv;
449 479
450=head2 IDLE WATCHERS 480=head2 IDLE WATCHERS
451 481
482 $w = AnyEvent->idle (cb => <callback>);
483
452Sometimes there is a need to do something, but it is not so important 484Sometimes there is a need to do something, but it is not so important
453to do it instantly, but only when there is nothing better to do. This 485to do it instantly, but only when there is nothing better to do. This
454"nothing better to do" is usually defined to be "no other events need 486"nothing better to do" is usually defined to be "no other events need
455attention by the event loop". 487attention by the event loop".
456 488
482 }); 514 });
483 }); 515 });
484 516
485=head2 CONDITION VARIABLES 517=head2 CONDITION VARIABLES
486 518
519 $cv = AnyEvent->condvar;
520
521 $cv->send (<list>);
522 my @res = $cv->recv;
523
487If you are familiar with some event loops you will know that all of them 524If you are familiar with some event loops you will know that all of them
488require you to run some blocking "loop", "run" or similar function that 525require you to run some blocking "loop", "run" or similar function that
489will actively watch for new events and call your callbacks. 526will actively watch for new events and call your callbacks.
490 527
491AnyEvent is different, it expects somebody else to run the event loop and 528AnyEvent is slightly different: it expects somebody else to run the event
492will only block when necessary (usually when told by the user). 529loop and will only block when necessary (usually when told by the user).
493 530
494The instrument to do that is called a "condition variable", so called 531The instrument to do that is called a "condition variable", so called
495because they represent a condition that must become true. 532because they represent a condition that must become true.
496 533
534Now is probably a good time to look at the examples further below.
535
497Condition variables can be created by calling the C<< AnyEvent->condvar 536Condition variables can be created by calling the C<< AnyEvent->condvar
498>> method, usually without arguments. The only argument pair allowed is 537>> method, usually without arguments. The only argument pair allowed is
499
500C<cb>, which specifies a callback to be called when the condition variable 538C<cb>, which specifies a callback to be called when the condition variable
501becomes true, with the condition variable as the first argument (but not 539becomes true, with the condition variable as the first argument (but not
502the results). 540the results).
503 541
504After creation, the condition variable is "false" until it becomes "true" 542After creation, the condition variable is "false" until it becomes "true"
509Condition variables are similar to callbacks, except that you can 547Condition variables are similar to callbacks, except that you can
510optionally wait for them. They can also be called merge points - points 548optionally wait for them. They can also be called merge points - points
511in time where multiple outstanding events have been processed. And yet 549in time where multiple outstanding events have been processed. And yet
512another way to call them is transactions - each condition variable can be 550another way to call them is transactions - each condition variable can be
513used to represent a transaction, which finishes at some point and delivers 551used to represent a transaction, which finishes at some point and delivers
514a result. 552a result. And yet some people know them as "futures" - a promise to
553compute/deliver something that you can wait for.
515 554
516Condition variables are very useful to signal that something has finished, 555Condition variables are very useful to signal that something has finished,
517for example, if you write a module that does asynchronous http requests, 556for example, if you write a module that does asynchronous http requests,
518then a condition variable would be the ideal candidate to signal the 557then a condition variable would be the ideal candidate to signal the
519availability of results. The user can either act when the callback is 558availability of results. The user can either act when the callback is
553 after => 1, 592 after => 1,
554 cb => sub { $result_ready->send }, 593 cb => sub { $result_ready->send },
555 ); 594 );
556 595
557 # this "blocks" (while handling events) till the callback 596 # this "blocks" (while handling events) till the callback
558 # calls send 597 # calls -<send
559 $result_ready->recv; 598 $result_ready->recv;
560 599
561Example: wait for a timer, but take advantage of the fact that 600Example: wait for a timer, but take advantage of the fact that condition
562condition variables are also code references. 601variables are also callable directly.
563 602
564 my $done = AnyEvent->condvar; 603 my $done = AnyEvent->condvar;
565 my $delay = AnyEvent->timer (after => 5, cb => $done); 604 my $delay = AnyEvent->timer (after => 5, cb => $done);
566 $done->recv; 605 $done->recv;
567 606
573 612
574 ... 613 ...
575 614
576 my @info = $couchdb->info->recv; 615 my @info = $couchdb->info->recv;
577 616
578And this is how you would just ste a callback to be called whenever the 617And this is how you would just set a callback to be called whenever the
579results are available: 618results are available:
580 619
581 $couchdb->info->cb (sub { 620 $couchdb->info->cb (sub {
582 my @info = $_[0]->recv; 621 my @info = $_[0]->recv;
583 }); 622 });
601immediately from within send. 640immediately from within send.
602 641
603Any arguments passed to the C<send> call will be returned by all 642Any arguments passed to the C<send> call will be returned by all
604future C<< ->recv >> calls. 643future C<< ->recv >> calls.
605 644
606Condition variables are overloaded so one can call them directly 645Condition variables are overloaded so one can call them directly (as if
607(as a code reference). Calling them directly is the same as calling 646they were a code reference). Calling them directly is the same as calling
608C<send>. Note, however, that many C-based event loops do not handle 647C<send>.
609overloading, so as tempting as it may be, passing a condition variable
610instead of a callback does not work. Both the pure perl and EV loops
611support overloading, however, as well as all functions that use perl to
612invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
613example).
614 648
615=item $cv->croak ($error) 649=item $cv->croak ($error)
616 650
617Similar to send, but causes all call's to C<< ->recv >> to invoke 651Similar to send, but causes all call's to C<< ->recv >> to invoke
618C<Carp::croak> with the given error message/object/scalar. 652C<Carp::croak> with the given error message/object/scalar.
619 653
620This can be used to signal any errors to the condition variable 654This can be used to signal any errors to the condition variable
621user/consumer. 655user/consumer. Doing it this way instead of calling C<croak> directly
656delays the error detetcion, but has the overwhelmign advantage that it
657diagnoses the error at the place where the result is expected, and not
658deep in some event clalback without connection to the actual code causing
659the problem.
622 660
623=item $cv->begin ([group callback]) 661=item $cv->begin ([group callback])
624 662
625=item $cv->end 663=item $cv->end
626 664
722function will call C<croak>. 760function will call C<croak>.
723 761
724In list context, all parameters passed to C<send> will be returned, 762In list context, all parameters passed to C<send> will be returned,
725in scalar context only the first one will be returned. 763in scalar context only the first one will be returned.
726 764
765Note that doing a blocking wait in a callback is not supported by any
766event loop, that is, recursive invocation of a blocking C<< ->recv
767>> is not allowed, and the C<recv> call will C<croak> if such a
768condition is detected. This condition can be slightly loosened by using
769L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
770any thread that doesn't run the event loop itself.
771
727Not all event models support a blocking wait - some die in that case 772Not all event models support a blocking wait - some die in that case
728(programs might want to do that to stay interactive), so I<if you are 773(programs might want to do that to stay interactive), so I<if you are
729using this from a module, never require a blocking wait>, but let the 774using this from a module, never require a blocking wait>. Instead, let the
730caller decide whether the call will block or not (for example, by coupling 775caller decide whether the call will block or not (for example, by coupling
731condition variables with some kind of request results and supporting 776condition variables with some kind of request results and supporting
732callbacks so the caller knows that getting the result will not block, 777callbacks so the caller knows that getting the result will not block,
733while still supporting blocking waits if the caller so desires). 778while still supporting blocking waits if the caller so desires).
734 779
735Another reason I<never> to C<< ->recv >> in a module is that you cannot
736sensibly have two C<< ->recv >>'s in parallel, as that would require
737multiple interpreters or coroutines/threads, none of which C<AnyEvent>
738can supply.
739
740The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
741fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
742versions and also integrates coroutines into AnyEvent, making blocking
743C<< ->recv >> calls perfectly safe as long as they are done from another
744coroutine (one that doesn't run the event loop).
745
746You can ensure that C<< -recv >> never blocks by setting a callback and 780You can ensure that C<< -recv >> never blocks by setting a callback and
747only calling C<< ->recv >> from within that callback (or at a later 781only calling C<< ->recv >> from within that callback (or at a later
748time). This will work even when the event loop does not support blocking 782time). This will work even when the event loop does not support blocking
749waits otherwise. 783waits otherwise.
750 784
763variable itself. Calling C<recv> inside the callback or at any later time 797variable itself. Calling C<recv> inside the callback or at any later time
764is guaranteed not to block. 798is guaranteed not to block.
765 799
766=back 800=back
767 801
802=head1 SUPPORTED EVENT LOOPS/BACKENDS
803
804The available backend classes are (every class has its own manpage):
805
806=over 4
807
808=item Backends that are autoprobed when no other event loop can be found.
809
810EV is the preferred backend when no other event loop seems to be in
811use. If EV is not installed, then AnyEvent will try Event, and, failing
812that, will fall back to its own pure-perl implementation, which is
813available everywhere as it comes with AnyEvent itself.
814
815 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
816 AnyEvent::Impl::Event based on Event, very stable, few glitches.
817 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
818
819=item Backends that are transparently being picked up when they are used.
820
821These will be used when they are currently loaded when the first watcher
822is created, in which case it is assumed that the application is using
823them. This means that AnyEvent will automatically pick the right backend
824when the main program loads an event module before anything starts to
825create watchers. Nothing special needs to be done by the main program.
826
827 AnyEvent::Impl::Glib based on Glib, slow but very stable.
828 AnyEvent::Impl::Tk based on Tk, very broken.
829 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
830 AnyEvent::Impl::POE based on POE, very slow, some limitations.
831 AnyEvent::Impl::Irssi used when running within irssi.
832
833=item Backends with special needs.
834
835Qt requires the Qt::Application to be instantiated first, but will
836otherwise be picked up automatically. As long as the main program
837instantiates the application before any AnyEvent watchers are created,
838everything should just work.
839
840 AnyEvent::Impl::Qt based on Qt.
841
842Support for IO::Async can only be partial, as it is too broken and
843architecturally limited to even support the AnyEvent API. It also
844is the only event loop that needs the loop to be set explicitly, so
845it can only be used by a main program knowing about AnyEvent. See
846L<AnyEvent::Impl::Async> for the gory details.
847
848 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
849
850=item Event loops that are indirectly supported via other backends.
851
852Some event loops can be supported via other modules:
853
854There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
855
856B<WxWidgets> has no support for watching file handles. However, you can
857use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
858polls 20 times per second, which was considered to be too horrible to even
859consider for AnyEvent.
860
861B<Prima> is not supported as nobody seems to be using it, but it has a POE
862backend, so it can be supported through POE.
863
864AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
865load L<POE> when detecting them, in the hope that POE will pick them up,
866in which case everything will be automatic.
867
868=back
869
768=head1 GLOBAL VARIABLES AND FUNCTIONS 870=head1 GLOBAL VARIABLES AND FUNCTIONS
769 871
872These are not normally required to use AnyEvent, but can be useful to
873write AnyEvent extension modules.
874
770=over 4 875=over 4
771 876
772=item $AnyEvent::MODEL 877=item $AnyEvent::MODEL
773 878
774Contains C<undef> until the first watcher is being created. Then it 879Contains C<undef> until the first watcher is being created, before the
880backend has been autodetected.
881
775contains the event model that is being used, which is the name of the 882Afterwards it contains the event model that is being used, which is the
776Perl class implementing the model. This class is usually one of the 883name of the Perl class implementing the model. This class is usually one
777C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 884of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
778AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 885case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
779 886will be C<urxvt::anyevent>).
780The known classes so far are:
781
782 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
783 AnyEvent::Impl::Event based on Event, second best choice.
784 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
785 AnyEvent::Impl::Glib based on Glib, third-best choice.
786 AnyEvent::Impl::Tk based on Tk, very bad choice.
787 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
788 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
789 AnyEvent::Impl::POE based on POE, not generic enough for full support.
790
791 # warning, support for IO::Async is only partial, as it is too broken
792 # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
793 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
794
795There is no support for WxWidgets, as WxWidgets has no support for
796watching file handles. However, you can use WxWidgets through the
797POE Adaptor, as POE has a Wx backend that simply polls 20 times per
798second, which was considered to be too horrible to even consider for
799AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
800it's adaptor.
801
802AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
803autodetecting them.
804 887
805=item AnyEvent::detect 888=item AnyEvent::detect
806 889
807Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 890Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
808if necessary. You should only call this function right before you would 891if necessary. You should only call this function right before you would
809have created an AnyEvent watcher anyway, that is, as late as possible at 892have created an AnyEvent watcher anyway, that is, as late as possible at
810runtime. 893runtime, and not e.g. while initialising of your module.
894
895If you need to do some initialisation before AnyEvent watchers are
896created, use C<post_detect>.
811 897
812=item $guard = AnyEvent::post_detect { BLOCK } 898=item $guard = AnyEvent::post_detect { BLOCK }
813 899
814Arranges for the code block to be executed as soon as the event model is 900Arranges for the code block to be executed as soon as the event model is
815autodetected (or immediately if this has already happened). 901autodetected (or immediately if this has already happened).
816 902
903The block will be executed I<after> the actual backend has been detected
904(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
905created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
906other initialisations - see the sources of L<AnyEvent::Strict> or
907L<AnyEvent::AIO> to see how this is used.
908
909The most common usage is to create some global watchers, without forcing
910event module detection too early, for example, L<AnyEvent::AIO> creates
911and installs the global L<IO::AIO> watcher in a C<post_detect> block to
912avoid autodetecting the event module at load time.
913
817If called in scalar or list context, then it creates and returns an object 914If called in scalar or list context, then it creates and returns an object
818that automatically removes the callback again when it is destroyed. See 915that automatically removes the callback again when it is destroyed (or
916C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
819L<Coro::BDB> for a case where this is useful. 917a case where this is useful.
918
919Example: Create a watcher for the IO::AIO module and store it in
920C<$WATCHER>. Only do so after the event loop is initialised, though.
921
922 our WATCHER;
923
924 my $guard = AnyEvent::post_detect {
925 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
926 };
927
928 # the ||= is important in case post_detect immediately runs the block,
929 # as to not clobber the newly-created watcher. assigning both watcher and
930 # post_detect guard to the same variable has the advantage of users being
931 # able to just C<undef $WATCHER> if the watcher causes them grief.
932
933 $WATCHER ||= $guard;
820 934
821=item @AnyEvent::post_detect 935=item @AnyEvent::post_detect
822 936
823If there are any code references in this array (you can C<push> to it 937If there are any code references in this array (you can C<push> to it
824before or after loading AnyEvent), then they will called directly after 938before or after loading AnyEvent), then they will called directly after
825the event loop has been chosen. 939the event loop has been chosen.
826 940
827You should check C<$AnyEvent::MODEL> before adding to this array, though: 941You should check C<$AnyEvent::MODEL> before adding to this array, though:
828if it contains a true value then the event loop has already been detected, 942if it is defined then the event loop has already been detected, and the
829and the array will be ignored. 943array will be ignored.
830 944
831Best use C<AnyEvent::post_detect { BLOCK }> instead. 945Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946it,as it takes care of these details.
947
948This variable is mainly useful for modules that can do something useful
949when AnyEvent is used and thus want to know when it is initialised, but do
950not need to even load it by default. This array provides the means to hook
951into AnyEvent passively, without loading it.
832 952
833=back 953=back
834 954
835=head1 WHAT TO DO IN A MODULE 955=head1 WHAT TO DO IN A MODULE
836 956
891 1011
892 1012
893=head1 OTHER MODULES 1013=head1 OTHER MODULES
894 1014
895The following is a non-exhaustive list of additional modules that use 1015The following is a non-exhaustive list of additional modules that use
896AnyEvent and can therefore be mixed easily with other AnyEvent modules 1016AnyEvent as a client and can therefore be mixed easily with other AnyEvent
897in the same program. Some of the modules come with AnyEvent, some are 1017modules and other event loops in the same program. Some of the modules
898available via CPAN. 1018come with AnyEvent, most are available via CPAN.
899 1019
900=over 4 1020=over 4
901 1021
902=item L<AnyEvent::Util> 1022=item L<AnyEvent::Util>
903 1023
912 1032
913=item L<AnyEvent::Handle> 1033=item L<AnyEvent::Handle>
914 1034
915Provide read and write buffers, manages watchers for reads and writes, 1035Provide read and write buffers, manages watchers for reads and writes,
916supports raw and formatted I/O, I/O queued and fully transparent and 1036supports raw and formatted I/O, I/O queued and fully transparent and
917non-blocking SSL/TLS. 1037non-blocking SSL/TLS (via L<AnyEvent::TLS>.
918 1038
919=item L<AnyEvent::DNS> 1039=item L<AnyEvent::DNS>
920 1040
921Provides rich asynchronous DNS resolver capabilities. 1041Provides rich asynchronous DNS resolver capabilities.
922 1042
950 1070
951=item L<AnyEvent::GPSD> 1071=item L<AnyEvent::GPSD>
952 1072
953A non-blocking interface to gpsd, a daemon delivering GPS information. 1073A non-blocking interface to gpsd, a daemon delivering GPS information.
954 1074
1075=item L<AnyEvent::IRC>
1076
1077AnyEvent based IRC client module family (replacing the older Net::IRC3).
1078
1079=item L<AnyEvent::XMPP>
1080
1081AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1082Net::XMPP2>.
1083
955=item L<AnyEvent::IGS> 1084=item L<AnyEvent::IGS>
956 1085
957A non-blocking interface to the Internet Go Server protocol (used by 1086A non-blocking interface to the Internet Go Server protocol (used by
958L<App::IGS>). 1087L<App::IGS>).
959 1088
960=item L<AnyEvent::IRC>
961
962AnyEvent based IRC client module family (replacing the older Net::IRC3).
963
964=item L<Net::XMPP2>
965
966AnyEvent based XMPP (Jabber protocol) module family.
967
968=item L<Net::FCP> 1089=item L<Net::FCP>
969 1090
970AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1091AnyEvent-based implementation of the Freenet Client Protocol, birthplace
971of AnyEvent. 1092of AnyEvent.
972 1093
976 1097
977=item L<Coro> 1098=item L<Coro>
978 1099
979Has special support for AnyEvent via L<Coro::AnyEvent>. 1100Has special support for AnyEvent via L<Coro::AnyEvent>.
980 1101
981=item L<IO::Lambda>
982
983The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
984
985=back 1102=back
986 1103
987=cut 1104=cut
988 1105
989package AnyEvent; 1106package AnyEvent;
990 1107
1108# basically a tuned-down version of common::sense
1109sub common_sense {
991no warnings; 1110 # no warnings
1111 ${^WARNING_BITS} ^= ${^WARNING_BITS};
992use strict qw(vars subs); 1112 # use strict vars subs
1113 $^H |= 0x00000600;
1114}
993 1115
1116BEGIN { AnyEvent::common_sense }
1117
994use Carp; 1118use Carp ();
995 1119
996our $VERSION = 4.8; 1120our $VERSION = 4.881;
997our $MODEL; 1121our $MODEL;
998 1122
999our $AUTOLOAD; 1123our $AUTOLOAD;
1000our @ISA; 1124our @ISA;
1001 1125
1002our @REGISTRY; 1126our @REGISTRY;
1003 1127
1004our $WIN32; 1128our $WIN32;
1129
1130our $VERBOSE;
1005 1131
1006BEGIN { 1132BEGIN {
1007 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1133 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1008 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1134 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
1009 1135
1010 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1136 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1011 if ${^TAINT}; 1137 if ${^TAINT};
1012}
1013 1138
1014our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1139 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1140
1141}
1142
1143our $MAX_SIGNAL_LATENCY = 10;
1015 1144
1016our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1145our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1017 1146
1018{ 1147{
1019 my $idx; 1148 my $idx;
1021 for reverse split /\s*,\s*/, 1150 for reverse split /\s*,\s*/,
1022 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1023} 1152}
1024 1153
1025my @models = ( 1154my @models = (
1026 [EV:: => AnyEvent::Impl::EV::], 1155 [EV:: => AnyEvent::Impl::EV:: , 1],
1027 [Event:: => AnyEvent::Impl::Event::], 1156 [Event:: => AnyEvent::Impl::Event::, 1],
1028 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1157 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1029 # everything below here will not be autoprobed 1158 # everything below here will not (normally) be autoprobed
1030 # as the pureperl backend should work everywhere 1159 # as the pureperl backend should work everywhere
1031 # and is usually faster 1160 # and is usually faster
1161 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1032 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1164 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1033 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1034 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1035 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1036 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1166 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1037 [Wx:: => AnyEvent::Impl::POE::], 1167 [Wx:: => AnyEvent::Impl::POE::],
1038 [Prima:: => AnyEvent::Impl::POE::], 1168 [Prima:: => AnyEvent::Impl::POE::],
1039 # IO::Async is just too broken - we would need workaorunds for its 1169 # IO::Async is just too broken - we would need workarounds for its
1040 # byzantine signal and broken child handling, among others. 1170 # byzantine signal and broken child handling, among others.
1041 # IO::Async is rather hard to detect, as it doesn't have any 1171 # IO::Async is rather hard to detect, as it doesn't have any
1042 # obvious default class. 1172 # obvious default class.
1043# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1173# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1044# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1174# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1045# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1175# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1046); 1176);
1047 1177
1048our %method = map +($_ => 1), 1178our %method = map +($_ => 1),
1049 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1179 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1050 1180
1054 my ($cb) = @_; 1184 my ($cb) = @_;
1055 1185
1056 if ($MODEL) { 1186 if ($MODEL) {
1057 $cb->(); 1187 $cb->();
1058 1188
1059 1 1189 undef
1060 } else { 1190 } else {
1061 push @post_detect, $cb; 1191 push @post_detect, $cb;
1062 1192
1063 defined wantarray 1193 defined wantarray
1064 ? bless \$cb, "AnyEvent::Util::postdetect" 1194 ? bless \$cb, "AnyEvent::Util::postdetect"
1070 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1200 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1071} 1201}
1072 1202
1073sub detect() { 1203sub detect() {
1074 unless ($MODEL) { 1204 unless ($MODEL) {
1075 no strict 'refs';
1076 local $SIG{__DIE__}; 1205 local $SIG{__DIE__};
1077 1206
1078 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1207 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1079 my $model = "AnyEvent::Impl::$1"; 1208 my $model = "AnyEvent::Impl::$1";
1080 if (eval "require $model") { 1209 if (eval "require $model") {
1081 $MODEL = $model; 1210 $MODEL = $model;
1082 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1211 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1083 } else { 1212 } else {
1084 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1213 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1085 } 1214 }
1086 } 1215 }
1087 1216
1088 # check for already loaded models 1217 # check for already loaded models
1089 unless ($MODEL) { 1218 unless ($MODEL) {
1090 for (@REGISTRY, @models) { 1219 for (@REGISTRY, @models) {
1091 my ($package, $model) = @$_; 1220 my ($package, $model) = @$_;
1092 if (${"$package\::VERSION"} > 0) { 1221 if (${"$package\::VERSION"} > 0) {
1093 if (eval "require $model") { 1222 if (eval "require $model") {
1094 $MODEL = $model; 1223 $MODEL = $model;
1095 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1224 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1096 last; 1225 last;
1097 } 1226 }
1098 } 1227 }
1099 } 1228 }
1100 1229
1101 unless ($MODEL) { 1230 unless ($MODEL) {
1102 # try to load a model 1231 # try to autoload a model
1103
1104 for (@REGISTRY, @models) { 1232 for (@REGISTRY, @models) {
1105 my ($package, $model) = @$_; 1233 my ($package, $model, $autoload) = @$_;
1234 if (
1235 $autoload
1106 if (eval "require $package" 1236 and eval "require $package"
1107 and ${"$package\::VERSION"} > 0 1237 and ${"$package\::VERSION"} > 0
1108 and eval "require $model") { 1238 and eval "require $model"
1239 ) {
1109 $MODEL = $model; 1240 $MODEL = $model;
1110 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1241 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1111 last; 1242 last;
1112 } 1243 }
1113 } 1244 }
1114 1245
1115 $MODEL 1246 $MODEL
1131 1262
1132sub AUTOLOAD { 1263sub AUTOLOAD {
1133 (my $func = $AUTOLOAD) =~ s/.*://; 1264 (my $func = $AUTOLOAD) =~ s/.*://;
1134 1265
1135 $method{$func} 1266 $method{$func}
1136 or croak "$func: not a valid method for AnyEvent objects"; 1267 or Carp::croak "$func: not a valid method for AnyEvent objects";
1137 1268
1138 detect unless $MODEL; 1269 detect unless $MODEL;
1139 1270
1140 my $class = shift; 1271 my $class = shift;
1141 $class->$func (@_); 1272 $class->$func (@_);
1146# allow only one watcher per fd, so we dup it to get a different one). 1277# allow only one watcher per fd, so we dup it to get a different one).
1147sub _dupfh($$;$$) { 1278sub _dupfh($$;$$) {
1148 my ($poll, $fh, $r, $w) = @_; 1279 my ($poll, $fh, $r, $w) = @_;
1149 1280
1150 # cygwin requires the fh mode to be matching, unix doesn't 1281 # cygwin requires the fh mode to be matching, unix doesn't
1151 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1282 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1152 : $poll eq "w" ? ($w, ">")
1153 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1154 1283
1155 open my $fh2, "$mode&" . fileno $fh 1284 open my $fh2, $mode, $fh
1156 or die "cannot dup() filehandle: $!,"; 1285 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1157 1286
1158 # we assume CLOEXEC is already set by perl in all important cases 1287 # we assume CLOEXEC is already set by perl in all important cases
1159 1288
1160 ($fh2, $rw) 1289 ($fh2, $rw)
1161} 1290}
1162 1291
1163package AnyEvent::Base; 1292package AnyEvent::Base;
1164 1293
1165# default implementations for many methods 1294# default implementations for many methods
1166 1295
1167BEGIN { 1296sub _time {
1297 # probe for availability of Time::HiRes
1168 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1298 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1299 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1169 *_time = \&Time::HiRes::time; 1300 *_time = \&Time::HiRes::time;
1170 # if (eval "use POSIX (); (POSIX::times())... 1301 # if (eval "use POSIX (); (POSIX::times())...
1171 } else { 1302 } else {
1303 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1172 *_time = sub { time }; # epic fail 1304 *_time = sub { time }; # epic fail
1173 } 1305 }
1306
1307 &_time
1174} 1308}
1175 1309
1176sub time { _time } 1310sub time { _time }
1177sub now { _time } 1311sub now { _time }
1178sub now_update { } 1312sub now_update { }
1183 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1317 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1184} 1318}
1185 1319
1186# default implementation for ->signal 1320# default implementation for ->signal
1187 1321
1322our $HAVE_ASYNC_INTERRUPT;
1323
1324sub _have_async_interrupt() {
1325 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1326 && eval "use Async::Interrupt 1.0 (); 1")
1327 unless defined $HAVE_ASYNC_INTERRUPT;
1328
1329 $HAVE_ASYNC_INTERRUPT
1330}
1331
1188our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1332our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1333our (%SIG_ASY, %SIG_ASY_W);
1334our ($SIG_COUNT, $SIG_TW);
1189 1335
1190sub _signal_exec { 1336sub _signal_exec {
1337 $HAVE_ASYNC_INTERRUPT
1338 ? $SIGPIPE_R->drain
1191 sysread $SIGPIPE_R, my $dummy, 4; 1339 : sysread $SIGPIPE_R, my $dummy, 9;
1192 1340
1193 while (%SIG_EV) { 1341 while (%SIG_EV) {
1194 for (keys %SIG_EV) { 1342 for (keys %SIG_EV) {
1195 delete $SIG_EV{$_}; 1343 delete $SIG_EV{$_};
1196 $_->() for values %{ $SIG_CB{$_} || {} }; 1344 $_->() for values %{ $SIG_CB{$_} || {} };
1197 } 1345 }
1198 } 1346 }
1199} 1347}
1200 1348
1349# install a dummy wakeup watcher to reduce signal catching latency
1350sub _sig_add() {
1351 unless ($SIG_COUNT++) {
1352 # try to align timer on a full-second boundary, if possible
1353 my $NOW = AnyEvent->now;
1354
1355 $SIG_TW = AnyEvent->timer (
1356 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1357 interval => $MAX_SIGNAL_LATENCY,
1358 cb => sub { }, # just for the PERL_ASYNC_CHECK
1359 );
1360 }
1361}
1362
1363sub _sig_del {
1364 undef $SIG_TW
1365 unless --$SIG_COUNT;
1366}
1367
1368our $_sig_name_init; $_sig_name_init = sub {
1369 eval q{ # poor man's autoloading
1370 undef $_sig_name_init;
1371
1372 if (_have_async_interrupt) {
1373 *sig2num = \&Async::Interrupt::sig2num;
1374 *sig2name = \&Async::Interrupt::sig2name;
1375 } else {
1376 require Config;
1377
1378 my %signame2num;
1379 @signame2num{ split ' ', $Config::Config{sig_name} }
1380 = split ' ', $Config::Config{sig_num};
1381
1382 my @signum2name;
1383 @signum2name[values %signame2num] = keys %signame2num;
1384
1385 *sig2num = sub($) {
1386 $_[0] > 0 ? shift : $signame2num{+shift}
1387 };
1388 *sig2name = sub ($) {
1389 $_[0] > 0 ? $signum2name[+shift] : shift
1390 };
1391 }
1392 };
1393 die if $@;
1394};
1395
1396sub sig2num ($) { &$_sig_name_init; &sig2num }
1397sub sig2name($) { &$_sig_name_init; &sig2name }
1398
1201sub signal { 1399sub signal {
1202 my (undef, %arg) = @_; 1400 eval q{ # poor man's autoloading {}
1401 # probe for availability of Async::Interrupt
1402 if (_have_async_interrupt) {
1403 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1203 1404
1204 unless ($SIGPIPE_R) { 1405 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1205 require Fcntl; 1406 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1206 1407
1207 if (AnyEvent::WIN32) {
1208 require AnyEvent::Util;
1209
1210 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1211 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1212 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1213 } else { 1408 } else {
1409 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1410
1411 require Fcntl;
1412
1413 if (AnyEvent::WIN32) {
1414 require AnyEvent::Util;
1415
1416 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1417 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1418 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1419 } else {
1214 pipe $SIGPIPE_R, $SIGPIPE_W; 1420 pipe $SIGPIPE_R, $SIGPIPE_W;
1215 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1421 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1216 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1422 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1217 1423
1218 # not strictly required, as $^F is normally 2, but let's make sure... 1424 # not strictly required, as $^F is normally 2, but let's make sure...
1219 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1425 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1220 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1426 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1427 }
1428
1429 $SIGPIPE_R
1430 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1431
1432 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1221 } 1433 }
1222 1434
1223 $SIGPIPE_R 1435 *signal = sub {
1224 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1436 my (undef, %arg) = @_;
1225 1437
1226 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1227 }
1228
1229 my $signal = uc $arg{signal} 1438 my $signal = uc $arg{signal}
1230 or Carp::croak "required option 'signal' is missing"; 1439 or Carp::croak "required option 'signal' is missing";
1231 1440
1441 if ($HAVE_ASYNC_INTERRUPT) {
1442 # async::interrupt
1443
1444 $signal = sig2num $signal;
1232 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1445 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1446
1447 $SIG_ASY{$signal} ||= new Async::Interrupt
1448 cb => sub { undef $SIG_EV{$signal} },
1449 signal => $signal,
1450 pipe => [$SIGPIPE_R->filenos],
1451 pipe_autodrain => 0,
1452 ;
1453
1454 } else {
1455 # pure perl
1456
1457 # AE::Util has been loaded in signal
1458 $signal = sig2name $signal;
1459 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1460
1233 $SIG{$signal} ||= sub { 1461 $SIG{$signal} ||= sub {
1234 local $!; 1462 local $!;
1235 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1463 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1236 undef $SIG_EV{$signal}; 1464 undef $SIG_EV{$signal};
1465 };
1466
1467 # can't do signal processing without introducing races in pure perl,
1468 # so limit the signal latency.
1469 _sig_add;
1470 }
1471
1472 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1473 };
1474
1475 *AnyEvent::Base::signal::DESTROY = sub {
1476 my ($signal, $cb) = @{$_[0]};
1477
1478 _sig_del;
1479
1480 delete $SIG_CB{$signal}{$cb};
1481
1482 $HAVE_ASYNC_INTERRUPT
1483 ? delete $SIG_ASY{$signal}
1484 : # delete doesn't work with older perls - they then
1485 # print weird messages, or just unconditionally exit
1486 # instead of getting the default action.
1487 undef $SIG{$signal}
1488 unless keys %{ $SIG_CB{$signal} };
1489 };
1237 }; 1490 };
1238 1491 die if $@;
1239 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1492 &signal
1240}
1241
1242sub AnyEvent::Base::signal::DESTROY {
1243 my ($signal, $cb) = @{$_[0]};
1244
1245 delete $SIG_CB{$signal}{$cb};
1246
1247 # delete doesn't work with older perls - they then
1248 # print weird messages, or just unconditionally exit
1249 # instead of getting the default action.
1250 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1251} 1493}
1252 1494
1253# default implementation for ->child 1495# default implementation for ->child
1254 1496
1255our %PID_CB; 1497our %PID_CB;
1256our $CHLD_W; 1498our $CHLD_W;
1257our $CHLD_DELAY_W; 1499our $CHLD_DELAY_W;
1258our $WNOHANG; 1500our $WNOHANG;
1259 1501
1502sub _emit_childstatus($$) {
1503 my (undef, $rpid, $rstatus) = @_;
1504
1505 $_->($rpid, $rstatus)
1506 for values %{ $PID_CB{$rpid} || {} },
1507 values %{ $PID_CB{0} || {} };
1508}
1509
1260sub _sigchld { 1510sub _sigchld {
1511 my $pid;
1512
1513 AnyEvent->_emit_childstatus ($pid, $?)
1261 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1514 while ($pid = waitpid -1, $WNOHANG) > 0;
1262 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1263 (values %{ $PID_CB{0} || {} });
1264 }
1265} 1515}
1266 1516
1267sub child { 1517sub child {
1268 my (undef, %arg) = @_; 1518 my (undef, %arg) = @_;
1269 1519
1270 defined (my $pid = $arg{pid} + 0) 1520 defined (my $pid = $arg{pid} + 0)
1271 or Carp::croak "required option 'pid' is missing"; 1521 or Carp::croak "required option 'pid' is missing";
1272 1522
1273 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1523 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1274 1524
1525 # WNOHANG is almost cetrainly 1 everywhere
1526 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1527 ? 1
1275 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1528 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1276 1529
1277 unless ($CHLD_W) { 1530 unless ($CHLD_W) {
1278 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1531 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1279 # child could be a zombie already, so make at least one round 1532 # child could be a zombie already, so make at least one round
1280 &_sigchld; 1533 &_sigchld;
1332 1585
1333our @ISA = AnyEvent::CondVar::Base::; 1586our @ISA = AnyEvent::CondVar::Base::;
1334 1587
1335package AnyEvent::CondVar::Base; 1588package AnyEvent::CondVar::Base;
1336 1589
1337use overload 1590#use overload
1338 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1591# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1339 fallback => 1; 1592# fallback => 1;
1593
1594# save 300+ kilobytes by dirtily hardcoding overloading
1595${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1596*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1597*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1598${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1599
1600our $WAITING;
1340 1601
1341sub _send { 1602sub _send {
1342 # nop 1603 # nop
1343} 1604}
1344 1605
1357sub ready { 1618sub ready {
1358 $_[0]{_ae_sent} 1619 $_[0]{_ae_sent}
1359} 1620}
1360 1621
1361sub _wait { 1622sub _wait {
1623 $WAITING
1624 and !$_[0]{_ae_sent}
1625 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1626
1627 local $WAITING = 1;
1362 AnyEvent->one_event while !$_[0]{_ae_sent}; 1628 AnyEvent->one_event while !$_[0]{_ae_sent};
1363} 1629}
1364 1630
1365sub recv { 1631sub recv {
1366 $_[0]->_wait; 1632 $_[0]->_wait;
1385} 1651}
1386 1652
1387# undocumented/compatibility with pre-3.4 1653# undocumented/compatibility with pre-3.4
1388*broadcast = \&send; 1654*broadcast = \&send;
1389*wait = \&_wait; 1655*wait = \&_wait;
1656
1657#############################################################################
1658# "new" API, currently only emulation of it
1659#############################################################################
1660
1661package AE;
1662
1663sub io($$$) {
1664 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1665}
1666
1667sub timer($$$) {
1668 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1669}
1670
1671sub signal($$) {
1672 AnyEvent->signal (signal => $_[0], cb => $_[1]);
1673}
1674
1675sub child($$) {
1676 AnyEvent->child (pid => $_[0], cb => $_[1]);
1677}
1678
1679sub idle($) {
1680 AnyEvent->idle (cb => $_[0]);
1681}
1682
1683sub cv() {
1684 AnyEvent->condvar
1685}
1686
1687sub now() {
1688 AnyEvent->now
1689}
1690
1691sub now_update() {
1692 AnyEvent->now_update
1693}
1694
1695sub time() {
1696 AnyEvent->time
1697}
1390 1698
1391=head1 ERROR AND EXCEPTION HANDLING 1699=head1 ERROR AND EXCEPTION HANDLING
1392 1700
1393In general, AnyEvent does not do any error handling - it relies on the 1701In general, AnyEvent does not do any error handling - it relies on the
1394caller to do that if required. The L<AnyEvent::Strict> module (see also 1702caller to do that if required. The L<AnyEvent::Strict> module (see also
1428C<PERL_ANYEVENT_MODEL>. 1736C<PERL_ANYEVENT_MODEL>.
1429 1737
1430When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1738When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1431model it chooses. 1739model it chooses.
1432 1740
1741When set to C<8> or higher, then AnyEvent will report extra information on
1742which optional modules it loads and how it implements certain features.
1743
1433=item C<PERL_ANYEVENT_STRICT> 1744=item C<PERL_ANYEVENT_STRICT>
1434 1745
1435AnyEvent does not do much argument checking by default, as thorough 1746AnyEvent does not do much argument checking by default, as thorough
1436argument checking is very costly. Setting this variable to a true value 1747argument checking is very costly. Setting this variable to a true value
1437will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1748will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1438check the arguments passed to most method calls. If it finds any problems, 1749check the arguments passed to most method calls. If it finds any problems,
1439it will croak. 1750it will croak.
1440 1751
1441In other words, enables "strict" mode. 1752In other words, enables "strict" mode.
1442 1753
1443Unlike C<use strict>, it is definitely recommended to keep it off in 1754Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1444production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1755>>, it is definitely recommended to keep it off in production. Keeping
1445developing programs can be very useful, however. 1756C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1757can be very useful, however.
1446 1758
1447=item C<PERL_ANYEVENT_MODEL> 1759=item C<PERL_ANYEVENT_MODEL>
1448 1760
1449This can be used to specify the event model to be used by AnyEvent, before 1761This can be used to specify the event model to be used by AnyEvent, before
1450auto detection and -probing kicks in. It must be a string consisting 1762auto detection and -probing kicks in. It must be a string consisting
1512 1824
1513When neither C<ca_file> nor C<ca_path> was specified during 1825When neither C<ca_file> nor C<ca_path> was specified during
1514L<AnyEvent::TLS> context creation, and either of these environment 1826L<AnyEvent::TLS> context creation, and either of these environment
1515variables exist, they will be used to specify CA certificate locations 1827variables exist, they will be used to specify CA certificate locations
1516instead of a system-dependent default. 1828instead of a system-dependent default.
1829
1830=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1831
1832When these are set to C<1>, then the respective modules are not
1833loaded. Mostly good for testing AnyEvent itself.
1517 1834
1518=back 1835=back
1519 1836
1520=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1837=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1521 1838
2060 2377
2061A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2378A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2062emulation for event loops that do not support them natively. Also, some 2379emulation for event loops that do not support them natively. Also, some
2063event loops install a similar handler. 2380event loops install a similar handler.
2064 2381
2065If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will 2382Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2066reset it to default, to avoid losing child exit statuses. 2383AnyEvent will reset it to default, to avoid losing child exit statuses.
2067 2384
2068=item SIGPIPE 2385=item SIGPIPE
2069 2386
2070A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2387A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2071when AnyEvent gets loaded. 2388when AnyEvent gets loaded.
2089 if $SIG{CHLD} eq 'IGNORE'; 2406 if $SIG{CHLD} eq 'IGNORE';
2090 2407
2091$SIG{PIPE} = sub { } 2408$SIG{PIPE} = sub { }
2092 unless defined $SIG{PIPE}; 2409 unless defined $SIG{PIPE};
2093 2410
2411=head1 RECOMMENDED/OPTIONAL MODULES
2412
2413One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2414it's built-in modules) are required to use it.
2415
2416That does not mean that AnyEvent won't take advantage of some additional
2417modules if they are installed.
2418
2419This section epxlains which additional modules will be used, and how they
2420affect AnyEvent's operetion.
2421
2422=over 4
2423
2424=item L<Async::Interrupt>
2425
2426This slightly arcane module is used to implement fast signal handling: To
2427my knowledge, there is no way to do completely race-free and quick
2428signal handling in pure perl. To ensure that signals still get
2429delivered, AnyEvent will start an interval timer to wake up perl (and
2430catch the signals) with some delay (default is 10 seconds, look for
2431C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2432
2433If this module is available, then it will be used to implement signal
2434catching, which means that signals will not be delayed, and the event loop
2435will not be interrupted regularly, which is more efficient (And good for
2436battery life on laptops).
2437
2438This affects not just the pure-perl event loop, but also other event loops
2439that have no signal handling on their own (e.g. Glib, Tk, Qt).
2440
2441Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2442and either employ their own workarounds (POE) or use AnyEvent's workaround
2443(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2444does nothing for those backends.
2445
2446=item L<EV>
2447
2448This module isn't really "optional", as it is simply one of the backend
2449event loops that AnyEvent can use. However, it is simply the best event
2450loop available in terms of features, speed and stability: It supports
2451the AnyEvent API optimally, implements all the watcher types in XS, does
2452automatic timer adjustments even when no monotonic clock is available,
2453can take avdantage of advanced kernel interfaces such as C<epoll> and
2454C<kqueue>, and is the fastest backend I<by far>. You can even embed
2455L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2456
2457=item L<Guard>
2458
2459The guard module, when used, will be used to implement
2460C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2461lot less memory), but otherwise doesn't affect guard operation much. It is
2462purely used for performance.
2463
2464=item L<JSON> and L<JSON::XS>
2465
2466This module is required when you want to read or write JSON data via
2467L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2468advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2469
2470In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2471installed.
2472
2473=item L<Net::SSLeay>
2474
2475Implementing TLS/SSL in Perl is certainly interesting, but not very
2476worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2477the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2478
2479=item L<Time::HiRes>
2480
2481This module is part of perl since release 5.008. It will be used when the
2482chosen event library does not come with a timing source on it's own. The
2483pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2484try to use a monotonic clock for timing stability.
2485
2486=back
2487
2488
2094=head1 FORK 2489=head1 FORK
2095 2490
2096Most event libraries are not fork-safe. The ones who are usually are 2491Most event libraries are not fork-safe. The ones who are usually are
2097because they rely on inefficient but fork-safe C<select> or C<poll> 2492because they rely on inefficient but fork-safe C<select> or C<poll>
2098calls. Only L<EV> is fully fork-aware. 2493calls. Only L<EV> is fully fork-aware.
2099 2494
2100If you have to fork, you must either do so I<before> creating your first 2495If you have to fork, you must either do so I<before> creating your first
2101watcher OR you must not use AnyEvent at all in the child. 2496watcher OR you must not use AnyEvent at all in the child OR you must do
2497something completely out of the scope of AnyEvent.
2102 2498
2103 2499
2104=head1 SECURITY CONSIDERATIONS 2500=head1 SECURITY CONSIDERATIONS
2105 2501
2106AnyEvent can be forced to load any event model via 2502AnyEvent can be forced to load any event model via
2144L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2540L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2145 2541
2146Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2542Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2147L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2543L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2148L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2544L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2149L<AnyEvent::Impl::POE>. 2545L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2150 2546
2151Non-blocking file handles, sockets, TCP clients and 2547Non-blocking file handles, sockets, TCP clients and
2152servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2548servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2153 2549
2154Asynchronous DNS: L<AnyEvent::DNS>. 2550Asynchronous DNS: L<AnyEvent::DNS>.
2155 2551
2156Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2552Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2553L<Coro::Event>,
2157 2554
2158Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2555Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2556L<AnyEvent::HTTP>.
2159 2557
2160 2558
2161=head1 AUTHOR 2559=head1 AUTHOR
2162 2560
2163 Marc Lehmann <schmorp@schmorp.de> 2561 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines