[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.223 by root, Mon Jun 29 21:00:32 2009 UTC vs.
Revision 1.258 by root, Sun Jul 26 05:57:05 2009 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6	event loops.	6	and 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
42	This manpage is mainly a reference manual. If you are interested	42	This manpage is mainly a reference manual. If you are interested
43	in a tutorial or some gentle introduction, have a look at the	43	in a tutorial or some gentle introduction, have a look at the
44	L<AnyEvent::Intro> manpage.	44	L<AnyEvent::Intro> manpage.
		45
		46	=head1 SUPPORT
		47
		48	There is a mailinglist for discussing all things AnyEvent, and an IRC
		49	channel, too.
		50
		51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		52	Repository>, 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
48	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
176	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
177		185
178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	186	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179	with the following mandatory key-value pairs as arguments:	187	with the following mandatory key-value pairs as arguments:
180		188
181	C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch	189	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182	for events (AnyEvent might or might not keep a reference to this file	190	for events (AnyEvent might or might not keep a reference to this file
183	handle). Note that only file handles pointing to things for which	191	handle). Note that only file handles pointing to things for which
184	non-blocking operation makes sense are allowed. This includes sockets,	192	non-blocking operation makes sense are allowed. This includes sockets,
185	most character devices, pipes, fifos and so on, but not for example files	193	most character devices, pipes, fifos and so on, but not for example files
186	or block devices.	194	or block devices.
…		…
361	invocation, and callback invocation will be synchronous. Synchronous means	369	invocation, and callback invocation will be synchronous. Synchronous means
362	that it might take a while until the signal gets handled by the process,	370	that it might take a while until the signal gets handled by the process,
363	but it is guaranteed not to interrupt any other callbacks.	371	but it is guaranteed not to interrupt any other callbacks.
364		372
365	The main advantage of using these watchers is that you can share a signal	373	The main advantage of using these watchers is that you can share a signal
366	between multiple watchers.	374	between multiple watchers, and AnyEvent will ensure that signals will not
		375	interrupt your program at bad times.
367		376
368	This watcher might use C<%SIG>, so programs overwriting those signals	377	This watcher might use C<%SIG> (depending on the event loop used),
369	directly will likely not work correctly.	378	so programs overwriting those signals directly will likely not work
		379	correctly.
370		380
371	Example: exit on SIGINT	381	Example: exit on SIGINT
372		382
373	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
374		384
		385	=head3 Signal Races, Delays and Workarounds
		386
		387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		388	callbacks to signals in a generic way, which is a pity, as you cannot do
		389	race-free signal handling in perl. AnyEvent will try to do it's best, but
		390	in some cases, signals will be delayed. The maximum time a signal might
		391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
		392	seconds). This variable can be changed only before the first signal
		393	watcher is created, and should be left alone otherwise. Higher values
		394	will cause fewer spurious wake-ups, which is better for power and CPU
		395	saving. All these problems can be avoided by installing the optional
		396	L<Async::Interrupt> module. This will not work with inherently broken
		397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
		398	currently, as POE does it's own workaround with one-second latency). With
		399	those, you just have to suffer the delays.
		400
375	=head2 CHILD PROCESS WATCHERS	401	=head2 CHILD PROCESS WATCHERS
376		402
377	You can also watch on a child process exit and catch its exit status.	403	You can also watch on a child process exit and catch its exit status.
378		404
379	The child process is specified by the C<pid> argument (if set to C<0>, it	405	The child process is specified by the C<pid> argument (one some backends,
380	watches for any child process exit). The watcher will triggered only when	406	using C<0> watches for any child process exit, on others this will
381	the child process has finished and an exit status is available, not on	407	croak). The watcher will be triggered only when the child process has
382	any trace events (stopped/continued).	408	finished and an exit status is available, not on any trace events
		409	(stopped/continued).
383		410
384	The callback will be called with the pid and exit status (as returned by	411	The callback will be called with the pid and exit status (as returned by
385	waitpid), so unlike other watcher types, you I<can> rely on child watcher	412	waitpid), so unlike other watcher types, you I<can> rely on child watcher
386	callback arguments.	413	callback arguments.
387		414
…		…
403		430
404	This means you cannot create a child watcher as the very first	431	This means you cannot create a child watcher as the very first
405	thing in an AnyEvent program, you I<have> to create at least one	432	thing in an AnyEvent program, you I<have> to create at least one
406	watcher before you C<fork> the child (alternatively, you can call	433	watcher before you C<fork> the child (alternatively, you can call
407	C<AnyEvent::detect>).	434	C<AnyEvent::detect>).
		435
		436	As most event loops do not support waiting for child events, they will be
		437	emulated by AnyEvent in most cases, in which the latency and race problems
		438	mentioned in the description of signal watchers apply.
408		439
409	Example: fork a process and wait for it	440	Example: fork a process and wait for it
410		441
411	my $done = AnyEvent->condvar;	442	my $done = AnyEvent->condvar;
412		443
…		…
463		494
464	If you are familiar with some event loops you will know that all of them	495	If you are familiar with some event loops you will know that all of them
465	require you to run some blocking "loop", "run" or similar function that	496	require you to run some blocking "loop", "run" or similar function that
466	will actively watch for new events and call your callbacks.	497	will actively watch for new events and call your callbacks.
467		498
468	AnyEvent is different, it expects somebody else to run the event loop and	499	AnyEvent is slightly different: it expects somebody else to run the event
469	will only block when necessary (usually when told by the user).	500	loop and will only block when necessary (usually when told by the user).
470		501
471	The instrument to do that is called a "condition variable", so called	502	The instrument to do that is called a "condition variable", so called
472	because they represent a condition that must become true.	503	because they represent a condition that must become true.
473		504
		505	Now is probably a good time to look at the examples further below.
		506
474	Condition variables can be created by calling the C<< AnyEvent->condvar	507	Condition variables can be created by calling the C<< AnyEvent->condvar
475	>> method, usually without arguments. The only argument pair allowed is	508	>> method, usually without arguments. The only argument pair allowed is
476
477	C<cb>, which specifies a callback to be called when the condition variable	509	C<cb>, which specifies a callback to be called when the condition variable
478	becomes true, with the condition variable as the first argument (but not	510	becomes true, with the condition variable as the first argument (but not
479	the results).	511	the results).
480		512
481	After creation, the condition variable is "false" until it becomes "true"	513	After creation, the condition variable is "false" until it becomes "true"
…		…
486	Condition variables are similar to callbacks, except that you can	518	Condition variables are similar to callbacks, except that you can
487	optionally wait for them. They can also be called merge points - points	519	optionally wait for them. They can also be called merge points - points
488	in time where multiple outstanding events have been processed. And yet	520	in time where multiple outstanding events have been processed. And yet
489	another way to call them is transactions - each condition variable can be	521	another way to call them is transactions - each condition variable can be
490	used to represent a transaction, which finishes at some point and delivers	522	used to represent a transaction, which finishes at some point and delivers
491	a result.	523	a result. And yet some people know them as "futures" - a promise to
		524	compute/deliver something that you can wait for.
492		525
493	Condition variables are very useful to signal that something has finished,	526	Condition variables are very useful to signal that something has finished,
494	for example, if you write a module that does asynchronous http requests,	527	for example, if you write a module that does asynchronous http requests,
495	then a condition variable would be the ideal candidate to signal the	528	then a condition variable would be the ideal candidate to signal the
496	availability of results. The user can either act when the callback is	529	availability of results. The user can either act when the callback is
…		…
530	after => 1,	563	after => 1,
531	cb => sub { $result_ready->send },	564	cb => sub { $result_ready->send },
532	);	565	);
533		566
534	# this "blocks" (while handling events) till the callback	567	# this "blocks" (while handling events) till the callback
535	# calls send	568	# calls -<send
536	$result_ready->recv;	569	$result_ready->recv;
537		570
538	Example: wait for a timer, but take advantage of the fact that	571	Example: wait for a timer, but take advantage of the fact that condition
539	condition variables are also code references.	572	variables are also callable directly.
540		573
541	my $done = AnyEvent->condvar;	574	my $done = AnyEvent->condvar;
542	my $delay = AnyEvent->timer (after => 5, cb => $done);	575	my $delay = AnyEvent->timer (after => 5, cb => $done);
543	$done->recv;	576	$done->recv;
544		577
…		…
550		583
551	...	584	...
552		585
553	my @info = $couchdb->info->recv;	586	my @info = $couchdb->info->recv;
554		587
555	And this is how you would just ste a callback to be called whenever the	588	And this is how you would just set a callback to be called whenever the
556	results are available:	589	results are available:
557		590
558	$couchdb->info->cb (sub {	591	$couchdb->info->cb (sub {
559	my @info = $_[0]->recv;	592	my @info = $_[0]->recv;
560	});	593	});
…		…
578	immediately from within send.	611	immediately from within send.
579		612
580	Any arguments passed to the C<send> call will be returned by all	613	Any arguments passed to the C<send> call will be returned by all
581	future C<< ->recv >> calls.	614	future C<< ->recv >> calls.
582		615
583	Condition variables are overloaded so one can call them directly	616	Condition variables are overloaded so one can call them directly (as if
584	(as a code reference). Calling them directly is the same as calling	617	they were a code reference). Calling them directly is the same as calling
585	C<send>. Note, however, that many C-based event loops do not handle	618	C<send>.
586	overloading, so as tempting as it may be, passing a condition variable
587	instead of a callback does not work. Both the pure perl and EV loops
588	support overloading, however, as well as all functions that use perl to
589	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
590	example).
591		619
592	=item $cv->croak ($error)	620	=item $cv->croak ($error)
593		621
594	Similar to send, but causes all call's to C<< ->recv >> to invoke	622	Similar to send, but causes all call's to C<< ->recv >> to invoke
595	C<Carp::croak> with the given error message/object/scalar.	623	C<Carp::croak> with the given error message/object/scalar.
596		624
597	This can be used to signal any errors to the condition variable	625	This can be used to signal any errors to the condition variable
598	user/consumer.	626	user/consumer. Doing it this way instead of calling C<croak> directly
		627	delays the error detetcion, but has the overwhelmign advantage that it
		628	diagnoses the error at the place where the result is expected, and not
		629	deep in some event clalback without connection to the actual code causing
		630	the problem.
599		631
600	=item $cv->begin ([group callback])	632	=item $cv->begin ([group callback])
601		633
602	=item $cv->end	634	=item $cv->end
603		635
…		…
699	function will call C<croak>.	731	function will call C<croak>.
700		732
701	In list context, all parameters passed to C<send> will be returned,	733	In list context, all parameters passed to C<send> will be returned,
702	in scalar context only the first one will be returned.	734	in scalar context only the first one will be returned.
703		735
		736	Note that doing a blocking wait in a callback is not supported by any
		737	event loop, that is, recursive invocation of a blocking C<< ->recv
		738	>> is not allowed, and the C<recv> call will C<croak> if such a
		739	condition is detected. This condition can be slightly loosened by using
		740	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		741	any thread that doesn't run the event loop itself.
		742
704	Not all event models support a blocking wait - some die in that case	743	Not all event models support a blocking wait - some die in that case
705	(programs might want to do that to stay interactive), so I<if you are	744	(programs might want to do that to stay interactive), so I<if you are
706	using this from a module, never require a blocking wait>, but let the	745	using this from a module, never require a blocking wait>. Instead, let the
707	caller decide whether the call will block or not (for example, by coupling	746	caller decide whether the call will block or not (for example, by coupling
708	condition variables with some kind of request results and supporting	747	condition variables with some kind of request results and supporting
709	callbacks so the caller knows that getting the result will not block,	748	callbacks so the caller knows that getting the result will not block,
710	while still supporting blocking waits if the caller so desires).	749	while still supporting blocking waits if the caller so desires).
711		750
712	Another reason I<never> to C<< ->recv >> in a module is that you cannot
713	sensibly have two C<< ->recv >>'s in parallel, as that would require
714	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
715	can supply.
716
717	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
718	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
719	versions and also integrates coroutines into AnyEvent, making blocking
720	C<< ->recv >> calls perfectly safe as long as they are done from another
721	coroutine (one that doesn't run the event loop).
722
723	You can ensure that C<< -recv >> never blocks by setting a callback and	751	You can ensure that C<< -recv >> never blocks by setting a callback and
724	only calling C<< ->recv >> from within that callback (or at a later	752	only calling C<< ->recv >> from within that callback (or at a later
725	time). This will work even when the event loop does not support blocking	753	time). This will work even when the event loop does not support blocking
726	waits otherwise.	754	waits otherwise.
727		755
…		…
740	variable itself. Calling C<recv> inside the callback or at any later time	768	variable itself. Calling C<recv> inside the callback or at any later time
741	is guaranteed not to block.	769	is guaranteed not to block.
742		770
743	=back	771	=back
744		772
		773	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		774
		775	The available backend classes are (every class has its own manpage):
		776
		777	=over 4
		778
		779	=item Backends that are autoprobed when no other event loop can be found.
		780
		781	EV is the preferred backend when no other event loop seems to be in
		782	use. If EV is not installed, then AnyEvent will try Event, and, failing
		783	that, will fall back to its own pure-perl implementation, which is
		784	available everywhere as it comes with AnyEvent itself.
		785
		786	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		787	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		788	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		789
		790	=item Backends that are transparently being picked up when they are used.
		791
		792	These will be used when they are currently loaded when the first watcher
		793	is created, in which case it is assumed that the application is using
		794	them. This means that AnyEvent will automatically pick the right backend
		795	when the main program loads an event module before anything starts to
		796	create watchers. Nothing special needs to be done by the main program.
		797
		798	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		799	AnyEvent::Impl::Tk based on Tk, very broken.
		800	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		801	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		802	AnyEvent::Impl::Irssi used when running within irssi.
		803
		804	=item Backends with special needs.
		805
		806	Qt requires the Qt::Application to be instantiated first, but will
		807	otherwise be picked up automatically. As long as the main program
		808	instantiates the application before any AnyEvent watchers are created,
		809	everything should just work.
		810
		811	AnyEvent::Impl::Qt based on Qt.
		812
		813	Support for IO::Async can only be partial, as it is too broken and
		814	architecturally limited to even support the AnyEvent API. It also
		815	is the only event loop that needs the loop to be set explicitly, so
		816	it can only be used by a main program knowing about AnyEvent. See
		817	L<AnyEvent::Impl::Async> for the gory details.
		818
		819	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		820
		821	=item Event loops that are indirectly supported via other backends.
		822
		823	Some event loops can be supported via other modules:
		824
		825	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		826
		827	B<WxWidgets> has no support for watching file handles. However, you can
		828	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		829	polls 20 times per second, which was considered to be too horrible to even
		830	consider for AnyEvent.
		831
		832	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		833	backend, so it can be supported through POE.
		834
		835	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		836	load L<POE> when detecting them, in the hope that POE will pick them up,
		837	in which case everything will be automatic.
		838
		839	=back
		840
745	=head1 GLOBAL VARIABLES AND FUNCTIONS	841	=head1 GLOBAL VARIABLES AND FUNCTIONS
746		842
		843	These are not normally required to use AnyEvent, but can be useful to
		844	write AnyEvent extension modules.
		845
747	=over 4	846	=over 4
748		847
749	=item $AnyEvent::MODEL	848	=item $AnyEvent::MODEL
750		849
751	Contains C<undef> until the first watcher is being created. Then it	850	Contains C<undef> until the first watcher is being created, before the
		851	backend has been autodetected.
		852
752	contains the event model that is being used, which is the name of the	853	Afterwards it contains the event model that is being used, which is the
753	Perl class implementing the model. This class is usually one of the	854	name of the Perl class implementing the model. This class is usually one
754	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	855	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
755	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	856	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
756		857	will be C<urxvt::anyevent>).
757	The known classes so far are:
758
759	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
760	AnyEvent::Impl::Event based on Event, second best choice.
761	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
762	AnyEvent::Impl::Glib based on Glib, third-best choice.
763	AnyEvent::Impl::Tk based on Tk, very bad choice.
764	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
765	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
766	AnyEvent::Impl::POE based on POE, not generic enough for full support.
767
768	# warning, support for IO::Async is only partial, as it is too broken
769	# and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
770	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
771
772	There is no support for WxWidgets, as WxWidgets has no support for
773	watching file handles. However, you can use WxWidgets through the
774	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
775	second, which was considered to be too horrible to even consider for
776	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
777	it's adaptor.
778
779	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
780	autodetecting them.
781		858
782	=item AnyEvent::detect	859	=item AnyEvent::detect
783		860
784	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	861	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
785	if necessary. You should only call this function right before you would	862	if necessary. You should only call this function right before you would
786	have created an AnyEvent watcher anyway, that is, as late as possible at	863	have created an AnyEvent watcher anyway, that is, as late as possible at
787	runtime.	864	runtime, and not e.g. while initialising of your module.
		865
		866	If you need to do some initialisation before AnyEvent watchers are
		867	created, use C<post_detect>.
788		868
789	=item $guard = AnyEvent::post_detect { BLOCK }	869	=item $guard = AnyEvent::post_detect { BLOCK }
790		870
791	Arranges for the code block to be executed as soon as the event model is	871	Arranges for the code block to be executed as soon as the event model is
792	autodetected (or immediately if this has already happened).	872	autodetected (or immediately if this has already happened).
793		873
		874	The block will be executed I<after> the actual backend has been detected
		875	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		876	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		877	other initialisations - see the sources of L<AnyEvent::Strict> or
		878	L<AnyEvent::AIO> to see how this is used.
		879
		880	The most common usage is to create some global watchers, without forcing
		881	event module detection too early, for example, L<AnyEvent::AIO> creates
		882	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		883	avoid autodetecting the event module at load time.
		884
794	If called in scalar or list context, then it creates and returns an object	885	If called in scalar or list context, then it creates and returns an object
795	that automatically removes the callback again when it is destroyed. See	886	that automatically removes the callback again when it is destroyed (or
		887	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
796	L<Coro::BDB> for a case where this is useful.	888	a case where this is useful.
		889
		890	Example: Create a watcher for the IO::AIO module and store it in
		891	C<$WATCHER>. Only do so after the event loop is initialised, though.
		892
		893	our WATCHER;
		894
		895	my $guard = AnyEvent::post_detect {
		896	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		897	};
		898
		899	# the \|\|= is important in case post_detect immediately runs the block,
		900	# as to not clobber the newly-created watcher. assigning both watcher and
		901	# post_detect guard to the same variable has the advantage of users being
		902	# able to just C<undef $WATCHER> if the watcher causes them grief.
		903
		904	$WATCHER \|\|= $guard;
797		905
798	=item @AnyEvent::post_detect	906	=item @AnyEvent::post_detect
799		907
800	If there are any code references in this array (you can C<push> to it	908	If there are any code references in this array (you can C<push> to it
801	before or after loading AnyEvent), then they will called directly after	909	before or after loading AnyEvent), then they will called directly after
802	the event loop has been chosen.	910	the event loop has been chosen.
803		911
804	You should check C<$AnyEvent::MODEL> before adding to this array, though:	912	You should check C<$AnyEvent::MODEL> before adding to this array, though:
805	if it contains a true value then the event loop has already been detected,	913	if it is defined then the event loop has already been detected, and the
806	and the array will be ignored.	914	array will be ignored.
807		915
808	Best use C<AnyEvent::post_detect { BLOCK }> instead.	916	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		917	it,as it takes care of these details.
		918
		919	This variable is mainly useful for modules that can do something useful
		920	when AnyEvent is used and thus want to know when it is initialised, but do
		921	not need to even load it by default. This array provides the means to hook
		922	into AnyEvent passively, without loading it.
809		923
810	=back	924	=back
811		925
812	=head1 WHAT TO DO IN A MODULE	926	=head1 WHAT TO DO IN A MODULE
813		927
…		…
868		982
869		983
870	=head1 OTHER MODULES	984	=head1 OTHER MODULES
871		985
872	The following is a non-exhaustive list of additional modules that use	986	The following is a non-exhaustive list of additional modules that use
873	AnyEvent and can therefore be mixed easily with other AnyEvent modules	987	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
874	in the same program. Some of the modules come with AnyEvent, some are	988	modules and other event loops in the same program. Some of the modules
875	available via CPAN.	989	come with AnyEvent, most are available via CPAN.
876		990
877	=over 4	991	=over 4
878		992
879	=item L<AnyEvent::Util>	993	=item L<AnyEvent::Util>
880		994
…		…
889		1003
890	=item L<AnyEvent::Handle>	1004	=item L<AnyEvent::Handle>
891		1005
892	Provide read and write buffers, manages watchers for reads and writes,	1006	Provide read and write buffers, manages watchers for reads and writes,
893	supports raw and formatted I/O, I/O queued and fully transparent and	1007	supports raw and formatted I/O, I/O queued and fully transparent and
894	non-blocking SSL/TLS.	1008	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
895		1009
896	=item L<AnyEvent::DNS>	1010	=item L<AnyEvent::DNS>
897		1011
898	Provides rich asynchronous DNS resolver capabilities.	1012	Provides rich asynchronous DNS resolver capabilities.
899		1013
…		…
927		1041
928	=item L<AnyEvent::GPSD>	1042	=item L<AnyEvent::GPSD>
929		1043
930	A non-blocking interface to gpsd, a daemon delivering GPS information.	1044	A non-blocking interface to gpsd, a daemon delivering GPS information.
931		1045
		1046	=item L<AnyEvent::IRC>
		1047
		1048	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		1049
		1050	=item L<AnyEvent::XMPP>
		1051
		1052	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1053	Net::XMPP2>.
		1054
932	=item L<AnyEvent::IGS>	1055	=item L<AnyEvent::IGS>
933		1056
934	A non-blocking interface to the Internet Go Server protocol (used by	1057	A non-blocking interface to the Internet Go Server protocol (used by
935	L<App::IGS>).	1058	L<App::IGS>).
936		1059
937	=item L<AnyEvent::IRC>
938
939	AnyEvent based IRC client module family (replacing the older Net::IRC3).
940
941	=item L<Net::XMPP2>
942
943	AnyEvent based XMPP (Jabber protocol) module family.
944
945	=item L<Net::FCP>	1060	=item L<Net::FCP>
946		1061
947	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1062	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
948	of AnyEvent.	1063	of AnyEvent.
949		1064
…		…
953		1068
954	=item L<Coro>	1069	=item L<Coro>
955		1070
956	Has special support for AnyEvent via L<Coro::AnyEvent>.	1071	Has special support for AnyEvent via L<Coro::AnyEvent>.
957		1072
958	=item L<IO::Lambda>
959
960	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
961
962	=back	1073	=back
963		1074
964	=cut	1075	=cut
965		1076
966	package AnyEvent;	1077	package AnyEvent;
967		1078
		1079	# basically a tuned-down version of common::sense
		1080	sub common_sense {
968	no warnings;	1081	# no warnings
		1082	${^WARNING_BITS} ^= ${^WARNING_BITS};
969	use strict qw(vars subs);	1083	# use strict vars subs
		1084	$^H \|= 0x00000600;
		1085	}
970		1086
		1087	BEGIN { AnyEvent::common_sense }
		1088
971	use Carp;	1089	use Carp ();
972		1090
973	our $VERSION = 4.45;	1091	our $VERSION = 4.87;
974	our $MODEL;	1092	our $MODEL;
975		1093
976	our $AUTOLOAD;	1094	our $AUTOLOAD;
977	our @ISA;	1095	our @ISA;
978		1096
979	our @REGISTRY;	1097	our @REGISTRY;
980		1098
981	our $WIN32;	1099	our $WIN32;
		1100
		1101	our $VERBOSE;
982		1102
983	BEGIN {	1103	BEGIN {
984	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1104	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
985	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1105	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
986		1106
987	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1107	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
988	if ${^TAINT};	1108	if ${^TAINT};
989	}
990		1109
991	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1110	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1111
		1112	}
		1113
		1114	our $MAX_SIGNAL_LATENCY = 10;
992		1115
993	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1116	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
994		1117
995	{	1118	{
996	my $idx;	1119	my $idx;
…		…
998	for reverse split /\s,\s/,	1121	for reverse split /\s,\s/,
999	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1122	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1000	}	1123	}
1001		1124
1002	my @models = (	1125	my @models = (
1003	[EV:: => AnyEvent::Impl::EV::],	1126	[EV:: => AnyEvent::Impl::EV:: , 1],
1004	[Event:: => AnyEvent::Impl::Event::],	1127	[Event:: => AnyEvent::Impl::Event::, 1],
1005	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1128	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1006	# everything below here will not be autoprobed	1129	# everything below here will not (normally) be autoprobed
1007	# as the pureperl backend should work everywhere	1130	# as the pureperl backend should work everywhere
1008	# and is usually faster	1131	# and is usually faster
		1132	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1133	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1134	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1009	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1135	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1010	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1011	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1012	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1136	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1013	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1137	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1014	[Wx:: => AnyEvent::Impl::POE::],	1138	[Wx:: => AnyEvent::Impl::POE::],
1015	[Prima:: => AnyEvent::Impl::POE::],	1139	[Prima:: => AnyEvent::Impl::POE::],
1016	# IO::Async is just too broken - we would need workaorunds for its	1140	# IO::Async is just too broken - we would need workarounds for its
1017	# byzantine signal and broken child handling, among others.	1141	# byzantine signal and broken child handling, among others.
1018	# IO::Async is rather hard to detect, as it doesn't have any	1142	# IO::Async is rather hard to detect, as it doesn't have any
1019	# obvious default class.	1143	# obvious default class.
1020	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1144	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1021	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1145	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1022	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1146	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1023	);	1147	);
1024		1148
1025	our %method = map +($_ => 1),	1149	our %method = map +($_ => 1),
1026	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1150	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1027		1151
…		…
1031	my ($cb) = @_;	1155	my ($cb) = @_;
1032		1156
1033	if ($MODEL) {	1157	if ($MODEL) {
1034	$cb->();	1158	$cb->();
1035		1159
1036	1	1160	undef
1037	} else {	1161	} else {
1038	push @post_detect, $cb;	1162	push @post_detect, $cb;
1039		1163
1040	defined wantarray	1164	defined wantarray
1041	? bless \$cb, "AnyEvent::Util::postdetect"	1165	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1047	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1171	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1048	}	1172	}
1049		1173
1050	sub detect() {	1174	sub detect() {
1051	unless ($MODEL) {	1175	unless ($MODEL) {
1052	no strict 'refs';
1053	local $SIG{__DIE__};	1176	local $SIG{__DIE__};
1054		1177
1055	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1178	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1056	my $model = "AnyEvent::Impl::$1";	1179	my $model = "AnyEvent::Impl::$1";
1057	if (eval "require $model") {	1180	if (eval "require $model") {
1058	$MODEL = $model;	1181	$MODEL = $model;
1059	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1182	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1060	} else {	1183	} else {
1061	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1184	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1062	}	1185	}
1063	}	1186	}
1064		1187
1065	# check for already loaded models	1188	# check for already loaded models
1066	unless ($MODEL) {	1189	unless ($MODEL) {
1067	for (@REGISTRY, @models) {	1190	for (@REGISTRY, @models) {
1068	my ($package, $model) = @$_;	1191	my ($package, $model) = @$_;
1069	if (${"$package\::VERSION"} > 0) {	1192	if (${"$package\::VERSION"} > 0) {
1070	if (eval "require $model") {	1193	if (eval "require $model") {
1071	$MODEL = $model;	1194	$MODEL = $model;
1072	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1195	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1073	last;	1196	last;
1074	}	1197	}
1075	}	1198	}
1076	}	1199	}
1077		1200
1078	unless ($MODEL) {	1201	unless ($MODEL) {
1079	# try to load a model	1202	# try to autoload a model
1080
1081	for (@REGISTRY, @models) {	1203	for (@REGISTRY, @models) {
1082	my ($package, $model) = @$_;	1204	my ($package, $model, $autoload) = @$_;
		1205	if (
		1206	$autoload
1083	if (eval "require $package"	1207	and eval "require $package"
1084	and ${"$package\::VERSION"} > 0	1208	and ${"$package\::VERSION"} > 0
1085	and eval "require $model") {	1209	and eval "require $model"
		1210	) {
1086	$MODEL = $model;	1211	$MODEL = $model;
1087	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1212	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1088	last;	1213	last;
1089	}	1214	}
1090	}	1215	}
1091		1216
1092	$MODEL	1217	$MODEL
…		…
1108		1233
1109	sub AUTOLOAD {	1234	sub AUTOLOAD {
1110	(my $func = $AUTOLOAD) =~ s/.*://;	1235	(my $func = $AUTOLOAD) =~ s/.*://;
1111		1236
1112	$method{$func}	1237	$method{$func}
1113	or croak "$func: not a valid method for AnyEvent objects";	1238	or Carp::croak "$func: not a valid method for AnyEvent objects";
1114		1239
1115	detect unless $MODEL;	1240	detect unless $MODEL;
1116		1241
1117	my $class = shift;	1242	my $class = shift;
1118	$class->$func (@_);	1243	$class->$func (@_);
…		…
1123	# allow only one watcher per fd, so we dup it to get a different one).	1248	# allow only one watcher per fd, so we dup it to get a different one).
1124	sub _dupfh($$;$$) {	1249	sub _dupfh($$;$$) {
1125	my ($poll, $fh, $r, $w) = @_;	1250	my ($poll, $fh, $r, $w) = @_;
1126		1251
1127	# cygwin requires the fh mode to be matching, unix doesn't	1252	# cygwin requires the fh mode to be matching, unix doesn't
1128	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1253	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1129	: $poll eq "w" ? ($w, ">")
1130	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1131		1254
1132	open my $fh2, "$mode&" . fileno $fh	1255	open my $fh2, $mode, $fh
1133	or die "cannot dup() filehandle: $!,";	1256	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1134		1257
1135	# we assume CLOEXEC is already set by perl in all important cases	1258	# we assume CLOEXEC is already set by perl in all important cases
1136		1259
1137	($fh2, $rw)	1260	($fh2, $rw)
1138	}	1261	}
1139		1262
1140	package AnyEvent::Base;	1263	package AnyEvent::Base;
1141		1264
1142	# default implementations for many methods	1265	# default implementations for many methods
1143		1266
1144	BEGIN {	1267	sub _time {
		1268	# probe for availability of Time::HiRes
1145	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1269	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1270	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1146	*_time = \&Time::HiRes::time;	1271	*_time = \&Time::HiRes::time;
1147	# if (eval "use POSIX (); (POSIX::times())...	1272	# if (eval "use POSIX (); (POSIX::times())...
1148	} else {	1273	} else {
		1274	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1149	*_time = sub { time }; # epic fail	1275	*_time = sub { time }; # epic fail
1150	}	1276	}
		1277
		1278	&_time
1151	}	1279	}
1152		1280
1153	sub time { _time }	1281	sub time { _time }
1154	sub now { _time }	1282	sub now { _time }
1155	sub now_update { }	1283	sub now_update { }
…		…
1160	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1288	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1161	}	1289	}
1162		1290
1163	# default implementation for ->signal	1291	# default implementation for ->signal
1164		1292
		1293	our $HAVE_ASYNC_INTERRUPT;
1165	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1294	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1295	our (%SIG_ASY, %SIG_ASY_W);
		1296	our ($SIG_COUNT, $SIG_TW);
1166		1297
1167	sub _signal_exec {	1298	sub _signal_exec {
		1299	$HAVE_ASYNC_INTERRUPT
		1300	? $SIGPIPE_R->drain
1168	sysread $SIGPIPE_R, my $dummy, 4;	1301	: sysread $SIGPIPE_R, my $dummy, 9;
1169		1302
1170	while (%SIG_EV) {	1303	while (%SIG_EV) {
1171	for (keys %SIG_EV) {	1304	for (keys %SIG_EV) {
1172	delete $SIG_EV{$_};	1305	delete $SIG_EV{$_};
1173	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1306	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1174	}	1307	}
1175	}	1308	}
1176	}	1309	}
1177		1310
		1311	# install a dumym wakeupw atcher to reduce signal catching latency
		1312	sub _sig_add() {
		1313	unless ($SIG_COUNT++) {
		1314	# try to align timer on a full-second boundary, if possible
		1315	my $NOW = AnyEvent->now;
		1316
		1317	$SIG_TW = AnyEvent->timer (
		1318	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1319	interval => $MAX_SIGNAL_LATENCY,
		1320	cb => sub { }, # just for the PERL_ASYNC_CHECK
		1321	);
		1322	}
		1323	}
		1324
		1325	sub _sig_del {
		1326	undef $SIG_TW
		1327	unless --$SIG_COUNT;
		1328	}
		1329
		1330	sub _signal {
		1331	my (undef, %arg) = @_;
		1332
		1333	my $signal = uc $arg{signal}
		1334	or Carp::croak "required option 'signal' is missing";
		1335
		1336	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1337
		1338	if ($HAVE_ASYNC_INTERRUPT) {
		1339	# async::interrupt
		1340
		1341	$SIG_ASY{$signal} \|\|= do {
		1342	my $asy = new Async::Interrupt
		1343	cb => sub { undef $SIG_EV{$signal} },
		1344	signal => $signal,
		1345	pipe => [$SIGPIPE_R->filenos],
		1346	;
		1347	$asy->pipe_autodrain (0);
		1348
		1349	$asy
		1350	};
		1351
		1352	} else {
		1353	# pure perl
		1354
		1355	$SIG{$signal} \|\|= sub {
		1356	local $!;
		1357	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1358	undef $SIG_EV{$signal};
		1359	};
		1360
		1361	# can't do signal processing without introducing races in pure perl,
		1362	# so limit the signal latency.
		1363	_sig_add;
		1364	}
		1365
		1366	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1367	}
		1368
1178	sub signal {	1369	sub signal {
1179	my (undef, %arg) = @_;	1370	# probe for availability of Async::Interrupt
		1371	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
		1372	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1180		1373
1181	unless ($SIGPIPE_R) {	1374	$HAVE_ASYNC_INTERRUPT = 1;
		1375	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1376	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
		1377
		1378	} else {
		1379	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1380
1182	require Fcntl;	1381	require Fcntl;
1183		1382
1184	if (AnyEvent::WIN32) {	1383	if (AnyEvent::WIN32) {
1185	require AnyEvent::Util;	1384	require AnyEvent::Util;
1186		1385
…		…
1201	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1400	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1202		1401
1203	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1402	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1204	}	1403	}
1205		1404
1206	my $signal = uc $arg{signal}	1405	*signal = \&_signal;
1207	or Carp::croak "required option 'signal' is missing";	1406	&signal
1208
1209	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1210	$SIG{$signal} \|\|= sub {
1211	local $!;
1212	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1213	undef $SIG_EV{$signal};
1214	};
1215
1216	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1217	}	1407	}
1218		1408
1219	sub AnyEvent::Base::signal::DESTROY {	1409	sub AnyEvent::Base::signal::DESTROY {
1220	my ($signal, $cb) = @{$_[0]};	1410	my ($signal, $cb) = @{$_[0]};
1221		1411
		1412	_sig_del;
		1413
1222	delete $SIG_CB{$signal}{$cb};	1414	delete $SIG_CB{$signal}{$cb};
1223		1415
		1416	$HAVE_ASYNC_INTERRUPT
		1417	? delete $SIG_ASY{$signal}
1224	# delete doesn't work with older perls - they then	1418	: # delete doesn't work with older perls - they then
1225	# print weird messages, or just unconditionally exit	1419	# print weird messages, or just unconditionally exit
1226	# instead of getting the default action.	1420	# instead of getting the default action.
		1421	undef $SIG{$signal}
1227	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };	1422	unless keys %{ $SIG_CB{$signal} };
1228	}	1423	}
1229		1424
1230	# default implementation for ->child	1425	# default implementation for ->child
1231		1426
1232	our %PID_CB;	1427	our %PID_CB;
1233	our $CHLD_W;	1428	our $CHLD_W;
1234	our $CHLD_DELAY_W;	1429	our $CHLD_DELAY_W;
1235	our $WNOHANG;	1430	our $WNOHANG;
1236		1431
		1432	sub _emit_childstatus($$) {
		1433	my (undef, $rpid, $rstatus) = @_;
		1434
		1435	$_->($rpid, $rstatus)
		1436	for values %{ $PID_CB{$rpid} \|\| {} },
		1437	values %{ $PID_CB{0} \|\| {} };
		1438	}
		1439
1237	sub _sigchld {	1440	sub _sigchld {
		1441	my $pid;
		1442
		1443	AnyEvent->_emit_childstatus ($pid, $?)
1238	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1444	while ($pid = waitpid -1, $WNOHANG) > 0;
1239	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),
1240	(values %{ $PID_CB{0} \|\| {} });
1241	}
1242	}	1445	}
1243		1446
1244	sub child {	1447	sub child {
1245	my (undef, %arg) = @_;	1448	my (undef, %arg) = @_;
1246		1449
1247	defined (my $pid = $arg{pid} + 0)	1450	defined (my $pid = $arg{pid} + 0)
1248	or Carp::croak "required option 'pid' is missing";	1451	or Carp::croak "required option 'pid' is missing";
1249		1452
1250	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1453	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1251		1454
		1455	# WNOHANG is almost cetrainly 1 everywhere
		1456	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1457	? 1
1252	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1458	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1253		1459
1254	unless ($CHLD_W) {	1460	unless ($CHLD_W) {
1255	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1461	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1256	# child could be a zombie already, so make at least one round	1462	# child could be a zombie already, so make at least one round
1257	&_sigchld;	1463	&_sigchld;
…		…
1309		1515
1310	our @ISA = AnyEvent::CondVar::Base::;	1516	our @ISA = AnyEvent::CondVar::Base::;
1311		1517
1312	package AnyEvent::CondVar::Base;	1518	package AnyEvent::CondVar::Base;
1313		1519
1314	use overload	1520	#use overload
1315	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1521	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1316	fallback => 1;	1522	# fallback => 1;
		1523
		1524	# save 300+ kilobytes by dirtily hardcoding overloading
		1525	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1526	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1527	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1528	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1529
		1530	our $WAITING;
1317		1531
1318	sub _send {	1532	sub _send {
1319	# nop	1533	# nop
1320	}	1534	}
1321		1535
…		…
1334	sub ready {	1548	sub ready {
1335	$_[0]{_ae_sent}	1549	$_[0]{_ae_sent}
1336	}	1550	}
1337		1551
1338	sub _wait {	1552	sub _wait {
		1553	$WAITING
		1554	and !$_[0]{_ae_sent}
		1555	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1556
		1557	local $WAITING = 1;
1339	AnyEvent->one_event while !$_[0]{_ae_sent};	1558	AnyEvent->one_event while !$_[0]{_ae_sent};
1340	}	1559	}
1341		1560
1342	sub recv {	1561	sub recv {
1343	$_[0]->_wait;	1562	$_[0]->_wait;
…		…
1405	C<PERL_ANYEVENT_MODEL>.	1624	C<PERL_ANYEVENT_MODEL>.
1406		1625
1407	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1626	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1408	model it chooses.	1627	model it chooses.
1409		1628
		1629	When set to C<8> or higher, then AnyEvent will report extra information on
		1630	which optional modules it loads and how it implements certain features.
		1631
1410	=item C<PERL_ANYEVENT_STRICT>	1632	=item C<PERL_ANYEVENT_STRICT>
1411		1633
1412	AnyEvent does not do much argument checking by default, as thorough	1634	AnyEvent does not do much argument checking by default, as thorough
1413	argument checking is very costly. Setting this variable to a true value	1635	argument checking is very costly. Setting this variable to a true value
1414	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1636	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1415	check the arguments passed to most method calls. If it finds any problems,	1637	check the arguments passed to most method calls. If it finds any problems,
1416	it will croak.	1638	it will croak.
1417		1639
1418	In other words, enables "strict" mode.	1640	In other words, enables "strict" mode.
1419		1641
1420	Unlike C<use strict>, it is definitely recommended to keep it off in	1642	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1421	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1643	>>, it is definitely recommended to keep it off in production. Keeping
1422	developing programs can be very useful, however.	1644	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1645	can be very useful, however.
1423		1646
1424	=item C<PERL_ANYEVENT_MODEL>	1647	=item C<PERL_ANYEVENT_MODEL>
1425		1648
1426	This can be used to specify the event model to be used by AnyEvent, before	1649	This can be used to specify the event model to be used by AnyEvent, before
1427	auto detection and -probing kicks in. It must be a string consisting	1650	auto detection and -probing kicks in. It must be a string consisting
…		…
1470		1693
1471	=item C<PERL_ANYEVENT_MAX_FORKS>	1694	=item C<PERL_ANYEVENT_MAX_FORKS>
1472		1695
1473	The maximum number of child processes that C<AnyEvent::Util::fork_call>	1696	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1474	will create in parallel.	1697	will create in parallel.
		1698
		1699	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1700
		1701	The default value for the C<max_outstanding> parameter for the default DNS
		1702	resolver - this is the maximum number of parallel DNS requests that are
		1703	sent to the DNS server.
		1704
		1705	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1706
		1707	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1708	configuration) in the default resolver. When set to the empty string, no
		1709	default config will be used.
		1710
		1711	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1712
		1713	When neither C<ca_file> nor C<ca_path> was specified during
		1714	L<AnyEvent::TLS> context creation, and either of these environment
		1715	variables exist, they will be used to specify CA certificate locations
		1716	instead of a system-dependent default.
		1717
		1718	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1719
		1720	When these are set to C<1>, then the respective modules are not
		1721	loaded. Mostly good for testing AnyEvent itself.
1475		1722
1476	=back	1723	=back
1477		1724
1478	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1725	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1479		1726
…		…
2018		2265
2019	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2266	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2020	emulation for event loops that do not support them natively. Also, some	2267	emulation for event loops that do not support them natively. Also, some
2021	event loops install a similar handler.	2268	event loops install a similar handler.
2022		2269
2023	If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will	2270	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2024	reset it to default, to avoid losing child exit statuses.	2271	AnyEvent will reset it to default, to avoid losing child exit statuses.
2025		2272
2026	=item SIGPIPE	2273	=item SIGPIPE
2027		2274
2028	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2275	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2029	when AnyEvent gets loaded.	2276	when AnyEvent gets loaded.
…		…
2047	if $SIG{CHLD} eq 'IGNORE';	2294	if $SIG{CHLD} eq 'IGNORE';
2048		2295
2049	$SIG{PIPE} = sub { }	2296	$SIG{PIPE} = sub { }
2050	unless defined $SIG{PIPE};	2297	unless defined $SIG{PIPE};
2051		2298
		2299	=head1 RECOMMENDED/OPTIONAL MODULES
		2300
		2301	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2302	it's built-in modules) are required to use it.
		2303
		2304	That does not mean that AnyEvent won't take advantage of some additional
		2305	modules if they are installed.
		2306
		2307	This section epxlains which additional modules will be used, and how they
		2308	affect AnyEvent's operetion.
		2309
		2310	=over 4
		2311
		2312	=item L<Async::Interrupt>
		2313
		2314	This slightly arcane module is used to implement fast signal handling: To
		2315	my knowledge, there is no way to do completely race-free and quick
		2316	signal handling in pure perl. To ensure that signals still get
		2317	delivered, AnyEvent will start an interval timer to wake up perl (and
		2318	catch the signals) with some delay (default is 10 seconds, look for
		2319	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2320
		2321	If this module is available, then it will be used to implement signal
		2322	catching, which means that signals will not be delayed, and the event loop
		2323	will not be interrupted regularly, which is more efficient (And good for
		2324	battery life on laptops).
		2325
		2326	This affects not just the pure-perl event loop, but also other event loops
		2327	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2328
		2329	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2330	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2331	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2332	does nothing for those backends.
		2333
		2334	=item L<EV>
		2335
		2336	This module isn't really "optional", as it is simply one of the backend
		2337	event loops that AnyEvent can use. However, it is simply the best event
		2338	loop available in terms of features, speed and stability: It supports
		2339	the AnyEvent API optimally, implements all the watcher types in XS, does
		2340	automatic timer adjustments even when no monotonic clock is available,
		2341	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2342	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2343	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2344
		2345	=item L<Guard>
		2346
		2347	The guard module, when used, will be used to implement
		2348	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2349	lot less memory), but otherwise doesn't affect guard operation much. It is
		2350	purely used for performance.
		2351
		2352	=item L<JSON> and L<JSON::XS>
		2353
		2354	This module is required when you want to read or write JSON data via
		2355	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2356	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2357
		2358	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2359	installed.
		2360
		2361	=item L<Net::SSLeay>
		2362
		2363	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2364	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2365	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2366
		2367	=item L<Time::HiRes>
		2368
		2369	This module is part of perl since release 5.008. It will be used when the
		2370	chosen event library does not come with a timing source on it's own. The
		2371	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2372	try to use a monotonic clock for timing stability.
		2373
		2374	=back
		2375
		2376
2052	=head1 FORK	2377	=head1 FORK
2053		2378
2054	Most event libraries are not fork-safe. The ones who are usually are	2379	Most event libraries are not fork-safe. The ones who are usually are
2055	because they rely on inefficient but fork-safe C<select> or C<poll>	2380	because they rely on inefficient but fork-safe C<select> or C<poll>
2056	calls. Only L<EV> is fully fork-aware.	2381	calls. Only L<EV> is fully fork-aware.
2057		2382
2058	If you have to fork, you must either do so I<before> creating your first	2383	If you have to fork, you must either do so I<before> creating your first
2059	watcher OR you must not use AnyEvent at all in the child.	2384	watcher OR you must not use AnyEvent at all in the child OR you must do
		2385	something completely out of the scope of AnyEvent.
2060		2386
2061		2387
2062	=head1 SECURITY CONSIDERATIONS	2388	=head1 SECURITY CONSIDERATIONS
2063		2389
2064	AnyEvent can be forced to load any event model via	2390	AnyEvent can be forced to load any event model via
…		…
2102	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2428	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2103		2429
2104	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2430	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2105	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2431	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2106	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2432	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2107	L<AnyEvent::Impl::POE>.	2433	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2108		2434
2109	Non-blocking file handles, sockets, TCP clients and	2435	Non-blocking file handles, sockets, TCP clients and
2110	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2436	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2111		2437
2112	Asynchronous DNS: L<AnyEvent::DNS>.	2438	Asynchronous DNS: L<AnyEvent::DNS>.
2113		2439
2114	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2440	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2441	L<Coro::Event>,
2115		2442
2116	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2443	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2444	L<AnyEvent::HTTP>.
2117		2445
2118		2446
2119	=head1 AUTHOR	2447	=head1 AUTHOR
2120		2448
2121	Marc Lehmann <schmorp@schmorp.de>	2449	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.223 by root, Mon Jun 29 21:00:32 2009 UTC vs. Revision 1.258 by root, Sun Jul 26 05:57:05 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.223 by root, Mon Jun 29 21:00:32 2009 UTC vs.
Revision 1.258 by root, Sun Jul 26 05:57:05 2009 UTC