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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.249 by root, Mon Jul 20 06:00:42 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 - events independent of event loop implementation	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 => ...
47		50
48	There is a mailinglist for discussing all things AnyEvent, and an IRC	51	There is a mailinglist for discussing all things AnyEvent, and an IRC
49	channel, too.	52	channel, too.
50		53
51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	54	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52	Respository>, at L<http://anyevent.schmorp.de>, for more info.	55	Repository>, at L<http://anyevent.schmorp.de>, for more info.
53		56
54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	57	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
55		58
56	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
57	nowadays. So what is different about AnyEvent?	60	nowadays. So what is different about AnyEvent?
…		…
181	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
182	declared.	185	declared.
183		186
184	=head2 I/O WATCHERS	187	=head2 I/O WATCHERS
185		188
		189	$w = AnyEvent->io (
		190	fh => <filehandle_or_fileno>,
		191	poll => <"r" or "w">,
		192	cb => <callback>,
		193	);
		194
186	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
187	with the following mandatory key-value pairs as arguments:	196	with the following mandatory key-value pairs as arguments:
188		197
189	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
190	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
…		…
219	undef $w;	228	undef $w;
220	});	229	});
221		230
222	=head2 TIME WATCHERS	231	=head2 TIME WATCHERS
223		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
224	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 >>
225	method with the following mandatory arguments:	242	method with the following mandatory arguments:
226		243
227	C<after> specifies after how many seconds (fractional values are	244	C<after> specifies after how many seconds (fractional values are
228	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
…		…
349	might affect timers and time-outs.	366	might affect timers and time-outs.
350		367
351	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
352	event loop's idea of "current time".	369	event loop's idea of "current time".
353		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
354	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.
355		379
356	=back	380	=back
357		381
358	=head2 SIGNAL WATCHERS	382	=head2 SIGNAL WATCHERS
		383
		384	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
359		385
360	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
361	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
362	callback to be invoked whenever a signal occurs.	388	callback to be invoked whenever a signal occurs.
363		389
…		…
380		406
381	Example: exit on SIGINT	407	Example: exit on SIGINT
382		408
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	409	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		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
385	=head3 Signal Races, Delays and Workarounds	428	=head3 Signal Races, Delays and Workarounds
386		429
387	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
388	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
389	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,
390	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
391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	435	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	436	variable can be changed only before the first signal watcher is created,
393	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
394	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
395	saving. All these problems can be avoided by installing the optional	442	All these problems can be avoided by installing the optional
396	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
397	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>
398	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
399	those, you just have to suffer the delays.	446	one-second latency). For those, you just have to suffer the delays.
400		447
401	=head2 CHILD PROCESS WATCHERS	448	=head2 CHILD PROCESS WATCHERS
402		449
		450	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		451
403	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.
404		453
405	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,
406	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
407	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
408	any trace events (stopped/continued).	457	finished and an exit status is available, not on any trace events
		458	(stopped/continued).
409		459
410	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
411	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
412	callback arguments.	462	callback arguments.
413		463
…		…
454	# do something else, then wait for process exit	504	# do something else, then wait for process exit
455	$done->recv;	505	$done->recv;
456		506
457	=head2 IDLE WATCHERS	507	=head2 IDLE WATCHERS
458		508
459	Sometimes there is a need to do something, but it is not so important	509	$w = AnyEvent->idle (cb => <callback>);
460	to do it instantly, but only when there is nothing better to do. This
461	"nothing better to do" is usually defined to be "no other events need
462	attention by the event loop".
463		510
464	Idle watchers ideally get invoked when the event loop has nothing	511	Repeatedly invoke the callback after the process becomes idle, until
465	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.
466	events. Instead of blocking, the idle watcher is invoked.
467		513
468	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
469	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
470	will simply call the callback "from time to time".	525	will simply call the callback "from time to time".
471		526
472	Example: read lines from STDIN, but only process them when the	527	Example: read lines from STDIN, but only process them when the
473	program is otherwise idle:	528	program is otherwise idle:
…		…
489	});	544	});
490	});	545	});
491		546
492	=head2 CONDITION VARIABLES	547	=head2 CONDITION VARIABLES
493		548
		549	$cv = AnyEvent->condvar;
		550
		551	$cv->send (<list>);
		552	my @res = $cv->recv;
		553
