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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.245 by root, Sat Jul 18 05:19:09 2009 UTC vs.
Revision 1.320 by root, Mon Apr 12 02:50:31 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 L<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
…		…
368		402
369	This watcher might use C<%SIG> (depending on the event loop used),	403	This watcher might use C<%SIG> (depending on the event loop used),
370	so programs overwriting those signals directly will likely not work	404	so programs overwriting those signals directly will likely not work
371	correctly.	405	correctly.
372		406
		407	Example: exit on SIGINT
		408
		409	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		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
		428	=head3 Signal Races, Delays and Workarounds
		429
373	Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not	430	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
374	support attaching callbacks to signals, which is a pity, as you cannot do	431	callbacks to signals in a generic way, which is a pity, as you cannot
375	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,
376	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
377	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	435	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
378	seconds). This variable can be changed only before the first signal	436	variable can be changed only before the first signal watcher is created,
379	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
380	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
381	saving. All these problems can be avoided by installing the optional	442	All these problems can be avoided by installing the optional
382	L<Async::Interrupt> module.	443	L<Async::Interrupt> module, which works with most event loops. It will not
383		444	work with inherently broken event loops such as L<Event> or L<Event::Lib>
384	Example: exit on SIGINT	445	(and not with L<POE> currently, as POE does it's own workaround with
385		446	one-second latency). For those, you just have to suffer the delays.
386	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
387		447
388	=head2 CHILD PROCESS WATCHERS	448	=head2 CHILD PROCESS WATCHERS
389		449
		450	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		451
390	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.
391		453
392	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,
393	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
394	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
395	any trace events (stopped/continued).	457	finished and an exit status is available, not on any trace events
		458	(stopped/continued).
396		459
397	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
398	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
399	callback arguments.	462	callback arguments.
400		463
…		…
441	# do something else, then wait for process exit	504	# do something else, then wait for process exit
442	$done->recv;	505	$done->recv;
443		506
444	=head2 IDLE WATCHERS	507	=head2 IDLE WATCHERS
445		508
446	Sometimes there is a need to do something, but it is not so important	509	$w = AnyEvent->idle (cb => <callback>);
447	to do it instantly, but only when there is nothing better to do. This
448	"nothing better to do" is usually defined to be "no other events need
449	attention by the event loop".
450		510
451	Idle watchers ideally get invoked when the event loop has nothing	511	Repeatedly invoke the callback after the process becomes idle, until
452	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.
453	events. Instead of blocking, the idle watcher is invoked.
454		513
455	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
456	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
457	will simply call the callback "from time to time".	525	will simply call the callback "from time to time".
458		526
459	Example: read lines from STDIN, but only process them when the	527	Example: read lines from STDIN, but only process them when the
460	program is otherwise idle:	528	program is otherwise idle:
…		…
476	});	544	});
477	});	545	});
478		546
479	=head2 CONDITION VARIABLES	547	=head2 CONDITION VARIABLES
480		548
		549	$cv = AnyEvent->condvar;
		550
		551	$cv->send (<list>);
		552	my @res = $cv->recv;
		553
