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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines