[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.247 by root, Sat Jul 18 22:24:17 2009 UTC

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