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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.211 by root, Sat Jun 6 12:04:30 2009 UTC vs.
Revision 1.264 by root, Wed Jul 29 12:42:09 2009 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6	event loops.	6	and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
40	=head1 INTRODUCTION/TUTORIAL	40	=head1 INTRODUCTION/TUTORIAL
41		41
42	This manpage is mainly a reference manual. If you are interested	42	This manpage is mainly a reference manual. If you are interested
43	in a tutorial or some gentle introduction, have a look at the	43	in a tutorial or some gentle introduction, have a look at the
44	L<AnyEvent::Intro> manpage.	44	L<AnyEvent::Intro> manpage.
		45
		46	=head1 SUPPORT
		47
		48	There is a mailinglist for discussing all things AnyEvent, and an IRC
		49	channel, too.
		50
		51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		52	Repository>, at L<http://anyevent.schmorp.de>, for more info.
45		53
46	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47		55
48	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
176	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
177		185
178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	186	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179	with the following mandatory key-value pairs as arguments:	187	with the following mandatory key-value pairs as arguments:
180		188
181	C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch	189	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182	for events (AnyEvent might or might not keep a reference to this file	190	for events (AnyEvent might or might not keep a reference to this file
183	handle). Note that only file handles pointing to things for which	191	handle). Note that only file handles pointing to things for which
184	non-blocking operation makes sense are allowed. This includes sockets,	192	non-blocking operation makes sense are allowed. This includes sockets,
185	most character devices, pipes, fifos and so on, but not for example files	193	most character devices, pipes, fifos and so on, but not for example files
186	or block devices.	194	or block devices.
…		…
361	invocation, and callback invocation will be synchronous. Synchronous means	369	invocation, and callback invocation will be synchronous. Synchronous means
362	that it might take a while until the signal gets handled by the process,	370	that it might take a while until the signal gets handled by the process,
363	but it is guaranteed not to interrupt any other callbacks.	371	but it is guaranteed not to interrupt any other callbacks.
364		372
365	The main advantage of using these watchers is that you can share a signal	373	The main advantage of using these watchers is that you can share a signal
366	between multiple watchers.	374	between multiple watchers, and AnyEvent will ensure that signals will not
		375	interrupt your program at bad times.
367		376
368	This watcher might use C<%SIG>, so programs overwriting those signals	377	This watcher might use C<%SIG> (depending on the event loop used),
369	directly will likely not work correctly.	378	so programs overwriting those signals directly will likely not work
		379	correctly.
370		380
371	Example: exit on SIGINT	381	Example: exit on SIGINT
372		382
373	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
374		384
		385	=head3 Signal Races, Delays and Workarounds
		386
		387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		388	callbacks to signals in a generic way, which is a pity, as you cannot do
		389	race-free signal handling in perl. AnyEvent will try to do it's best, but
		390	in some cases, signals will be delayed. The maximum time a signal might
		391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
		392	seconds). This variable can be changed only before the first signal
		393	watcher is created, and should be left alone otherwise. Higher values
		394	will cause fewer spurious wake-ups, which is better for power and CPU
		395	saving. All these problems can be avoided by installing the optional
		396	L<Async::Interrupt> module. This will not work with inherently broken
		397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
		398	currently, as POE does it's own workaround with one-second latency). With
		399	those, you just have to suffer the delays.
		400
375	=head2 CHILD PROCESS WATCHERS	401	=head2 CHILD PROCESS WATCHERS
376		402
377	You can also watch on a child process exit and catch its exit status.	403	You can also watch on a child process exit and catch its exit status.
378		404
379	The child process is specified by the C<pid> argument (if set to C<0>, it	405	The child process is specified by the C<pid> argument (one some backends,
380	watches for any child process exit). The watcher will triggered only when	406	using C<0> watches for any child process exit, on others this will
381	the child process has finished and an exit status is available, not on	407	croak). The watcher will be triggered only when the child process has
382	any trace events (stopped/continued).	408	finished and an exit status is available, not on any trace events
		409	(stopped/continued).
383		410
384	The callback will be called with the pid and exit status (as returned by	411	The callback will be called with the pid and exit status (as returned by
385	waitpid), so unlike other watcher types, you I<can> rely on child watcher	412	waitpid), so unlike other watcher types, you I<can> rely on child watcher
386	callback arguments.	413	callback arguments.
387		414
…		…
392		419
393	There is a slight catch to child watchers, however: you usually start them	420	There is a slight catch to child watchers, however: you usually start them
394	I<after> the child process was created, and this means the process could	421	I<after> the child process was created, and this means the process could
395	have exited already (and no SIGCHLD will be sent anymore).	422	have exited already (and no SIGCHLD will be sent anymore).
396		423
397	Not all event models handle this correctly (POE doesn't), but even for	424	Not all event models handle this correctly (neither POE nor IO::Async do,
		425	see their AnyEvent::Impl manpages for details), but even for event models
398	event models that I<do> handle this correctly, they usually need to be	426	that I<do> handle this correctly, they usually need to be loaded before
399	loaded before the process exits (i.e. before you fork in the first place).	427	the process exits (i.e. before you fork in the first place). AnyEvent's
		428	pure perl event loop handles all cases correctly regardless of when you
		429	start the watcher.
400		430
401	This means you cannot create a child watcher as the very first thing in an	431	This means you cannot create a child watcher as the very first
402	AnyEvent program, you I<have> to create at least one watcher before you	432	thing in an AnyEvent program, you I<have> to create at least one
403	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	433	watcher before you C<fork> the child (alternatively, you can call
		434	C<AnyEvent::detect>).
		435
		436	As most event loops do not support waiting for child events, they will be
		437	emulated by AnyEvent in most cases, in which the latency and race problems
		438	mentioned in the description of signal watchers apply.
404		439
405	Example: fork a process and wait for it	440	Example: fork a process and wait for it
406		441
407	my $done = AnyEvent->condvar;	442	my $done = AnyEvent->condvar;
408		443
…		…
459		494
460	If you are familiar with some event loops you will know that all of them	495	If you are familiar with some event loops you will know that all of them
461	require you to run some blocking "loop", "run" or similar function that	496	require you to run some blocking "loop", "run" or similar function that
462	will actively watch for new events and call your callbacks.	497	will actively watch for new events and call your callbacks.
463		498
464	AnyEvent is different, it expects somebody else to run the event loop and	499	AnyEvent is slightly different: it expects somebody else to run the event
465	will only block when necessary (usually when told by the user).	500	loop and will only block when necessary (usually when told by the user).
466		501
467	The instrument to do that is called a "condition variable", so called	502	The instrument to do that is called a "condition variable", so called
468	because they represent a condition that must become true.	503	because they represent a condition that must become true.
469		504
		505	Now is probably a good time to look at the examples further below.
		506
470	Condition variables can be created by calling the C<< AnyEvent->condvar	507	Condition variables can be created by calling the C<< AnyEvent->condvar
471	>> method, usually without arguments. The only argument pair allowed is	508	>> method, usually without arguments. The only argument pair allowed is
472
473	C<cb>, which specifies a callback to be called when the condition variable	509	C<cb>, which specifies a callback to be called when the condition variable
474	becomes true, with the condition variable as the first argument (but not	510	becomes true, with the condition variable as the first argument (but not
475	the results).	511	the results).
476		512
477	After creation, the condition variable is "false" until it becomes "true"	513	After creation, the condition variable is "false" until it becomes "true"
…		…
482	Condition variables are similar to callbacks, except that you can	518	Condition variables are similar to callbacks, except that you can
483	optionally wait for them. They can also be called merge points - points	519	optionally wait for them. They can also be called merge points - points
484	in time where multiple outstanding events have been processed. And yet	520	in time where multiple outstanding events have been processed. And yet
485	another way to call them is transactions - each condition variable can be	521	another way to call them is transactions - each condition variable can be
486	used to represent a transaction, which finishes at some point and delivers	522	used to represent a transaction, which finishes at some point and delivers
487	a result.	523	a result. And yet some people know them as "futures" - a promise to
		524	compute/deliver something that you can wait for.
488		525
489	Condition variables are very useful to signal that something has finished,	526	Condition variables are very useful to signal that something has finished,
490	for example, if you write a module that does asynchronous http requests,	527	for example, if you write a module that does asynchronous http requests,
491	then a condition variable would be the ideal candidate to signal the	528	then a condition variable would be the ideal candidate to signal the
492	availability of results. The user can either act when the callback is	529	availability of results. The user can either act when the callback is
…		…
526	after => 1,	563	after => 1,
527	cb => sub { $result_ready->send },	564	cb => sub { $result_ready->send },
528	);	565	);
529		566
530	# this "blocks" (while handling events) till the callback	567	# this "blocks" (while handling events) till the callback
531	# calls send	568	# calls -<send
532	$result_ready->recv;	569	$result_ready->recv;
533		570
534	Example: wait for a timer, but take advantage of the fact that	571	Example: wait for a timer, but take advantage of the fact that condition
535	condition variables are also code references.	572	variables are also callable directly.
536		573
537	my $done = AnyEvent->condvar;	574	my $done = AnyEvent->condvar;
538	my $delay = AnyEvent->timer (after => 5, cb => $done);	575	my $delay = AnyEvent->timer (after => 5, cb => $done);
539	$done->recv;	576	$done->recv;
540		577
…		…
546		583
547	...	584	...
548		585
549	my @info = $couchdb->info->recv;	586	my @info = $couchdb->info->recv;
550		587
551	And this is how you would just ste a callback to be called whenever the	588	And this is how you would just set a callback to be called whenever the
552	results are available:	589	results are available:
553		590
554	$couchdb->info->cb (sub {	591	$couchdb->info->cb (sub {
555	my @info = $_[0]->recv;	592	my @info = $_[0]->recv;
556	});	593	});
…		…
574	immediately from within send.	611	immediately from within send.
575		612
576	Any arguments passed to the C<send> call will be returned by all	613	Any arguments passed to the C<send> call will be returned by all
577	future C<< ->recv >> calls.	614	future C<< ->recv >> calls.
578		615
579	Condition variables are overloaded so one can call them directly	616	Condition variables are overloaded so one can call them directly (as if
580	(as a code reference). Calling them directly is the same as calling	617	they were a code reference). Calling them directly is the same as calling
581	C<send>. Note, however, that many C-based event loops do not handle	618	C<send>.
582	overloading, so as tempting as it may be, passing a condition variable
583	instead of a callback does not work. Both the pure perl and EV loops
584	support overloading, however, as well as all functions that use perl to
585	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
586	example).
587		619
588	=item $cv->croak ($error)	620	=item $cv->croak ($error)
589		621
590	Similar to send, but causes all call's to C<< ->recv >> to invoke	622	Similar to send, but causes all call's to C<< ->recv >> to invoke
591	C<Carp::croak> with the given error message/object/scalar.	623	C<Carp::croak> with the given error message/object/scalar.
592		624
593	This can be used to signal any errors to the condition variable	625	This can be used to signal any errors to the condition variable
594	user/consumer.	626	user/consumer. Doing it this way instead of calling C<croak> directly
		627	delays the error detetcion, but has the overwhelmign advantage that it
		628	diagnoses the error at the place where the result is expected, and not
		629	deep in some event clalback without connection to the actual code causing
		630	the problem.
595		631
596	=item $cv->begin ([group callback])	632	=item $cv->begin ([group callback])
597		633
598	=item $cv->end	634	=item $cv->end
599
600	These two methods are EXPERIMENTAL and MIGHT CHANGE.
601		635
602	These two methods can be used to combine many transactions/events into	636	These two methods can be used to combine many transactions/events into
603	one. For example, a function that pings many hosts in parallel might want	637	one. For example, a function that pings many hosts in parallel might want
604	to use a condition variable for the whole process.	638	to use a condition variable for the whole process.
605		639
…		…
607	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	641	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
608	>>, the (last) callback passed to C<begin> will be executed. That callback	642	>>, the (last) callback passed to C<begin> will be executed. That callback
609	is I<supposed> to call C<< ->send >>, but that is not required. If no	643	is I<supposed> to call C<< ->send >>, but that is not required. If no
610	callback was set, C<send> will be called without any arguments.	644	callback was set, C<send> will be called without any arguments.
611		645
612	Let's clarify this with the ping example:	646	You can think of C<< $cv->send >> giving you an OR condition (one call
		647	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
		648	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
		649
		650	Let's start with a simple example: you have two I/O watchers (for example,
		651	STDOUT and STDERR for a program), and you want to wait for both streams to
		652	close before activating a condvar:
		653
		654	my $cv = AnyEvent->condvar;
		655
		656	$cv->begin; # first watcher
		657	my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
		658	defined sysread $fh1, my $buf, 4096
		659	or $cv->end;
		660	});
		661
		662	$cv->begin; # second watcher
		663	my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
		664	defined sysread $fh2, my $buf, 4096
		665	or $cv->end;
		666	});
		667
		668	$cv->recv;
		669
		670	This works because for every event source (EOF on file handle), there is
		671	one call to C<begin>, so the condvar waits for all calls to C<end> before
		672	sending.
		673
		674	The ping example mentioned above is slightly more complicated, as the
		675	there are results to be passwd back, and the number of tasks that are
		676	begung can potentially be zero:
613		677
614	my $cv = AnyEvent->condvar;	678	my $cv = AnyEvent->condvar;
615		679
616	my %result;	680	my %result;
617	$cv->begin (sub { $cv->send (\%result) });	681	$cv->begin (sub { $cv->send (\%result) });
…		…
637	loop, which serves two important purposes: first, it sets the callback	701	loop, which serves two important purposes: first, it sets the callback
638	to be called once the counter reaches C<0>, and second, it ensures that	702	to be called once the counter reaches C<0>, and second, it ensures that
639	C<send> is called even when C<no> hosts are being pinged (the loop	703	C<send> is called even when C<no> hosts are being pinged (the loop
640	doesn't execute once).	704	doesn't execute once).
641		705
642	This is the general pattern when you "fan out" into multiple subrequests:	706	This is the general pattern when you "fan out" into multiple (but
643	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	707	potentially none) subrequests: use an outer C<begin>/C<end> pair to set
644	is called at least once, and then, for each subrequest you start, call	708	the callback and ensure C<end> is called at least once, and then, for each
645	C<begin> and for each subrequest you finish, call C<end>.	709	subrequest you start, call C<begin> and for each subrequest you finish,
		710	call C<end>.
646		711
647	=back	712	=back
648		713
649	=head3 METHODS FOR CONSUMERS	714	=head3 METHODS FOR CONSUMERS
650		715
…		…
666	function will call C<croak>.	731	function will call C<croak>.
667		732
668	In list context, all parameters passed to C<send> will be returned,	733	In list context, all parameters passed to C<send> will be returned,
669	in scalar context only the first one will be returned.	734	in scalar context only the first one will be returned.
670		735
		736	Note that doing a blocking wait in a callback is not supported by any
		737	event loop, that is, recursive invocation of a blocking C<< ->recv
		738	>> is not allowed, and the C<recv> call will C<croak> if such a
		739	condition is detected. This condition can be slightly loosened by using
		740	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		741	any thread that doesn't run the event loop itself.
		742
671	Not all event models support a blocking wait - some die in that case	743	Not all event models support a blocking wait - some die in that case
672	(programs might want to do that to stay interactive), so I<if you are	744	(programs might want to do that to stay interactive), so I<if you are
673	using this from a module, never require a blocking wait>, but let the	745	using this from a module, never require a blocking wait>. Instead, let the
674	caller decide whether the call will block or not (for example, by coupling	746	caller decide whether the call will block or not (for example, by coupling
675	condition variables with some kind of request results and supporting	747	condition variables with some kind of request results and supporting
676	callbacks so the caller knows that getting the result will not block,	748	callbacks so the caller knows that getting the result will not block,
677	while still supporting blocking waits if the caller so desires).	749	while still supporting blocking waits if the caller so desires).
678		750
679	Another reason I<never> to C<< ->recv >> in a module is that you cannot
680	sensibly have two C<< ->recv >>'s in parallel, as that would require
681	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
682	can supply.
683
684	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
685	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
686	versions and also integrates coroutines into AnyEvent, making blocking
687	C<< ->recv >> calls perfectly safe as long as they are done from another
688	coroutine (one that doesn't run the event loop).
689
690	You can ensure that C<< -recv >> never blocks by setting a callback and	751	You can ensure that C<< -recv >> never blocks by setting a callback and
691	only calling C<< ->recv >> from within that callback (or at a later	752	only calling C<< ->recv >> from within that callback (or at a later
692	time). This will work even when the event loop does not support blocking	753	time). This will work even when the event loop does not support blocking
693	waits otherwise.	754	waits otherwise.
694		755
…		…
707	variable itself. Calling C<recv> inside the callback or at any later time	768	variable itself. Calling C<recv> inside the callback or at any later time
708	is guaranteed not to block.	769	is guaranteed not to block.
709		770
710	=back	771	=back
711		772
		773	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		774
		775	The available backend classes are (every class has its own manpage):
		776
		777	=over 4
		778
		779	=item Backends that are autoprobed when no other event loop can be found.
		780
		781	EV is the preferred backend when no other event loop seems to be in
		782	use. If EV is not installed, then AnyEvent will try Event, and, failing
		783	that, will fall back to its own pure-perl implementation, which is
		784	available everywhere as it comes with AnyEvent itself.
		785
		786	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		787	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		788	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		789
		790	=item Backends that are transparently being picked up when they are used.
		791
		792	These will be used when they are currently loaded when the first watcher
		793	is created, in which case it is assumed that the application is using
		794	them. This means that AnyEvent will automatically pick the right backend
		795	when the main program loads an event module before anything starts to
		796	create watchers. Nothing special needs to be done by the main program.
		797
		798	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		799	AnyEvent::Impl::Tk based on Tk, very broken.
		800	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		801	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		802	AnyEvent::Impl::Irssi used when running within irssi.
		803
		804	=item Backends with special needs.
		805
		806	Qt requires the Qt::Application to be instantiated first, but will
		807	otherwise be picked up automatically. As long as the main program
		808	instantiates the application before any AnyEvent watchers are created,
		809	everything should just work.
		810
		811	AnyEvent::Impl::Qt based on Qt.
		812
		813	Support for IO::Async can only be partial, as it is too broken and
		814	architecturally limited to even support the AnyEvent API. It also
		815	is the only event loop that needs the loop to be set explicitly, so
		816	it can only be used by a main program knowing about AnyEvent. See
		817	L<AnyEvent::Impl::Async> for the gory details.
		818
		819	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		820
		821	=item Event loops that are indirectly supported via other backends.
		822
		823	Some event loops can be supported via other modules:
		824
		825	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		826
		827	B<WxWidgets> has no support for watching file handles. However, you can
		828	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		829	polls 20 times per second, which was considered to be too horrible to even
		830	consider for AnyEvent.
		831
		832	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		833	backend, so it can be supported through POE.
		834
		835	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		836	load L<POE> when detecting them, in the hope that POE will pick them up,
		837	in which case everything will be automatic.
		838
		839	=back
		840
712	=head1 GLOBAL VARIABLES AND FUNCTIONS	841	=head1 GLOBAL VARIABLES AND FUNCTIONS
713		842
		843	These are not normally required to use AnyEvent, but can be useful to
		844	write AnyEvent extension modules.
		845
714	=over 4	846	=over 4
715		847
716	=item $AnyEvent::MODEL	848	=item $AnyEvent::MODEL
717		849
718	Contains C<undef> until the first watcher is being created. Then it	850	Contains C<undef> until the first watcher is being created, before the
		851	backend has been autodetected.
		852
719	contains the event model that is being used, which is the name of the	853	Afterwards it contains the event model that is being used, which is the
720	Perl class implementing the model. This class is usually one of the	854	name of the Perl class implementing the model. This class is usually one
721	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	855	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
722	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	856	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
723		857	will be C<urxvt::anyevent>).
724	The known classes so far are:
725
726	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
727	AnyEvent::Impl::Event based on Event, second best choice.
728	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
729	AnyEvent::Impl::Glib based on Glib, third-best choice.
730	AnyEvent::Impl::Tk based on Tk, very bad choice.
731	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
732	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
733	AnyEvent::Impl::POE based on POE, not generic enough for full support.
734
735	There is no support for WxWidgets, as WxWidgets has no support for
736	watching file handles. However, you can use WxWidgets through the
737	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
738	second, which was considered to be too horrible to even consider for
739	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
740	it's adaptor.
741
742	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
743	autodetecting them.
744		858
745	=item AnyEvent::detect	859	=item AnyEvent::detect
746		860
747	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	861	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
748	if necessary. You should only call this function right before you would	862	if necessary. You should only call this function right before you would
749	have created an AnyEvent watcher anyway, that is, as late as possible at	863	have created an AnyEvent watcher anyway, that is, as late as possible at
750	runtime.	864	runtime, and not e.g. while initialising of your module.
		865
		866	If you need to do some initialisation before AnyEvent watchers are
		867	created, use C<post_detect>.
751		868
752	=item $guard = AnyEvent::post_detect { BLOCK }	869	=item $guard = AnyEvent::post_detect { BLOCK }
753		870
754	Arranges for the code block to be executed as soon as the event model is	871	Arranges for the code block to be executed as soon as the event model is
755	autodetected (or immediately if this has already happened).	872	autodetected (or immediately if this has already happened).
756		873
		874	The block will be executed I<after> the actual backend has been detected
		875	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		876	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		877	other initialisations - see the sources of L<AnyEvent::Strict> or
		878	L<AnyEvent::AIO> to see how this is used.
		879
		880	The most common usage is to create some global watchers, without forcing
		881	event module detection too early, for example, L<AnyEvent::AIO> creates
		882	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		883	avoid autodetecting the event module at load time.
		884
757	If called in scalar or list context, then it creates and returns an object	885	If called in scalar or list context, then it creates and returns an object
758	that automatically removes the callback again when it is destroyed. See	886	that automatically removes the callback again when it is destroyed (or
		887	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
759	L<Coro::BDB> for a case where this is useful.	888	a case where this is useful.
		889
		890	Example: Create a watcher for the IO::AIO module and store it in
		891	C<$WATCHER>. Only do so after the event loop is initialised, though.
		892
		893	our WATCHER;
		894
		895	my $guard = AnyEvent::post_detect {
		896	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		897	};
		898
		899	# the \|\|= is important in case post_detect immediately runs the block,
		900	# as to not clobber the newly-created watcher. assigning both watcher and
		901	# post_detect guard to the same variable has the advantage of users being
		902	# able to just C<undef $WATCHER> if the watcher causes them grief.
		903
		904	$WATCHER \|\|= $guard;
760		905
761	=item @AnyEvent::post_detect	906	=item @AnyEvent::post_detect
762		907
763	If there are any code references in this array (you can C<push> to it	908	If there are any code references in this array (you can C<push> to it
764	before or after loading AnyEvent), then they will called directly after	909	before or after loading AnyEvent), then they will called directly after
765	the event loop has been chosen.	910	the event loop has been chosen.
766		911
767	You should check C<$AnyEvent::MODEL> before adding to this array, though:	912	You should check C<$AnyEvent::MODEL> before adding to this array, though:
768	if it contains a true value then the event loop has already been detected,	913	if it is defined then the event loop has already been detected, and the
769	and the array will be ignored.	914	array will be ignored.
770		915
771	Best use C<AnyEvent::post_detect { BLOCK }> instead.	916	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		917	it,as it takes care of these details.
		918
		919	This variable is mainly useful for modules that can do something useful
		920	when AnyEvent is used and thus want to know when it is initialised, but do
		921	not need to even load it by default. This array provides the means to hook
		922	into AnyEvent passively, without loading it.
772		923
773	=back	924	=back
774		925
775	=head1 WHAT TO DO IN A MODULE	926	=head1 WHAT TO DO IN A MODULE
776		927
…		…
831		982
832		983
833	=head1 OTHER MODULES	984	=head1 OTHER MODULES
834		985
835	The following is a non-exhaustive list of additional modules that use	986	The following is a non-exhaustive list of additional modules that use
836	AnyEvent and can therefore be mixed easily with other AnyEvent modules	987	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
837	in the same program. Some of the modules come with AnyEvent, some are	988	modules and other event loops in the same program. Some of the modules
838	available via CPAN.	989	come with AnyEvent, most are available via CPAN.
839		990
840	=over 4	991	=over 4
841		992
842	=item L<AnyEvent::Util>	993	=item L<AnyEvent::Util>
843		994
…		…
852		1003
853	=item L<AnyEvent::Handle>	1004	=item L<AnyEvent::Handle>
854		1005
855	Provide read and write buffers, manages watchers for reads and writes,	1006	Provide read and write buffers, manages watchers for reads and writes,
856	supports raw and formatted I/O, I/O queued and fully transparent and	1007	supports raw and formatted I/O, I/O queued and fully transparent and
857	non-blocking SSL/TLS.	1008	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
858		1009
859	=item L<AnyEvent::DNS>	1010	=item L<AnyEvent::DNS>
860		1011
861	Provides rich asynchronous DNS resolver capabilities.	1012	Provides rich asynchronous DNS resolver capabilities.
862		1013
…		…
890		1041
891	=item L<AnyEvent::GPSD>	1042	=item L<AnyEvent::GPSD>
892		1043
893	A non-blocking interface to gpsd, a daemon delivering GPS information.	1044	A non-blocking interface to gpsd, a daemon delivering GPS information.
894		1045
		1046	=item L<AnyEvent::IRC>
		1047
		1048	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		1049
		1050	=item L<AnyEvent::XMPP>
		1051
		1052	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1053	Net::XMPP2>.
		1054
895	=item L<AnyEvent::IGS>	1055	=item L<AnyEvent::IGS>
896		1056
897	A non-blocking interface to the Internet Go Server protocol (used by	1057	A non-blocking interface to the Internet Go Server protocol (used by
898	L<App::IGS>).	1058	L<App::IGS>).
899		1059
900	=item L<AnyEvent::IRC>
901
902	AnyEvent based IRC client module family (replacing the older Net::IRC3).
903
904	=item L<Net::XMPP2>
905
906	AnyEvent based XMPP (Jabber protocol) module family.
907
908	=item L<Net::FCP>	1060	=item L<Net::FCP>
909		1061
910	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1062	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
911	of AnyEvent.	1063	of AnyEvent.
912		1064
…		…
916		1068
917	=item L<Coro>	1069	=item L<Coro>
918		1070
919	Has special support for AnyEvent via L<Coro::AnyEvent>.	1071	Has special support for AnyEvent via L<Coro::AnyEvent>.
920		1072
921	=item L<IO::Lambda>
922
923	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
924
925	=back	1073	=back
926		1074
927	=cut	1075	=cut
928		1076
929	package AnyEvent;	1077	package AnyEvent;
930		1078
		1079	# basically a tuned-down version of common::sense
		1080	sub common_sense {
931	no warnings;	1081	# no warnings
		1082	${^WARNING_BITS} ^= ${^WARNING_BITS};
932	use strict qw(vars subs);	1083	# use strict vars subs
		1084	$^H \|= 0x00000600;
		1085	}
933		1086
		1087	BEGIN { AnyEvent::common_sense }
		1088
934	use Carp;	1089	use Carp ();
935		1090
936	our $VERSION = 4.41;	1091	our $VERSION = 4.881;
937	our $MODEL;	1092	our $MODEL;
938		1093
939	our $AUTOLOAD;	1094	our $AUTOLOAD;
940	our @ISA;	1095	our @ISA;
941		1096
942	our @REGISTRY;	1097	our @REGISTRY;
943		1098
944	our $WIN32;	1099	our $WIN32;
945		1100
		1101	our $VERBOSE;
		1102
946	BEGIN {	1103	BEGIN {
947	my $win32 = ! ! ($^O =~ /mswin32/i);	1104	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
948	eval "sub WIN32(){ $win32 }";	1105	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
949	}
950		1106
		1107	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1108	if ${^TAINT};
		1109
951	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1110	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1111
		1112	}
		1113
		1114	our $MAX_SIGNAL_LATENCY = 10;
952		1115
953	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1116	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
954		1117
955	{	1118	{
956	my $idx;	1119	my $idx;
…		…
958	for reverse split /\s,\s/,	1121	for reverse split /\s,\s/,
959	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1122	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
960	}	1123	}
961		1124
962	my @models = (	1125	my @models = (
963	[EV:: => AnyEvent::Impl::EV::],	1126	[EV:: => AnyEvent::Impl::EV:: , 1],
964	[Event:: => AnyEvent::Impl::Event::],	1127	[Event:: => AnyEvent::Impl::Event::, 1],
965	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1128	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
966	# everything below here will not be autoprobed	1129	# everything below here will not (normally) be autoprobed
967	# as the pureperl backend should work everywhere	1130	# as the pureperl backend should work everywhere
968	# and is usually faster	1131	# and is usually faster
		1132	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1133	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1134	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
969	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1135	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
970	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
971	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
972	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1136	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
973	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1137	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
974	[Wx:: => AnyEvent::Impl::POE::],	1138	[Wx:: => AnyEvent::Impl::POE::],
975	[Prima:: => AnyEvent::Impl::POE::],	1139	[Prima:: => AnyEvent::Impl::POE::],
		1140	# IO::Async is just too broken - we would need workarounds for its
		1141	# byzantine signal and broken child handling, among others.
		1142	# IO::Async is rather hard to detect, as it doesn't have any
		1143	# obvious default class.
		1144	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1145	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1146	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
976	);	1147	);
977		1148
978	our %method = map +($_ => 1),	1149	our %method = map +($_ => 1),
979	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1150	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
980		1151
…		…
984	my ($cb) = @_;	1155	my ($cb) = @_;
985		1156
986	if ($MODEL) {	1157	if ($MODEL) {
987	$cb->();	1158	$cb->();
988		1159
989	1	1160	undef
990	} else {	1161	} else {
991	push @post_detect, $cb;	1162	push @post_detect, $cb;
992		1163
993	defined wantarray	1164	defined wantarray
994	? bless \$cb, "AnyEvent::Util::postdetect"	1165	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1000	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1171	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1001	}	1172	}
1002		1173
1003	sub detect() {	1174	sub detect() {
1004	unless ($MODEL) {	1175	unless ($MODEL) {
1005	no strict 'refs';
1006	local $SIG{__DIE__};	1176	local $SIG{__DIE__};
1007		1177
1008	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1178	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1009	my $model = "AnyEvent::Impl::$1";	1179	my $model = "AnyEvent::Impl::$1";
1010	if (eval "require $model") {	1180	if (eval "require $model") {
1011	$MODEL = $model;	1181	$MODEL = $model;
1012	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1182	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1013	} else {	1183	} else {
1014	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1184	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1015	}	1185	}
1016	}	1186	}
1017		1187
1018	# check for already loaded models	1188	# check for already loaded models
1019	unless ($MODEL) {	1189	unless ($MODEL) {
1020	for (@REGISTRY, @models) {	1190	for (@REGISTRY, @models) {
1021	my ($package, $model) = @$_;	1191	my ($package, $model) = @$_;
1022	if (${"$package\::VERSION"} > 0) {	1192	if (${"$package\::VERSION"} > 0) {
1023	if (eval "require $model") {	1193	if (eval "require $model") {
1024	$MODEL = $model;	1194	$MODEL = $model;
1025	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1195	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1026	last;	1196	last;
1027	}	1197	}
1028	}	1198	}
1029	}	1199	}
1030		1200
1031	unless ($MODEL) {	1201	unless ($MODEL) {
1032	# try to load a model	1202	# try to autoload a model
1033
1034	for (@REGISTRY, @models) {	1203	for (@REGISTRY, @models) {
1035	my ($package, $model) = @$_;	1204	my ($package, $model, $autoload) = @$_;
		1205	if (
		1206	$autoload
1036	if (eval "require $package"	1207	and eval "require $package"
1037	and ${"$package\::VERSION"} > 0	1208	and ${"$package\::VERSION"} > 0
1038	and eval "require $model") {	1209	and eval "require $model"
		1210	) {
1039	$MODEL = $model;	1211	$MODEL = $model;
1040	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1212	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1041	last;	1213	last;
1042	}	1214	}
1043	}	1215	}
1044		1216
1045	$MODEL	1217	$MODEL
…		…
1061		1233
1062	sub AUTOLOAD {	1234	sub AUTOLOAD {
1063	(my $func = $AUTOLOAD) =~ s/.*://;	1235	(my $func = $AUTOLOAD) =~ s/.*://;
1064		1236
1065	$method{$func}	1237	$method{$func}
1066	or croak "$func: not a valid method for AnyEvent objects";	1238	or Carp::croak "$func: not a valid method for AnyEvent objects";
1067		1239
1068	detect unless $MODEL;	1240	detect unless $MODEL;
1069		1241
1070	my $class = shift;	1242	my $class = shift;
1071	$class->$func (@_);	1243	$class->$func (@_);
1072	}	1244	}
1073		1245
1074	# utility function to dup a filehandle. this is used by many backends	1246	# utility function to dup a filehandle. this is used by many backends
1075	# to support binding more than one watcher per filehandle (they usually	1247	# to support binding more than one watcher per filehandle (they usually
1076	# allow only one watcher per fd, so we dup it to get a different one).	1248	# allow only one watcher per fd, so we dup it to get a different one).
1077	sub _dupfh($$$$) {	1249	sub _dupfh($$;$$) {
1078	my ($poll, $fh, $r, $w) = @_;	1250	my ($poll, $fh, $r, $w) = @_;
1079		1251
1080	# cygwin requires the fh mode to be matching, unix doesn't	1252	# cygwin requires the fh mode to be matching, unix doesn't
1081	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1253	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1082	: $poll eq "w" ? ($w, ">")
1083	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1084		1254
1085	open my $fh2, "$mode&" . fileno $fh	1255	open my $fh2, $mode, $fh
1086	or die "cannot dup() filehandle: $!,";	1256	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1087		1257
1088	# we assume CLOEXEC is already set by perl in all important cases	1258	# we assume CLOEXEC is already set by perl in all important cases
1089		1259
1090	($fh2, $rw)	1260	($fh2, $rw)
1091	}	1261	}
1092		1262
1093	package AnyEvent::Base;	1263	package AnyEvent::Base;
1094		1264
1095	# default implementations for many methods	1265	# default implementations for many methods
1096		1266
1097	BEGIN {	1267	sub _time {
		1268	# probe for availability of Time::HiRes
1098	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1269	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1270	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1099	*_time = \&Time::HiRes::time;	1271	*_time = \&Time::HiRes::time;
1100	# if (eval "use POSIX (); (POSIX::times())...	1272	# if (eval "use POSIX (); (POSIX::times())...
1101	} else {	1273	} else {
		1274	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1102	*_time = sub { time }; # epic fail	1275	*_time = sub { time }; # epic fail
1103	}	1276	}
		1277
		1278	&_time
1104	}	1279	}
1105		1280
1106	sub time { _time }	1281	sub time { _time }
1107	sub now { _time }	1282	sub now { _time }
1108	sub now_update { }	1283	sub now_update { }
…		…
1113	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1288	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1114	}	1289	}
1115		1290
1116	# default implementation for ->signal	1291	# default implementation for ->signal
1117		1292
		1293	our $HAVE_ASYNC_INTERRUPT;
		1294
		1295	sub _have_async_interrupt() {
		1296	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1297	&& eval "use Async::Interrupt 1.0 (); 1")
		1298	unless defined $HAVE_ASYNC_INTERRUPT;
		1299
		1300	$HAVE_ASYNC_INTERRUPT
		1301	}
		1302
1118	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1303	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1304	our (%SIG_ASY, %SIG_ASY_W);
		1305	our ($SIG_COUNT, $SIG_TW);
1119		1306
1120	sub _signal_exec {	1307	sub _signal_exec {
		1308	$HAVE_ASYNC_INTERRUPT
		1309	? $SIGPIPE_R->drain
1121	sysread $SIGPIPE_R, my $dummy, 4;	1310	: sysread $SIGPIPE_R, my $dummy, 9;
1122		1311
1123	while (%SIG_EV) {	1312	while (%SIG_EV) {
1124	for (keys %SIG_EV) {	1313	for (keys %SIG_EV) {
1125	delete $SIG_EV{$_};	1314	delete $SIG_EV{$_};
1126	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1315	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1127	}	1316	}
1128	}	1317	}
1129	}	1318	}
1130		1319
		1320	# install a dummy wakeup watcher to reduce signal catching latency
		1321	sub _sig_add() {
		1322	unless ($SIG_COUNT++) {
		1323	# try to align timer on a full-second boundary, if possible
		1324	my $NOW = AnyEvent->now;
		1325
		1326	$SIG_TW = AnyEvent->timer (
		1327	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1328	interval => $MAX_SIGNAL_LATENCY,
		1329	cb => sub { }, # just for the PERL_ASYNC_CHECK
		1330	);
		1331	}
		1332	}
		1333
		1334	sub _sig_del {
		1335	undef $SIG_TW
		1336	unless --$SIG_COUNT;
		1337	}
		1338
		1339	our $_sig_name_init; $_sig_name_init = sub {
		1340	undef $_sig_name_init;
		1341
		1342	if (_have_async_interrupt) {
		1343	*sig2num = \&Async::Interrupt::sig2num;
		1344	*sig2name = \&Async::Interrupt::sig2name;
		1345	} else {
		1346	require Config;
		1347
		1348	my %signame2num;
		1349	@signame2num{ split ' ', $Config::Config{sig_name} }
		1350	= split ' ', $Config::Config{sig_num};
		1351
		1352	my @signum2name;
		1353	@signum2name[values %signame2num] = keys %signame2num;
		1354
		1355	*sig2num = sub($) {
		1356	$_[0] > 0 ? shift : $signame2num{+shift}
		1357	};
		1358	*sig2name = sub ($) {
		1359	$_[0] > 0 ? $signum2name[+shift] : shift
		1360	};
		1361	}
		1362	};
		1363
		1364	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1365	sub sig2name($) { &$_sig_name_init; &sig2name }
		1366
		1367	sub _signal {
		1368	my (undef, %arg) = @_;
		1369
		1370	my $signal = uc $arg{signal}
		1371	or Carp::croak "required option 'signal' is missing";
		1372
		1373	if ($HAVE_ASYNC_INTERRUPT) {
		1374	# async::interrupt
		1375
		1376	$signal = sig2num $signal;
		1377	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1378
		1379	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1380	cb => sub { undef $SIG_EV{$signal} },
		1381	signal => $signal,
		1382	pipe => [$SIGPIPE_R->filenos],
		1383	pipe_autodrain => 0,
		1384	;
		1385
		1386	} else {
		1387	# pure perl
		1388
		1389	# AE::Util has been loaded in signal
		1390	$signal = sig2name $signal;
		1391	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1392
		1393	$SIG{$signal} \|\|= sub {
		1394	local $!;
		1395	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1396	undef $SIG_EV{$signal};
		1397	};
		1398
		1399	# can't do signal processing without introducing races in pure perl,
		1400	# so limit the signal latency.
		1401	_sig_add;
		1402	}
		1403
		1404	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1405	}
		1406
1131	sub signal {	1407	sub signal {
1132	my (undef, %arg) = @_;	1408	# probe for availability of Async::Interrupt
		1409	if (_have_async_interrupt) {
		1410	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1133		1411
1134	unless ($SIGPIPE_R) {	1412	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1413	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
		1414
		1415	} else {
		1416	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1417
1135	require Fcntl;	1418	require Fcntl;
1136		1419
1137	if (AnyEvent::WIN32) {	1420	if (AnyEvent::WIN32) {
1138	require AnyEvent::Util;	1421	require AnyEvent::Util;
1139		1422
…		…
1154	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1437	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1155		1438
1156	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1439	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1157	}	1440	}
1158		1441
1159	my $signal = uc $arg{signal}	1442	*signal = \&_signal;
1160	or Carp::croak "required option 'signal' is missing";	1443	&signal
1161
1162	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1163	$SIG{$signal} \|\|= sub {
1164	local $!;
1165	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1166	undef $SIG_EV{$signal};
1167	};
1168
1169	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1170	}	1444	}
1171		1445
1172	sub AnyEvent::Base::signal::DESTROY {	1446	sub AnyEvent::Base::signal::DESTROY {
1173	my ($signal, $cb) = @{$_[0]};	1447	my ($signal, $cb) = @{$_[0]};
1174		1448
		1449	_sig_del;
		1450
1175	delete $SIG_CB{$signal}{$cb};	1451	delete $SIG_CB{$signal}{$cb};
1176		1452
		1453	$HAVE_ASYNC_INTERRUPT
		1454	? delete $SIG_ASY{$signal}
1177	# delete doesn't work with older perls - they then	1455	: # delete doesn't work with older perls - they then
1178	# print weird messages, or just unconditionally exit	1456	# print weird messages, or just unconditionally exit
1179	# instead of getting the default action.	1457	# instead of getting the default action.
		1458	undef $SIG{$signal}
1180	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };	1459	unless keys %{ $SIG_CB{$signal} };
1181	}	1460	}
1182		1461
1183	# default implementation for ->child	1462	# default implementation for ->child
1184		1463
1185	our %PID_CB;	1464	our %PID_CB;
1186	our $CHLD_W;	1465	our $CHLD_W;
1187	our $CHLD_DELAY_W;	1466	our $CHLD_DELAY_W;
1188	our $WNOHANG;	1467	our $WNOHANG;
1189		1468
		1469	sub _emit_childstatus($$) {
		1470	my (undef, $rpid, $rstatus) = @_;
		1471
		1472	$_->($rpid, $rstatus)
		1473	for values %{ $PID_CB{$rpid} \|\| {} },
		1474	values %{ $PID_CB{0} \|\| {} };
		1475	}
		1476
1190	sub _sigchld {	1477	sub _sigchld {
		1478	my $pid;
		1479
		1480	AnyEvent->_emit_childstatus ($pid, $?)
1191	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1481	while ($pid = waitpid -1, $WNOHANG) > 0;
1192	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),
1193	(values %{ $PID_CB{0} \|\| {} });
1194	}
1195	}	1482	}
1196		1483
1197	sub child {	1484	sub child {
1198	my (undef, %arg) = @_;	1485	my (undef, %arg) = @_;
1199		1486
1200	defined (my $pid = $arg{pid} + 0)	1487	defined (my $pid = $arg{pid} + 0)
1201	or Carp::croak "required option 'pid' is missing";	1488	or Carp::croak "required option 'pid' is missing";
1202		1489
1203	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1490	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1204		1491
		1492	# WNOHANG is almost cetrainly 1 everywhere
		1493	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1494	? 1
1205	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1495	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1206		1496
1207	unless ($CHLD_W) {	1497	unless ($CHLD_W) {
1208	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1498	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1209	# child could be a zombie already, so make at least one round	1499	# child could be a zombie already, so make at least one round
1210	&_sigchld;	1500	&_sigchld;
…		…
1262		1552
1263	our @ISA = AnyEvent::CondVar::Base::;	1553	our @ISA = AnyEvent::CondVar::Base::;
1264		1554
1265	package AnyEvent::CondVar::Base;	1555	package AnyEvent::CondVar::Base;
1266		1556
1267	use overload	1557	#use overload
1268	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1558	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1269	fallback => 1;	1559	# fallback => 1;
		1560
		1561	# save 300+ kilobytes by dirtily hardcoding overloading
		1562	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1563	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1564	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1565	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1566
		1567	our $WAITING;
1270		1568
1271	sub _send {	1569	sub _send {
1272	# nop	1570	# nop
1273	}	1571	}
1274		1572
…		…
1287	sub ready {	1585	sub ready {
1288	$_[0]{_ae_sent}	1586	$_[0]{_ae_sent}
1289	}	1587	}
1290		1588
1291	sub _wait {	1589	sub _wait {
		1590	$WAITING
		1591	and !$_[0]{_ae_sent}
		1592	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1593
		1594	local $WAITING = 1;
1292	AnyEvent->one_event while !$_[0]{_ae_sent};	1595	AnyEvent->one_event while !$_[0]{_ae_sent};
1293	}	1596	}
1294		1597
1295	sub recv {	1598	sub recv {
1296	$_[0]->_wait;	1599	$_[0]->_wait;
…		…
1337	so on.	1640	so on.
1338		1641
1339	=head1 ENVIRONMENT VARIABLES	1642	=head1 ENVIRONMENT VARIABLES
1340		1643
1341	The following environment variables are used by this module or its	1644	The following environment variables are used by this module or its
1342	submodules:	1645	submodules.
		1646
		1647	Note that AnyEvent will remove I<all> environment variables starting with
		1648	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1649	enabled.
1343		1650
1344	=over 4	1651	=over 4
1345		1652
1346	=item C<PERL_ANYEVENT_VERBOSE>	1653	=item C<PERL_ANYEVENT_VERBOSE>
1347		1654
…		…
1354	C<PERL_ANYEVENT_MODEL>.	1661	C<PERL_ANYEVENT_MODEL>.
1355		1662
1356	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1663	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1357	model it chooses.	1664	model it chooses.
1358		1665
		1666	When set to C<8> or higher, then AnyEvent will report extra information on
		1667	which optional modules it loads and how it implements certain features.
		1668
1359	=item C<PERL_ANYEVENT_STRICT>	1669	=item C<PERL_ANYEVENT_STRICT>
1360		1670
1361	AnyEvent does not do much argument checking by default, as thorough	1671	AnyEvent does not do much argument checking by default, as thorough
1362	argument checking is very costly. Setting this variable to a true value	1672	argument checking is very costly. Setting this variable to a true value
1363	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1673	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1364	check the arguments passed to most method calls. If it finds any problems	1674	check the arguments passed to most method calls. If it finds any problems,
1365	it will croak.	1675	it will croak.
1366		1676
1367	In other words, enables "strict" mode.	1677	In other words, enables "strict" mode.
1368		1678
1369	Unlike C<use strict>, it is definitely recommended ot keep it off in	1679	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1370	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1680	>>, it is definitely recommended to keep it off in production. Keeping
1371	developing programs can be very useful, however.	1681	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1682	can be very useful, however.
1372		1683
1373	=item C<PERL_ANYEVENT_MODEL>	1684	=item C<PERL_ANYEVENT_MODEL>
1374		1685
1375	This can be used to specify the event model to be used by AnyEvent, before	1686	This can be used to specify the event model to be used by AnyEvent, before
1376	auto detection and -probing kicks in. It must be a string consisting	1687	auto detection and -probing kicks in. It must be a string consisting
…		…
1419		1730
1420	=item C<PERL_ANYEVENT_MAX_FORKS>	1731	=item C<PERL_ANYEVENT_MAX_FORKS>
1421		1732
1422	The maximum number of child processes that C<AnyEvent::Util::fork_call>	1733	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1423	will create in parallel.	1734	will create in parallel.
		1735
		1736	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1737
		1738	The default value for the C<max_outstanding> parameter for the default DNS
		1739	resolver - this is the maximum number of parallel DNS requests that are
		1740	sent to the DNS server.
		1741
		1742	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1743
		1744	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1745	configuration) in the default resolver. When set to the empty string, no
		1746	default config will be used.
		1747
		1748	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1749
		1750	When neither C<ca_file> nor C<ca_path> was specified during
		1751	L<AnyEvent::TLS> context creation, and either of these environment
		1752	variables exist, they will be used to specify CA certificate locations
		1753	instead of a system-dependent default.
		1754
		1755	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1756
		1757	When these are set to C<1>, then the respective modules are not
		1758	loaded. Mostly good for testing AnyEvent itself.
1424		1759
1425	=back	1760	=back
1426		1761
1427	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1762	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1428		1763
…		…
1673	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2008	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1674	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2009	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1675	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2010	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1676	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2011	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1677	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2012	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
		2013	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
		2014	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1678	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2015	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1679	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2016	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1680	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2017	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1681	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2018	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1682		2019
…		…
1711	performance becomes really bad with lots of file descriptors (and few of	2048	performance becomes really bad with lots of file descriptors (and few of
1712	them active), of course, but this was not subject of this benchmark.	2049	them active), of course, but this was not subject of this benchmark.
1713		2050
1714	The C<Event> module has a relatively high setup and callback invocation	2051	The C<Event> module has a relatively high setup and callback invocation
1715	cost, but overall scores in on the third place.	2052	cost, but overall scores in on the third place.
		2053
		2054	C<IO::Async> performs admirably well, about on par with C<Event>, even
		2055	when using its pure perl backend.
1716		2056
1717	C<Glib>'s memory usage is quite a bit higher, but it features a	2057	C<Glib>'s memory usage is quite a bit higher, but it features a
1718	faster callback invocation and overall ends up in the same class as	2058	faster callback invocation and overall ends up in the same class as
1719	C<Event>. However, Glib scales extremely badly, doubling the number of	2059	C<Event>. However, Glib scales extremely badly, doubling the number of
1720	watchers increases the processing time by more than a factor of four,	2060	watchers increases the processing time by more than a factor of four,
…		…
1798	it to another server. This includes deleting the old timeout and creating	2138	it to another server. This includes deleting the old timeout and creating
1799	a new one that moves the timeout into the future.	2139	a new one that moves the timeout into the future.
1800		2140
1801	=head3 Results	2141	=head3 Results
1802		2142
1803	name sockets create request	2143	name sockets create request
1804	EV 20000 69.01 11.16	2144	EV 20000 69.01 11.16
1805	Perl 20000 73.32 35.87	2145	Perl 20000 73.32 35.87
		2146	IOAsync 20000 157.00 98.14 epoll
		2147	IOAsync 20000 159.31 616.06 poll
1806	Event 20000 212.62 257.32	2148	Event 20000 212.62 257.32
1807	Glib 20000 651.16 1896.30	2149	Glib 20000 651.16 1896.30
1808	POE 20000 349.67 12317.24 uses POE::Loop::Event	2150	POE 20000 349.67 12317.24 uses POE::Loop::Event
1809		2151
1810	=head3 Discussion	2152	=head3 Discussion
1811		2153
1812	This benchmark I<does> measure scalability and overall performance of the	2154	This benchmark I<does> measure scalability and overall performance of the
1813	particular event loop.	2155	particular event loop.
…		…
1815	EV is again fastest. Since it is using epoll on my system, the setup time	2157	EV is again fastest. Since it is using epoll on my system, the setup time
1816	is relatively high, though.	2158	is relatively high, though.
1817		2159
1818	Perl surprisingly comes second. It is much faster than the C-based event	2160	Perl surprisingly comes second. It is much faster than the C-based event
1819	loops Event and Glib.	2161	loops Event and Glib.
		2162
		2163	IO::Async performs very well when using its epoll backend, and still quite
		2164	good compared to Glib when using its pure perl backend.
1820		2165
1821	Event suffers from high setup time as well (look at its code and you will	2166	Event suffers from high setup time as well (look at its code and you will
1822	understand why). Callback invocation also has a high overhead compared to	2167	understand why). Callback invocation also has a high overhead compared to
1823	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2168	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1824	uses select or poll in basically all documented configurations.	2169	uses select or poll in basically all documented configurations.
…		…
1887	=item * C-based event loops perform very well with small number of	2232	=item * C-based event loops perform very well with small number of
1888	watchers, as the management overhead dominates.	2233	watchers, as the management overhead dominates.
1889		2234
1890	=back	2235	=back
1891		2236
		2237	=head2 THE IO::Lambda BENCHMARK
		2238
		2239	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2240	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2241	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2242	shouldn't come as a surprise to anybody). As such, the benchmark is
		2243	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2244	very optimal. But how would AnyEvent compare when used without the extra
		2245	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2246
		2247	The benchmark itself creates an echo-server, and then, for 500 times,
		2248	connects to the echo server, sends a line, waits for the reply, and then
		2249	creates the next connection. This is a rather bad benchmark, as it doesn't
		2250	test the efficiency of the framework or much non-blocking I/O, but it is a
		2251	benchmark nevertheless.
		2252
		2253	name runtime
		2254	Lambda/select 0.330 sec
		2255	+ optimized 0.122 sec
		2256	Lambda/AnyEvent 0.327 sec
		2257	+ optimized 0.138 sec
		2258	Raw sockets/select 0.077 sec
		2259	POE/select, components 0.662 sec
		2260	POE/select, raw sockets 0.226 sec
		2261	POE/select, optimized 0.404 sec
		2262
		2263	AnyEvent/select/nb 0.085 sec
		2264	AnyEvent/EV/nb 0.068 sec
		2265	+state machine 0.134 sec
		2266
		2267	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2268	benchmarks actually make blocking connects and use 100% blocking I/O,
		2269	defeating the purpose of an event-based solution. All of the newly
		2270	written AnyEvent benchmarks use 100% non-blocking connects (using
		2271	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2272	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2273	generally require a lot more bookkeeping and event handling than blocking
		2274	connects (which involve a single syscall only).
		2275
		2276	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2277	offers similar expressive power as POE and IO::Lambda, using conventional
		2278	Perl syntax. This means that both the echo server and the client are 100%
		2279	non-blocking, further placing it at a disadvantage.
		2280
		2281	As you can see, the AnyEvent + EV combination even beats the
		2282	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2283	backend easily beats IO::Lambda and POE.
		2284
		2285	And even the 100% non-blocking version written using the high-level (and
		2286	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
		2287	large margin, even though it does all of DNS, tcp-connect and socket I/O
		2288	in a non-blocking way.
		2289
		2290	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2291	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2292	part of the IO::lambda distribution and were used without any changes.
		2293
1892		2294
1893	=head1 SIGNALS	2295	=head1 SIGNALS
1894		2296
1895	AnyEvent currently installs handlers for these signals:	2297	AnyEvent currently installs handlers for these signals:
1896		2298
…		…
1899	=item SIGCHLD	2301	=item SIGCHLD
1900		2302
1901	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2303	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1902	emulation for event loops that do not support them natively. Also, some	2304	emulation for event loops that do not support them natively. Also, some
1903	event loops install a similar handler.	2305	event loops install a similar handler.
		2306
		2307	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2308	AnyEvent will reset it to default, to avoid losing child exit statuses.
1904		2309
1905	=item SIGPIPE	2310	=item SIGPIPE
1906		2311
1907	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2312	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1908	when AnyEvent gets loaded.	2313	when AnyEvent gets loaded.
…		…
1920		2325
1921	=back	2326	=back
1922		2327
1923	=cut	2328	=cut
1924		2329
		2330	undef $SIG{CHLD}
		2331	if $SIG{CHLD} eq 'IGNORE';
		2332
1925	$SIG{PIPE} = sub { }	2333	$SIG{PIPE} = sub { }
1926	unless defined $SIG{PIPE};	2334	unless defined $SIG{PIPE};
		2335
		2336	=head1 RECOMMENDED/OPTIONAL MODULES
		2337
		2338	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2339	it's built-in modules) are required to use it.
		2340
		2341	That does not mean that AnyEvent won't take advantage of some additional
		2342	modules if they are installed.
		2343
		2344	This section epxlains which additional modules will be used, and how they
		2345	affect AnyEvent's operetion.
		2346
		2347	=over 4
		2348
		2349	=item L<Async::Interrupt>
		2350
		2351	This slightly arcane module is used to implement fast signal handling: To
		2352	my knowledge, there is no way to do completely race-free and quick
		2353	signal handling in pure perl. To ensure that signals still get
		2354	delivered, AnyEvent will start an interval timer to wake up perl (and
		2355	catch the signals) with some delay (default is 10 seconds, look for
		2356	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2357
		2358	If this module is available, then it will be used to implement signal
		2359	catching, which means that signals will not be delayed, and the event loop
		2360	will not be interrupted regularly, which is more efficient (And good for
		2361	battery life on laptops).
		2362
		2363	This affects not just the pure-perl event loop, but also other event loops
		2364	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2365
		2366	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2367	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2368	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2369	does nothing for those backends.
		2370
		2371	=item L<EV>
		2372
		2373	This module isn't really "optional", as it is simply one of the backend
		2374	event loops that AnyEvent can use. However, it is simply the best event
		2375	loop available in terms of features, speed and stability: It supports
		2376	the AnyEvent API optimally, implements all the watcher types in XS, does
		2377	automatic timer adjustments even when no monotonic clock is available,
		2378	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2379	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2380	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2381
		2382	=item L<Guard>
		2383
		2384	The guard module, when used, will be used to implement
		2385	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2386	lot less memory), but otherwise doesn't affect guard operation much. It is
		2387	purely used for performance.
		2388
		2389	=item L<JSON> and L<JSON::XS>
		2390
		2391	This module is required when you want to read or write JSON data via
		2392	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2393	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2394
		2395	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2396	installed.
		2397
		2398	=item L<Net::SSLeay>
		2399
		2400	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2401	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2402	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2403
		2404	=item L<Time::HiRes>
		2405
		2406	This module is part of perl since release 5.008. It will be used when the
		2407	chosen event library does not come with a timing source on it's own. The
		2408	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2409	try to use a monotonic clock for timing stability.
		2410
		2411	=back
1927		2412
1928		2413
1929	=head1 FORK	2414	=head1 FORK
1930		2415
1931	Most event libraries are not fork-safe. The ones who are usually are	2416	Most event libraries are not fork-safe. The ones who are usually are
1932	because they rely on inefficient but fork-safe C<select> or C<poll>	2417	because they rely on inefficient but fork-safe C<select> or C<poll>
1933	calls. Only L<EV> is fully fork-aware.	2418	calls. Only L<EV> is fully fork-aware.
1934		2419
1935	If you have to fork, you must either do so I<before> creating your first	2420	If you have to fork, you must either do so I<before> creating your first
1936	watcher OR you must not use AnyEvent at all in the child.	2421	watcher OR you must not use AnyEvent at all in the child OR you must do
		2422	something completely out of the scope of AnyEvent.
1937		2423
1938		2424
1939	=head1 SECURITY CONSIDERATIONS	2425	=head1 SECURITY CONSIDERATIONS
1940		2426
1941	AnyEvent can be forced to load any event model via	2427	AnyEvent can be forced to load any event model via
…		…
1953	use AnyEvent;	2439	use AnyEvent;
1954		2440
1955	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2441	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1956	be used to probe what backend is used and gain other information (which is	2442	be used to probe what backend is used and gain other information (which is
1957	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and	2443	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1958	$ENV{PERL_ANYEGENT_STRICT}.	2444	$ENV{PERL_ANYEVENT_STRICT}.
		2445
		2446	Note that AnyEvent will remove I<all> environment variables starting with
		2447	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2448	enabled.
1959		2449
1960		2450
1961	=head1 BUGS	2451	=head1 BUGS
1962		2452
1963	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	2453	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
…		…
1975	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2465	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1976		2466
1977	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2467	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1978	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2468	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1979	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2469	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1980	L<AnyEvent::Impl::POE>.	2470	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1981		2471
1982	Non-blocking file handles, sockets, TCP clients and	2472	Non-blocking file handles, sockets, TCP clients and
1983	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2473	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1984		2474
1985	Asynchronous DNS: L<AnyEvent::DNS>.	2475	Asynchronous DNS: L<AnyEvent::DNS>.
1986		2476
1987	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2477	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2478	L<Coro::Event>,
1988		2479
1989	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2480	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2481	L<AnyEvent::HTTP>.
1990		2482
1991		2483
1992	=head1 AUTHOR	2484	=head1 AUTHOR
1993		2485
1994	Marc Lehmann <schmorp@schmorp.de>	2486	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.211 by root, Sat Jun 6 12:04:30 2009 UTC vs. Revision 1.264 by root, Wed Jul 29 12:42:09 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.211 by root, Sat Jun 6 12:04:30 2009 UTC vs.
Revision 1.264 by root, Wed Jul 29 12:42:09 2009 UTC