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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.228 by root, Wed Jul 8 01:11:12 2009 UTC vs.
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - events independent of event loop implementation
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported	5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported
6	event loops.	6	event loops.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
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	Respository>, 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, see below) to	189	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182	watch for events (AnyEvent might or might not keep a reference to this	190	for events (AnyEvent might or might not keep a reference to this file
183	file 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.
187		195
188	C<poll> must be a string that is either C<r> or C<w>, which creates a	196	C<poll> must be a string that is either C<r> or C<w>, which creates a
…		…
209	chomp (my $input = <STDIN>);	217	chomp (my $input = <STDIN>);
210	warn "read: $input\n";	218	warn "read: $input\n";
211	undef $w;	219	undef $w;
212	});	220	});
213		221
214	=head3 GETTING A FILE HANDLE FROM A FILE DESCRIPTOR
215
216	It is not uncommon to only have a file descriptor, while AnyEvent requires
217	a Perl file handle.
218
219	There are basically two methods to convert a file descriptor into a file handle. If you own
220	the file descriptor, you can open it with C<&=>, as in:
221
222	open my $fh, "<&=$fileno" or die "xxx: §!";
223
224	This will "own" the file descriptor, meaning that when C<$fh> is
225	destroyed, it will automatically close the C<$fileno>. Also, note that
226	the open mode (read, write, read/write) must correspond with how the
227	underlying file descriptor was opened.
228
229	In many cases, taking over the file descriptor is now what you want, in
230	which case the only alternative is to dup the file descriptor:
231
232	open my $fh, "<&$fileno" or die "xxx: $!";
233
234	This has the advantage of not closing the file descriptor and the
235	disadvantage of making a slow copy.
236
237	=head2 TIME WATCHERS	222	=head2 TIME WATCHERS
238		223
239	You can create a time watcher by calling the C<< AnyEvent->timer >>	224	You can create a time watcher by calling the C<< AnyEvent->timer >>
240	method with the following mandatory arguments:	225	method with the following mandatory arguments:
241		226
…		…
384	invocation, and callback invocation will be synchronous. Synchronous means	369	invocation, and callback invocation will be synchronous. Synchronous means
385	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,
386	but it is guaranteed not to interrupt any other callbacks.	371	but it is guaranteed not to interrupt any other callbacks.
387		372
388	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
389	between multiple watchers.	374	between multiple watchers, and AnyEvent will ensure that signals will not
		375	interrupt your program at bad times.
390		376
391	This watcher might use C<%SIG>, so programs overwriting those signals	377	This watcher might use C<%SIG> (depending on the event loop used),
392	directly will likely not work correctly.	378	so programs overwriting those signals directly will likely not work
		379	correctly.
393		380
394	Example: exit on SIGINT	381	Example: exit on SIGINT
395		382
396	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		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.
397		400
398	=head2 CHILD PROCESS WATCHERS	401	=head2 CHILD PROCESS WATCHERS
399		402
400	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.
401		404
…		…
426		429
427	This means you cannot create a child watcher as the very first	430	This means you cannot create a child watcher as the very first
428	thing in an AnyEvent program, you I<have> to create at least one	431	thing in an AnyEvent program, you I<have> to create at least one
429	watcher before you C<fork> the child (alternatively, you can call	432	watcher before you C<fork> the child (alternatively, you can call
430	C<AnyEvent::detect>).	433	C<AnyEvent::detect>).
		434
		435	As most event loops do not support waiting for child events, they will be
		436	emulated by AnyEvent in most cases, in which the latency and race problems
		437	mentioned in the description of signal watchers apply.
431		438
432	Example: fork a process and wait for it	439	Example: fork a process and wait for it
433		440
434	my $done = AnyEvent->condvar;	441	my $done = AnyEvent->condvar;
435		442
…		…
486		493
487	If you are familiar with some event loops you will know that all of them	494	If you are familiar with some event loops you will know that all of them
488	require you to run some blocking "loop", "run" or similar function that	495	require you to run some blocking "loop", "run" or similar function that
489	will actively watch for new events and call your callbacks.	496	will actively watch for new events and call your callbacks.
490		497
491	AnyEvent is different, it expects somebody else to run the event loop and	498	AnyEvent is slightly different: it expects somebody else to run the event
492	will only block when necessary (usually when told by the user).	499	loop and will only block when necessary (usually when told by the user).
493		500
494	The instrument to do that is called a "condition variable", so called	501	The instrument to do that is called a "condition variable", so called
495	because they represent a condition that must become true.	502	because they represent a condition that must become true.
496		503
		504	Now is probably a good time to look at the examples further below.
		505
497	Condition variables can be created by calling the C<< AnyEvent->condvar	506	Condition variables can be created by calling the C<< AnyEvent->condvar
498	>> method, usually without arguments. The only argument pair allowed is	507	>> method, usually without arguments. The only argument pair allowed is
499
500	C<cb>, which specifies a callback to be called when the condition variable	508	C<cb>, which specifies a callback to be called when the condition variable
501	becomes true, with the condition variable as the first argument (but not	509	becomes true, with the condition variable as the first argument (but not
502	the results).	510	the results).
503		511
504	After creation, the condition variable is "false" until it becomes "true"	512	After creation, the condition variable is "false" until it becomes "true"
…		…
553	after => 1,	561	after => 1,
554	cb => sub { $result_ready->send },	562	cb => sub { $result_ready->send },
555	);	563	);
556		564
557	# this "blocks" (while handling events) till the callback	565	# this "blocks" (while handling events) till the callback
558	# calls send	566	# calls -<send
559	$result_ready->recv;	567	$result_ready->recv;
560		568
561	Example: wait for a timer, but take advantage of the fact that	569	Example: wait for a timer, but take advantage of the fact that condition
562	condition variables are also code references.	570	variables are also callable directly.
563		571
564	my $done = AnyEvent->condvar;	572	my $done = AnyEvent->condvar;
565	my $delay = AnyEvent->timer (after => 5, cb => $done);	573	my $delay = AnyEvent->timer (after => 5, cb => $done);
566	$done->recv;	574	$done->recv;
567		575
…		…
573		581
574	...	582	...
575		583
576	my @info = $couchdb->info->recv;	584	my @info = $couchdb->info->recv;
577		585
578	And this is how you would just ste a callback to be called whenever the	586	And this is how you would just set a callback to be called whenever the
579	results are available:	587	results are available:
580		588
581	$couchdb->info->cb (sub {	589	$couchdb->info->cb (sub {
582	my @info = $_[0]->recv;	590	my @info = $_[0]->recv;
583	});	591	});
…		…
601	immediately from within send.	609	immediately from within send.
602		610
603	Any arguments passed to the C<send> call will be returned by all	611	Any arguments passed to the C<send> call will be returned by all
604	future C<< ->recv >> calls.	612	future C<< ->recv >> calls.
605		613
606	Condition variables are overloaded so one can call them directly	614	Condition variables are overloaded so one can call them directly (as if
607	(as a code reference). Calling them directly is the same as calling	615	they were a code reference). Calling them directly is the same as calling
608	C<send>. Note, however, that many C-based event loops do not handle	616	C<send>.
609	overloading, so as tempting as it may be, passing a condition variable
610	instead of a callback does not work. Both the pure perl and EV loops
611	support overloading, however, as well as all functions that use perl to
612	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
613	example).
614		617
615	=item $cv->croak ($error)	618	=item $cv->croak ($error)
616		619
617	Similar to send, but causes all call's to C<< ->recv >> to invoke	620	Similar to send, but causes all call's to C<< ->recv >> to invoke
618	C<Carp::croak> with the given error message/object/scalar.	621	C<Carp::croak> with the given error message/object/scalar.
619		622
620	This can be used to signal any errors to the condition variable	623	This can be used to signal any errors to the condition variable
621	user/consumer.	624	user/consumer. Doing it this way instead of calling C<croak> directly
		625	delays the error detetcion, but has the overwhelmign advantage that it
		626	diagnoses the error at the place where the result is expected, and not
		627	deep in some event clalback without connection to the actual code causing
		628	the problem.
622		629
623	=item $cv->begin ([group callback])	630	=item $cv->begin ([group callback])
624		631
625	=item $cv->end	632	=item $cv->end
626		633
…		…
722	function will call C<croak>.	729	function will call C<croak>.
723		730
724	In list context, all parameters passed to C<send> will be returned,	731	In list context, all parameters passed to C<send> will be returned,
725	in scalar context only the first one will be returned.	732	in scalar context only the first one will be returned.
726		733
		734	Note that doing a blocking wait in a callback is not supported by any
		735	event loop, that is, recursive invocation of a blocking C<< ->recv
		736	>> is not allowed, and the C<recv> call will C<croak> if such a
		737	condition is detected. This condition can be slightly loosened by using
		738	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		739	any thread that doesn't run the event loop itself.
		740
727	Not all event models support a blocking wait - some die in that case	741	Not 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	742	(programs might want to do that to stay interactive), so I<if you are
729	using this from a module, never require a blocking wait>, but let the	743	using this from a module, never require a blocking wait>. Instead, let the
730	caller decide whether the call will block or not (for example, by coupling	744	caller decide whether the call will block or not (for example, by coupling
731	condition variables with some kind of request results and supporting	745	condition variables with some kind of request results and supporting
732	callbacks so the caller knows that getting the result will not block,	746	callbacks so the caller knows that getting the result will not block,
733	while still supporting blocking waits if the caller so desires).	747	while still supporting blocking waits if the caller so desires).
734		748
735	Another reason I<never> to C<< ->recv >> in a module is that you cannot
736	sensibly have two C<< ->recv >>'s in parallel, as that would require
737	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
738	can supply.
739
740	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
741	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
742	versions and also integrates coroutines into AnyEvent, making blocking
743	C<< ->recv >> calls perfectly safe as long as they are done from another
744	coroutine (one that doesn't run the event loop).
745
746	You can ensure that C<< -recv >> never blocks by setting a callback and	749	You can ensure that C<< -recv >> never blocks by setting a callback and
747	only calling C<< ->recv >> from within that callback (or at a later	750	only calling C<< ->recv >> from within that callback (or at a later
748	time). This will work even when the event loop does not support blocking	751	time). This will work even when the event loop does not support blocking
749	waits otherwise.	752	waits otherwise.
750		753
…		…
763	variable itself. Calling C<recv> inside the callback or at any later time	766	variable itself. Calling C<recv> inside the callback or at any later time
764	is guaranteed not to block.	767	is guaranteed not to block.
765		768
766	=back	769	=back
767		770
		771	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		772
		773	The available backend classes are (every class has its own manpage):
		774
		775	=over 4
		776
		777	=item Backends that are autoprobed when no other event loop can be found.
		778
		779	EV is the preferred backend when no other event loop seems to be in
		780	use. If EV is not installed, then AnyEvent will try Event, and, failing
		781	that, will fall back to its own pure-perl implementation, which is
		782	available everywhere as it comes with AnyEvent itself.
		783
		784	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		785	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		786	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		787
		788	=item Backends that are transparently being picked up when they are used.
		789
		790	These will be used when they are currently loaded when the first watcher
		791	is created, in which case it is assumed that the application is using
		792	them. This means that AnyEvent will automatically pick the right backend
		793	when the main program loads an event module before anything starts to
		794	create watchers. Nothing special needs to be done by the main program.
		795
		796	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		797	AnyEvent::Impl::Tk based on Tk, very broken.
		798	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		799	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		800
		801	=item Backends with special needs.
		802
		803	Qt requires the Qt::Application to be instantiated first, but will
		804	otherwise be picked up automatically. As long as the main program
		805	instantiates the application before any AnyEvent watchers are created,
		806	everything should just work.
		807
		808	AnyEvent::Impl::Qt based on Qt.
		809
		810	Support for IO::Async can only be partial, as it is too broken and
		811	architecturally limited to even support the AnyEvent API. It also
		812	is the only event loop that needs the loop to be set explicitly, so
		813	it can only be used by a main program knowing about AnyEvent. See
		814	L<AnyEvent::Impl::Async> for the gory details.
		815
		816	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		817
		818	=item Event loops that are indirectly supported via other backends.
		819
		820	Some event loops can be supported via other modules:
		821
		822	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		823
		824	B<WxWidgets> has no support for watching file handles. However, you can
		825	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		826	polls 20 times per second, which was considered to be too horrible to even
		827	consider for AnyEvent.
		828
		829	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		830	backend, so it can be supported through POE.
		831
		832	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		833	load L<POE> when detecting them, in the hope that POE will pick them up,
		834	in which case everything will be automatic.
		835
		836	=back
		837
768	=head1 GLOBAL VARIABLES AND FUNCTIONS	838	=head1 GLOBAL VARIABLES AND FUNCTIONS
769		839
		840	These are not normally required to use AnyEvent, but can be useful to
		841	write AnyEvent extension modules.
		842
770	=over 4	843	=over 4
771		844
772	=item $AnyEvent::MODEL	845	=item $AnyEvent::MODEL
773		846
774	Contains C<undef> until the first watcher is being created. Then it	847	Contains C<undef> until the first watcher is being created, before the
		848	backend has been autodetected.
		849
775	contains the event model that is being used, which is the name of the	850	Afterwards it contains the event model that is being used, which is the
776	Perl class implementing the model. This class is usually one of the	851	name of the Perl class implementing the model. This class is usually one
777	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	852	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
778	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	853	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
779		854	will be C<urxvt::anyevent>).
780	The 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
795	There is no support for WxWidgets, as WxWidgets has no support for
796	watching file handles. However, you can use WxWidgets through the
797	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
798	second, which was considered to be too horrible to even consider for
799	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
800	it's adaptor.
801
802	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
803	autodetecting them.
804		855
805	=item AnyEvent::detect	856	=item AnyEvent::detect
806		857
807	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	858	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
808	if necessary. You should only call this function right before you would	859	if necessary. You should only call this function right before you would
809	have created an AnyEvent watcher anyway, that is, as late as possible at	860	have created an AnyEvent watcher anyway, that is, as late as possible at
810	runtime.	861	runtime, and not e.g. while initialising of your module.
		862
		863	If you need to do some initialisation before AnyEvent watchers are
		864	created, use C<post_detect>.
811		865
812	=item $guard = AnyEvent::post_detect { BLOCK }	866	=item $guard = AnyEvent::post_detect { BLOCK }
813		867
814	Arranges for the code block to be executed as soon as the event model is	868	Arranges for the code block to be executed as soon as the event model is
815	autodetected (or immediately if this has already happened).	869	autodetected (or immediately if this has already happened).
		870
		871	The block will be executed I<after> the actual backend has been detected
		872	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		873	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		874	other initialisations - see the sources of L<AnyEvent::Strict> or
		875	L<AnyEvent::AIO> to see how this is used.
		876
		877	The most common usage is to create some global watchers, without forcing
		878	event module detection too early, for example, L<AnyEvent::AIO> creates
		879	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		880	avoid autodetecting the event module at load time.
816		881
817	If called in scalar or list context, then it creates and returns an object	882	If called in scalar or list context, then it creates and returns an object
818	that automatically removes the callback again when it is destroyed. See	883	that automatically removes the callback again when it is destroyed. See
819	L<Coro::BDB> for a case where this is useful.	884	L<Coro::BDB> for a case where this is useful.
820		885
…		…
823	If there are any code references in this array (you can C<push> to it	888	If there are any code references in this array (you can C<push> to it
824	before or after loading AnyEvent), then they will called directly after	889	before or after loading AnyEvent), then they will called directly after
825	the event loop has been chosen.	890	the event loop has been chosen.
826		891
827	You should check C<$AnyEvent::MODEL> before adding to this array, though:	892	You should check C<$AnyEvent::MODEL> before adding to this array, though:
828	if it contains a true value then the event loop has already been detected,	893	if it is defined then the event loop has already been detected, and the
829	and the array will be ignored.	894	array will be ignored.
830		895
831	Best use C<AnyEvent::post_detect { BLOCK }> instead.	896	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		897	it,as it takes care of these details.
		898
		899	This variable is mainly useful for modules that can do something useful
		900	when AnyEvent is used and thus want to know when it is initialised, but do
		901	not need to even load it by default. This array provides the means to hook
		902	into AnyEvent passively, without loading it.
832		903
833	=back	904	=back
834		905
835	=head1 WHAT TO DO IN A MODULE	906	=head1 WHAT TO DO IN A MODULE
836		907
…		…
891		962
892		963
893	=head1 OTHER MODULES	964	=head1 OTHER MODULES
894		965
895	The following is a non-exhaustive list of additional modules that use	966	The following is a non-exhaustive list of additional modules that use
896	AnyEvent and can therefore be mixed easily with other AnyEvent modules	967	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
897	in the same program. Some of the modules come with AnyEvent, some are	968	modules and other event loops in the same program. Some of the modules
898	available via CPAN.	969	come with AnyEvent, most are available via CPAN.
899		970
900	=over 4	971	=over 4
901		972
902	=item L<AnyEvent::Util>	973	=item L<AnyEvent::Util>
903		974
…		…
912		983
913	=item L<AnyEvent::Handle>	984	=item L<AnyEvent::Handle>
914		985
915	Provide read and write buffers, manages watchers for reads and writes,	986	Provide read and write buffers, manages watchers for reads and writes,
916	supports raw and formatted I/O, I/O queued and fully transparent and	987	supports raw and formatted I/O, I/O queued and fully transparent and
917	non-blocking SSL/TLS.	988	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
918		989
919	=item L<AnyEvent::DNS>	990	=item L<AnyEvent::DNS>
920		991
921	Provides rich asynchronous DNS resolver capabilities.	992	Provides rich asynchronous DNS resolver capabilities.
922		993
…		…
950		1021
951	=item L<AnyEvent::GPSD>	1022	=item L<AnyEvent::GPSD>
952		1023
953	A non-blocking interface to gpsd, a daemon delivering GPS information.	1024	A non-blocking interface to gpsd, a daemon delivering GPS information.
954		1025
		1026	=item L<AnyEvent::IRC>
		1027
		1028	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		1029
		1030	=item L<AnyEvent::XMPP>
		1031
		1032	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1033	Net::XMPP2>.
		1034
955	=item L<AnyEvent::IGS>	1035	=item L<AnyEvent::IGS>
956		1036
957	A non-blocking interface to the Internet Go Server protocol (used by	1037	A non-blocking interface to the Internet Go Server protocol (used by
958	L<App::IGS>).	1038	L<App::IGS>).
959		1039
960	=item L<AnyEvent::IRC>
961
962	AnyEvent based IRC client module family (replacing the older Net::IRC3).
963
964	=item L<Net::XMPP2>
965
966	AnyEvent based XMPP (Jabber protocol) module family.
967
968	=item L<Net::FCP>	1040	=item L<Net::FCP>
969		1041
970	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1042	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
971	of AnyEvent.	1043	of AnyEvent.
972		1044
…		…
976		1048
977	=item L<Coro>	1049	=item L<Coro>
978		1050
979	Has special support for AnyEvent via L<Coro::AnyEvent>.	1051	Has special support for AnyEvent via L<Coro::AnyEvent>.
980		1052
981	=item L<IO::Lambda>
982
983	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
984
985	=back	1053	=back
986		1054
987	=cut	1055	=cut
988		1056
989	package AnyEvent;	1057	package AnyEvent;
990		1058
		1059	# basically a tuned-down version of common::sense
		1060	sub common_sense {
991	no warnings;	1061	# no warnings
		1062	${^WARNING_BITS} ^= ${^WARNING_BITS};
992	use strict qw(vars subs);	1063	# use strict vars subs
		1064	$^H \|= 0x00000600;
		1065	}
993		1066
		1067	BEGIN { AnyEvent::common_sense }
		1068
994	use Carp;	1069	use Carp ();
995		1070
996	our $VERSION = 4.8;	1071	our $VERSION = 4.85;
997	our $MODEL;	1072	our $MODEL;
998		1073
999	our $AUTOLOAD;	1074	our $AUTOLOAD;
1000	our @ISA;	1075	our @ISA;
1001		1076
1002	our @REGISTRY;	1077	our @REGISTRY;
1003		1078
1004	our $WIN32;	1079	our $WIN32;
		1080
		1081	our $VERBOSE;
1005		1082
1006	BEGIN {	1083	BEGIN {
1007	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1084	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1008	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1085	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
1009		1086
1010	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1087	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1011	if ${^TAINT};	1088	if ${^TAINT};
1012	}
1013		1089
1014	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1090	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1091
		1092	}
		1093
		1094	our $MAX_SIGNAL_LATENCY = 10;
1015		1095
1016	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1096	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
1017		1097
1018	{	1098	{
1019	my $idx;	1099	my $idx;
…		…
1027	[Event:: => AnyEvent::Impl::Event::],	1107	[Event:: => AnyEvent::Impl::Event::],
1028	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1108	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
1029	# everything below here will not be autoprobed	1109	# everything below here will not be autoprobed
1030	# as the pureperl backend should work everywhere	1110	# as the pureperl backend should work everywhere
1031	# and is usually faster	1111	# and is usually faster
1032	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1033	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1112	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1034	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1113	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1114	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1035	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1115	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1036	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1116	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1037	[Wx:: => AnyEvent::Impl::POE::],	1117	[Wx:: => AnyEvent::Impl::POE::],
1038	[Prima:: => AnyEvent::Impl::POE::],	1118	[Prima:: => AnyEvent::Impl::POE::],
1039	# IO::Async is just too broken - we would need workaorunds for its	1119	# IO::Async is just too broken - we would need workarounds for its
1040	# byzantine signal and broken child handling, among others.	1120	# byzantine signal and broken child handling, among others.
1041	# IO::Async is rather hard to detect, as it doesn't have any	1121	# IO::Async is rather hard to detect, as it doesn't have any
1042	# obvious default class.	1122	# obvious default class.
1043	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1123	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1044	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1124	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
…		…
1070	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1150	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1071	}	1151	}
1072		1152
1073	sub detect() {	1153	sub detect() {
1074	unless ($MODEL) {	1154	unless ($MODEL) {
1075	no strict 'refs';
1076	local $SIG{__DIE__};	1155	local $SIG{__DIE__};
1077		1156
1078	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1157	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1079	my $model = "AnyEvent::Impl::$1";	1158	my $model = "AnyEvent::Impl::$1";
1080	if (eval "require $model") {	1159	if (eval "require $model") {
1081	$MODEL = $model;	1160	$MODEL = $model;
1082	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1161	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1083	} else {	1162	} else {
1084	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1163	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1085	}	1164	}
1086	}	1165	}
1087		1166
1088	# check for already loaded models	1167	# check for already loaded models
1089	unless ($MODEL) {	1168	unless ($MODEL) {
1090	for (@REGISTRY, @models) {	1169	for (@REGISTRY, @models) {
1091	my ($package, $model) = @$_;	1170	my ($package, $model) = @$_;
1092	if (${"$package\::VERSION"} > 0) {	1171	if (${"$package\::VERSION"} > 0) {
1093	if (eval "require $model") {	1172	if (eval "require $model") {
1094	$MODEL = $model;	1173	$MODEL = $model;
1095	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1174	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1096	last;	1175	last;
1097	}	1176	}
1098	}	1177	}
1099	}	1178	}
1100		1179
…		…
1105	my ($package, $model) = @$_;	1184	my ($package, $model) = @$_;
1106	if (eval "require $package"	1185	if (eval "require $package"
1107	and ${"$package\::VERSION"} > 0	1186	and ${"$package\::VERSION"} > 0
1108	and eval "require $model") {	1187	and eval "require $model") {
1109	$MODEL = $model;	1188	$MODEL = $model;
1110	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1189	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1111	last;	1190	last;
1112	}	1191	}
1113	}	1192	}
1114		1193
1115	$MODEL	1194	$MODEL
…		…
1131		1210
1132	sub AUTOLOAD {	1211	sub AUTOLOAD {
1133	(my $func = $AUTOLOAD) =~ s/.*://;	1212	(my $func = $AUTOLOAD) =~ s/.*://;
1134		1213
1135	$method{$func}	1214	$method{$func}
1136	or croak "$func: not a valid method for AnyEvent objects";	1215	or Carp::croak "$func: not a valid method for AnyEvent objects";
1137		1216
1138	detect unless $MODEL;	1217	detect unless $MODEL;
1139		1218
1140	my $class = shift;	1219	my $class = shift;
1141	$class->$func (@_);	1220	$class->$func (@_);
…		…
1146	# allow only one watcher per fd, so we dup it to get a different one).	1225	# allow only one watcher per fd, so we dup it to get a different one).
1147	sub _dupfh($$;$$) {	1226	sub _dupfh($$;$$) {
1148	my ($poll, $fh, $r, $w) = @_;	1227	my ($poll, $fh, $r, $w) = @_;
1149		1228
1150	# cygwin requires the fh mode to be matching, unix doesn't	1229	# cygwin requires the fh mode to be matching, unix doesn't
1151	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1230	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		1231
1155	open my $fh2, "$mode&" . fileno $fh	1232	open my $fh2, $mode, $fh
1156	or die "cannot dup() filehandle: $!,";	1233	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1157		1234
1158	# we assume CLOEXEC is already set by perl in all important cases	1235	# we assume CLOEXEC is already set by perl in all important cases
1159		1236
1160	($fh2, $rw)	1237	($fh2, $rw)
1161	}	1238	}
1162		1239
1163	package AnyEvent::Base;	1240	package AnyEvent::Base;
1164		1241
1165	# default implementations for many methods	1242	# default implementations for many methods
1166		1243
1167	BEGIN {	1244	sub _time {
		1245	# probe for availability of Time::HiRes
1168	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1246	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1247	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1169	*_time = \&Time::HiRes::time;	1248	*_time = \&Time::HiRes::time;
1170	# if (eval "use POSIX (); (POSIX::times())...	1249	# if (eval "use POSIX (); (POSIX::times())...
1171	} else {	1250	} else {
		1251	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1172	*_time = sub { time }; # epic fail	1252	*_time = sub { time }; # epic fail
1173	}	1253	}
		1254
		1255	&_time
1174	}	1256	}
1175		1257
1176	sub time { _time }	1258	sub time { _time }
1177	sub now { _time }	1259	sub now { _time }
1178	sub now_update { }	1260	sub now_update { }
…		…
1183	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1265	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1184	}	1266	}
1185		1267
1186	# default implementation for ->signal	1268	# default implementation for ->signal
1187		1269
		1270	our $HAVE_ASYNC_INTERRUPT;