481	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
482	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
483	will actively watch for new events and call your callbacks.	556	will actively watch for new events and call your callbacks.
484		557
485	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
…		…
504	Condition variables are similar to callbacks, except that you can	577	Condition variables are similar to callbacks, except that you can
505	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
506	in time where multiple outstanding events have been processed. And yet	579	in time where multiple outstanding events have been processed. And yet
507	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
508	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
509	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.
510		584
511	Condition variables are very useful to signal that something has finished,	585	Condition variables are very useful to signal that something has finished,
512	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,
513	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
514	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
…		…
535	eventually calls C<< -> send >>, and the "consumer side", which waits	609	eventually calls C<< -> send >>, and the "consumer side", which waits
536	for the send to occur.	610	for the send to occur.
537		611
538	Example: wait for a timer.	612	Example: wait for a timer.
539		613
540	# wait till the result is ready	614	# condition: "wait till the timer is fired"
541	my $result_ready = AnyEvent->condvar;	615	my $timer_fired = AnyEvent->condvar;
542		616
543	# do something such as adding a timer	617	# create the timer - we could wait for, say
544	# or socket watcher the calls $result_ready->send	618	# a handle becomign ready, or even an
545	# when the "result" is ready.	619	# AnyEvent::HTTP request to finish, but
546	# in this case, we simply use a timer:	620	# in this case, we simply use a timer:
547	my $w = AnyEvent->timer (	621	my $w = AnyEvent->timer (
548	after => 1,	622	after => 1,
549	cb => sub { $result_ready->send },	623	cb => sub { $timer_fired->send },
550	);	624	);
551		625
552	# this "blocks" (while handling events) till the callback	626	# this "blocks" (while handling events) till the callback
553	# calls -<send	627	# calls ->send
554	$result_ready->recv;	628	$timer_fired->recv;
555		629
556	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
557	variables are also callable directly.	631	variables are also callable directly.
558		632
559	my $done = AnyEvent->condvar;	633	my $done = AnyEvent->condvar;
…		…
622	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
623	to use a condition variable for the whole process.	697	to use a condition variable for the whole process.
624		698
625	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
626	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
627	>>, 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
628	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
629	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.
630		705
631	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
632	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
633	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).
634		709
…		…
661	begung can potentially be zero:	736	begung can potentially be zero:
662		737
663	my $cv = AnyEvent->condvar;	738	my $cv = AnyEvent->condvar;
664		739
665	my %result;	740	my %result;
666	$cv->begin (sub { $cv->send (\%result) });	741	$cv->begin (sub { shift->send (\%result) });
667		742
668	for my $host (@list_of_hosts) {	743	for my $host (@list_of_hosts) {
669	$cv->begin;	744	$cv->begin;
670	ping_host_then_call_callback $host, sub {	745	ping_host_then_call_callback $host, sub {
671	$result{$host} = ...;	746	$result{$host} = ...;
…		…
746	=item $cb = $cv->cb ($cb->($cv))	821	=item $cb = $cv->cb ($cb->($cv))
747		822
748	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
749	replaces it before doing so.	824	replaces it before doing so.
750		825
751	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)
752	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
753	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>
754	is guaranteed not to block.	829	inside the callback or at any later time is guaranteed not to block.
755		830
756	=back	831	=back
757		832
758	=head1 SUPPORTED EVENT LOOPS/BACKENDS	833	=head1 SUPPORTED EVENT LOOPS/BACKENDS
759		834
…		…
762	=over 4	837	=over 4
763		838
764	=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.
765		840
766	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
767	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
768	that, will fall back to its own pure-perl implementation, which is	843	pure-perl implementation, which is available everywhere as it comes with
769	available everywhere as it comes with AnyEvent itself.	844	AnyEvent itself.
770		845
771	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	846	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
772	AnyEvent::Impl::Event based on Event, very stable, few glitches.
773	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	847	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
774		848
775	=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.
776		850
777	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
778	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
779	them. This means that AnyEvent will automatically pick the right backend	853	them. This means that AnyEvent will automatically pick the right backend
780	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
781	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.
782		856
		857	AnyEvent::Impl::Event based on Event, very stable, few glitches.
783	AnyEvent::Impl::Glib based on Glib, slow but very stable.	858	AnyEvent::Impl::Glib based on Glib, slow but very stable.
784	AnyEvent::Impl::Tk based on Tk, very broken.	859	AnyEvent::Impl::Tk based on Tk, very broken.
785	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	860	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786	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.
787		863
788	=item Backends with special needs.	864	=item Backends with special needs.
789		865
790	Qt requires the Qt::Application to be instantiated first, but will	866	Qt requires the Qt::Application to be instantiated first, but will
791	otherwise be picked up automatically. As long as the main program	867	otherwise be picked up automatically. As long as the main program
…		…
865	event module detection too early, for example, L<AnyEvent::AIO> creates	941	event module detection too early, for example, L<AnyEvent::AIO> creates
866	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
867	avoid autodetecting the event module at load time.	943	avoid autodetecting the event module at load time.
868		944
869	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
870	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
871	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;
872		965
873	=item @AnyEvent::post_detect	966	=item @AnyEvent::post_detect
874		967
875	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
876	before or after loading AnyEvent), then they will called directly after	969	before or after loading AnyEvent), then they will called directly after
…		…
879	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:
880	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
881	array will be ignored.	974	array will be ignored.
882		975
883	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	976	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
884	it,as it takes care of these details.	977	it, as it takes care of these details.
885		978
886	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
887	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
888	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
889	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	}
890		996
891	=back	997	=back
892		998
893	=head1 WHAT TO DO IN A MODULE	999	=head1 WHAT TO DO IN A MODULE
894		1000
…		…
1043		1149
1044	package AnyEvent;	1150	package AnyEvent;
1045		1151
1046	# basically a tuned-down version of common::sense	1152	# basically a tuned-down version of common::sense
1047	sub common_sense {	1153	sub common_sense {
1048	# no warnings	1154	# from common:.sense 1.0
1049	${^WARNING_BITS} ^= ${^WARNING_BITS};	1155	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1050	# use strict vars subs	1156	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1051	$^H \|= 0x00000600;	1157	$^H \|= 0x00000600;
1052	}	1158	}
1053		1159
1054	BEGIN { AnyEvent::common_sense }	1160	BEGIN { AnyEvent::common_sense }
1055		1161
1056	use Carp ();	1162	use Carp ();
1057		1163
1058	our $VERSION = 4.85;	1164	our $VERSION = '5.26';
1059	our $MODEL;	1165	our $MODEL;
1060		1166
1061	our $AUTOLOAD;	1167	our $AUTOLOAD;
1062	our @ISA;	1168	our @ISA;
1063		1169
1064	our @REGISTRY;	1170	our @REGISTRY;
1065		1171
1066	our $WIN32;
1067
1068	our $VERBOSE;	1172	our $VERBOSE;
1069		1173
1070	BEGIN {	1174	BEGIN {
1071	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1175	require "AnyEvent/constants.pl";
		1176
1072	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1177	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1073		1178
1074	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1179	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1075	if ${^TAINT};	1180	if ${^TAINT};
1076		1181
1077	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1182	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1088	for reverse split /\s,\s/,	1193	for reverse split /\s,\s/,
1089	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1194	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1090	}	1195	}
1091		1196
1092	my @models = (	1197	my @models = (
1093	[EV:: => AnyEvent::Impl::EV::],	1198	[EV:: => AnyEvent::Impl::EV:: , 1],
1094	[Event:: => AnyEvent::Impl::Event::],
1095	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1199	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1096	# everything below here will not be autoprobed	1200	# everything below here will not (normally) be autoprobed
1097	# as the pureperl backend should work everywhere	1201	# as the pureperl backend should work everywhere
1098	# and is usually faster	1202	# and is usually faster
		1203	[Event:: => AnyEvent::Impl::Event::, 1],
1099	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1204	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1100	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1205	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1206	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1101	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1207	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1102	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1208	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1103	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1209	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1104	[Wx:: => AnyEvent::Impl::POE::],	1210	[Wx:: => AnyEvent::Impl::POE::],
1105	[Prima:: => AnyEvent::Impl::POE::],	1211	[Prima:: => AnyEvent::Impl::POE::],
1106	# IO::Async is just too broken - we would need workarounds for its	1212	# IO::Async is just too broken - we would need workarounds for its
1107	# byzantine signal and broken child handling, among others.	1213	# byzantine signal and broken child handling, among others.
1108	# IO::Async is rather hard to detect, as it doesn't have any	1214	# IO::Async is rather hard to detect, as it doesn't have any
1109	# obvious default class.	1215	# obvious default class.
1110	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1216	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1111	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1217	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1112	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1218	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1219	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1113	);	1220	);
1114		1221
1115	our %method = map +($_ => 1),	1222	our %method = map +($_ => 1),
1116	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1223	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1117		1224
1118	our @post_detect;	1225	our @post_detect;
1119		1226
1120	sub post_detect(&) {	1227	sub post_detect(&) {
1121	my ($cb) = @_;	1228	my ($cb) = @_;
1122		1229
1123	if ($MODEL) {
1124	$cb->();
1125
1126	1
1127	} else {
1128	push @post_detect, $cb;	1230	push @post_detect, $cb;
1129		1231
1130	defined wantarray	1232	defined wantarray
1131	? bless \$cb, "AnyEvent::Util::postdetect"	1233	? bless \$cb, "AnyEvent::Util::postdetect"
1132	: ()	1234	: ()
1133	}
1134	}	1235	}
1135		1236
1136	sub AnyEvent::Util::postdetect::DESTROY {	1237	sub AnyEvent::Util::postdetect::DESTROY {
1137	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1238	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1138	}	1239	}
1139		1240
1140	sub detect() {	1241	sub detect() {
		1242	# free some memory
		1243	*detect = sub () { $MODEL };
		1244
		1245	local $!; # for good measure
		1246	local $SIG{__DIE__};
		1247
		1248	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1249	my $model = "AnyEvent::Impl::$1";
		1250	if (eval "require $model") {
		1251	$MODEL = $model;
		1252	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1253	} else {
		1254	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1255	}
		1256	}
		1257
		1258	# check for already loaded models
1141	unless ($MODEL) {	1259	unless ($MODEL) {
1142	local $SIG{__DIE__};	1260	for (@REGISTRY, @models) {
1143		1261	my ($package, $model) = @$_;
1144	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1262	if (${"$package\::VERSION"} > 0) {
1145	my $model = "AnyEvent::Impl::$1";
1146	if (eval "require $model") {	1263	if (eval "require $model") {
1147	$MODEL = $model;	1264	$MODEL = $model;
1148	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1265	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1149	} else {	1266	last;
1150	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1267	}
1151	}	1268	}
1152	}	1269	}
1153		1270
1154	# check for already loaded models
1155	unless ($MODEL) {	1271	unless ($MODEL) {
		1272	# try to autoload a model
1156	for (@REGISTRY, @models) {	1273	for (@REGISTRY, @models) {
1157	my ($package, $model) = @$_;	1274	my ($package, $model, $autoload) = @$_;
		1275	if (
		1276	$autoload
		1277	and eval "require $package"
1158	if (${"$package\::VERSION"} > 0) {	1278	and ${"$package\::VERSION"} > 0
1159	if (eval "require $model") {	1279	and eval "require $model"
		1280	) {
1160	$MODEL = $model;	1281	$MODEL = $model;
1161	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1282	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1162	last;	1283	last;
1163	}
1164	}	1284	}
1165	}	1285	}
1166		1286
1167	unless ($MODEL) {
1168	# try to load a model
1169
1170	for (@REGISTRY, @models) {
1171	my ($package, $model) = @$_;
1172	if (eval "require $package"
1173	and ${"$package\::VERSION"} > 0
1174	and eval "require $model") {
1175	$MODEL = $model;
1176	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1177	last;
1178	}
1179	}
1180
1181	$MODEL	1287	$MODEL
1182	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1288	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1183	}
1184	}	1289	}
1185
1186	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1187
1188	unshift @ISA, $MODEL;
1189
1190	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1191
1192	(shift @post_detect)->() while @post_detect;
1193	}	1290	}
		1291
		1292	@models = (); # free probe data
		1293
		1294	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1295	unshift @ISA, $MODEL;
		1296
		1297	# now nuke some methods that are overriden by the backend.
		1298	# SUPER is not allowed.
		1299	for (qw(time signal child idle)) {
		1300	undef &{"AnyEvent::Base::$_"}
		1301	if defined &{"$MODEL\::$_"};
		1302	}
		1303
		1304	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1305
		1306	(shift @post_detect)->() while @post_detect;
		1307
		1308	*post_detect = sub(&) {
		1309	shift->();
		1310
		1311	undef
		1312	};
1194		1313
1195	$MODEL	1314	$MODEL
1196	}	1315	}
1197		1316
1198	sub AUTOLOAD {	1317	sub AUTOLOAD {
1199	(my $func = $AUTOLOAD) =~ s/.*://;	1318	(my $func = $AUTOLOAD) =~ s/.*://;
1200		1319
1201	$method{$func}	1320	$method{$func}
1202	or Carp::croak "$func: not a valid method for AnyEvent objects";	1321	or Carp::croak "$func: not a valid AnyEvent class method";
1203		1322
1204	detect unless $MODEL;	1323	detect;
1205		1324
1206	my $class = shift;	1325	my $class = shift;
1207	$class->$func (@_);	1326	$class->$func (@_);
1208	}	1327	}
1209		1328
…		…
1222	# we assume CLOEXEC is already set by perl in all important cases	1341	# we assume CLOEXEC is already set by perl in all important cases
1223		1342
1224	($fh2, $rw)	1343	($fh2, $rw)
1225	}	1344	}
1226		1345
		1346	=head1 SIMPLIFIED AE API
		1347
		1348	Starting with version 5.0, AnyEvent officially supports a second, much
		1349	simpler, API that is designed to reduce the calling, typing and memory
		1350	overhead by using function call syntax and a fixed number of parameters.
		1351
		1352	See the L<AE> manpage for details.
		1353
		1354	=cut
		1355
		1356	package AE;
		1357
		1358	our $VERSION = $AnyEvent::VERSION;
		1359
		1360	# fall back to the main API by default - backends and AnyEvent::Base
		1361	# implementations can overwrite these.
		1362
		1363	sub io($$$) {
		1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1365	}
		1366
		1367	sub timer($$$) {
		1368	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1369	}
		1370
		1371	sub signal($$) {
		1372	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1373	}
		1374
		1375	sub child($$) {
		1376	AnyEvent->child (pid => $_[0], cb => $_[1])
		1377	}
		1378
		1379	sub idle($) {
		1380	AnyEvent->idle (cb => $_[0])
		1381	}
		1382
		1383	sub cv(;&) {
		1384	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1385	}
		1386
		1387	sub now() {
		1388	AnyEvent->now
		1389	}
		1390
		1391	sub now_update() {
		1392	AnyEvent->now_update
		1393	}
		1394
		1395	sub time() {
		1396	AnyEvent->time
		1397	}
		1398
1227	package AnyEvent::Base;	1399	package AnyEvent::Base;
1228		1400
1229	# default implementations for many methods	1401	# default implementations for many methods
1230		1402
1231	sub _time {	1403	sub time {
		1404	eval q{ # poor man's autoloading {}
1232	# probe for availability of Time::HiRes	1405	# probe for availability of Time::HiRes
1233	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1234	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1407	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1235	*_time = \&Time::HiRes::time;	1408	*AE::time = \&Time::HiRes::time;
1236	# if (eval "use POSIX (); (POSIX::times())...	1409	# if (eval "use POSIX (); (POSIX::times())...
1237	} else {	1410	} else {
1238	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1411	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1239	*_time = sub { time }; # epic fail	1412	*AE::time = sub (){ time }; # epic fail
		1413	}
		1414
		1415	*time = sub { AE::time }; # different prototypes
1240	}	1416	};
		1417	die if $@;
1241		1418
1242	&_time	1419	&time
1243	}	1420	}
1244		1421
1245	sub time { _time }	1422	*now = \&time;
1246	sub now { _time }	1423
1247	sub now_update { }	1424	sub now_update { }
1248		1425
1249	# default implementation for ->condvar	1426	# default implementation for ->condvar
1250		1427
1251	sub condvar {	1428	sub condvar {
		1429	eval q{ # poor man's autoloading {}
		1430	*condvar = sub {
1252	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1431	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1432	};
		1433
		1434	*AE::cv = sub (;&) {
		1435	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1436	};
		1437	};
		1438	die if $@;
		1439
		1440	&condvar
1253	}	1441	}
1254		1442
1255	# default implementation for ->signal	1443	# default implementation for ->signal
1256		1444
1257	our $HAVE_ASYNC_INTERRUPT;	1445	our $HAVE_ASYNC_INTERRUPT;
		1446
		1447	sub _have_async_interrupt() {
		1448	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1449	&& eval "use Async::Interrupt 1.02 (); 1")
		1450	unless defined $HAVE_ASYNC_INTERRUPT;
		1451
		1452	$HAVE_ASYNC_INTERRUPT
		1453	}
		1454
1258	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1455	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1259	our (%SIG_ASY, %SIG_ASY_W);	1456	our (%SIG_ASY, %SIG_ASY_W);
1260	our ($SIG_COUNT, $SIG_TW);	1457	our ($SIG_COUNT, $SIG_TW);
1261		1458
1262	sub _signal_exec {	1459	# install a dummy wakeup watcher to reduce signal catching latency
1263	$HAVE_ASYNC_INTERRUPT	1460	# used by Impls
1264	? $SIGPIPE_R->drain	1461	sub _sig_add() {
1265	: sysread $SIGPIPE_R, my $dummy, 9;	1462	unless ($SIG_COUNT++) {
		1463	# try to align timer on a full-second boundary, if possible
		1464	my $NOW = AE::now;
1266		1465
1267	while (%SIG_EV) {	1466	$SIG_TW = AE::timer
1268	for (keys %SIG_EV) {	1467	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1269	delete $SIG_EV{$_};	1468	$MAX_SIGNAL_LATENCY,
1270	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1469	sub { } # just for the PERL_ASYNC_CHECK
1271	}	1470	;
1272	}	1471	}
1273	}	1472	}
1274		1473
1275	sub _signal {	1474	sub _sig_del {
1276	my (undef, %arg) = @_;
1277
1278	my $signal = uc $arg{signal}
1279	or Carp::croak "required option 'signal' is missing";
1280
1281	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1282
1283	if ($HAVE_ASYNC_INTERRUPT) {
1284	# async::interrupt
1285
1286	$SIG_ASY{$signal} \|\|= do {
1287	my $asy = new Async::Interrupt
1288	cb => sub { undef $SIG_EV{$signal} },
1289	signal => $signal,
1290	pipe => [$SIGPIPE_R->filenos],
1291	;
1292	$asy->pipe_autodrain (0);
1293
1294	$asy
1295	};
1296
1297	} else {
1298	# pure perl
1299
1300	$SIG{$signal} \|\|= sub {
1301	local $!;
1302	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1303	undef $SIG_EV{$signal};
1304	};
1305
1306	# can't do signal processing without introducing races in pure perl,
1307	# so limit the signal latency.
1308	++$SIG_COUNT;
1309	$SIG_TW \|\|= AnyEvent->timer (
1310	after => $MAX_SIGNAL_LATENCY,
1311	interval => $MAX_SIGNAL_LATENCY,
1312	cb => sub { }, # just for the PERL_ASYNC_CHECK
1313	);
1314	}
1315
1316	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1317	}
1318
1319	sub signal {
1320	# probe for availability of Async::Interrupt
1321	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1322	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1323
1324	$HAVE_ASYNC_INTERRUPT = 1;
1325	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1326	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1327
1328	} else {
1329	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1330
1331	require Fcntl;
1332
1333	if (AnyEvent::WIN32) {
1334	require AnyEvent::Util;
1335
1336	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1337	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1338	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1339	} else {
1340	pipe $SIGPIPE_R, $SIGPIPE_W;
1341	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1342	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1343
1344	# not strictly required, as $^F is normally 2, but let's make sure...
1345	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1346	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1347	}
1348
1349	$SIGPIPE_R
1350	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1351
1352	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1353	}
1354
1355	*signal = \&_signal;
1356	&signal
1357	}
1358
1359	sub AnyEvent::Base::signal::DESTROY {
1360	my ($signal, $cb) = @{$_[0]};
1361
1362	undef $SIG_TW	1475	undef $SIG_TW
1363	unless --$SIG_COUNT;	1476	unless --$SIG_COUNT;
		1477	}
