ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.248 by root, Sat Jul 18 22:27:10 2009 UTC vs.
Revision 1.325 by root, Thu May 20 23:56:04 2010 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
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
…		…
40	=head1 INTRODUCTION/TUTORIAL	43	=head1 INTRODUCTION/TUTORIAL
41		44
42	This manpage is mainly a reference manual. If you are interested	45	This manpage is mainly a reference manual. If you are interested
43	in a tutorial or some gentle introduction, have a look at the	46	in a tutorial or some gentle introduction, have a look at the
44	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
		48
		49	=head1 SUPPORT
		50
		51	There is a mailinglist for discussing all things AnyEvent, and an IRC
		52	channel, too.
		53
		54	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		55	Repository>, at L<http://anyevent.schmorp.de>, for more info.
45		56
46	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	57	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47		58
48	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	59	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49	nowadays. So what is different about AnyEvent?	60	nowadays. So what is different about AnyEvent?
…		…
173	my variables are only visible after the statement in which they are	184	my variables are only visible after the statement in which they are
174	declared.	185	declared.
175		186
176	=head2 I/O WATCHERS	187	=head2 I/O WATCHERS
177		188
		189	$w = AnyEvent->io (
		190	fh => <filehandle_or_fileno>,
		191	poll => <"r" or "w">,
		192	cb => <callback>,
		193	);
		194
178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	195	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179	with the following mandatory key-value pairs as arguments:	196	with the following mandatory key-value pairs as arguments:
180		197
181	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch	198	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	199	for events (AnyEvent might or might not keep a reference to this file
…		…
211	undef $w;	228	undef $w;
212	});	229	});
213		230
214	=head2 TIME WATCHERS	231	=head2 TIME WATCHERS
215		232
		233	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		234
		235	$w = AnyEvent->timer (
		236	after => <fractional_seconds>,
		237	interval => <fractional_seconds>,
		238	cb => <callback>,
		239	);
		240
216	You can create a time watcher by calling the C<< AnyEvent->timer >>	241	You can create a time watcher by calling the C<< AnyEvent->timer >>
217	method with the following mandatory arguments:	242	method with the following mandatory arguments:
218		243
219	C<after> specifies after how many seconds (fractional values are	244	C<after> specifies after how many seconds (fractional values are
220	supported) the callback should be invoked. C<cb> is the callback to invoke	245	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
341	might affect timers and time-outs.	366	might affect timers and time-outs.
342		367
343	When this is the case, you can call this method, which will update the	368	When this is the case, you can call this method, which will update the
344	event loop's idea of "current time".	369	event loop's idea of "current time".
345		370
		371	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		372	when mod_perl executes the script, then the event loop will have the wrong
		373	idea about the "current time" (being potentially far in the past, when the
		374	script ran the last time). In that case you should arrange a call to C<<
		375	AnyEvent->now_update >> each time the web server process wakes up again
		376	(e.g. at the start of your script, or in a handler).
		377
346	Note that updating the time I<might> cause some events to be handled.	378	Note that updating the time I<might> cause some events to be handled.
347		379
348	=back	380	=back
349		381
350	=head2 SIGNAL WATCHERS	382	=head2 SIGNAL WATCHERS
		383
		384	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
351		385
352	You can watch for signals using a signal watcher, C<signal> is the signal	386	You can watch for signals using a signal watcher, C<signal> is the signal
353	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	387	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
354	callback to be invoked whenever a signal occurs.	388	callback to be invoked whenever a signal occurs.
355		389
…		…
372		406
373	Example: exit on SIGINT	407	Example: exit on SIGINT
374		408
375	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	409	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
376		410
		411	=head3 Restart Behaviour
		412
		413	While restart behaviour is up to the event loop implementation, most will
		414	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		415	pure perl implementation).
		416
		417	=head3 Safe/Unsafe Signals
		418
		419	Perl signals can be either "safe" (synchronous to opcode handling) or
		420	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		421	latter might corrupt your memory.
		422
		423	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		424	i.e. they will not interrupt your running perl program but will only be
		425	called as part of the normal event handling (just like timer, I/O etc.
		426	callbacks, too).
		427
377	=head3 Signal Races, Delays and Workarounds	428	=head3 Signal Races, Delays and Workarounds
378		429
379	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	430	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	431	callbacks to signals in a generic way, which is a pity, as you cannot
381	race-free signal handling in perl. AnyEvent will try to do it's best, but	432	do race-free signal handling in perl, requiring C libraries for
		433	this. AnyEvent will try to do it's best, which means in some cases,
382	in some cases, signals will be delayed. The maximum time a signal might	434	signals will be delayed. The maximum time a signal might be delayed is
383	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	435	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
384	seconds). This variable can be changed only before the first signal	436	variable can be changed only before the first signal watcher is created,
385	watcher is created, and should be left alone otherwise. Higher values	437	and should be left alone otherwise. This variable determines how often
		438	AnyEvent polls for signals (in case a wake-up was missed). Higher values
386	will cause fewer spurious wake-ups, which is better for power and CPU	439	will cause fewer spurious wake-ups, which is better for power and CPU
		440	saving.
		441
387	saving. All these problems can be avoided by installing the optional	442	All these problems can be avoided by installing the optional
388	L<Async::Interrupt> module. This will not work with inherently broken	443	L<Async::Interrupt> module, which works with most event loops. It will not
389	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>	444	work with inherently broken event loops such as L<Event> or L<Event::Lib>
390	currently, as POE does it's own workaround with one-second latency). With	445	(and not with L<POE> currently, as POE does it's own workaround with
391	those, you just have to suffer the delays.	446	one-second latency). For those, you just have to suffer the delays.
392		447
393	=head2 CHILD PROCESS WATCHERS	448	=head2 CHILD PROCESS WATCHERS
394		449
		450	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		451
395	You can also watch on a child process exit and catch its exit status.	452	You can also watch on a child process exit and catch its exit status.
396		453
397	The child process is specified by the C<pid> argument (if set to C<0>, it	454	The child process is specified by the C<pid> argument (one some backends,
398	watches for any child process exit). The watcher will triggered only when	455	using C<0> watches for any child process exit, on others this will
399	the child process has finished and an exit status is available, not on	456	croak). The watcher will be triggered only when the child process has
400	any trace events (stopped/continued).	457	finished and an exit status is available, not on any trace events
		458	(stopped/continued).
401		459
402	The callback will be called with the pid and exit status (as returned by	460	The callback will be called with the pid and exit status (as returned by
403	waitpid), so unlike other watcher types, you I<can> rely on child watcher	461	waitpid), so unlike other watcher types, you I<can> rely on child watcher
404	callback arguments.	462	callback arguments.
405		463
…		…
446	# do something else, then wait for process exit	504	# do something else, then wait for process exit
447	$done->recv;	505	$done->recv;
448		506
449	=head2 IDLE WATCHERS	507	=head2 IDLE WATCHERS
450		508
451	Sometimes there is a need to do something, but it is not so important	509	$w = AnyEvent->idle (cb => <callback>);
452	to do it instantly, but only when there is nothing better to do. This
453	"nothing better to do" is usually defined to be "no other events need
454	attention by the event loop".
455		510
456	Idle watchers ideally get invoked when the event loop has nothing	511	Repeatedly invoke the callback after the process becomes idle, until
457	better to do, just before it would block the process to wait for new	512	either the watcher is destroyed or new events have been detected.
458	events. Instead of blocking, the idle watcher is invoked.
459		513
460	Most event loops unfortunately do not really support idle watchers (only	514	Idle watchers are useful when there is a need to do something, but it
		515	is not so important (or wise) to do it instantly. The callback will be
		516	invoked only when there is "nothing better to do", which is usually
		517	defined as "all outstanding events have been handled and no new events
		518	have been detected". That means that idle watchers ideally get invoked
		519	when the event loop has just polled for new events but none have been
		520	detected. Instead of blocking to wait for more events, the idle watchers
		521	will be invoked.
		522
		523	Unfortunately, most event loops do not really support idle watchers (only
461	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	524	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
462	will simply call the callback "from time to time".	525	will simply call the callback "from time to time".
463		526
464	Example: read lines from STDIN, but only process them when the	527	Example: read lines from STDIN, but only process them when the
465	program is otherwise idle:	528	program is otherwise idle:
…		…
481	});	544	});
482	});	545	});
483		546
484	=head2 CONDITION VARIABLES	547	=head2 CONDITION VARIABLES
485		548
		549	$cv = AnyEvent->condvar;
		550
		551	$cv->send (<list>);
		552	my @res = $cv->recv;
		553
486	If you are familiar with some event loops you will know that all of them	554	If you are familiar with some event loops you will know that all of them
487	require you to run some blocking "loop", "run" or similar function that	555	require you to run some blocking "loop", "run" or similar function that
488	will actively watch for new events and call your callbacks.	556	will actively watch for new events and call your callbacks.
489		557
490	AnyEvent is slightly different: it expects somebody else to run the event	558	AnyEvent is slightly different: it expects somebody else to run the event
…		…
509	Condition variables are similar to callbacks, except that you can	577	Condition variables are similar to callbacks, except that you can
510	optionally wait for them. They can also be called merge points - points	578	optionally wait for them. They can also be called merge points - points
511	in time where multiple outstanding events have been processed. And yet	579	in time where multiple outstanding events have been processed. And yet
512	another way to call them is transactions - each condition variable can be	580	another way to call them is transactions - each condition variable can be
513	used to represent a transaction, which finishes at some point and delivers	581	used to represent a transaction, which finishes at some point and delivers
514	a result.	582	a result. And yet some people know them as "futures" - a promise to
		583	compute/deliver something that you can wait for.
515		584
516	Condition variables are very useful to signal that something has finished,	585	Condition variables are very useful to signal that something has finished,
517	for example, if you write a module that does asynchronous http requests,	586	for example, if you write a module that does asynchronous http requests,
518	then a condition variable would be the ideal candidate to signal the	587	then a condition variable would be the ideal candidate to signal the
519	availability of results. The user can either act when the callback is	588	availability of results. The user can either act when the callback is
…		…
540	eventually calls C<< -> send >>, and the "consumer side", which waits	609	eventually calls C<< -> send >>, and the "consumer side", which waits
541	for the send to occur.	610	for the send to occur.
542		611
543	Example: wait for a timer.	612	Example: wait for a timer.
544		613
545	# wait till the result is ready	614	# condition: "wait till the timer is fired"
546	my $result_ready = AnyEvent->condvar;	615	my $timer_fired = AnyEvent->condvar;
547		616
548	# do something such as adding a timer	617	# create the timer - we could wait for, say
549	# or socket watcher the calls $result_ready->send	618	# a handle becomign ready, or even an
550	# when the "result" is ready.	619	# AnyEvent::HTTP request to finish, but
551	# in this case, we simply use a timer:	620	# in this case, we simply use a timer:
552	my $w = AnyEvent->timer (	621	my $w = AnyEvent->timer (
553	after => 1,	622	after => 1,
554	cb => sub { $result_ready->send },	623	cb => sub { $timer_fired->send },
555	);	624	);
556		625
557	# this "blocks" (while handling events) till the callback	626	# this "blocks" (while handling events) till the callback
558	# calls -<send	627	# calls ->send
559	$result_ready->recv;	628	$timer_fired->recv;
560		629
561	Example: wait for a timer, but take advantage of the fact that condition	630	Example: wait for a timer, but take advantage of the fact that condition
562	variables are also callable directly.	631	variables are also callable directly.
563		632
564	my $done = AnyEvent->condvar;	633	my $done = AnyEvent->condvar;
…		…
627	one. For example, a function that pings many hosts in parallel might want	696	one. For example, a function that pings many hosts in parallel might want
628	to use a condition variable for the whole process.	697	to use a condition variable for the whole process.
629		698
630	Every call to C<< ->begin >> will increment a counter, and every call to	699	Every call to C<< ->begin >> will increment a counter, and every call to
631	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	700	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
632	>>, the (last) callback passed to C<begin> will be executed. That callback	701	>>, the (last) callback passed to C<begin> will be executed, passing the
633	is I<supposed> to call C<< ->send >>, but that is not required. If no	702	condvar as first argument. That callback is I<supposed> to call C<< ->send
634	callback was set, C<send> will be called without any arguments.	703	>>, but that is not required. If no group callback was set, C<send> will
		704	be called without any arguments.
635		705
636	You can think of C<< $cv->send >> giving you an OR condition (one call	706	You can think of C<< $cv->send >> giving you an OR condition (one call
637	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	707	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
638	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	708	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
639		709
…		…
666	begung can potentially be zero:	736	begung can potentially be zero:
667		737
668	my $cv = AnyEvent->condvar;	738	my $cv = AnyEvent->condvar;
669		739
670	my %result;	740	my %result;
671	$cv->begin (sub { $cv->send (\%result) });	741	$cv->begin (sub { shift->send (\%result) });
672		742
673	for my $host (@list_of_hosts) {	743	for my $host (@list_of_hosts) {
674	$cv->begin;	744	$cv->begin;
675	ping_host_then_call_callback $host, sub {	745	ping_host_then_call_callback $host, sub {
676	$result{$host} = ...;	746	$result{$host} = ...;
…		…
751	=item $cb = $cv->cb ($cb->($cv))	821	=item $cb = $cv->cb ($cb->($cv))
752		822
753	This is a mutator function that returns the callback set and optionally	823	This is a mutator function that returns the callback set and optionally
754	replaces it before doing so.	824	replaces it before doing so.
755		825
756	The callback will be called when the condition becomes "true", i.e. when	826	The callback will be called when the condition becomes (or already was)
757	C<send> or C<croak> are called, with the only argument being the condition	827	"true", i.e. when C<send> or C<croak> are called (or were called), with
758	variable itself. Calling C<recv> inside the callback or at any later time	828	the only argument being the condition variable itself. Calling C<recv>
759	is guaranteed not to block.	829	inside the callback or at any later time is guaranteed not to block.
760		830
761	=back	831	=back
762		832
763	=head1 SUPPORTED EVENT LOOPS/BACKENDS	833	=head1 SUPPORTED EVENT LOOPS/BACKENDS
764		834
…		…
767	=over 4	837	=over 4
768		838
769	=item Backends that are autoprobed when no other event loop can be found.	839	=item Backends that are autoprobed when no other event loop can be found.
770		840
771	EV is the preferred backend when no other event loop seems to be in	841	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	842	use. If EV is not installed, then AnyEvent will fall back to its own
773	that, will fall back to its own pure-perl implementation, which is	843	pure-perl implementation, which is available everywhere as it comes with
774	available everywhere as it comes with AnyEvent itself.	844	AnyEvent itself.
775		845
776	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	846	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.	847	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
779		848
780	=item Backends that are transparently being picked up when they are used.	849	=item Backends that are transparently being picked up when they are used.
781		850
782	These will be used when they are currently loaded when the first watcher	851	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	852	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	853	them. This means that AnyEvent will automatically pick the right backend
785	when the main program loads an event module before anything starts to	854	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.	855	create watchers. Nothing special needs to be done by the main program.
787		856
		857	AnyEvent::Impl::Event based on Event, very stable, few glitches.
788	AnyEvent::Impl::Glib based on Glib, slow but very stable.	858	AnyEvent::Impl::Glib based on Glib, slow but very stable.
789	AnyEvent::Impl::Tk based on Tk, very broken.	859	AnyEvent::Impl::Tk based on Tk, very broken.
790	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	860	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
791	AnyEvent::Impl::POE based on POE, very slow, some limitations.	861	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		862	AnyEvent::Impl::Irssi used when running within irssi.
792		863
793	=item Backends with special needs.	864	=item Backends with special needs.
794		865
795	Qt requires the Qt::Application to be instantiated first, but will	866	Qt requires the Qt::Application to be instantiated first, but will
796	otherwise be picked up automatically. As long as the main program	867	otherwise be picked up automatically. As long as the main program
…		…
870	event module detection too early, for example, L<AnyEvent::AIO> creates	941	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	942	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
872	avoid autodetecting the event module at load time.	943	avoid autodetecting the event module at load time.
873		944
874	If called in scalar or list context, then it creates and returns an object	945	If called in scalar or list context, then it creates and returns an object
875	that automatically removes the callback again when it is destroyed. See	946	that automatically removes the callback again when it is destroyed (or
		947	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
876	L<Coro::BDB> for a case where this is useful.	948	a case where this is useful.
		949
		950	Example: Create a watcher for the IO::AIO module and store it in
		951	C<$WATCHER>. Only do so after the event loop is initialised, though.
		952
		953	our WATCHER;
		954
		955	my $guard = AnyEvent::post_detect {
		956	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		957	};
		958
		959	# the ||= is important in case post_detect immediately runs the block,
		960	# as to not clobber the newly-created watcher. assigning both watcher and
		961	# post_detect guard to the same variable has the advantage of users being
		962	# able to just C<undef $WATCHER> if the watcher causes them grief.
		963
		964	$WATCHER ||= $guard;
877		965
878	=item @AnyEvent::post_detect	966	=item @AnyEvent::post_detect
879		967
880	If there are any code references in this array (you can C<push> to it	968	If there are any code references in this array (you can C<push> to it
881	before or after loading AnyEvent), then they will called directly after	969	before or after loading AnyEvent), then they will called directly after
…		…
884	You should check C<$AnyEvent::MODEL> before adding to this array, though:	972	You should check C<$AnyEvent::MODEL> before adding to this array, though:
885	if it is defined then the event loop has already been detected, and the	973	if it is defined then the event loop has already been detected, and the
886	array will be ignored.	974	array will be ignored.
887		975
888	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	976	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
889	it,as it takes care of these details.	977	it, as it takes care of these details.
890		978
891	This variable is mainly useful for modules that can do something useful	979	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	980	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	981	not need to even load it by default. This array provides the means to hook
894	into AnyEvent passively, without loading it.	982	into AnyEvent passively, without loading it.
		983
		984	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		985	together, you could put this into Coro (this is the actual code used by
		986	Coro to accomplish this):
		987
		988	if (defined $AnyEvent::MODEL) {
		989	# AnyEvent already initialised, so load Coro::AnyEvent
		990	require Coro::AnyEvent;
		991	} else {
		992	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		993	# as soon as it is
		994	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		995	}
895		996
896	=back	997	=back
897		998
898	=head1 WHAT TO DO IN A MODULE	999	=head1 WHAT TO DO IN A MODULE
899		1000
…		…
956	=head1 OTHER MODULES	1057	=head1 OTHER MODULES
957		1058
958	The following is a non-exhaustive list of additional modules that use	1059	The following is a non-exhaustive list of additional modules that use
959	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1060	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
960	modules and other event loops in the same program. Some of the modules	1061	modules and other event loops in the same program. Some of the modules
961	come with AnyEvent, most are available via CPAN.	1062	come as part of AnyEvent, the others are available via CPAN.
962		1063
963	=over 4	1064	=over 4
964		1065
965	=item L<AnyEvent::Util>	1066	=item L<AnyEvent::Util>
966		1067
…		…
981		1082
982	=item L<AnyEvent::DNS>	1083	=item L<AnyEvent::DNS>
983		1084
984	Provides rich asynchronous DNS resolver capabilities.	1085	Provides rich asynchronous DNS resolver capabilities.
985		1086
		1087	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1088
		1089	Implement event-based interfaces to the protocols of the same name (for
		1090	the curious, IGS is the International Go Server and FCP is the Freenet
		1091	Client Protocol).
		1092
		1093	=item L<AnyEvent::Handle::UDP>
		1094
		1095	Here be danger!
		1096
		1097	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1098	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1099	it's use of a stream-based API with a protocol that isn't streamable, that
		1100	the only way to improve it is to delete it.
		1101
		1102	It features data corruption (but typically only under load) and general
		1103	confusion. On top, the author is not only clueless about UDP but also
		1104	fact-resistant - some gems of his understanding: "connect doesn't work
		1105	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1106	packets", "I don't need to implement proper error checking as UDP doesn't
		1107	support error checking" and so on - he doesn't even understand what's
		1108	wrong with his module when it is explained to him.
		1109
986	=item L<AnyEvent::HTTP>	1110	=item L<AnyEvent::DBI>
987		1111
988	A simple-to-use HTTP library that is capable of making a lot of concurrent	1112	Executes L<DBI> requests asynchronously in a proxy process for you,
989	HTTP requests.	1113	notifying you in an event-bnased way when the operation is finished.
		1114
		1115	=item L<AnyEvent::AIO>
		1116
		1117	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1118	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1119	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1120	file I/O, and much more.
990		1121
991	=item L<AnyEvent::HTTPD>	1122	=item L<AnyEvent::HTTPD>
992		1123
993	Provides a simple web application server framework.	1124	A simple embedded webserver.
994		1125
995	=item L<AnyEvent::FastPing>	1126	=item L<AnyEvent::FastPing>
996		1127
997	The fastest ping in the west.	1128	The fastest ping in the west.
998
999	=item L<AnyEvent::DBI>
1000
1001	Executes L<DBI> requests asynchronously in a proxy process.
1002
1003	=item L<AnyEvent::AIO>
1004
1005	Truly asynchronous I/O, should be in the toolbox of every event
1006	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1007	together.
1008
1009	=item L<AnyEvent::BDB>
1010
1011	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1012	L<BDB> and AnyEvent together.
1013
1014	=item L<AnyEvent::GPSD>
1015
1016	A non-blocking interface to gpsd, a daemon delivering GPS information.
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
1027	=item L<AnyEvent::IGS>
1028
1029	A non-blocking interface to the Internet Go Server protocol (used by
1030	L<App::IGS>).
1031
1032	=item L<Net::FCP>
1033
1034	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1035	of AnyEvent.
1036
1037	=item L<Event::ExecFlow>
1038
1039	High level API for event-based execution flow control.
1040		1129
1041	=item L<Coro>	1130	=item L<Coro>
1042		1131
1043	Has special support for AnyEvent via L<Coro::AnyEvent>.	1132	Has special support for AnyEvent via L<Coro::AnyEvent>.
1044		1133
…		…
1048		1137
1049	package AnyEvent;	1138	package AnyEvent;
1050		1139
1051	# basically a tuned-down version of common::sense	1140	# basically a tuned-down version of common::sense
1052	sub common_sense {	1141	sub common_sense {
1053	# no warnings	1142	# from common:.sense 1.0
1054	${^WARNING_BITS} ^= ${^WARNING_BITS};	1143	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1055	# use strict vars subs	1144	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1056	$^H |= 0x00000600;	1145	$^H |= 0x00000600;
1057	}	1146	}
1058		1147
1059	BEGIN { AnyEvent::common_sense }	1148	BEGIN { AnyEvent::common_sense }
1060		1149
1061	use Carp ();	1150	use Carp ();
1062		1151
1063	our $VERSION = 4.85;	1152	our $VERSION = '5.261';
1064	our $MODEL;	1153	our $MODEL;
1065		1154
1066	our $AUTOLOAD;	1155	our $AUTOLOAD;
1067	our @ISA;	1156	our @ISA;
1068		1157
1069	our @REGISTRY;	1158	our @REGISTRY;
1070		1159
1071	our $WIN32;
1072
1073	our $VERBOSE;	1160	our $VERBOSE;
1074		1161
1075	BEGIN {	1162	BEGIN {
1076	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1163	require "AnyEvent/constants.pl";
		1164
1077	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1165	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1078		1166
1079	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1167	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1080	if ${^TAINT};	1168	if ${^TAINT};
1081		1169
1082	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1170	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1093	for reverse split /\s*,\s*/,	1181	for reverse split /\s*,\s*/,
1094	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1182	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1095	}	1183	}
1096		1184
1097	my @models = (	1185	my @models = (
1098	[EV:: => AnyEvent::Impl::EV::],	1186	[EV:: => AnyEvent::Impl::EV:: , 1],
1099	[Event:: => AnyEvent::Impl::Event::],
1100	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1187	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1101	# everything below here will not be autoprobed	1188	# everything below here will not (normally) be autoprobed
1102	# as the pureperl backend should work everywhere	1189	# as the pureperl backend should work everywhere
1103	# and is usually faster	1190	# and is usually faster
		1191	[Event:: => AnyEvent::Impl::Event::, 1],
1104	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1192	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1105	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1193	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1194	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1106	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1195	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1107	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1196	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1108	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1197	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1109	[Wx:: => AnyEvent::Impl::POE::],	1198	[Wx:: => AnyEvent::Impl::POE::],
1110	[Prima:: => AnyEvent::Impl::POE::],	1199	[Prima:: => AnyEvent::Impl::POE::],
1111	# IO::Async is just too broken - we would need workarounds for its	1200	# IO::Async is just too broken - we would need workarounds for its
1112	# byzantine signal and broken child handling, among others.	1201	# byzantine signal and broken child handling, among others.
1113	# IO::Async is rather hard to detect, as it doesn't have any	1202	# IO::Async is rather hard to detect, as it doesn't have any
1114	# obvious default class.	1203	# obvious default class.
1115	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1204	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1116	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1205	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1117	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1206	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1207	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1118	);	1208	);
1119		1209
1120	our %method = map +($_ => 1),	1210	our %method = map +($_ => 1),
1121	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1211	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1122		1212
1123	our @post_detect;	1213	our @post_detect;
1124		1214
1125	sub post_detect(&) {	1215	sub post_detect(&) {
1126	my ($cb) = @_;	1216	my ($cb) = @_;
1127		1217
1128	if ($MODEL) {
1129	$cb->();
1130
1131	1
1132	} else {
1133	push @post_detect, $cb;	1218	push @post_detect, $cb;
1134		1219
1135	defined wantarray	1220	defined wantarray
1136	? bless \$cb, "AnyEvent::Util::postdetect"	1221	? bless \$cb, "AnyEvent::Util::postdetect"
1137	: ()	1222	: ()
1138	}
1139	}	1223	}
1140		1224
1141	sub AnyEvent::Util::postdetect::DESTROY {	1225	sub AnyEvent::Util::postdetect::DESTROY {
1142	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1226	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1143	}	1227	}
1144		1228
1145	sub detect() {	1229	sub detect() {
		1230	# free some memory
		1231	*detect = sub () { $MODEL };
		1232
		1233	local $!; # for good measure
		1234	local $SIG{__DIE__};
		1235
		1236	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1237	my $model = "AnyEvent::Impl::$1";
		1238	if (eval "require $model") {
		1239	$MODEL = $model;
		1240	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1241	} else {
		1242	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1243	}
		1244	}
		1245
		1246	# check for already loaded models
1146	unless ($MODEL) {	1247	unless ($MODEL) {
1147	local $SIG{__DIE__};	1248	for (@REGISTRY, @models) {
1148		1249	my ($package, $model) = @$_;
1149	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1250	if (${"$package\::VERSION"} > 0) {
1150	my $model = "AnyEvent::Impl::$1";
1151	if (eval "require $model") {	1251	if (eval "require $model") {
1152	$MODEL = $model;	1252	$MODEL = $model;
1153	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1253	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1154	} else {	1254	last;
1155	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1255	}
1156	}	1256	}
1157	}	1257	}
1158		1258
1159	# check for already loaded models
1160	unless ($MODEL) {	1259	unless ($MODEL) {
		1260	# try to autoload a model
1161	for (@REGISTRY, @models) {	1261	for (@REGISTRY, @models) {
1162	my ($package, $model) = @$_;	1262	my ($package, $model, $autoload) = @$_;
		1263	if (
		1264	$autoload
		1265	and eval "require $package"
1163	if (${"$package\::VERSION"} > 0) {	1266	and ${"$package\::VERSION"} > 0
1164	if (eval "require $model") {	1267	and eval "require $model"
		1268	) {
1165	$MODEL = $model;	1269	$MODEL = $model;
1166	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1270	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1167	last;	1271	last;
1168	}
1169	}	1272	}
1170	}	1273	}
1171		1274
1172	unless ($MODEL) {
1173	# try to load a model
1174
1175	for (@REGISTRY, @models) {
1176	my ($package, $model) = @$_;
1177	if (eval "require $package"
1178	and ${"$package\::VERSION"} > 0
1179	and eval "require $model") {
1180	$MODEL = $model;
1181	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1182	last;
1183	}
1184	}
1185
1186	$MODEL	1275	$MODEL
1187	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1276	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1188	}
1189	}	1277	}
1190
1191	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1192
1193	unshift @ISA, $MODEL;
1194
1195	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1196
1197	(shift @post_detect)->() while @post_detect;
1198	}	1278	}
		1279
		1280	@models = (); # free probe data
		1281
		1282	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1283	unshift @ISA, $MODEL;
		1284
		1285	# now nuke some methods that are overriden by the backend.
		1286	# SUPER is not allowed.
		1287	for (qw(time signal child idle)) {
		1288	undef &{"AnyEvent::Base::$_"}
		1289	if defined &{"$MODEL\::$_"};
		1290	}
		1291
		1292	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1293
		1294	(shift @post_detect)->() while @post_detect;
		1295
		1296	*post_detect = sub(&) {
		1297	shift->();
		1298
		1299	undef
		1300	};
1199		1301
1200	$MODEL	1302	$MODEL
1201	}	1303	}
1202		1304
1203	sub AUTOLOAD {	1305	sub AUTOLOAD {
1204	(my $func = $AUTOLOAD) =~ s/.*://;	1306	(my $func = $AUTOLOAD) =~ s/.*://;
1205		1307
1206	$method{$func}	1308	$method{$func}
1207	or Carp::croak "$func: not a valid method for AnyEvent objects";	1309	or Carp::croak "$func: not a valid AnyEvent class method";
1208		1310
1209	detect unless $MODEL;	1311	detect;
1210		1312
1211	my $class = shift;	1313	my $class = shift;
1212	$class->$func (@_);	1314	$class->$func (@_);
1213	}	1315	}
1214		1316
…		…
1227	# we assume CLOEXEC is already set by perl in all important cases	1329	# we assume CLOEXEC is already set by perl in all important cases
1228		1330
1229	($fh2, $rw)	1331	($fh2, $rw)
1230	}	1332	}
1231		1333
		1334	=head1 SIMPLIFIED AE API
		1335
		1336	Starting with version 5.0, AnyEvent officially supports a second, much
		1337	simpler, API that is designed to reduce the calling, typing and memory
		1338	overhead by using function call syntax and a fixed number of parameters.
		1339
		1340	See the L<AE> manpage for details.
		1341
		1342	=cut
		1343
		1344	package AE;
		1345
		1346	our $VERSION = $AnyEvent::VERSION;
		1347
		1348	# fall back to the main API by default - backends and AnyEvent::Base
		1349	# implementations can overwrite these.
		1350
		1351	sub io($$$) {
		1352	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1353	}
		1354
		1355	sub timer($$$) {
		1356	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1357	}
		1358
		1359	sub signal($$) {
		1360	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1361	}
		1362
		1363	sub child($$) {
		1364	AnyEvent->child (pid => $_[0], cb => $_[1])
		1365	}
		1366
		1367	sub idle($) {
		1368	AnyEvent->idle (cb => $_[0])
		1369	}
		1370
		1371	sub cv(;&) {
		1372	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1373	}
		1374
		1375	sub now() {
		1376	AnyEvent->now
		1377	}
		1378
		1379	sub now_update() {
		1380	AnyEvent->now_update
		1381	}
		1382
		1383	sub time() {
		1384	AnyEvent->time
		1385	}
		1386
1232	package AnyEvent::Base;	1387	package AnyEvent::Base;
1233		1388
1234	# default implementations for many methods	1389	# default implementations for many methods
1235		1390
1236	sub _time {	1391	sub time {
		1392	eval q{ # poor man's autoloading {}
1237	# probe for availability of Time::HiRes	1393	# probe for availability of Time::HiRes
1238	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1394	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1239	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1395	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1240	*_time = \&Time::HiRes::time;	1396	*AE::time = \&Time::HiRes::time;
1241	# if (eval "use POSIX (); (POSIX::times())...	1397	# if (eval "use POSIX (); (POSIX::times())...
1242	} else {	1398	} else {
1243	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1399	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1244	*_time = sub { time }; # epic fail	1400	*AE::time = sub (){ time }; # epic fail
		1401	}
		1402
		1403	*time = sub { AE::time }; # different prototypes
1245	}	1404	};
		1405	die if $@;
1246		1406
1247	&_time	1407	&time
1248	}	1408	}
1249		1409
1250	sub time { _time }	1410	*now = \&time;
1251	sub now { _time }	1411
1252	sub now_update { }	1412	sub now_update { }
1253		1413
1254	# default implementation for ->condvar	1414	# default implementation for ->condvar
1255		1415
1256	sub condvar {	1416	sub condvar {
		1417	eval q{ # poor man's autoloading {}
		1418	*condvar = sub {
1257	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1419	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1420	};
		1421
		1422	*AE::cv = sub (;&) {
		1423	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1424	};
		1425	};
		1426	die if $@;
		1427
		1428	&condvar
1258	}	1429	}
1259		1430
1260	# default implementation for ->signal	1431	# default implementation for ->signal
1261		1432
1262	our $HAVE_ASYNC_INTERRUPT;	1433	our $HAVE_ASYNC_INTERRUPT;
		1434
		1435	sub _have_async_interrupt() {
		1436	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1437	&& eval "use Async::Interrupt 1.02 (); 1")
		1438	unless defined $HAVE_ASYNC_INTERRUPT;
		1439
		1440	$HAVE_ASYNC_INTERRUPT
		1441	}
		1442
1263	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1443	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1264	our (%SIG_ASY, %SIG_ASY_W);	1444	our (%SIG_ASY, %SIG_ASY_W);
1265	our ($SIG_COUNT, $SIG_TW);	1445	our ($SIG_COUNT, $SIG_TW);
1266		1446
1267	sub _signal_exec {
1268	$HAVE_ASYNC_INTERRUPT
1269	? $SIGPIPE_R->drain
1270	: sysread $SIGPIPE_R, my $dummy, 9;
1271
1272	while (%SIG_EV) {
1273	for (keys %SIG_EV) {
1274	delete $SIG_EV{$_};
1275	$_->() for values %{ $SIG_CB{$_} || {} };
1276	}
1277	}
1278	}
1279
1280	# install a dumym wakeupw atcher to reduce signal catching latency	1447	# install a dummy wakeup watcher to reduce signal catching latency
		1448	# used by Impls
1281	sub _sig_add() {	1449	sub _sig_add() {
1282	unless ($SIG_COUNT++) {	1450	unless ($SIG_COUNT++) {
1283	# try to align timer on a full-second boundary, if possible	1451	# try to align timer on a full-second boundary, if possible
1284	my $NOW = AnyEvent->now;	1452	my $NOW = AE::now;
1285		1453
1286	$SIG_TW = AnyEvent->timer (	1454	$SIG_TW = AE::timer
1287	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1455	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1288	interval => $MAX_SIGNAL_LATENCY,	1456	$MAX_SIGNAL_LATENCY,
1289	cb => sub { }, # just for the PERL_ASYNC_CHECK	1457	sub { } # just for the PERL_ASYNC_CHECK
1290	);	1458	;
1291	}	1459	}
1292	}	1460	}
1293		1461
1294	sub _sig_del {	1462	sub _sig_del {
1295	undef $SIG_TW	1463	undef $SIG_TW
1296	unless --$SIG_COUNT;	1464	unless --$SIG_COUNT;
1297	}	1465	}
1298		1466
		1467	our $_sig_name_init; $_sig_name_init = sub {
		1468	eval q{ # poor man's autoloading {}
		1469	undef $_sig_name_init;
		1470
		1471	if (_have_async_interrupt) {
		1472	*sig2num = \&Async::Interrupt::sig2num;
		1473	*sig2name = \&Async::Interrupt::sig2name;
		1474	} else {
		1475	require Config;
		1476
		1477	my %signame2num;
		1478	@signame2num{ split ' ', $Config::Config{sig_name} }
		1479	= split ' ', $Config::Config{sig_num};
		1480
		1481	my @signum2name;
		1482	@signum2name[values %signame2num] = keys %signame2num;
		1483
		1484	*sig2num = sub($) {
		1485	$_[0] > 0 ? shift : $signame2num{+shift}
		1486	};
		1487	*sig2name = sub ($) {
		1488	$_[0] > 0 ? $signum2name[+shift] : shift
		1489	};
		1490	}
		1491	};
		1492	die if $@;
		1493	};
		1494
		1495	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1496	sub sig2name($) { &$_sig_name_init; &sig2name }
		1497
1299	sub _signal {	1498	sub signal {
1300	my (undef, %arg) = @_;	1499	eval q{ # poor man's autoloading {}
		1500	# probe for availability of Async::Interrupt
		1501	if (_have_async_interrupt) {
		1502	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1301		1503
1302	my $signal = uc $arg{signal}	1504	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1303	or Carp::croak "required option 'signal' is missing";	1505	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1304		1506
1305	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1507	} else {
		1508	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1306		1509
1307	if ($HAVE_ASYNC_INTERRUPT) {	1510	if (AnyEvent::WIN32) {
1308	# async::interrupt	1511	require AnyEvent::Util;
1309		1512
1310	$SIG_ASY{$signal} ||= do {	1513	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1311	my $asy = new Async::Interrupt	1514	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1312	cb => sub { undef $SIG_EV{$signal} },	1515	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1313	signal => $signal,	1516	} else {
1314	pipe => [$SIGPIPE_R->filenos],	1517	pipe $SIGPIPE_R, $SIGPIPE_W;
		1518	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
		1519	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
		1520
		1521	# not strictly required, as $^F is normally 2, but let's make sure...
		1522	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1523	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1315	;	1524	}
1316	$asy->pipe_autodrain (0);
1317		1525
1318	$asy	1526	$SIGPIPE_R
		1527	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1528
		1529	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1530	}
		1531
		1532	*signal = $HAVE_ASYNC_INTERRUPT
		1533	? sub {
		1534	my (undef, %arg) = @_;
		1535
		1536	# async::interrupt
		1537	my $signal = sig2num $arg{signal};
		1538	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1539
		1540	$SIG_ASY{$signal} ||= new Async::Interrupt
		1541	cb => sub { undef $SIG_EV{$signal} },
		1542	signal => $signal,
		1543	pipe => [$SIGPIPE_R->filenos],
		1544	pipe_autodrain => 0,
		1545	;
		1546
		1547	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1548	}
		1549	: sub {
		1550	my (undef, %arg) = @_;
		1551
		1552	# pure perl
		1553	my $signal = sig2name $arg{signal};
		1554	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1555
		1556	$SIG{$signal} ||= sub {
		1557	local $!;
		1558	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1559	undef $SIG_EV{$signal};
		1560	};
		1561
		1562	# can't do signal processing without introducing races in pure perl,
		1563	# so limit the signal latency.
		1564	_sig_add;
		1565
		1566	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1567	}
		1568	;
		1569
		1570	*AnyEvent::Base::signal::DESTROY = sub {
		1571	my ($signal, $cb) = @{$_[0]};
		1572
		1573	_sig_del;
		1574
		1575	delete $SIG_CB{$signal}{$cb};
		1576
		1577	$HAVE_ASYNC_INTERRUPT
		1578	? delete $SIG_ASY{$signal}
		1579	: # delete doesn't work with older perls - they then
		1580	# print weird messages, or just unconditionally exit
		1581	# instead of getting the default action.
		1582	undef $SIG{$signal}
		1583	unless keys %{ $SIG_CB{$signal} };
1319	};	1584	};
1320		1585
1321	} else {	1586	*_signal_exec = sub {
1322	# pure perl	1587	$HAVE_ASYNC_INTERRUPT
		1588	? $SIGPIPE_R->drain
		1589	: sysread $SIGPIPE_R, (my $dummy), 9;
1323		1590
1324	$SIG{$signal} ||= sub {	1591	while (%SIG_EV) {
1325	local $!;	1592	for (keys %SIG_EV) {
1326	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1593	delete $SIG_EV{$_};
1327	undef $SIG_EV{$signal};	1594	$_->() for values %{ $SIG_CB{$_} || {} };
		1595	}
		1596	}
1328	};	1597	};
1329
1330	# can't do signal processing without introducing races in pure perl,
1331	# so limit the signal latency.
1332	_sig_add;
1333	}	1598	};
		1599	die if $@;
1334		1600
1335	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1336	}
1337
1338	sub signal {
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;
1342
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
1350	require Fcntl;
1351
1352	if (AnyEvent::WIN32) {
1353	require AnyEvent::Util;
1354
1355	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1356	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1357	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1358	} else {
1359	pipe $SIGPIPE_R, $SIGPIPE_W;
1360	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1361	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1362
1363	# not strictly required, as $^F is normally 2, but let's make sure...
1364	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1365	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1366	}
1367
1368	$SIGPIPE_R
1369	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1370
1371	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1372	}
1373
1374	*signal = \&_signal;
1375	&signal	1601	&signal
1376	}
1377
1378	sub AnyEvent::Base::signal::DESTROY {
1379	my ($signal, $cb) = @{$_[0]};
1380
1381	_sig_del;
1382
1383	delete $SIG_CB{$signal}{$cb};
1384
1385	$HAVE_ASYNC_INTERRUPT
1386	? delete $SIG_ASY{$signal}
1387	: # delete doesn't work with older perls - they then
1388	# print weird messages, or just unconditionally exit
1389	# instead of getting the default action.
1390	undef $SIG{$signal}
1391	unless keys %{ $SIG_CB{$signal} };
1392	}	1602	}
1393		1603
1394	# default implementation for ->child	1604	# default implementation for ->child
1395		1605
1396	our %PID_CB;	1606	our %PID_CB;
1397	our $CHLD_W;	1607	our $CHLD_W;
1398	our $CHLD_DELAY_W;	1608	our $CHLD_DELAY_W;
1399	our $WNOHANG;	1609	our $WNOHANG;
1400		1610
1401	sub _sigchld {	1611	# used by many Impl's
1402	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1612	sub _emit_childstatus($$) {
1403	$_->($pid, $?)	1613	my (undef, $rpid, $rstatus) = @_;
		1614
		1615	$_->($rpid, $rstatus)
1404	for values %{ $PID_CB{$pid} || {} },	1616	for values %{ $PID_CB{$rpid} || {} },
1405	values %{ $PID_CB{0} || {} };	1617	values %{ $PID_CB{0} || {} };
1406	}
1407	}	1618	}
1408		1619
1409	sub child {	1620	sub child {
		1621	eval q{ # poor man's autoloading {}
		1622	*_sigchld = sub {
		1623	my $pid;
		1624
		1625	AnyEvent->_emit_childstatus ($pid, $?)
		1626	while ($pid = waitpid -1, $WNOHANG) > 0;
		1627	};
		1628
		1629	*child = sub {
1410	my (undef, %arg) = @_;	1630	my (undef, %arg) = @_;
1411		1631
1412	defined (my $pid = $arg{pid} + 0)	1632	defined (my $pid = $arg{pid} + 0)
1413	or Carp::croak "required option 'pid' is missing";	1633	or Carp::croak "required option 'pid' is missing";
1414		1634
1415	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1635	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1416		1636
1417	# WNOHANG is almost cetrainly 1 everywhere	1637	# WNOHANG is almost cetrainly 1 everywhere
1418	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/	1638	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1419	? 1	1639	? 1
1420	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1640	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1421		1641
1422	unless ($CHLD_W) {	1642	unless ($CHLD_W) {
1423	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1643	$CHLD_W = AE::signal CHLD => \&_sigchld;
1424	# child could be a zombie already, so make at least one round	1644	# child could be a zombie already, so make at least one round
1425	&_sigchld;	1645	&_sigchld;
1426	}	1646	}
1427		1647
1428	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1648	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1429	}	1649	};
1430		1650
1431	sub AnyEvent::Base::child::DESTROY {	1651	*AnyEvent::Base::child::DESTROY = sub {
1432	my ($pid, $cb) = @{$_[0]};	1652	my ($pid, $cb) = @{$_[0]};
1433		1653
1434	delete $PID_CB{$pid}{$cb};	1654	delete $PID_CB{$pid}{$cb};
1435	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1655	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1436		1656
1437	undef $CHLD_W unless keys %PID_CB;	1657	undef $CHLD_W unless keys %PID_CB;
		1658	};
		1659	};
		1660	die if $@;
		1661
		1662	&child
1438	}	1663	}
1439		1664
1440	# idle emulation is done by simply using a timer, regardless	1665	# idle emulation is done by simply using a timer, regardless
1441	# of whether the process is idle or not, and not letting	1666	# of whether the process is idle or not, and not letting
1442	# the callback use more than 50% of the time.	1667	# the callback use more than 50% of the time.
1443	sub idle {	1668	sub idle {
		1669	eval q{ # poor man's autoloading {}
		1670	*idle = sub {
1444	my (undef, %arg) = @_;	1671	my (undef, %arg) = @_;
1445		1672
1446	my ($cb, $w, $rcb) = $arg{cb};	1673	my ($cb, $w, $rcb) = $arg{cb};
1447		1674
1448	$rcb = sub {	1675	$rcb = sub {
1449	if ($cb) {	1676	if ($cb) {
1450	$w = _time;	1677	$w = _time;
1451	&$cb;	1678	&$cb;
1452	$w = _time - $w;	1679	$w = _time - $w;
1453		1680
1454	# never use more then 50% of the time for the idle watcher,	1681	# never use more then 50% of the time for the idle watcher,
1455	# within some limits	1682	# within some limits
1456	$w = 0.0001 if $w < 0.0001;	1683	$w = 0.0001 if $w < 0.0001;
1457	$w = 5 if $w > 5;	1684	$w = 5 if $w > 5;
1458		1685
1459	$w = AnyEvent->timer (after => $w, cb => $rcb);	1686	$w = AE::timer $w, 0, $rcb;
1460	} else {	1687	} else {
1461	# clean up...	1688	# clean up...
1462	undef $w;	1689	undef $w;
1463	undef $rcb;	1690	undef $rcb;
		1691	}
		1692	};
		1693
		1694	$w = AE::timer 0.05, 0, $rcb;
		1695
		1696	bless \\$cb, "AnyEvent::Base::idle"
1464	}	1697	};
		1698
		1699	*AnyEvent::Base::idle::DESTROY = sub {
		1700	undef $${$_[0]};
		1701	};
1465	};	1702	};
		1703	die if $@;
1466		1704
1467	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1705	&idle
1468
1469	bless \\$cb, "AnyEvent::Base::idle"
1470	}
1471
1472	sub AnyEvent::Base::idle::DESTROY {
1473	undef $${$_[0]};
1474	}	1706	}
1475		1707
1476	package AnyEvent::CondVar;	1708	package AnyEvent::CondVar;
1477		1709
1478	our @ISA = AnyEvent::CondVar::Base::;	1710	our @ISA = AnyEvent::CondVar::Base::;
…		…
1526	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1758	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1527	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1759	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1528	}	1760	}
1529		1761
1530	sub cb {	1762	sub cb {
1531	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1763	my $cv = shift;
		1764
		1765	@_
		1766	and $cv->{_ae_cb} = shift
		1767	and $cv->{_ae_sent}
		1768	and (delete $cv->{_ae_cb})->($cv);
		1769
1532	$_[0]{_ae_cb}	1770	$cv->{_ae_cb}
1533	}	1771	}
1534		1772
1535	sub begin {	1773	sub begin {
1536	++$_[0]{_ae_counter};	1774	++$_[0]{_ae_counter};
1537	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1775	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1746	warn "read: $input\n"; # output what has been read	1984	warn "read: $input\n"; # output what has been read
1747	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1985	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1748	},	1986	},
1749	);	1987	);
1750		1988
1751	my $time_watcher; # can only be used once
1752
1753	sub new_timer {
1754	$timer = AnyEvent->timer (after => 1, cb => sub {	1989	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1755	warn "timeout\n"; # print 'timeout' about every second	1990	warn "timeout\n"; # print 'timeout' at most every second
1756	&new_timer; # and restart the time
1757	});	1991	});
1758	}
1759
1760	new_timer; # create first timer
1761		1992
1762	$cv->recv; # wait until user enters /^q/i	1993	$cv->recv; # wait until user enters /^q/i
1763		1994
1764	=head1 REAL-WORLD EXAMPLE	1995	=head1 REAL-WORLD EXAMPLE
1765		1996
…		…
1838		2069
1839	The actual code goes further and collects all errors (C<die>s, exceptions)	2070	The actual code goes further and collects all errors (C<die>s, exceptions)
1840	that occurred during request processing. The C<result> method detects	2071	that occurred during request processing. The C<result> method detects
1841	whether an exception as thrown (it is stored inside the $txn object)	2072	whether an exception as thrown (it is stored inside the $txn object)
1842	and just throws the exception, which means connection errors and other	2073	and just throws the exception, which means connection errors and other
1843	problems get reported tot he code that tries to use the result, not in a	2074	problems get reported to the code that tries to use the result, not in a
1844	random callback.	2075	random callback.
1845		2076
1846	All of this enables the following usage styles:	2077	All of this enables the following usage styles:
1847		2078
1848	1. Blocking:	2079	1. Blocking:
…		…
1896	through AnyEvent. The benchmark creates a lot of timers (with a zero	2127	through AnyEvent. The benchmark creates a lot of timers (with a zero
1897	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2128	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1898	which it is), lets them fire exactly once and destroys them again.	2129	which it is), lets them fire exactly once and destroys them again.
1899		2130
1900	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2131	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1901	distribution.	2132	distribution. It uses the L<AE> interface, which makes a real difference
		2133	for the EV and Perl backends only.
1902		2134
1903	=head3 Explanation of the columns	2135	=head3 Explanation of the columns
1904		2136
1905	I<watcher> is the number of event watchers created/destroyed. Since	2137	I<watcher> is the number of event watchers created/destroyed. Since
1906	different event models feature vastly different performances, each event	2138	different event models feature vastly different performances, each event
…		…
1927	watcher.	2159	watcher.
1928		2160
1929	=head3 Results	2161	=head3 Results
1930		2162
1931	name watchers bytes create invoke destroy comment	2163	name watchers bytes create invoke destroy comment
1932	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2164	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1933	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2165	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1934	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2166	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1935	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2167	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1936	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2168	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1937	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2169	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1938	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2170	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1939	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2171	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1940	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2172	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1941	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2173	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1942	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2174	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1943	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2175	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1944		2176
1945	=head3 Discussion	2177	=head3 Discussion
1946		2178
1947	The benchmark does I<not> measure scalability of the event loop very	2179	The benchmark does I<not> measure scalability of the event loop very
1948	well. For example, a select-based event loop (such as the pure perl one)	2180	well. For example, a select-based event loop (such as the pure perl one)
…		…
1960	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2192	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1961	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2193	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1962	cycles with POE.	2194	cycles with POE.
1963		2195
1964	C<EV> is the sole leader regarding speed and memory use, which are both	2196	C<EV> is the sole leader regarding speed and memory use, which are both
1965	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2197	maximal/minimal, respectively. When using the L<AE> API there is zero
		2198	overhead (when going through the AnyEvent API create is about 5-6 times
		2199	slower, with other times being equal, so still uses far less memory than
1966	far less memory than any other event loop and is still faster than Event	2200	any other event loop and is still faster than Event natively).
1967	natively.
1968		2201
1969	The pure perl implementation is hit in a few sweet spots (both the	2202	The pure perl implementation is hit in a few sweet spots (both the
1970	constant timeout and the use of a single fd hit optimisations in the perl	2203	constant timeout and the use of a single fd hit optimisations in the perl
1971	interpreter and the backend itself). Nevertheless this shows that it	2204	interpreter and the backend itself). Nevertheless this shows that it
1972	adds very little overhead in itself. Like any select-based backend its	2205	adds very little overhead in itself. Like any select-based backend its
…		…
2046	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2279	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2047	(1%) are active. This mirrors the activity of large servers with many	2280	(1%) are active. This mirrors the activity of large servers with many
2048	connections, most of which are idle at any one point in time.	2281	connections, most of which are idle at any one point in time.
2049		2282
2050	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2283	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2051	distribution.	2284	distribution. It uses the L<AE> interface, which makes a real difference
		2285	for the EV and Perl backends only.
2052		2286
2053	=head3 Explanation of the columns	2287	=head3 Explanation of the columns
2054		2288
2055	I<sockets> is the number of sockets, and twice the number of "servers" (as	2289	I<sockets> is the number of sockets, and twice the number of "servers" (as
2056	each server has a read and write socket end).	2290	each server has a read and write socket end).
…		…
2064	a new one that moves the timeout into the future.	2298	a new one that moves the timeout into the future.
2065		2299
2066	=head3 Results	2300	=head3 Results
2067		2301
2068	name sockets create request	2302	name sockets create request
2069	EV 20000 69.01 11.16	2303	EV 20000 62.66 7.99
2070	Perl 20000 73.32 35.87	2304	Perl 20000 68.32 32.64
2071	IOAsync 20000 157.00 98.14 epoll	2305	IOAsync 20000 174.06 101.15 epoll
2072	IOAsync 20000 159.31 616.06 poll	2306	IOAsync 20000 174.67 610.84 poll
2073	Event 20000 212.62 257.32	2307	Event 20000 202.69 242.91
2074	Glib 20000 651.16 1896.30	2308	Glib 20000 557.01 1689.52
2075	POE 20000 349.67 12317.24 uses POE::Loop::Event	2309	POE 20000 341.54 12086.32 uses POE::Loop::Event
2076		2310
2077	=head3 Discussion	2311	=head3 Discussion
2078		2312
2079	This benchmark I<does> measure scalability and overall performance of the	2313	This benchmark I<does> measure scalability and overall performance of the
2080	particular event loop.	2314	particular event loop.
…		…
2206	As you can see, the AnyEvent + EV combination even beats the	2440	As you can see, the AnyEvent + EV combination even beats the
2207	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2441	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2208	backend easily beats IO::Lambda and POE.	2442	backend easily beats IO::Lambda and POE.
2209		2443
2210	And even the 100% non-blocking version written using the high-level (and	2444	And even the 100% non-blocking version written using the high-level (and
2211	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2445	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2212	large margin, even though it does all of DNS, tcp-connect and socket I/O	2446	higher level ("unoptimised") abstractions by a large margin, even though
2213	in a non-blocking way.	2447	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2214		2448
2215	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2449	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2216	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2450	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2217	part of the IO::lambda distribution and were used without any changes.	2451	part of the IO::Lambda distribution and were used without any changes.
2218		2452
2219		2453
2220	=head1 SIGNALS	2454	=head1 SIGNALS
2221		2455
2222	AnyEvent currently installs handlers for these signals:	2456	AnyEvent currently installs handlers for these signals:
…		…
2264	it's built-in modules) are required to use it.	2498	it's built-in modules) are required to use it.
2265		2499
2266	That does not mean that AnyEvent won't take advantage of some additional	2500	That does not mean that AnyEvent won't take advantage of some additional
2267	modules if they are installed.	2501	modules if they are installed.
2268		2502
2269	This section epxlains which additional modules will be used, and how they	2503	This section explains which additional modules will be used, and how they
2270	affect AnyEvent's operetion.	2504	affect AnyEvent's operation.
2271		2505
2272	=over 4	2506	=over 4
2273		2507
2274	=item L<Async::Interrupt>	2508	=item L<Async::Interrupt>
2275		2509
…		…
2280	catch the signals) with some delay (default is 10 seconds, look for	2514	catch the signals) with some delay (default is 10 seconds, look for
2281	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2515	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2282		2516
2283	If this module is available, then it will be used to implement signal	2517	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	2518	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	2519	will not be interrupted regularly, which is more efficient (and good for
2286	battery life on laptops).	2520	battery life on laptops).
2287		2521
2288	This affects not just the pure-perl event loop, but also other event loops	2522	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).	2523	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2290		2524
…		…
2302	automatic timer adjustments even when no monotonic clock is available,	2536	automatic timer adjustments even when no monotonic clock is available,
2303	can take avdantage of advanced kernel interfaces such as C<epoll> and	2537	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	2538	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>).	2539	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2306		2540
		2541	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2542	then this module will do nothing for you.
		2543
2307	=item L<Guard>	2544	=item L<Guard>
2308		2545
2309	The guard module, when used, will be used to implement	2546	The guard module, when used, will be used to implement
2310	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2547	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	2548	lot less memory), but otherwise doesn't affect guard operation much. It is
2312	purely used for performance.	2549	purely used for performance.
2313		2550
2314	=item L<JSON> and L<JSON::XS>	2551	=item L<JSON> and L<JSON::XS>
2315		2552
2316	This module is required when you want to read or write JSON data via	2553	One of these modules is required when you want to read or write JSON data
2317	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2554	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2318	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2555	advantage of the ultra-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		2556
2323	=item L<Net::SSLeay>	2557	=item L<Net::SSLeay>
2324		2558
2325	Implementing TLS/SSL in Perl is certainly interesting, but not very	2559	Implementing TLS/SSL in Perl is certainly interesting, but not very
2326	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2560	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2337		2571
2338		2572
2339	=head1 FORK	2573	=head1 FORK
2340		2574
2341	Most event libraries are not fork-safe. The ones who are usually are	2575	Most event libraries are not fork-safe. The ones who are usually are
2342	because they rely on inefficient but fork-safe C<select> or C<poll>	2576	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2343	calls. Only L<EV> is fully fork-aware.	2577	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2578	are usually badly thought-out hacks that are incompatible with fork in
		2579	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2580	continue event-processing in both parent and child (or both, if you know
		2581	what you are doing).
		2582
		2583	This means that, in general, you cannot fork and do event processing in
		2584	the child if the event library was initialised before the fork (which
		2585	usually happens when the first AnyEvent watcher is created, or the library
		2586	is loaded).
2344		2587
2345	If you have to fork, you must either do so I<before> creating your first	2588	If you have to fork, you must either do so I<before> creating your first
2346	watcher OR you must not use AnyEvent at all in the child OR you must do	2589	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.	2590	something completely out of the scope of AnyEvent.
		2591
		2592	The problem of doing event processing in the parent I<and> the child
		2593	is much more complicated: even for backends that I<are> fork-aware or
		2594	fork-safe, their behaviour is not usually what you want: fork clones all
		2595	watchers, that means all timers, I/O watchers etc. are active in both
		2596	parent and child, which is almost never what you want. USing C<exec>
		2597	to start worker children from some kind of manage rprocess is usually
		2598	preferred, because it is much easier and cleaner, at the expense of having
		2599	to have another binary.
2348		2600
2349		2601
2350	=head1 SECURITY CONSIDERATIONS	2602	=head1 SECURITY CONSIDERATIONS
2351		2603
2352	AnyEvent can be forced to load any event model via	2604	AnyEvent can be forced to load any event model via
…		…
2390	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2642	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2391		2643
2392	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2644	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2393	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2645	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2394	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2646	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2395	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2647	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2396		2648
2397	Non-blocking file handles, sockets, TCP clients and	2649	Non-blocking file handles, sockets, TCP clients and
2398	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2650	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2399		2651
2400	Asynchronous DNS: L<AnyEvent::DNS>.	2652	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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