1188	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1271	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1272	our (%SIG_ASY, %SIG_ASY_W);
		1273	our ($SIG_COUNT, $SIG_TW);
1189		1274
1190	sub _signal_exec {	1275	sub _signal_exec {
		1276	$HAVE_ASYNC_INTERRUPT
		1277	? $SIGPIPE_R->drain
1191	sysread $SIGPIPE_R, my $dummy, 4;	1278	: sysread $SIGPIPE_R, my $dummy, 9;
1192		1279
1193	while (%SIG_EV) {	1280	while (%SIG_EV) {
1194	for (keys %SIG_EV) {	1281	for (keys %SIG_EV) {
1195	delete $SIG_EV{$_};	1282	delete $SIG_EV{$_};
1196	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1283	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1197	}	1284	}
1198	}	1285	}
1199	}	1286	}
1200		1287
		1288	# install a dumym wakeupw atcher to reduce signal catching latency
		1289	sub _sig_add() {
		1290	unless ($SIG_COUNT++) {
		1291	# try to align timer on a full-second boundary, if possible
		1292	my $NOW = AnyEvent->now;
		1293
		1294	$SIG_TW = AnyEvent->timer (
		1295	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1296	interval => $MAX_SIGNAL_LATENCY,
		1297	cb => sub { }, # just for the PERL_ASYNC_CHECK
		1298	);
		1299	}
		1300	}
		1301
		1302	sub _sig_del {
		1303	undef $SIG_TW
		1304	unless --$SIG_COUNT;
		1305	}
		1306
		1307	sub _signal {
		1308	my (undef, %arg) = @_;
		1309
		1310	my $signal = uc $arg{signal}
		1311	or Carp::croak "required option 'signal' is missing";
		1312
		1313	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1314
		1315	if ($HAVE_ASYNC_INTERRUPT) {
		1316	# async::interrupt
		1317
		1318	$SIG_ASY{$signal} \|\|= do {
		1319	my $asy = new Async::Interrupt
		1320	cb => sub { undef $SIG_EV{$signal} },
		1321	signal => $signal,
		1322	pipe => [$SIGPIPE_R->filenos],
		1323	;
		1324	$asy->pipe_autodrain (0);
		1325
		1326	$asy
		1327	};
		1328
		1329	} else {
		1330	# pure perl
		1331
		1332	$SIG{$signal} \|\|= sub {
		1333	local $!;
		1334	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1335	undef $SIG_EV{$signal};
		1336	};
		1337
		1338	# can't do signal processing without introducing races in pure perl,
		1339	# so limit the signal latency.
		1340	_sig_add;
		1341	}
		1342
		1343	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1344	}
		1345