1364		1478
		1479	our $_sig_name_init; $_sig_name_init = sub {
		1480	eval q{ # poor man's autoloading {}
		1481	undef $_sig_name_init;
		1482
		1483	if (_have_async_interrupt) {
		1484	*sig2num = \&Async::Interrupt::sig2num;
		1485	*sig2name = \&Async::Interrupt::sig2name;
		1486	} else {
		1487	require Config;
		1488
		1489	my %signame2num;
		1490	@signame2num{ split ' ', $Config::Config{sig_name} }
		1491	= split ' ', $Config::Config{sig_num};
		1492
		1493	my @signum2name;
		1494	@signum2name[values %signame2num] = keys %signame2num;
		1495
		1496	*sig2num = sub($) {
		1497	$_[0] > 0 ? shift : $signame2num{+shift}
		1498	};
		1499	*sig2name = sub ($) {
		1500	$_[0] > 0 ? $signum2name[+shift] : shift
		1501	};
		1502	}
		1503	};
		1504	die if $@;
		1505	};
		1506
		1507	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1508	sub sig2name($) { &$_sig_name_init; &sig2name }
		1509
		1510	sub signal {
		1511	eval q{ # poor man's autoloading {}
		1512	# probe for availability of Async::Interrupt
		1513	if (_have_async_interrupt) {
		1514	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1515
		1516	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1517	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1518
		1519	} else {
		1520	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1521
		1522	if (AnyEvent::WIN32) {
		1523	require AnyEvent::Util;
		1524
		1525	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1526	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1527	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1528	} else {
		1529	pipe $SIGPIPE_R, $SIGPIPE_W;
		1530	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
		1531	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
		1532
		1533	# not strictly required, as $^F is normally 2, but let's make sure...
		1534	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1535	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1536	}
		1537
		1538	$SIGPIPE_R
		1539	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1540
		1541	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1542	}
		1543
		1544	*signal = $HAVE_ASYNC_INTERRUPT
		1545	? sub {
		1546	my (undef, %arg) = @_;
		1547
		1548	# async::interrupt
		1549	my $signal = sig2num $arg{signal};
		1550	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1551
		1552	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1553	cb => sub { undef $SIG_EV{$signal} },
		1554	signal => $signal,
		1555	pipe => [$SIGPIPE_R->filenos],
		1556	pipe_autodrain => 0,
		1557	;
		1558
		1559	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1560	}
		1561	: sub {
		1562	my (undef, %arg) = @_;
		1563
		1564	# pure perl
		1565	my $signal = sig2name $arg{signal};
		1566	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1567
		1568	$SIG{$signal} \|\|= sub {
		1569	local $!;
		1570	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1571	undef $SIG_EV{$signal};
		1572	};
		1573
		1574	# can't do signal processing without introducing races in pure perl,
		1575	# so limit the signal latency.
		1576	_sig_add;
		1577
		1578	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1579	}
		1580	;
		1581
		1582	*AnyEvent::Base::signal::DESTROY = sub {
		1583	my ($signal, $cb) = @{$_[0]};
		1584
		1585	_sig_del;
		1586
1365	delete $SIG_CB{$signal}{$cb};	1587	delete $SIG_CB{$signal}{$cb};
1366		1588
1367	$HAVE_ASYNC_INTERRUPT	1589	$HAVE_ASYNC_INTERRUPT
1368	? delete $SIG_ASY{$signal}	1590	? delete $SIG_ASY{$signal}
1369	: # delete doesn't work with older perls - they then	1591	: # delete doesn't work with older perls - they then
1370	# print weird messages, or just unconditionally exit	1592	# print weird messages, or just unconditionally exit
1371	# instead of getting the default action.	1593	# instead of getting the default action.
1372	undef $SIG{$signal}	1594	undef $SIG{$signal}
1373	unless keys %{ $SIG_CB{$signal} };	1595	unless keys %{ $SIG_CB{$signal} };
		1596	};
		1597
		1598	*_signal_exec = sub {
		1599	$HAVE_ASYNC_INTERRUPT
		1600	? $SIGPIPE_R->drain
		1601	: sysread $SIGPIPE_R, (my $dummy), 9;
		1602
		1603	while (%SIG_EV) {
		1604	for (keys %SIG_EV) {
		1605	delete $SIG_EV{$_};
		1606	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1607	}
		1608	}
		1609	};
		1610	};
		1611	die if $@;
		1612
		1613	&signal
1374	}	1614	}
1375		1615
1376	# default implementation for ->child	1616	# default implementation for ->child
1377		1617
1378	our %PID_CB;	1618	our %PID_CB;
1379	our $CHLD_W;	1619	our $CHLD_W;
1380	our $CHLD_DELAY_W;	1620	our $CHLD_DELAY_W;
1381	our $WNOHANG;	1621	our $WNOHANG;
1382		1622
1383	sub _sigchld {	1623	# used by many Impl's
1384	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1624	sub _emit_childstatus($$) {
1385	$_->($pid, $?)	1625	my (undef, $rpid, $rstatus) = @_;
		1626
		1627	$_->($rpid, $rstatus)
1386	for values %{ $PID_CB{$pid} \|\| {} },	1628	for values %{ $PID_CB{$rpid} \|\| {} },
1387	values %{ $PID_CB{0} \|\| {} };	1629	values %{ $PID_CB{0} \|\| {} };
1388	}
1389	}	1630	}
1390		1631
1391	sub child {	1632	sub child {
		1633	eval q{ # poor man's autoloading {}
		1634	*_sigchld = sub {
		1635	my $pid;
		1636
		1637	AnyEvent->_emit_childstatus ($pid, $?)
		1638	while ($pid = waitpid -1, $WNOHANG) > 0;
		1639	};
		1640
		1641	*child = sub {
1392	my (undef, %arg) = @_;	1642	my (undef, %arg) = @_;
1393		1643
1394	defined (my $pid = $arg{pid} + 0)	1644	defined (my $pid = $arg{pid} + 0)
1395	or Carp::croak "required option 'pid' is missing";	1645	or Carp::croak "required option 'pid' is missing";
1396		1646
1397	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1647	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1398		1648
1399	# WNOHANG is almost cetrainly 1 everywhere	1649	# WNOHANG is almost cetrainly 1 everywhere
1400	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1650	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1401	? 1	1651	? 1
1402	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1652	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1403		1653
1404	unless ($CHLD_W) {	1654	unless ($CHLD_W) {
1405	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1655	$CHLD_W = AE::signal CHLD => \&_sigchld;
1406	# child could be a zombie already, so make at least one round	1656	# child could be a zombie already, so make at least one round
1407	&_sigchld;	1657	&_sigchld;
1408	}	1658	}
1409		1659
1410	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1660	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1411	}	1661	};
1412		1662
1413	sub AnyEvent::Base::child::DESTROY {	1663	*AnyEvent::Base::child::DESTROY = sub {
1414	my ($pid, $cb) = @{$_[0]};	1664	my ($pid, $cb) = @{$_[0]};
1415		1665
1416	delete $PID_CB{$pid}{$cb};	1666	delete $PID_CB{$pid}{$cb};
1417	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1667	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1418		1668
1419	undef $CHLD_W unless keys %PID_CB;	1669	undef $CHLD_W unless keys %PID_CB;
		1670	};
		1671	};
		1672	die if $@;
		1673
		1674	&child
1420	}	1675	}
1421		1676
1422	# idle emulation is done by simply using a timer, regardless	1677	# idle emulation is done by simply using a timer, regardless
1423	# of whether the process is idle or not, and not letting	1678	# of whether the process is idle or not, and not letting
1424	# the callback use more than 50% of the time.	1679	# the callback use more than 50% of the time.
1425	sub idle {	1680	sub idle {
		1681	eval q{ # poor man's autoloading {}
		1682	*idle = sub {
1426	my (undef, %arg) = @_;	1683	my (undef, %arg) = @_;
1427		1684
1428	my ($cb, $w, $rcb) = $arg{cb};	1685	my ($cb, $w, $rcb) = $arg{cb};
1429		1686
1430	$rcb = sub {	1687	$rcb = sub {
1431	if ($cb) {	1688	if ($cb) {
1432	$w = _time;	1689	$w = _time;
1433	&$cb;	1690	&$cb;
1434	$w = _time - $w;	1691	$w = _time - $w;
1435		1692
1436	# never use more then 50% of the time for the idle watcher,	1693	# never use more then 50% of the time for the idle watcher,
1437	# within some limits	1694	# within some limits
1438	$w = 0.0001 if $w < 0.0001;	1695	$w = 0.0001 if $w < 0.0001;
1439	$w = 5 if $w > 5;	1696	$w = 5 if $w > 5;
1440		1697
1441	$w = AnyEvent->timer (after => $w, cb => $rcb);	1698	$w = AE::timer $w, 0, $rcb;
1442	} else {	1699	} else {
1443	# clean up...	1700	# clean up...
1444	undef $w;	1701	undef $w;
1445	undef $rcb;	1702	undef $rcb;
		1703	}
		1704	};
		1705
		1706	$w = AE::timer 0.05, 0, $rcb;
		1707
		1708	bless \\$cb, "AnyEvent::Base::idle"
1446	}	1709	};
		1710
		1711	*AnyEvent::Base::idle::DESTROY = sub {
		1712	undef $${$_[0]};
		1713	};
1447	};	1714	};
		1715	die if $@;
1448		1716
1449	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1717	&idle
1450
1451	bless \\$cb, "AnyEvent::Base::idle"
1452	}
1453
1454	sub AnyEvent::Base::idle::DESTROY {
1455	undef $${$_[0]};
1456	}	1718	}
1457		1719
1458	package AnyEvent::CondVar;	1720	package AnyEvent::CondVar;
1459		1721
1460	our @ISA = AnyEvent::CondVar::Base::;	1722	our @ISA = AnyEvent::CondVar::Base::;
…		…
1508	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1770	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1509	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1771	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1510	}	1772	}
1511		1773
1512	sub cb {	1774	sub cb {
1513	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1775	my $cv = shift;
		1776
		1777	@_
		1778	and $cv->{_ae_cb} = shift
		1779	and $cv->{_ae_sent}
		1780	and (delete $cv->{_ae_cb})->($cv);
		1781
1514	$_[0]{_ae_cb}	1782	$cv->{_ae_cb}
1515	}	1783	}
1516		1784
1517	sub begin {	1785	sub begin {
1518	++$_[0]{_ae_counter};	1786	++$_[0]{_ae_counter};
1519	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1787	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1728	warn "read: $input\n"; # output what has been read	1996	warn "read: $input\n"; # output what has been read
1729	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1997	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1730	},	1998	},
1731	);	1999	);
1732		2000
1733	my $time_watcher; # can only be used once
1734
1735	sub new_timer {
1736	$timer = AnyEvent->timer (after => 1, cb => sub {	2001	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1737	warn "timeout\n"; # print 'timeout' about every second	2002	warn "timeout\n"; # print 'timeout' at most every second
1738	&new_timer; # and restart the time
1739	});	2003	});
1740	}
1741
1742	new_timer; # create first timer
1743		2004
1744	$cv->recv; # wait until user enters /^q/i	2005	$cv->recv; # wait until user enters /^q/i
1745		2006
1746	=head1 REAL-WORLD EXAMPLE	2007	=head1 REAL-WORLD EXAMPLE
1747		2008
…		…
1820		2081
1821	The actual code goes further and collects all errors (C<die>s, exceptions)	2082	The actual code goes further and collects all errors (C<die>s, exceptions)
1822	that occurred during request processing. The C<result> method detects	2083	that occurred during request processing. The C<result> method detects
1823	whether an exception as thrown (it is stored inside the $txn object)	2084	whether an exception as thrown (it is stored inside the $txn object)
1824	and just throws the exception, which means connection errors and other	2085	and just throws the exception, which means connection errors and other
1825	problems get reported tot he code that tries to use the result, not in a	2086	problems get reported to the code that tries to use the result, not in a
1826	random callback.	2087	random callback.
1827		2088
1828	All of this enables the following usage styles:	2089	All of this enables the following usage styles:
1829		2090
1830	1. Blocking:	2091	1. Blocking:
…		…
1878	through AnyEvent. The benchmark creates a lot of timers (with a zero	2139	through AnyEvent. The benchmark creates a lot of timers (with a zero
1879	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2140	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1880	which it is), lets them fire exactly once and destroys them again.	2141	which it is), lets them fire exactly once and destroys them again.
1881		2142
1882	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2143	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1883	distribution.	2144	distribution. It uses the L<AE> interface, which makes a real difference
		2145	for the EV and Perl backends only.
1884		2146
1885	=head3 Explanation of the columns	2147	=head3 Explanation of the columns
1886		2148
1887	I<watcher> is the number of event watchers created/destroyed. Since	2149	I<watcher> is the number of event watchers created/destroyed. Since
1888	different event models feature vastly different performances, each event	2150	different event models feature vastly different performances, each event
…		…
1909	watcher.	2171	watcher.
1910		2172
1911	=head3 Results	2173	=head3 Results
1912		2174
1913	name watchers bytes create invoke destroy comment	2175	name watchers bytes create invoke destroy comment
1914	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2176	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1915	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2177	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1916	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2178	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1917	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2179	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1918	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2180	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1919	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2181	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1920	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2182	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1921	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2183	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1922	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2184	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1923	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2185	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1924	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2186	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1925	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2187	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1926		2188
1927	=head3 Discussion	2189	=head3 Discussion
1928		2190
1929	The benchmark does I<not> measure scalability of the event loop very	2191	The benchmark does I<not> measure scalability of the event loop very
1930	well. For example, a select-based event loop (such as the pure perl one)	2192	well. For example, a select-based event loop (such as the pure perl one)
…		…
1942	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2204	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1943	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2205	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1944	cycles with POE.	2206	cycles with POE.
1945		2207
1946	C<EV> is the sole leader regarding speed and memory use, which are both	2208	C<EV> is the sole leader regarding speed and memory use, which are both
1947	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2209	maximal/minimal, respectively. When using the L<AE> API there is zero
		2210	overhead (when going through the AnyEvent API create is about 5-6 times
		2211	slower, with other times being equal, so still uses far less memory than
1948	far less memory than any other event loop and is still faster than Event	2212	any other event loop and is still faster than Event natively).
1949	natively.
1950		2213
1951	The pure perl implementation is hit in a few sweet spots (both the	2214	The pure perl implementation is hit in a few sweet spots (both the
1952	constant timeout and the use of a single fd hit optimisations in the perl	2215	constant timeout and the use of a single fd hit optimisations in the perl
1953	interpreter and the backend itself). Nevertheless this shows that it	2216	interpreter and the backend itself). Nevertheless this shows that it
1954	adds very little overhead in itself. Like any select-based backend its	2217	adds very little overhead in itself. Like any select-based backend its
…		…
2028	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2291	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2029	(1%) are active. This mirrors the activity of large servers with many	2292	(1%) are active. This mirrors the activity of large servers with many
2030	connections, most of which are idle at any one point in time.	2293	connections, most of which are idle at any one point in time.
2031		2294
2032	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2295	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2033	distribution.	2296	distribution. It uses the L<AE> interface, which makes a real difference
		2297	for the EV and Perl backends only.
2034		2298
2035	=head3 Explanation of the columns	2299	=head3 Explanation of the columns
2036		2300
2037	I<sockets> is the number of sockets, and twice the number of "servers" (as	2301	I<sockets> is the number of sockets, and twice the number of "servers" (as
2038	each server has a read and write socket end).	2302	each server has a read and write socket end).
…		…
2046	a new one that moves the timeout into the future.	2310	a new one that moves the timeout into the future.
2047		2311
2048	=head3 Results	2312	=head3 Results
2049		2313
2050	name sockets create request	2314	name sockets create request
2051	EV 20000 69.01 11.16	2315	EV 20000 62.66 7.99
2052	Perl 20000 73.32 35.87	2316	Perl 20000 68.32 32.64
2053	IOAsync 20000 157.00 98.14 epoll	2317	IOAsync 20000 174.06 101.15 epoll
2054	IOAsync 20000 159.31 616.06 poll	2318	IOAsync 20000 174.67 610.84 poll
2055	Event 20000 212.62 257.32	2319	Event 20000 202.69 242.91
2056	Glib 20000 651.16 1896.30	2320	Glib 20000 557.01 1689.52
2057	POE 20000 349.67 12317.24 uses POE::Loop::Event	2321	POE 20000 341.54 12086.32 uses POE::Loop::Event
2058		2322
2059	=head3 Discussion	2323	=head3 Discussion
2060		2324
2061	This benchmark I<does> measure scalability and overall performance of the	2325	This benchmark I<does> measure scalability and overall performance of the
2062	particular event loop.	2326	particular event loop.
…		…
2188	As you can see, the AnyEvent + EV combination even beats the	2452	As you can see, the AnyEvent + EV combination even beats the
2189	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2453	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2190	backend easily beats IO::Lambda and POE.	2454	backend easily beats IO::Lambda and POE.
2191		2455
2192	And even the 100% non-blocking version written using the high-level (and	2456	And even the 100% non-blocking version written using the high-level (and
2193	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2457	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2194	large margin, even though it does all of DNS, tcp-connect and socket I/O	2458	higher level ("unoptimised") abstractions by a large margin, even though
2195	in a non-blocking way.	2459	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2196		2460
2197	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2461	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2198	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2462	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2199	part of the IO::lambda distribution and were used without any changes.	2463	part of the IO::Lambda distribution and were used without any changes.
2200		2464
2201		2465
2202	=head1 SIGNALS	2466	=head1 SIGNALS
2203		2467
2204	AnyEvent currently installs handlers for these signals:	2468	AnyEvent currently installs handlers for these signals:
…		…
2246	it's built-in modules) are required to use it.	2510	it's built-in modules) are required to use it.
2247		2511
2248	That does not mean that AnyEvent won't take advantage of some additional	2512	That does not mean that AnyEvent won't take advantage of some additional
2249	modules if they are installed.	2513	modules if they are installed.
2250		2514
2251	This section epxlains which additional modules will be used, and how they	2515	This section explains which additional modules will be used, and how they
2252	affect AnyEvent's operetion.	2516	affect AnyEvent's operation.
2253		2517
2254	=over 4	2518	=over 4
2255		2519
2256	=item L<Async::Interrupt>	2520	=item L<Async::Interrupt>
2257		2521
2258	This slightly arcane module is used to implement fast signal handling: To	2522	This slightly arcane module is used to implement fast signal handling: To
2259	my knowledge, there is no way to do completely race-free and quick	2523	my knowledge, there is no way to do completely race-free and quick
2260	signal handling in pure perl. To ensure that signals still get	2524	signal handling in pure perl. To ensure that signals still get
2261	delivered, AnyEvent will start an interval timer to wake up perl (and	2525	delivered, AnyEvent will start an interval timer to wake up perl (and
2262	catch the signals) with soemd elay (default is 10 seconds, look for	2526	catch the signals) with some delay (default is 10 seconds, look for
2263	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2527	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2264		2528
2265	If this module is available, then it will be used to implement signal	2529	If this module is available, then it will be used to implement signal
2266	catching, which means that signals will not be delayed, and the event loop	2530	catching, which means that signals will not be delayed, and the event loop
2267	will not be interrupted regularly, which is more efficient (And good for	2531	will not be interrupted regularly, which is more efficient (and good for
2268	battery life on laptops).	2532	battery life on laptops).
2269		2533
2270	This affects not just the pure-perl event loop, but also other event loops	2534	This affects not just the pure-perl event loop, but also other event loops
2271	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2535	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2536
		2537	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2538	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2539	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2540	does nothing for those backends.
2272		2541
2273	=item L<EV>	2542	=item L<EV>
2274		2543
2275	This module isn't really "optional", as it is simply one of the backend	2544	This module isn't really "optional", as it is simply one of the backend
2276	event loops that AnyEvent can use. However, it is simply the best event	2545	event loops that AnyEvent can use. However, it is simply the best event
…		…
2279	automatic timer adjustments even when no monotonic clock is available,	2548	automatic timer adjustments even when no monotonic clock is available,
2280	can take avdantage of advanced kernel interfaces such as C<epoll> and	2549	can take avdantage of advanced kernel interfaces such as C<epoll> and
2281	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2550	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2282	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2551	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2283		2552
		2553	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2554	then this module will do nothing for you.
		2555
2284	=item L<Guard>	2556	=item L<Guard>
2285		2557
2286	The guard module, when used, will be used to implement	2558	The guard module, when used, will be used to implement
2287	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2559	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2288	lot less memory), but otherwise doesn't affect guard operation much. It is	2560	lot less memory), but otherwise doesn't affect guard operation much. It is
2289	purely used for performance.	2561	purely used for performance.
2290		2562
2291	=item L<JSON> and L<JSON::XS>	2563	=item L<JSON> and L<JSON::XS>
2292		2564
2293	This module is required when you want to read or write JSON data via	2565	One of these modules is required when you want to read or write JSON data
2294	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2566	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2295	advantage of the ulta-high-speed L<JSON::XS> module when it is installed.	2567	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2296
2297	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2298	installed.
2299		2568
2300	=item L<Net::SSLeay>	2569	=item L<Net::SSLeay>
2301		2570
2302	Implementing TLS/SSL in Perl is certainly interesting, but not very	2571	Implementing TLS/SSL in Perl is certainly interesting, but not very
2303	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2572	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2314		2583
2315		2584
2316	=head1 FORK	2585	=head1 FORK
2317		2586
2318	Most event libraries are not fork-safe. The ones who are usually are	2587	Most event libraries are not fork-safe. The ones who are usually are
2319	because they rely on inefficient but fork-safe C<select> or C<poll>	2588	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2320	calls. Only L<EV> is fully fork-aware.	2589	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2590	are usually badly thought-out hacks that are incompatible with fork in
		2591	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2592	continue event-processing in both parent and child (or both, if you know
		2593	what you are doing).
		2594
		2595	This means that, in general, you cannot fork and do event processing in
		2596	the child if the event library was initialised before the fork (which
		2597	usually happens when the first AnyEvent watcher is created, or the library
		2598	is loaded).
2321		2599
2322	If you have to fork, you must either do so I<before> creating your first	2600	If you have to fork, you must either do so I<before> creating your first
2323	watcher OR you must not use AnyEvent at all in the child OR you must do	2601	watcher OR you must not use AnyEvent at all in the child OR you must do
2324	something completely out of the scope of AnyEvent.	2602	something completely out of the scope of AnyEvent.
		2603
		2604	The problem of doing event processing in the parent I<and> the child
		2605	is much more complicated: even for backends that I<are> fork-aware or
		2606	fork-safe, their behaviour is not usually what you want: fork clones all
		2607	watchers, that means all timers, I/O watchers etc. are active in both
		2608	parent and child, which is almost never what you want. USing C<exec>
		2609	to start worker children from some kind of manage rprocess is usually
		2610	preferred, because it is much easier and cleaner, at the expense of having
		2611	to have another binary.
2325		2612
2326		2613
2327	=head1 SECURITY CONSIDERATIONS	2614	=head1 SECURITY CONSIDERATIONS
2328		2615
2329	AnyEvent can be forced to load any event model via	2616	AnyEvent can be forced to load any event model via
…		…
2367	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2654	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2368		2655
2369	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2656	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2370	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2657	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2371	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2658	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2372	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2659	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2373		2660
2374	Non-blocking file handles, sockets, TCP clients and	2661	Non-blocking file handles, sockets, TCP clients and
2375	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2662	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2376		2663
2377	Asynchronous DNS: L<AnyEvent::DNS>.	2664	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.245 by root, Sat Jul 18 05:19:09 2009 UTC vs. Revision 1.320 by root, Mon Apr 12 02:50:31 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.245 by root, Sat Jul 18 05:19:09 2009 UTC vs.
Revision 1.320 by root, Mon Apr 12 02:50:31 2010 UTC