494	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
495	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
496	will actively watch for new events and call your callbacks.	556	will actively watch for new events and call your callbacks.
497		557
498	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
…		…
517	Condition variables are similar to callbacks, except that you can	577	Condition variables are similar to callbacks, except that you can
518	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
519	in time where multiple outstanding events have been processed. And yet	579	in time where multiple outstanding events have been processed. And yet
520	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
521	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
522	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.
523		584
524	Condition variables are very useful to signal that something has finished,	585	Condition variables are very useful to signal that something has finished,
525	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,
526	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
527	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
…		…
548	eventually calls C<< -> send >>, and the "consumer side", which waits	609	eventually calls C<< -> send >>, and the "consumer side", which waits
549	for the send to occur.	610	for the send to occur.
550		611
551	Example: wait for a timer.	612	Example: wait for a timer.
552		613
553	# wait till the result is ready	614	# condition: "wait till the timer is fired"
554	my $result_ready = AnyEvent->condvar;	615	my $timer_fired = AnyEvent->condvar;
555		616
556	# do something such as adding a timer	617	# create the timer - we could wait for, say
557	# or socket watcher the calls $result_ready->send	618	# a handle becomign ready, or even an
558	# when the "result" is ready.	619	# AnyEvent::HTTP request to finish, but
559	# in this case, we simply use a timer:	620	# in this case, we simply use a timer:
560	my $w = AnyEvent->timer (	621	my $w = AnyEvent->timer (
561	after => 1,	622	after => 1,
562	cb => sub { $result_ready->send },	623	cb => sub { $timer_fired->send },
563	);	624	);
564		625
565	# this "blocks" (while handling events) till the callback	626	# this "blocks" (while handling events) till the callback
566	# calls -<send	627	# calls ->send
567	$result_ready->recv;	628	$timer_fired->recv;
568		629
569	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
570	variables are also callable directly.	631	variables are also callable directly.
571		632
572	my $done = AnyEvent->condvar;	633	my $done = AnyEvent->condvar;
…		…
635	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
636	to use a condition variable for the whole process.	697	to use a condition variable for the whole process.
637		698
638	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
639	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
640	>>, 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
641	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
642	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.
643		705
644	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
645	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
646	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).
647		709
…		…
674	begung can potentially be zero:	736	begung can potentially be zero:
675		737
676	my $cv = AnyEvent->condvar;	738	my $cv = AnyEvent->condvar;
677		739
678	my %result;	740	my %result;
679	$cv->begin (sub { $cv->send (\%result) });	741	$cv->begin (sub { shift->send (\%result) });
680		742
681	for my $host (@list_of_hosts) {	743	for my $host (@list_of_hosts) {
682	$cv->begin;	744	$cv->begin;
683	ping_host_then_call_callback $host, sub {	745	ping_host_then_call_callback $host, sub {
684	$result{$host} = ...;	746	$result{$host} = ...;
…		…
759	=item $cb = $cv->cb ($cb->($cv))	821	=item $cb = $cv->cb ($cb->($cv))
760		822
761	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
762	replaces it before doing so.	824	replaces it before doing so.
763		825
764	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)
765	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
766	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>
767	is guaranteed not to block.	829	inside the callback or at any later time is guaranteed not to block.
768		830
769	=back	831	=back
770		832
771	=head1 SUPPORTED EVENT LOOPS/BACKENDS	833	=head1 SUPPORTED EVENT LOOPS/BACKENDS
772		834
…		…
775	=over 4	837	=over 4
776		838
777	=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.
778		840
779	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
780	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
781	that, will fall back to its own pure-perl implementation, which is	843	pure-perl implementation, which is available everywhere as it comes with
782	available everywhere as it comes with AnyEvent itself.	844	AnyEvent itself.
783		845
784	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	846	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
785	AnyEvent::Impl::Event based on Event, very stable, few glitches.
786	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	847	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
787		848
788	=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.
789		850
790	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
791	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
792	them. This means that AnyEvent will automatically pick the right backend	853	them. This means that AnyEvent will automatically pick the right backend
793	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
794	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.
795		856
		857	AnyEvent::Impl::Event based on Event, very stable, few glitches.
796	AnyEvent::Impl::Glib based on Glib, slow but very stable.	858	AnyEvent::Impl::Glib based on Glib, slow but very stable.
797	AnyEvent::Impl::Tk based on Tk, very broken.	859	AnyEvent::Impl::Tk based on Tk, very broken.
798	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	860	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
799	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.
800		863
801	=item Backends with special needs.	864	=item Backends with special needs.
802		865
803	Qt requires the Qt::Application to be instantiated first, but will	866	Qt requires the Qt::Application to be instantiated first, but will
804	otherwise be picked up automatically. As long as the main program	867	otherwise be picked up automatically. As long as the main program
…		…
878	event module detection too early, for example, L<AnyEvent::AIO> creates	941	event module detection too early, for example, L<AnyEvent::AIO> creates
879	and installs the global L<IO::AIO> watcher in a C<post_detect> block to	942	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
880	avoid autodetecting the event module at load time.	943	avoid autodetecting the event module at load time.
881		944
882	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
883	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
884	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;
885		965
886	=item @AnyEvent::post_detect	966	=item @AnyEvent::post_detect
887		967
888	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
889	before or after loading AnyEvent), then they will called directly after	969	before or after loading AnyEvent), then they will called directly after
…		…
892	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:
893	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
894	array will be ignored.	974	array will be ignored.
895		975
896	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	976	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
897	it,as it takes care of these details.	977	it, as it takes care of these details.
898		978
899	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
900	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
901	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
902	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	}
903		996
904	=back	997	=back
905		998
906	=head1 WHAT TO DO IN A MODULE	999	=head1 WHAT TO DO IN A MODULE
907		1000
…		…
964	=head1 OTHER MODULES	1057	=head1 OTHER MODULES
965		1058
966	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
967	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
968	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
969	come with AnyEvent, most are available via CPAN.	1062	come as part of AnyEvent, the others are available via CPAN.
970		1063
971	=over 4	1064	=over 4
972		1065
973	=item L<AnyEvent::Util>	1066	=item L<AnyEvent::Util>
974		1067
…		…
989		1082
990	=item L<AnyEvent::DNS>	1083	=item L<AnyEvent::DNS>
991		1084
992	Provides rich asynchronous DNS resolver capabilities.	1085	Provides rich asynchronous DNS resolver capabilities.
993		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
994	=item L<AnyEvent::HTTP>	1110	=item L<AnyEvent::DBI>
995		1111
996	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,
997	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.
998		1121
999	=item L<AnyEvent::HTTPD>	1122	=item L<AnyEvent::HTTPD>
1000		1123
1001	Provides a simple web application server framework.	1124	A simple embedded webserver.
1002		1125
1003	=item L<AnyEvent::FastPing>	1126	=item L<AnyEvent::FastPing>
1004		1127
1005	The fastest ping in the west.	1128	The fastest ping in the west.
1006
1007	=item L<AnyEvent::DBI>
1008
1009	Executes L<DBI> requests asynchronously in a proxy process.
1010
1011	=item L<AnyEvent::AIO>
1012
1013	Truly asynchronous I/O, should be in the toolbox of every event
1014	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1015	together.
1016
1017	=item L<AnyEvent::BDB>
1018
1019	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1020	L<BDB> and AnyEvent together.
1021
1022	=item L<AnyEvent::GPSD>
1023
1024	A non-blocking interface to gpsd, a daemon delivering GPS information.
1025
1026	=item L<AnyEvent::IRC>
1027
1028	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1029
1030	=item L<AnyEvent::XMPP>
1031
1032	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1033	Net::XMPP2>.
1034
1035	=item L<AnyEvent::IGS>
1036
1037	A non-blocking interface to the Internet Go Server protocol (used by
1038	L<App::IGS>).
1039
1040	=item L<Net::FCP>
1041
1042	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1043	of AnyEvent.
1044
1045	=item L<Event::ExecFlow>
1046
1047	High level API for event-based execution flow control.
1048		1129
1049	=item L<Coro>	1130	=item L<Coro>
1050		1131
1051	Has special support for AnyEvent via L<Coro::AnyEvent>.	1132	Has special support for AnyEvent via L<Coro::AnyEvent>.
1052		1133
…		…
1056		1137
1057	package AnyEvent;	1138	package AnyEvent;
1058		1139
1059	# basically a tuned-down version of common::sense	1140	# basically a tuned-down version of common::sense
1060	sub common_sense {	1141	sub common_sense {
1061	# no warnings	1142	# from common:.sense 1.0
1062	${^WARNING_BITS} ^= ${^WARNING_BITS};	1143	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1063	# use strict vars subs	1144	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1064	$^H \|= 0x00000600;	1145	$^H \|= 0x00000600;
1065	}	1146	}
1066		1147
1067	BEGIN { AnyEvent::common_sense }	1148	BEGIN { AnyEvent::common_sense }
1068		1149
1069	use Carp ();	1150	use Carp ();
1070		1151
1071	our $VERSION = 4.85;	1152	our $VERSION = '5.261';
1072	our $MODEL;	1153	our $MODEL;
1073		1154
1074	our $AUTOLOAD;	1155	our $AUTOLOAD;
1075	our @ISA;	1156	our @ISA;
1076		1157
1077	our @REGISTRY;	1158	our @REGISTRY;
1078		1159
1079	our $WIN32;
1080
1081	our $VERBOSE;	1160	our $VERBOSE;
1082		1161
1083	BEGIN {	1162	BEGIN {
1084	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1163	require "AnyEvent/constants.pl";
		1164
1085	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1165	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1086		1166
1087	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1167	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1088	if ${^TAINT};	1168	if ${^TAINT};
1089		1169
1090	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1170	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1101	for reverse split /\s,\s/,	1181	for reverse split /\s,\s/,
1102	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1182	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1103	}	1183	}
1104		1184
1105	my @models = (	1185	my @models = (
1106	[EV:: => AnyEvent::Impl::EV::],	1186	[EV:: => AnyEvent::Impl::EV:: , 1],
1107	[Event:: => AnyEvent::Impl::Event::],
1108	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1187	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1109	# everything below here will not be autoprobed	1188	# everything below here will not (normally) be autoprobed
1110	# as the pureperl backend should work everywhere	1189	# as the pureperl backend should work everywhere
1111	# and is usually faster	1190	# and is usually faster
		1191	[Event:: => AnyEvent::Impl::Event::, 1],
1112	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1192	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1113	[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
1114	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1195	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1115	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1196	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1116	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1197	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1117	[Wx:: => AnyEvent::Impl::POE::],	1198	[Wx:: => AnyEvent::Impl::POE::],
1118	[Prima:: => AnyEvent::Impl::POE::],	1199	[Prima:: => AnyEvent::Impl::POE::],
1119	# 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
1120	# byzantine signal and broken child handling, among others.	1201	# byzantine signal and broken child handling, among others.
1121	# 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
1122	# obvious default class.	1203	# obvious default class.
1123	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1204	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1124	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1205	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125	# [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
1126	);	1208	);
1127		1209
1128	our %method = map +($_ => 1),	1210	our %method = map +($_ => 1),
1129	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);
1130		1212
1131	our @post_detect;	1213	our @post_detect;
1132		1214
1133	sub post_detect(&) {	1215	sub post_detect(&) {
1134	my ($cb) = @_;	1216	my ($cb) = @_;
1135		1217
1136	if ($MODEL) {
1137	$cb->();
1138
1139	1
1140	} else {
1141	push @post_detect, $cb;	1218	push @post_detect, $cb;
1142		1219
1143	defined wantarray	1220	defined wantarray
1144	? bless \$cb, "AnyEvent::Util::postdetect"	1221	? bless \$cb, "AnyEvent::Util::postdetect"
1145	: ()	1222	: ()
1146	}
1147	}	1223	}
1148		1224
1149	sub AnyEvent::Util::postdetect::DESTROY {	1225	sub AnyEvent::Util::postdetect::DESTROY {
1150	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1226	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1151	}	1227	}
1152		1228
1153	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
1154	unless ($MODEL) {	1247	unless ($MODEL) {
1155	local $SIG{__DIE__};	1248	for (@REGISTRY, @models) {
1156		1249	my ($package, $model) = @$_;
1157	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1250	if (${"$package\::VERSION"} > 0) {
1158	my $model = "AnyEvent::Impl::$1";
1159	if (eval "require $model") {	1251	if (eval "require $model") {
1160	$MODEL = $model;	1252	$MODEL = $model;
1161	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;
1162	} else {	1254	last;
1163	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1255	}
1164	}	1256	}
1165	}	1257	}
1166		1258
1167	# check for already loaded models
1168	unless ($MODEL) {	1259	unless ($MODEL) {
		1260	# try to autoload a model
1169	for (@REGISTRY, @models) {	1261	for (@REGISTRY, @models) {
1170	my ($package, $model) = @$_;	1262	my ($package, $model, $autoload) = @$_;
		1263	if (
		1264	$autoload
		1265	and eval "require $package"
1171	if (${"$package\::VERSION"} > 0) {	1266	and ${"$package\::VERSION"} > 0
1172	if (eval "require $model") {	1267	and eval "require $model"
		1268	) {
1173	$MODEL = $model;	1269	$MODEL = $model;
1174	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1270	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1175	last;	1271	last;
1176	}
1177	}	1272	}
1178	}	1273	}
1179		1274
1180	unless ($MODEL) {
1181	# try to load a model
1182
1183	for (@REGISTRY, @models) {
1184	my ($package, $model) = @$_;
1185	if (eval "require $package"
1186	and ${"$package\::VERSION"} > 0
1187	and eval "require $model") {
1188	$MODEL = $model;
1189	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1190	last;
1191	}
1192	}
1193
1194	$MODEL	1275	$MODEL
1195	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";
1196	}
1197	}	1277	}
1198
1199	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1200
1201	unshift @ISA, $MODEL;
1202
1203	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1204
1205	(shift @post_detect)->() while @post_detect;
1206	}	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	};
1207		1301
1208	$MODEL	1302	$MODEL
1209	}	1303	}
1210		1304
1211	sub AUTOLOAD {	1305	sub AUTOLOAD {
1212	(my $func = $AUTOLOAD) =~ s/.*://;	1306	(my $func = $AUTOLOAD) =~ s/.*://;
1213		1307
1214	$method{$func}	1308	$method{$func}
1215	or Carp::croak "$func: not a valid method for AnyEvent objects";	1309	or Carp::croak "$func: not a valid AnyEvent class method";
1216		1310
1217	detect unless $MODEL;	1311	detect;
1218		1312
1219	my $class = shift;	1313	my $class = shift;
1220	$class->$func (@_);	1314	$class->$func (@_);
1221	}	1315	}
1222		1316
…		…
1235	# 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
1236		1330
1237	($fh2, $rw)	1331	($fh2, $rw)
1238	}	1332	}
1239		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
1240	package AnyEvent::Base;	1387	package AnyEvent::Base;
1241		1388
1242	# default implementations for many methods	1389	# default implementations for many methods
1243		1390
1244	sub _time {	1391	sub time {
		1392	eval q{ # poor man's autoloading {}
1245	# probe for availability of Time::HiRes	1393	# probe for availability of Time::HiRes
1246	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1394	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1247	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;
1248	*_time = \&Time::HiRes::time;	1396	*AE::time = \&Time::HiRes::time;
1249	# if (eval "use POSIX (); (POSIX::times())...	1397	# if (eval "use POSIX (); (POSIX::times())...
1250	} else {	1398	} else {
1251	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;
1252	*_time = sub { time }; # epic fail	1400	*AE::time = sub (){ time }; # epic fail
		1401	}
		1402
		1403	*time = sub { AE::time }; # different prototypes
1253	}	1404	};
		1405	die if $@;
1254		1406
1255	&_time	1407	&time
1256	}	1408	}
1257		1409
1258	sub time { _time }	1410	*now = \&time;
1259	sub now { _time }	1411
1260	sub now_update { }	1412	sub now_update { }
1261		1413
1262	# default implementation for ->condvar	1414	# default implementation for ->condvar
1263		1415
1264	sub condvar {	1416	sub condvar {
		1417	eval q{ # poor man's autoloading {}
		1418	*condvar = sub {
1265	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
1266	}	1429	}
1267		1430
1268	# default implementation for ->signal	1431	# default implementation for ->signal
1269		1432
1270	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
1271	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1443	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1272	our (%SIG_ASY, %SIG_ASY_W);	1444	our (%SIG_ASY, %SIG_ASY_W);
1273	our ($SIG_COUNT, $SIG_TW);	1445	our ($SIG_COUNT, $SIG_TW);
1274		1446
1275	sub _signal_exec {
1276	$HAVE_ASYNC_INTERRUPT
1277	? $SIGPIPE_R->drain
1278	: sysread $SIGPIPE_R, my $dummy, 9;
1279
1280	while (%SIG_EV) {
1281	for (keys %SIG_EV) {
1282	delete $SIG_EV{$_};
1283	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1284	}
1285	}
1286	}
1287
1288	# 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
1289	sub _sig_add() {	1449	sub _sig_add() {
1290	unless ($SIG_COUNT++) {	1450	unless ($SIG_COUNT++) {
1291	# try to align timer on a full-second boundary, if possible	1451	# try to align timer on a full-second boundary, if possible
1292	my $NOW = AnyEvent->now;	1452	my $NOW = AE::now;
1293		1453
1294	$SIG_TW = AnyEvent->timer (	1454	$SIG_TW = AE::timer
1295	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1455	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1296	interval => $MAX_SIGNAL_LATENCY,	1456	$MAX_SIGNAL_LATENCY,
1297	cb => sub { }, # just for the PERL_ASYNC_CHECK	1457	sub { } # just for the PERL_ASYNC_CHECK
1298	);	1458	;
1299	}	1459	}
1300	}	1460	}
1301		1461
1302	sub _sig_del {	1462	sub _sig_del {
1303	undef $SIG_TW	1463	undef $SIG_TW
1304	unless --$SIG_COUNT;	1464	unless --$SIG_COUNT;
1305	}	1465	}
1306		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
1307	sub _signal {	1498	sub signal {
1308	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;
1309		1503
1310	my $signal = uc $arg{signal}	1504	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1311	or Carp::croak "required option 'signal' is missing";	1505	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1312		1506
1313	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1507	} else {
		1508	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1314		1509
1315	if ($HAVE_ASYNC_INTERRUPT) {	1510	if (AnyEvent::WIN32) {
1316	# async::interrupt	1511	require AnyEvent::Util;
1317		1512
1318	$SIG_ASY{$signal} \|\|= do {	1513	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1319	my $asy = new Async::Interrupt	1514	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1320	cb => sub { undef $SIG_EV{$signal} },	1515	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1321	signal => $signal,	1516	} else {
1322	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;
1323	;	1524	}
1324	$asy->pipe_autodrain (0);
1325		1525
1326	$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} };
1327	};	1584	};
1328		1585
1329	} else {	1586	*_signal_exec = sub {
1330	# pure perl	1587	$HAVE_ASYNC_INTERRUPT
		1588	? $SIGPIPE_R->drain
		1589	: sysread $SIGPIPE_R, (my $dummy), 9;
1331		1590
1332	$SIG{$signal} \|\|= sub {	1591	while (%SIG_EV) {
1333	local $!;	1592	for (keys %SIG_EV) {
1334	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1593	delete $SIG_EV{$_};
1335	undef $SIG_EV{$signal};	1594	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1595	}
		1596	}
1336	};	1597	};
1337
1338	# can't do signal processing without introducing races in pure perl,
1339	# so limit the signal latency.
1340	_sig_add;
1341	}	1598	};
		1599	die if $@;
1342		1600
1343	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1344	}
1345
1346	sub signal {
1347	# probe for availability of Async::Interrupt
1348	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1349	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1350
1351	$HAVE_ASYNC_INTERRUPT = 1;
1352	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1353	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1354
1355	} else {
1356	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1357
1358	require Fcntl;
1359
1360	if (AnyEvent::WIN32) {
1361	require AnyEvent::Util;
1362
1363	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1364	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1365	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1366	} else {
1367	pipe $SIGPIPE_R, $SIGPIPE_W;
1368	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1369	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1370
1371	# not strictly required, as $^F is normally 2, but let's make sure...
1372	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1373	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1374	}
1375
1376	$SIGPIPE_R
1377	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1378
1379	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1380	}
1381
1382	*signal = \&_signal;
1383	&signal	1601	&signal
1384	}
1385
1386	sub AnyEvent::Base::signal::DESTROY {
1387	my ($signal, $cb) = @{$_[0]};
1388
1389	_sig_del;
1390
1391	delete $SIG_CB{$signal}{$cb};
1392
1393	$HAVE_ASYNC_INTERRUPT
1394	? delete $SIG_ASY{$signal}
1395	: # delete doesn't work with older perls - they then
1396	# print weird messages, or just unconditionally exit
1397	# instead of getting the default action.
1398	undef $SIG{$signal}
1399	unless keys %{ $SIG_CB{$signal} };
1400	}	1602	}
1401		1603
1402	# default implementation for ->child	1604	# default implementation for ->child
1403		1605
1404	our %PID_CB;	1606	our %PID_CB;
1405	our $CHLD_W;	1607	our $CHLD_W;
1406	our $CHLD_DELAY_W;	1608	our $CHLD_DELAY_W;
1407	our $WNOHANG;	1609	our $WNOHANG;
1408		1610
1409	sub _sigchld {	1611	# used by many Impl's
1410	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1612	sub _emit_childstatus($$) {
1411	$_->($pid, $?)	1613	my (undef, $rpid, $rstatus) = @_;
		1614
		1615	$_->($rpid, $rstatus)
1412	for values %{ $PID_CB{$pid} \|\| {} },	1616	for values %{ $PID_CB{$rpid} \|\| {} },
1413	values %{ $PID_CB{0} \|\| {} };	1617	values %{ $PID_CB{0} \|\| {} };
1414	}
1415	}	1618	}
1416		1619
1417	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 {
1418	my (undef, %arg) = @_;	1630	my (undef, %arg) = @_;
1419		1631
1420	defined (my $pid = $arg{pid} + 0)	1632	defined (my $pid = $arg{pid} + 0)
1421	or Carp::croak "required option 'pid' is missing";	1633	or Carp::croak "required option 'pid' is missing";
1422		1634
1423	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1635	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1424		1636
1425	# WNOHANG is almost cetrainly 1 everywhere	1637	# WNOHANG is almost cetrainly 1 everywhere
1426	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1638	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1427	? 1	1639	? 1
1428	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1640	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1429		1641
1430	unless ($CHLD_W) {	1642	unless ($CHLD_W) {
1431	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1643	$CHLD_W = AE::signal CHLD => \&_sigchld;
1432	# 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
1433	&_sigchld;	1645	&_sigchld;
1434	}	1646	}
1435		1647
1436	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1648	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1437	}	1649	};
1438		1650
1439	sub AnyEvent::Base::child::DESTROY {	1651	*AnyEvent::Base::child::DESTROY = sub {
1440	my ($pid, $cb) = @{$_[0]};	1652	my ($pid, $cb) = @{$_[0]};
1441		1653
1442	delete $PID_CB{$pid}{$cb};	1654	delete $PID_CB{$pid}{$cb};
1443	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1655	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1444		1656
1445	undef $CHLD_W unless keys %PID_CB;	1657	undef $CHLD_W unless keys %PID_CB;
		1658	};
		1659	};
		1660	die if $@;
		1661
		1662	&child
1446	}	1663	}
1447		1664
1448	# idle emulation is done by simply using a timer, regardless	1665	# idle emulation is done by simply using a timer, regardless
1449	# of whether the process is idle or not, and not letting	1666	# of whether the process is idle or not, and not letting
1450	# the callback use more than 50% of the time.	1667	# the callback use more than 50% of the time.
1451	sub idle {	1668	sub idle {
		1669	eval q{ # poor man's autoloading {}
		1670	*idle = sub {
1452	my (undef, %arg) = @_;	1671	my (undef, %arg) = @_;
1453		1672
1454	my ($cb, $w, $rcb) = $arg{cb};	1673	my ($cb, $w, $rcb) = $arg{cb};
1455		1674
1456	$rcb = sub {	1675	$rcb = sub {
1457	if ($cb) {	1676	if ($cb) {
1458	$w = _time;	1677	$w = _time;
1459	&$cb;	1678	&$cb;
1460	$w = _time - $w;	1679	$w = _time - $w;
1461		1680
1462	# 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,
1463	# within some limits	1682	# within some limits
1464	$w = 0.0001 if $w < 0.0001;	1683	$w = 0.0001 if $w < 0.0001;
1465	$w = 5 if $w > 5;	1684	$w = 5 if $w > 5;
1466		1685
1467	$w = AnyEvent->timer (after => $w, cb => $rcb);	1686	$w = AE::timer $w, 0, $rcb;
1468	} else {	1687	} else {
1469	# clean up...	1688	# clean up...
1470	undef $w;	1689	undef $w;
1471	undef $rcb;	1690	undef $rcb;
		1691	}
		1692	};
		1693
		1694	$w = AE::timer 0.05, 0, $rcb;
		1695
		1696	bless \\$cb, "AnyEvent::Base::idle"
1472	}	1697	};
		1698
		1699	*AnyEvent::Base::idle::DESTROY = sub {
		1700	undef $${$_[0]};
		1701	};
1473	};	1702	};
		1703	die if $@;
1474		1704
1475	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1705	&idle
1476
1477	bless \\$cb, "AnyEvent::Base::idle"
1478	}
1479
1480	sub AnyEvent::Base::idle::DESTROY {
1481	undef $${$_[0]};
1482	}	1706	}
1483		1707
1484	package AnyEvent::CondVar;	1708	package AnyEvent::CondVar;
1485		1709
1486	our @ISA = AnyEvent::CondVar::Base::;	1710	our @ISA = AnyEvent::CondVar::Base::;
…		…
1534	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1758	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1535	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1759	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1536	}	1760	}
1537		1761
1538	sub cb {	1762	sub cb {
1539	$_[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
1540	$_[0]{_ae_cb}	1770	$cv->{_ae_cb}
1541	}	1771	}
1542		1772
1543	sub begin {	1773	sub begin {
1544	++$_[0]{_ae_counter};	1774	++$_[0]{_ae_counter};
1545	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1775	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1754	warn "read: $input\n"; # output what has been read	1984	warn "read: $input\n"; # output what has been read
1755	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1985	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1756	},	1986	},
1757	);	1987	);
1758		1988
1759	my $time_watcher; # can only be used once
1760
1761	sub new_timer {
1762	$timer = AnyEvent->timer (after => 1, cb => sub {	1989	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1763	warn "timeout\n"; # print 'timeout' about every second	1990	warn "timeout\n"; # print 'timeout' at most every second
1764	&new_timer; # and restart the time
1765	});	1991	});
1766	}
1767
1768	new_timer; # create first timer
1769		1992
1770	$cv->recv; # wait until user enters /^q/i	1993	$cv->recv; # wait until user enters /^q/i
1771		1994
1772	=head1 REAL-WORLD EXAMPLE	1995	=head1 REAL-WORLD EXAMPLE
1773		1996
…		…
1846		2069
1847	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)
1848	that occurred during request processing. The C<result> method detects	2071	that occurred during request processing. The C<result> method detects
1849	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)
1850	and just throws the exception, which means connection errors and other	2073	and just throws the exception, which means connection errors and other
1851	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
1852	random callback.	2075	random callback.
1853		2076
1854	All of this enables the following usage styles:	2077	All of this enables the following usage styles:
1855		2078
1856	1. Blocking:	2079	1. Blocking:
…		…
1904	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
1905	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,
1906	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.
1907		2130
1908	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
1909	distribution.	2132	distribution. It uses the L<AE> interface, which makes a real difference
		2133	for the EV and Perl backends only.
1910		2134
1911	=head3 Explanation of the columns	2135	=head3 Explanation of the columns
1912		2136
1913	I<watcher> is the number of event watchers created/destroyed. Since	2137	I<watcher> is the number of event watchers created/destroyed. Since
1914	different event models feature vastly different performances, each event	2138	different event models feature vastly different performances, each event
…		…
1935	watcher.	2159	watcher.
1936		2160
1937	=head3 Results	2161	=head3 Results
1938		2162
1939	name watchers bytes create invoke destroy comment	2163	name watchers bytes create invoke destroy comment
1940	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
1941	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
1942	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
1943	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
1944	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
1945	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
1946	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
1947	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
1948	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
1949	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
1950	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
1951	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
1952		2176
1953	=head3 Discussion	2177	=head3 Discussion
1954		2178
1955	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
1956	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)
…		…
1968	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2192	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1969	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
1970	cycles with POE.	2194	cycles with POE.
1971		2195
1972	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
1973	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
1974	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).
1975	natively.
1976		2201
1977	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
1978	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
1979	interpreter and the backend itself). Nevertheless this shows that it	2204	interpreter and the backend itself). Nevertheless this shows that it
1980	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
…		…
2054	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
2055	(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
2056	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.
2057		2282
2058	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
2059	distribution.	2284	distribution. It uses the L<AE> interface, which makes a real difference
		2285	for the EV and Perl backends only.
2060		2286
2061	=head3 Explanation of the columns	2287	=head3 Explanation of the columns
2062		2288
2063	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
2064	each server has a read and write socket end).	2290	each server has a read and write socket end).
…		…
2072	a new one that moves the timeout into the future.	2298	a new one that moves the timeout into the future.
2073		2299
2074	=head3 Results	2300	=head3 Results
2075		2301
2076	name sockets create request	2302	name sockets create request
2077	EV 20000 69.01 11.16	2303	EV 20000 62.66 7.99
2078	Perl 20000 73.32 35.87	2304	Perl 20000 68.32 32.64
2079	IOAsync 20000 157.00 98.14 epoll	2305	IOAsync 20000 174.06 101.15 epoll
2080	IOAsync 20000 159.31 616.06 poll	2306	IOAsync 20000 174.67 610.84 poll
2081	Event 20000 212.62 257.32	2307	Event 20000 202.69 242.91
2082	Glib 20000 651.16 1896.30	2308	Glib 20000 557.01 1689.52
2083	POE 20000 349.67 12317.24 uses POE::Loop::Event	2309	POE 20000 341.54 12086.32 uses POE::Loop::Event
2084		2310
2085	=head3 Discussion	2311	=head3 Discussion
2086		2312
2087	This benchmark I<does> measure scalability and overall performance of the	2313	This benchmark I<does> measure scalability and overall performance of the
2088	particular event loop.	2314	particular event loop.
…		…
2214	As you can see, the AnyEvent + EV combination even beats the	2440	As you can see, the AnyEvent + EV combination even beats the
2215	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2441	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2216	backend easily beats IO::Lambda and POE.	2442	backend easily beats IO::Lambda and POE.
2217		2443
2218	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
2219	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
2220	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
2221	in a non-blocking way.	2447	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2222		2448
2223	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
2224	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
2225	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.
2226		2452
2227		2453
2228	=head1 SIGNALS	2454	=head1 SIGNALS
2229		2455
2230	AnyEvent currently installs handlers for these signals:	2456	AnyEvent currently installs handlers for these signals:
…		…
2272	it's built-in modules) are required to use it.	2498	it's built-in modules) are required to use it.
2273		2499
2274	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
2275	modules if they are installed.	2501	modules if they are installed.
2276		2502
2277	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
2278	affect AnyEvent's operetion.	2504	affect AnyEvent's operation.
2279		2505
2280	=over 4	2506	=over 4
2281		2507
2282	=item L<Async::Interrupt>	2508	=item L<Async::Interrupt>
2283		2509
…		…
2288	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
2289	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2515	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2290		2516
2291	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
2292	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
2293	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
2294	battery life on laptops).	2520	battery life on laptops).
2295		2521
2296	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
2297	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).
2298		2524
…		…
2310	automatic timer adjustments even when no monotonic clock is available,	2536	automatic timer adjustments even when no monotonic clock is available,
2311	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
2312	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
2313	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>).
2314		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
2315	=item L<Guard>	2544	=item L<Guard>
2316		2545
2317	The guard module, when used, will be used to implement	2546	The guard module, when used, will be used to implement
2318	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
2319	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
2320	purely used for performance.	2549	purely used for performance.
2321		2550
2322	=item L<JSON> and L<JSON::XS>	2551	=item L<JSON> and L<JSON::XS>
2323		2552
2324	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
2325	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
2326	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.
2327
2328	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2329	installed.
2330		2556
2331	=item L<Net::SSLeay>	2557	=item L<Net::SSLeay>
2332		2558
2333	Implementing TLS/SSL in Perl is certainly interesting, but not very	2559	Implementing TLS/SSL in Perl is certainly interesting, but not very
2334	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2560	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2345		2571
2346		2572
2347	=head1 FORK	2573	=head1 FORK
2348		2574
2349	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
2350	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
2351	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).
2352		2587
2353	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
2354	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
2355	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.
2356		2600
2357		2601
2358	=head1 SECURITY CONSIDERATIONS	2602	=head1 SECURITY CONSIDERATIONS
2359		2603
2360	AnyEvent can be forced to load any event model via	2604	AnyEvent can be forced to load any event model via
…		…
2398	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2642	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2399		2643
2400	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2644	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2401	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>,
2402	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2646	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2403	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2647	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2404		2648
2405	Non-blocking file handles, sockets, TCP clients and	2649	Non-blocking file handles, sockets, TCP clients and
2406	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2650	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2407		2651
2408	Asynchronous DNS: L<AnyEvent::DNS>.	2652	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs. Revision 1.325 by root, Thu May 20 23:56:04 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs.
Revision 1.325 by root, Thu May 20 23:56:04 2010 UTC