1201	sub signal {	1346	sub signal {
1202	my (undef, %arg) = @_;	1347	# probe for availability of Async::Interrupt
		1348	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
		1349	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1203		1350
1204	unless ($SIGPIPE_R) {	1351	$HAVE_ASYNC_INTERRUPT = 1;
		1352	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1353	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
		1354
		1355	} else {
		1356	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1357
1205	require Fcntl;	1358	require Fcntl;
1206		1359
1207	if (AnyEvent::WIN32) {	1360	if (AnyEvent::WIN32) {
1208	require AnyEvent::Util;	1361	require AnyEvent::Util;
1209		1362
…		…
1224	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1377	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1225		1378
1226	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1379	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1227	}	1380	}
1228		1381
1229	my $signal = uc $arg{signal}	1382	*signal = \&_signal;
1230	or Carp::croak "required option 'signal' is missing";	1383	&signal
1231
1232	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1233	$SIG{$signal} \|\|= sub {
1234	local $!;
1235	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1236	undef $SIG_EV{$signal};
1237	};
1238
1239	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1240	}	1384	}
1241		1385
1242	sub AnyEvent::Base::signal::DESTROY {	1386	sub AnyEvent::Base::signal::DESTROY {
1243	my ($signal, $cb) = @{$_[0]};	1387	my ($signal, $cb) = @{$_[0]};
1244		1388
		1389	_sig_del;
		1390
1245	delete $SIG_CB{$signal}{$cb};	1391	delete $SIG_CB{$signal}{$cb};
1246		1392
		1393	$HAVE_ASYNC_INTERRUPT
		1394	? delete $SIG_ASY{$signal}
1247	# delete doesn't work with older perls - they then	1395	: # delete doesn't work with older perls - they then
1248	# print weird messages, or just unconditionally exit	1396	# print weird messages, or just unconditionally exit
1249	# instead of getting the default action.	1397	# instead of getting the default action.
		1398	undef $SIG{$signal}
1250	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };	1399	unless keys %{ $SIG_CB{$signal} };
1251	}	1400	}
1252		1401
1253	# default implementation for ->child	1402	# default implementation for ->child
1254		1403
1255	our %PID_CB;	1404	our %PID_CB;
…		…
1257	our $CHLD_DELAY_W;	1406	our $CHLD_DELAY_W;
1258	our $WNOHANG;	1407	our $WNOHANG;
1259		1408
1260	sub _sigchld {	1409	sub _sigchld {
1261	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1410	while (0 < (my $pid = waitpid -1, $WNOHANG)) {
		1411	$_->($pid, $?)
1262	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),	1412	for values %{ $PID_CB{$pid} \|\| {} },
1263	(values %{ $PID_CB{0} \|\| {} });	1413	values %{ $PID_CB{0} \|\| {} };
1264	}	1414	}
1265	}	1415	}
1266		1416
1267	sub child {	1417	sub child {
1268	my (undef, %arg) = @_;	1418	my (undef, %arg) = @_;
…		…
1270	defined (my $pid = $arg{pid} + 0)	1420	defined (my $pid = $arg{pid} + 0)
1271	or Carp::croak "required option 'pid' is missing";	1421	or Carp::croak "required option 'pid' is missing";
1272		1422
1273	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1423	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1274		1424
		1425	# WNOHANG is almost cetrainly 1 everywhere
		1426	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1427	? 1
1275	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1428	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1276		1429
1277	unless ($CHLD_W) {	1430	unless ($CHLD_W) {
1278	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1431	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1279	# child could be a zombie already, so make at least one round	1432	# child could be a zombie already, so make at least one round
1280	&_sigchld;	1433	&_sigchld;
…		…
1332		1485
1333	our @ISA = AnyEvent::CondVar::Base::;	1486	our @ISA = AnyEvent::CondVar::Base::;
1334		1487
1335	package AnyEvent::CondVar::Base;	1488	package AnyEvent::CondVar::Base;
1336		1489
1337	use overload	1490	#use overload
1338	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1491	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1339	fallback => 1;	1492	# fallback => 1;
		1493
		1494	# save 300+ kilobytes by dirtily hardcoding overloading
		1495	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1496	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1497	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1498	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1499
		1500	our $WAITING;
1340		1501
1341	sub _send {	1502	sub _send {
1342	# nop	1503	# nop
1343	}	1504	}
1344		1505
…		…
1357	sub ready {	1518	sub ready {
1358	$_[0]{_ae_sent}	1519	$_[0]{_ae_sent}
1359	}	1520	}
1360		1521
1361	sub _wait {	1522	sub _wait {
		1523	$WAITING
		1524	and !$_[0]{_ae_sent}
		1525	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1526
		1527	local $WAITING = 1;
1362	AnyEvent->one_event while !$_[0]{_ae_sent};	1528	AnyEvent->one_event while !$_[0]{_ae_sent};
1363	}	1529	}
1364		1530
1365	sub recv {	1531	sub recv {
1366	$_[0]->_wait;	1532	$_[0]->_wait;
…		…
1428	C<PERL_ANYEVENT_MODEL>.	1594	C<PERL_ANYEVENT_MODEL>.
1429		1595
1430	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1596	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1431	model it chooses.	1597	model it chooses.
1432		1598
		1599	When set to C<8> or higher, then AnyEvent will report extra information on
		1600	which optional modules it loads and how it implements certain features.
		1601
1433	=item C<PERL_ANYEVENT_STRICT>	1602	=item C<PERL_ANYEVENT_STRICT>
1434		1603
1435	AnyEvent does not do much argument checking by default, as thorough	1604	AnyEvent does not do much argument checking by default, as thorough
1436	argument checking is very costly. Setting this variable to a true value	1605	argument checking is very costly. Setting this variable to a true value
1437	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1606	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1438	check the arguments passed to most method calls. If it finds any problems,	1607	check the arguments passed to most method calls. If it finds any problems,
1439	it will croak.	1608	it will croak.
1440		1609
1441	In other words, enables "strict" mode.	1610	In other words, enables "strict" mode.
1442		1611
1443	Unlike C<use strict>, it is definitely recommended to keep it off in	1612	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1444	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1613	>>, it is definitely recommended to keep it off in production. Keeping
1445	developing programs can be very useful, however.	1614	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1615	can be very useful, however.
1446		1616
1447	=item C<PERL_ANYEVENT_MODEL>	1617	=item C<PERL_ANYEVENT_MODEL>
1448		1618
1449	This can be used to specify the event model to be used by AnyEvent, before	1619	This can be used to specify the event model to be used by AnyEvent, before
1450	auto detection and -probing kicks in. It must be a string consisting	1620	auto detection and -probing kicks in. It must be a string consisting
…		…
1512		1682
1513	When neither C<ca_file> nor C<ca_path> was specified during	1683	When neither C<ca_file> nor C<ca_path> was specified during
1514	L<AnyEvent::TLS> context creation, and either of these environment	1684	L<AnyEvent::TLS> context creation, and either of these environment
1515	variables exist, they will be used to specify CA certificate locations	1685	variables exist, they will be used to specify CA certificate locations
1516	instead of a system-dependent default.	1686	instead of a system-dependent default.
		1687
		1688	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1689
		1690	When these are set to C<1>, then the respective modules are not
		1691	loaded. Mostly good for testing AnyEvent itself.
1517		1692
1518	=back	1693	=back
1519		1694
1520	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1695	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1521		1696
…		…
2060		2235
2061	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2236	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2062	emulation for event loops that do not support them natively. Also, some	2237	emulation for event loops that do not support them natively. Also, some
2063	event loops install a similar handler.	2238	event loops install a similar handler.
2064		2239
2065	If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will	2240	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2066	reset it to default, to avoid losing child exit statuses.	2241	AnyEvent will reset it to default, to avoid losing child exit statuses.
2067		2242
2068	=item SIGPIPE	2243	=item SIGPIPE
2069		2244
2070	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2245	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2071	when AnyEvent gets loaded.	2246	when AnyEvent gets loaded.
…		…
2089	if $SIG{CHLD} eq 'IGNORE';	2264	if $SIG{CHLD} eq 'IGNORE';
2090		2265
2091	$SIG{PIPE} = sub { }	2266	$SIG{PIPE} = sub { }
2092	unless defined $SIG{PIPE};	2267	unless defined $SIG{PIPE};
2093		2268
		2269	=head1 RECOMMENDED/OPTIONAL MODULES
		2270
		2271	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2272	it's built-in modules) are required to use it.
		2273
		2274	That does not mean that AnyEvent won't take advantage of some additional
		2275	modules if they are installed.
		2276
		2277	This section epxlains which additional modules will be used, and how they
		2278	affect AnyEvent's operetion.
		2279
		2280	=over 4
		2281
		2282	=item L<Async::Interrupt>
		2283
		2284	This slightly arcane module is used to implement fast signal handling: To
		2285	my knowledge, there is no way to do completely race-free and quick
		2286	signal handling in pure perl. To ensure that signals still get
		2287	delivered, AnyEvent will start an interval timer to wake up perl (and
		2288	catch the signals) with some delay (default is 10 seconds, look for
		2289	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2290
		2291	If this module is available, then it will be used to implement signal
		2292	catching, which means that signals will not be delayed, and the event loop
		2293	will not be interrupted regularly, which is more efficient (And good for
		2294	battery life on laptops).
		2295
		2296	This affects not just the pure-perl event loop, but also other event loops
		2297	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2298
		2299	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2300	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2301	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2302	does nothing for those backends.
		2303
		2304	=item L<EV>
		2305
		2306	This module isn't really "optional", as it is simply one of the backend
		2307	event loops that AnyEvent can use. However, it is simply the best event
		2308	loop available in terms of features, speed and stability: It supports
		2309	the AnyEvent API optimally, implements all the watcher types in XS, does
		2310	automatic timer adjustments even when no monotonic clock is available,
		2311	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2312	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2313	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2314
		2315	=item L<Guard>
		2316
		2317	The guard module, when used, will be used to implement
		2318	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2319	lot less memory), but otherwise doesn't affect guard operation much. It is
		2320	purely used for performance.
		2321
		2322	=item L<JSON> and L<JSON::XS>
		2323
		2324	This module is required when you want to read or write JSON data via
		2325	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2326	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2327
		2328	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2329	installed.
		2330
		2331	=item L<Net::SSLeay>
		2332
		2333	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2334	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2335	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2336
		2337	=item L<Time::HiRes>
		2338
		2339	This module is part of perl since release 5.008. It will be used when the
		2340	chosen event library does not come with a timing source on it's own. The
		2341	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2342	try to use a monotonic clock for timing stability.
		2343
		2344	=back
		2345
		2346
2094	=head1 FORK	2347	=head1 FORK
2095		2348
2096	Most event libraries are not fork-safe. The ones who are usually are	2349	Most event libraries are not fork-safe. The ones who are usually are
2097	because they rely on inefficient but fork-safe C<select> or C<poll>	2350	because they rely on inefficient but fork-safe C<select> or C<poll>
2098	calls. Only L<EV> is fully fork-aware.	2351	calls. Only L<EV> is fully fork-aware.
2099		2352
2100	If you have to fork, you must either do so I<before> creating your first	2353	If you have to fork, you must either do so I<before> creating your first
2101	watcher OR you must not use AnyEvent at all in the child.	2354	watcher OR you must not use AnyEvent at all in the child OR you must do
		2355	something completely out of the scope of AnyEvent.
2102		2356
2103		2357
2104	=head1 SECURITY CONSIDERATIONS	2358	=head1 SECURITY CONSIDERATIONS
2105		2359
2106	AnyEvent can be forced to load any event model via	2360	AnyEvent can be forced to load any event model via
…		…
2144	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2398	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2145		2399
2146	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2400	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2147	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2401	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2148	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2402	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2149	L<AnyEvent::Impl::POE>.	2403	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
2150		2404
2151	Non-blocking file handles, sockets, TCP clients and	2405	Non-blocking file handles, sockets, TCP clients and
2152	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2406	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2153		2407
2154	Asynchronous DNS: L<AnyEvent::DNS>.	2408	Asynchronous DNS: L<AnyEvent::DNS>.
2155		2409
2156	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2410	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2411	L<Coro::Event>,
2157		2412
2158	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2413	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2414	L<AnyEvent::HTTP>.
2159		2415
2160		2416
2161	=head1 AUTHOR	2417	=head1 AUTHOR
2162		2418
2163	Marc Lehmann <schmorp@schmorp.de>	2419	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.228 by root, Wed Jul 8 01:11:12 2009 UTC vs. Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.228 by root, Wed Jul 8 01:11:12 2009 UTC vs.
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC