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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.243 by root, Fri Jul 17 23:12:20 2009 UTC vs.
Revision 1.311 by root, Wed Feb 10 13:33:44 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
40	=head1 INTRODUCTION/TUTORIAL	40	=head1 INTRODUCTION/TUTORIAL
41		41
42	This manpage is mainly a reference manual. If you are interested	42	This manpage is mainly a reference manual. If you are interested
43	in a tutorial or some gentle introduction, have a look at the	43	in a tutorial or some gentle introduction, have a look at the
44	L<AnyEvent::Intro> manpage.	44	L<AnyEvent::Intro> manpage.
		45
		46	=head1 SUPPORT
		47
		48	There is a mailinglist for discussing all things AnyEvent, and an IRC
		49	channel, too.
		50
		51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		52	Repository>, at L<http://anyevent.schmorp.de>, for more info.
45		53
46	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47		55
48	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
173	my variables are only visible after the statement in which they are	181	my variables are only visible after the statement in which they are
174	declared.	182	declared.
175		183
176	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
177		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	192	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
180		194
181	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch	195	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	196	for events (AnyEvent might or might not keep a reference to this file
…		…
211	undef $w;	225	undef $w;
212	});	226	});
213		227
214	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
215		229
		230	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		231
		232	$w = AnyEvent->timer (
		233	after => <fractional_seconds>,
		234	interval => <fractional_seconds>,
		235	cb => <callback>,
		236	);
		237
216	You can create a time watcher by calling the C<< AnyEvent->timer >>	238	You can create a time watcher by calling the C<< AnyEvent->timer >>
217	method with the following mandatory arguments:	239	method with the following mandatory arguments:
218		240
219	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
220	supported) the callback should be invoked. C<cb> is the callback to invoke	242	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
341	might affect timers and time-outs.	363	might affect timers and time-outs.
342		364
343	When this is the case, you can call this method, which will update the	365	When this is the case, you can call this method, which will update the
344	event loop's idea of "current time".	366	event loop's idea of "current time".
345		367
		368	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		369	when mod_perl executes the script, then the event loop will have the wrong
		370	idea about the "current time" (being potentially far in the past, when the
		371	script ran the last time). In that case you should arrange a call to C<<
		372	AnyEvent->now_update >> each time the web server process wakes up again
		373	(e.g. at the start of your script, or in a handler).
		374
346	Note that updating the time I<might> cause some events to be handled.	375	Note that updating the time I<might> cause some events to be handled.
347		376
348	=back	377	=back
349		378
350	=head2 SIGNAL WATCHERS	379	=head2 SIGNAL WATCHERS
		380
		381	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
351		382
352	You can watch for signals using a signal watcher, C<signal> is the signal	383	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	384	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
354	callback to be invoked whenever a signal occurs.	385	callback to be invoked whenever a signal occurs.
355		386
…		…
368		399
369	This watcher might use C<%SIG> (depending on the event loop used),	400	This watcher might use C<%SIG> (depending on the event loop used),
370	so programs overwriting those signals directly will likely not work	401	so programs overwriting those signals directly will likely not work
371	correctly.	402	correctly.
372		403
		404	Example: exit on SIGINT
		405
		406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		407
		408	=head3 Restart Behaviour
		409
		410	While restart behaviour is up to the event loop implementation, most will
		411	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		412	pure perl implementation).
		413
		414	=head3 Safe/Unsafe Signals
		415
		416	Perl signals can be either "safe" (synchronous to opcode handling) or
		417	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		418	latter might corrupt your memory.
		419
		420	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		421	i.e. they will not interrupt your running perl program but will only be
		422	called as part of the normal event handling (just like timer, I/O etc.
		423	callbacks, too).
		424
		425	=head3 Signal Races, Delays and Workarounds
		426
373	Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not	427	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	428	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	429	do race-free signal handling in perl, requiring C libraries for
		430	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	431	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	432	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
378	seconds). This variable can be changed only before the first signal	433	variable can be changed only before the first signal watcher is created,
379	watcher is created, and should be left alone otherwise. Higher values	434	and should be left alone otherwise. This variable determines how often
		435	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	436	will cause fewer spurious wake-ups, which is better for power and CPU
		437	saving.
		438
381	saving. All these problems can be avoided by installing the optional	439	All these problems can be avoided by installing the optional
382	L<Async::Interrupt> module.	440	L<Async::Interrupt> module, which works with most event loops. It will not
383		441	work with inherently broken event loops such as L<Event> or L<Event::Lib>
384	Example: exit on SIGINT	442	(and not with L<POE> currently, as POE does it's own workaround with
385		443	one-second latency). For those, you just have to suffer the delays.
386	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
387		444
388	=head2 CHILD PROCESS WATCHERS	445	=head2 CHILD PROCESS WATCHERS
389		446
		447	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		448
390	You can also watch on a child process exit and catch its exit status.	449	You can also watch on a child process exit and catch its exit status.
391		450
392	The child process is specified by the C<pid> argument (if set to C<0>, it	451	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	452	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	453	croak). The watcher will be triggered only when the child process has
395	any trace events (stopped/continued).	454	finished and an exit status is available, not on any trace events
		455	(stopped/continued).
396		456
397	The callback will be called with the pid and exit status (as returned by	457	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	458	waitpid), so unlike other watcher types, you I<can> rely on child watcher
399	callback arguments.	459	callback arguments.
400		460
…		…
441	# do something else, then wait for process exit	501	# do something else, then wait for process exit
442	$done->recv;	502	$done->recv;
443		503
444	=head2 IDLE WATCHERS	504	=head2 IDLE WATCHERS
445		505
446	Sometimes there is a need to do something, but it is not so important	506	$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		507
451	Idle watchers ideally get invoked when the event loop has nothing	508	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	509	either the watcher is destroyed or new events have been detected.
453	events. Instead of blocking, the idle watcher is invoked.
454		510
455	Most event loops unfortunately do not really support idle watchers (only	511	Idle watchers are useful when there is a need to do something, but it
		512	is not so important (or wise) to do it instantly. The callback will be
		513	invoked only when there is "nothing better to do", which is usually
		514	defined as "all outstanding events have been handled and no new events
		515	have been detected". That means that idle watchers ideally get invoked
		516	when the event loop has just polled for new events but none have been
		517	detected. Instead of blocking to wait for more events, the idle watchers
		518	will be invoked.
		519
		520	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	521	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
457	will simply call the callback "from time to time".	522	will simply call the callback "from time to time".
458		523
459	Example: read lines from STDIN, but only process them when the	524	Example: read lines from STDIN, but only process them when the
460	program is otherwise idle:	525	program is otherwise idle:
…		…
476	});	541	});
477	});	542	});
478		543
479	=head2 CONDITION VARIABLES	544	=head2 CONDITION VARIABLES
480		545
		546	$cv = AnyEvent->condvar;
		547
		548	$cv->send (<list>);
		549	my @res = $cv->recv;
		550
481	If you are familiar with some event loops you will know that all of them	551	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	552	require you to run some blocking "loop", "run" or similar function that
483	will actively watch for new events and call your callbacks.	553	will actively watch for new events and call your callbacks.
484		554
485	AnyEvent is slightly different: it expects somebody else to run the event	555	AnyEvent is slightly different: it expects somebody else to run the event
…		…
504	Condition variables are similar to callbacks, except that you can	574	Condition variables are similar to callbacks, except that you can
505	optionally wait for them. They can also be called merge points - points	575	optionally wait for them. They can also be called merge points - points
506	in time where multiple outstanding events have been processed. And yet	576	in time where multiple outstanding events have been processed. And yet
507	another way to call them is transactions - each condition variable can be	577	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	578	used to represent a transaction, which finishes at some point and delivers
509	a result.	579	a result. And yet some people know them as "futures" - a promise to
		580	compute/deliver something that you can wait for.
510		581
511	Condition variables are very useful to signal that something has finished,	582	Condition variables are very useful to signal that something has finished,
512	for example, if you write a module that does asynchronous http requests,	583	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	584	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	585	availability of results. The user can either act when the callback is
…		…
548	after => 1,	619	after => 1,
549	cb => sub { $result_ready->send },	620	cb => sub { $result_ready->send },
550	);	621	);
551		622
552	# this "blocks" (while handling events) till the callback	623	# this "blocks" (while handling events) till the callback
553	# calls -<send	624	# calls ->send
554	$result_ready->recv;	625	$result_ready->recv;
555		626
556	Example: wait for a timer, but take advantage of the fact that condition	627	Example: wait for a timer, but take advantage of the fact that condition
557	variables are also callable directly.	628	variables are also callable directly.
558		629
…		…
622	one. For example, a function that pings many hosts in parallel might want	693	one. For example, a function that pings many hosts in parallel might want
623	to use a condition variable for the whole process.	694	to use a condition variable for the whole process.
624		695
625	Every call to C<< ->begin >> will increment a counter, and every call to	696	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	697	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	698	>>, 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	699	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.	700	>>, but that is not required. If no group callback was set, C<send> will
		701	be called without any arguments.
630		702
631	You can think of C<< $cv->send >> giving you an OR condition (one call	703	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	704	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).	705	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
634		706
…		…
661	begung can potentially be zero:	733	begung can potentially be zero:
662		734
663	my $cv = AnyEvent->condvar;	735	my $cv = AnyEvent->condvar;
664		736
665	my %result;	737	my %result;
666	$cv->begin (sub { $cv->send (\%result) });	738	$cv->begin (sub { shift->send (\%result) });
667		739
668	for my $host (@list_of_hosts) {	740	for my $host (@list_of_hosts) {
669	$cv->begin;	741	$cv->begin;
670	ping_host_then_call_callback $host, sub {	742	ping_host_then_call_callback $host, sub {
671	$result{$host} = ...;	743	$result{$host} = ...;
…		…
746	=item $cb = $cv->cb ($cb->($cv))	818	=item $cb = $cv->cb ($cb->($cv))
747		819
748	This is a mutator function that returns the callback set and optionally	820	This is a mutator function that returns the callback set and optionally
749	replaces it before doing so.	821	replaces it before doing so.
750		822
751	The callback will be called when the condition becomes "true", i.e. when	823	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	824	"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	825	the only argument being the condition variable itself. Calling C<recv>
754	is guaranteed not to block.	826	inside the callback or at any later time is guaranteed not to block.
755		827
756	=back	828	=back
757		829
758	=head1 SUPPORTED EVENT LOOPS/BACKENDS	830	=head1 SUPPORTED EVENT LOOPS/BACKENDS
759		831
…		…
762	=over 4	834	=over 4
763		835
764	=item Backends that are autoprobed when no other event loop can be found.	836	=item Backends that are autoprobed when no other event loop can be found.
765		837
766	EV is the preferred backend when no other event loop seems to be in	838	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	839	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	840	pure-perl implementation, which is available everywhere as it comes with
769	available everywhere as it comes with AnyEvent itself.	841	AnyEvent itself.
770		842
771	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	843	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.	844	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
774		845
775	=item Backends that are transparently being picked up when they are used.	846	=item Backends that are transparently being picked up when they are used.
776		847
777	These will be used when they are currently loaded when the first watcher	848	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	849	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	850	them. This means that AnyEvent will automatically pick the right backend
780	when the main program loads an event module before anything starts to	851	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.	852	create watchers. Nothing special needs to be done by the main program.
782		853
		854	AnyEvent::Impl::Event based on Event, very stable, few glitches.
783	AnyEvent::Impl::Glib based on Glib, slow but very stable.	855	AnyEvent::Impl::Glib based on Glib, slow but very stable.
784	AnyEvent::Impl::Tk based on Tk, very broken.	856	AnyEvent::Impl::Tk based on Tk, very broken.
785	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	857	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786	AnyEvent::Impl::POE based on POE, very slow, some limitations.	858	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		859	AnyEvent::Impl::Irssi used when running within irssi.
787		860
788	=item Backends with special needs.	861	=item Backends with special needs.
789		862
790	Qt requires the Qt::Application to be instantiated first, but will	863	Qt requires the Qt::Application to be instantiated first, but will
791	otherwise be picked up automatically. As long as the main program	864	otherwise be picked up automatically. As long as the main program
…		…
865	event module detection too early, for example, L<AnyEvent::AIO> creates	938	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	939	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867	avoid autodetecting the event module at load time.	940	avoid autodetecting the event module at load time.
868		941
869	If called in scalar or list context, then it creates and returns an object	942	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	943	that automatically removes the callback again when it is destroyed (or
		944	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
871	L<Coro::BDB> for a case where this is useful.	945	a case where this is useful.
		946
		947	Example: Create a watcher for the IO::AIO module and store it in
		948	C<$WATCHER>. Only do so after the event loop is initialised, though.
		949
		950	our WATCHER;
		951
		952	my $guard = AnyEvent::post_detect {
		953	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		954	};
		955
		956	# the \|\|= is important in case post_detect immediately runs the block,
		957	# as to not clobber the newly-created watcher. assigning both watcher and
		958	# post_detect guard to the same variable has the advantage of users being
		959	# able to just C<undef $WATCHER> if the watcher causes them grief.
		960
		961	$WATCHER \|\|= $guard;
872		962
873	=item @AnyEvent::post_detect	963	=item @AnyEvent::post_detect
874		964
875	If there are any code references in this array (you can C<push> to it	965	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	966	before or after loading AnyEvent), then they will called directly after
…		…
879	You should check C<$AnyEvent::MODEL> before adding to this array, though:	969	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	970	if it is defined then the event loop has already been detected, and the
881	array will be ignored.	971	array will be ignored.
882		972
883	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	973	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
884	it,as it takes care of these details.	974	it, as it takes care of these details.
885		975
886	This variable is mainly useful for modules that can do something useful	976	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	977	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	978	not need to even load it by default. This array provides the means to hook
889	into AnyEvent passively, without loading it.	979	into AnyEvent passively, without loading it.
		980
		981	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		982	together, you could put this into Coro (this is the actual code used by
		983	Coro to accomplish this):
		984
		985	if (defined $AnyEvent::MODEL) {
		986	# AnyEvent already initialised, so load Coro::AnyEvent
		987	require Coro::AnyEvent;
		988	} else {
		989	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		990	# as soon as it is
		991	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		992	}
890		993
891	=back	994	=back
892		995
893	=head1 WHAT TO DO IN A MODULE	996	=head1 WHAT TO DO IN A MODULE
894		997
…		…
1043		1146
1044	package AnyEvent;	1147	package AnyEvent;
1045		1148
1046	# basically a tuned-down version of common::sense	1149	# basically a tuned-down version of common::sense
1047	sub common_sense {	1150	sub common_sense {
1048	# no warnings	1151	# from common:.sense 1.0
1049	${^WARNING_BITS} ^= ${^WARNING_BITS};	1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1050	# use strict vars subs	1153	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1051	$^H \|= 0x00000600;	1154	$^H \|= 0x00000600;
1052	}	1155	}
1053		1156
1054	BEGIN { AnyEvent::common_sense }	1157	BEGIN { AnyEvent::common_sense }
1055		1158
1056	use Carp ();	1159	use Carp ();
1057		1160
1058	our $VERSION = 4.83;	1161	our $VERSION = '5.24';
1059	our $MODEL;	1162	our $MODEL;
1060		1163
1061	our $AUTOLOAD;	1164	our $AUTOLOAD;
1062	our @ISA;	1165	our @ISA;
1063		1166
1064	our @REGISTRY;	1167	our @REGISTRY;
1065		1168
1066	our $WIN32;
1067
1068	our $VERBOSE;	1169	our $VERBOSE;
1069		1170
1070	BEGIN {	1171	BEGIN {
		1172	eval "sub CYGWIN(){" . (($^O =~ /cygwin/i) *1) . "}";
1071	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1173	eval "sub WIN32 (){" . (($^O =~ /mswin32/i)*1) . "}";
1072	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1174	eval "sub TAINT (){" . (${^TAINT} *1) . "}";
1073		1175
1074	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1075	if ${^TAINT};	1177	if ${^TAINT};
1076		1178
1077	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1088	for reverse split /\s,\s/,	1190	for reverse split /\s,\s/,
1089	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1191	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1090	}	1192	}
1091		1193
1092	my @models = (	1194	my @models = (
1093	[EV:: => AnyEvent::Impl::EV::],	1195	[EV:: => AnyEvent::Impl::EV:: , 1],
1094	[Event:: => AnyEvent::Impl::Event::],
1095	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1196	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1096	# everything below here will not be autoprobed	1197	# everything below here will not (normally) be autoprobed
1097	# as the pureperl backend should work everywhere	1198	# as the pureperl backend should work everywhere
1098	# and is usually faster	1199	# and is usually faster
		1200	[Event:: => AnyEvent::Impl::Event::, 1],
1099	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1201	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1100	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1202	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1203	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1101	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1204	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1102	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1205	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1103	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1206	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1104	[Wx:: => AnyEvent::Impl::POE::],	1207	[Wx:: => AnyEvent::Impl::POE::],
1105	[Prima:: => AnyEvent::Impl::POE::],	1208	[Prima:: => AnyEvent::Impl::POE::],
1106	# IO::Async is just too broken - we would need workarounds for its	1209	# IO::Async is just too broken - we would need workarounds for its
1107	# byzantine signal and broken child handling, among others.	1210	# byzantine signal and broken child handling, among others.
1108	# IO::Async is rather hard to detect, as it doesn't have any	1211	# IO::Async is rather hard to detect, as it doesn't have any
1109	# obvious default class.	1212	# obvious default class.
1110	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1213	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1111	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1112	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1215	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1216	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1113	);	1217	);
1114		1218
1115	our %method = map +($_ => 1),	1219	our %method = map +($_ => 1),
1116	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1220	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1117		1221
…		…
1121	my ($cb) = @_;	1225	my ($cb) = @_;
1122		1226
1123	if ($MODEL) {	1227	if ($MODEL) {
1124	$cb->();	1228	$cb->();
1125		1229
1126	1	1230	undef
1127	} else {	1231	} else {
1128	push @post_detect, $cb;	1232	push @post_detect, $cb;
1129		1233
1130	defined wantarray	1234	defined wantarray
1131	? bless \$cb, "AnyEvent::Util::postdetect"	1235	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1163	}	1267	}
1164	}	1268	}
1165	}	1269	}
1166		1270
1167	unless ($MODEL) {	1271	unless ($MODEL) {
1168	# try to load a model	1272	# try to autoload a model
1169
1170	for (@REGISTRY, @models) {	1273	for (@REGISTRY, @models) {
1171	my ($package, $model) = @$_;	1274	my ($package, $model, $autoload) = @$_;
		1275	if (
		1276	$autoload
1172	if (eval "require $package"	1277	and eval "require $package"
1173	and ${"$package\::VERSION"} > 0	1278	and ${"$package\::VERSION"} > 0
1174	and eval "require $model") {	1279	and eval "require $model"
		1280	) {
1175	$MODEL = $model;	1281	$MODEL = $model;
1176	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1282	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1177	last;	1283	last;
1178	}	1284	}
1179	}	1285	}
1180		1286
1181	$MODEL	1287	$MODEL
…		…
1222	# we assume CLOEXEC is already set by perl in all important cases	1328	# we assume CLOEXEC is already set by perl in all important cases
1223		1329
1224	($fh2, $rw)	1330	($fh2, $rw)
1225	}	1331	}
1226		1332
		1333	=head1 SIMPLIFIED AE API
		1334
		1335	Starting with version 5.0, AnyEvent officially supports a second, much
		1336	simpler, API that is designed to reduce the calling, typing and memory
		1337	overhead.
		1338
		1339	See the L<AE> manpage for details.
		1340
		1341	=cut
		1342
		1343	package AE;
		1344
		1345	our $VERSION = $AnyEvent::VERSION;
		1346
		1347	sub io($$$) {
		1348	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1349	}
		1350
		1351	sub timer($$$) {
		1352	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1353	}
		1354
		1355	sub signal($$) {
		1356	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1357	}
		1358
		1359	sub child($$) {
		1360	AnyEvent->child (pid => $_[0], cb => $_[1])
		1361	}
		1362
		1363	sub idle($) {
		1364	AnyEvent->idle (cb => $_[0])
		1365	}
		1366
		1367	sub cv(;&) {
		1368	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1369	}
		1370
		1371	sub now() {
		1372	AnyEvent->now
		1373	}
		1374
		1375	sub now_update() {
		1376	AnyEvent->now_update
		1377	}
		1378
		1379	sub time() {
		1380	AnyEvent->time
		1381	}
		1382
1227	package AnyEvent::Base;	1383	package AnyEvent::Base;
1228		1384
1229	# default implementations for many methods	1385	# default implementations for many methods
1230		1386
1231	sub _time {	1387	sub _time() {
1232	# probe for availability of Time::HiRes	1388	# probe for availability of Time::HiRes
1233	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1389	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1234	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1390	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1235	*_time = \&Time::HiRes::time;	1391	*_time = \&Time::HiRes::time;
1236	# if (eval "use POSIX (); (POSIX::times())...	1392	# if (eval "use POSIX (); (POSIX::times())...
1237	} else {	1393	} else {
1238	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1394	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1239	*_time = sub { time }; # epic fail	1395	*_time = sub (){ time }; # epic fail
1240	}	1396	}
1241		1397
1242	&_time	1398	&_time
1243	}	1399	}
1244		1400
…		…
1253	}	1409	}
1254		1410
1255	# default implementation for ->signal	1411	# default implementation for ->signal
1256		1412
1257	our $HAVE_ASYNC_INTERRUPT;	1413	our $HAVE_ASYNC_INTERRUPT;
		1414
		1415	sub _have_async_interrupt() {
		1416	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1417	&& eval "use Async::Interrupt 1.02 (); 1")
		1418	unless defined $HAVE_ASYNC_INTERRUPT;
		1419
		1420	$HAVE_ASYNC_INTERRUPT
		1421	}
		1422
1258	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1423	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1259	our (%SIG_ASY, %SIG_ASY_W);	1424	our (%SIG_ASY, %SIG_ASY_W);
1260	our ($SIG_COUNT, $SIG_TW);	1425	our ($SIG_COUNT, $SIG_TW);
1261		1426
1262	sub _signal_exec {	1427	sub _signal_exec {
1263	$HAVE_ASYNC_INTERRUPT	1428	$HAVE_ASYNC_INTERRUPT
1264	? $SIGPIPE_R->drain	1429	? $SIGPIPE_R->drain
1265	: sysread $SIGPIPE_R, my $dummy, 9;	1430	: sysread $SIGPIPE_R, (my $dummy), 9;
1266		1431
1267	while (%SIG_EV) {	1432	while (%SIG_EV) {
1268	for (keys %SIG_EV) {	1433	for (keys %SIG_EV) {
1269	delete $SIG_EV{$_};	1434	delete $SIG_EV{$_};
1270	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1435	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1271	}	1436	}
1272	}	1437	}
1273	}	1438	}
1274		1439
		1440	# install a dummy wakeup watcher to reduce signal catching latency
1275	sub _signal {	1441	sub _sig_add() {
1276	my (undef, %arg) = @_;	1442	unless ($SIG_COUNT++) {
		1443	# try to align timer on a full-second boundary, if possible
		1444	my $NOW = AE::now;
1277		1445
1278	my $signal = uc $arg{signal}	1446	$SIG_TW = AE::timer
1279	or Carp::croak "required option 'signal' is missing";	1447	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1280		1448	$MAX_SIGNAL_LATENCY,
1281	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1449	sub { } # just for the PERL_ASYNC_CHECK
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	};	1450	;
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	}	1451	}
1315
1316	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1317	}	1452	}
1318		1453
1319	sub signal {	1454	sub _sig_del {
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	1455	undef $SIG_TW
1363	unless --$SIG_COUNT;	1456	unless --$SIG_COUNT;
		1457	}
1364		1458
		1459	our $_sig_name_init; $_sig_name_init = sub {
		1460	eval q{ # poor man's autoloading
		1461	undef $_sig_name_init;
		1462
		1463	if (_have_async_interrupt) {
		1464	*sig2num = \&Async::Interrupt::sig2num;
		1465	*sig2name = \&Async::Interrupt::sig2name;
		1466	} else {
		1467	require Config;
		1468
		1469	my %signame2num;
		1470	@signame2num{ split ' ', $Config::Config{sig_name} }
		1471	= split ' ', $Config::Config{sig_num};
		1472
		1473	my @signum2name;
		1474	@signum2name[values %signame2num] = keys %signame2num;
		1475
		1476	*sig2num = sub($) {
		1477	$_[0] > 0 ? shift : $signame2num{+shift}
		1478	};
		1479	*sig2name = sub ($) {
		1480	$_[0] > 0 ? $signum2name[+shift] : shift
		1481	};
		1482	}
		1483	};
		1484	die if $@;
		1485	};
		1486
		1487	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1488	sub sig2name($) { &$_sig_name_init; &sig2name }
		1489
		1490	sub signal {
		1491	eval q{ # poor man's autoloading {}
		1492	# probe for availability of Async::Interrupt
		1493	if (_have_async_interrupt) {
		1494	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1495
		1496	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1497	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1498
		1499	} else {
		1500	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1501
		1502	require Fcntl;
		1503
		1504	if (AnyEvent::WIN32) {
		1505	require AnyEvent::Util;
		1506
		1507	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1508	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1509	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1510	} else {
		1511	pipe $SIGPIPE_R, $SIGPIPE_W;
		1512	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1513	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1514
		1515	# not strictly required, as $^F is normally 2, but let's make sure...
		1516	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1517	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1518	}
		1519
		1520	$SIGPIPE_R
		1521	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1522
		1523	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1524	}
		1525
		1526	*signal = sub {
		1527	my (undef, %arg) = @_;
		1528
		1529	my $signal = uc $arg{signal}
		1530	or Carp::croak "required option 'signal' is missing";
		1531
		1532	if ($HAVE_ASYNC_INTERRUPT) {
		1533	# async::interrupt
		1534
		1535	$signal = sig2num $signal;
		1536	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1537
		1538	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1539	cb => sub { undef $SIG_EV{$signal} },
		1540	signal => $signal,
		1541	pipe => [$SIGPIPE_R->filenos],
		1542	pipe_autodrain => 0,
		1543	;
		1544
		1545	} else {
		1546	# pure perl
		1547
		1548	# AE::Util has been loaded in signal
		1549	$signal = sig2name $signal;
		1550	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1551
		1552	$SIG{$signal} \|\|= sub {
		1553	local $!;
		1554	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1555	undef $SIG_EV{$signal};
		1556	};
		1557
		1558	# can't do signal processing without introducing races in pure perl,
		1559	# so limit the signal latency.
		1560	_sig_add;
		1561	}
		1562
		1563	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1564	};
		1565
		1566	*AnyEvent::Base::signal::DESTROY = sub {
		1567	my ($signal, $cb) = @{$_[0]};
		1568
		1569	_sig_del;
		1570
1365	delete $SIG_CB{$signal}{$cb};	1571	delete $SIG_CB{$signal}{$cb};
1366		1572
		1573	$HAVE_ASYNC_INTERRUPT
		1574	? delete $SIG_ASY{$signal}
1367	# delete doesn't work with older perls - they then	1575	: # delete doesn't work with older perls - they then
1368	# print weird messages, or just unconditionally exit	1576	# print weird messages, or just unconditionally exit
1369	# instead of getting the default action.	1577	# instead of getting the default action.
1370	undef $SIG{$signal}	1578	undef $SIG{$signal}
1371	unless keys %{ $SIG_CB{$signal} };	1579	unless keys %{ $SIG_CB{$signal} };
		1580	};
		1581	};
		1582	die if $@;
		1583	&signal
1372	}	1584	}
1373		1585
1374	# default implementation for ->child	1586	# default implementation for ->child
1375		1587
1376	our %PID_CB;	1588	our %PID_CB;
1377	our $CHLD_W;	1589	our $CHLD_W;
1378	our $CHLD_DELAY_W;	1590	our $CHLD_DELAY_W;
1379	our $WNOHANG;	1591	our $WNOHANG;
1380		1592
		1593	sub _emit_childstatus($$) {
		1594	my (undef, $rpid, $rstatus) = @_;
		1595
		1596	$_->($rpid, $rstatus)
		1597	for values %{ $PID_CB{$rpid} \|\| {} },
		1598	values %{ $PID_CB{0} \|\| {} };
		1599	}
		1600
1381	sub _sigchld {	1601	sub _sigchld {
		1602	my $pid;
		1603
		1604	AnyEvent->_emit_childstatus ($pid, $?)
1382	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1605	while ($pid = waitpid -1, $WNOHANG) > 0;
1383	$_->($pid, $?)
1384	for values %{ $PID_CB{$pid} \|\| {} },
1385	values %{ $PID_CB{0} \|\| {} };
1386	}
1387	}	1606	}
1388		1607
1389	sub child {	1608	sub child {
1390	my (undef, %arg) = @_;	1609	my (undef, %arg) = @_;
1391		1610
…		…
1398	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1617	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1399	? 1	1618	? 1
1400	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1619	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1401		1620
1402	unless ($CHLD_W) {	1621	unless ($CHLD_W) {
1403	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1622	$CHLD_W = AE::signal CHLD => \&_sigchld;
1404	# child could be a zombie already, so make at least one round	1623	# child could be a zombie already, so make at least one round
1405	&_sigchld;	1624	&_sigchld;
1406	}	1625	}
1407		1626
1408	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1627	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1434	# never use more then 50% of the time for the idle watcher,	1653	# never use more then 50% of the time for the idle watcher,
1435	# within some limits	1654	# within some limits
1436	$w = 0.0001 if $w < 0.0001;	1655	$w = 0.0001 if $w < 0.0001;
1437	$w = 5 if $w > 5;	1656	$w = 5 if $w > 5;
1438		1657
1439	$w = AnyEvent->timer (after => $w, cb => $rcb);	1658	$w = AE::timer $w, 0, $rcb;
1440	} else {	1659	} else {
1441	# clean up...	1660	# clean up...
1442	undef $w;	1661	undef $w;
1443	undef $rcb;	1662	undef $rcb;
1444	}	1663	}
1445	};	1664	};
1446		1665
1447	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1666	$w = AE::timer 0.05, 0, $rcb;
1448		1667
1449	bless \\$cb, "AnyEvent::Base::idle"	1668	bless \\$cb, "AnyEvent::Base::idle"
1450	}	1669	}
1451		1670
1452	sub AnyEvent::Base::idle::DESTROY {	1671	sub AnyEvent::Base::idle::DESTROY {
…		…
1506	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1725	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1507	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1726	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1508	}	1727	}
1509		1728
1510	sub cb {	1729	sub cb {
1511	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1730	my $cv = shift;
		1731
		1732	@_
		1733	and $cv->{_ae_cb} = shift
		1734	and $cv->{_ae_sent}
		1735	and (delete $cv->{_ae_cb})->($cv);
		1736
1512	$_[0]{_ae_cb}	1737	$cv->{_ae_cb}
1513	}	1738	}
1514		1739
1515	sub begin {	1740	sub begin {
1516	++$_[0]{_ae_counter};	1741	++$_[0]{_ae_counter};
1517	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1742	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1565	conditions, such as not being able to load the event model specified by	1790	conditions, such as not being able to load the event model specified by
1566	C<PERL_ANYEVENT_MODEL>.	1791	C<PERL_ANYEVENT_MODEL>.
1567		1792
1568	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1793	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1569	model it chooses.	1794	model it chooses.
		1795
		1796	When set to C<8> or higher, then AnyEvent will report extra information on
		1797	which optional modules it loads and how it implements certain features.
1570		1798
1571	=item C<PERL_ANYEVENT_STRICT>	1799	=item C<PERL_ANYEVENT_STRICT>
1572		1800
1573	AnyEvent does not do much argument checking by default, as thorough	1801	AnyEvent does not do much argument checking by default, as thorough
1574	argument checking is very costly. Setting this variable to a true value	1802	argument checking is very costly. Setting this variable to a true value
…		…
1651		1879
1652	When neither C<ca_file> nor C<ca_path> was specified during	1880	When neither C<ca_file> nor C<ca_path> was specified during
1653	L<AnyEvent::TLS> context creation, and either of these environment	1881	L<AnyEvent::TLS> context creation, and either of these environment
1654	variables exist, they will be used to specify CA certificate locations	1882	variables exist, they will be used to specify CA certificate locations
1655	instead of a system-dependent default.	1883	instead of a system-dependent default.
		1884
		1885	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1886
		1887	When these are set to C<1>, then the respective modules are not
		1888	loaded. Mostly good for testing AnyEvent itself.
1656		1889
1657	=back	1890	=back
1658		1891
1659	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1892	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1660		1893
…		…
1718	warn "read: $input\n"; # output what has been read	1951	warn "read: $input\n"; # output what has been read
1719	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1952	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1720	},	1953	},
1721	);	1954	);
1722		1955
1723	my $time_watcher; # can only be used once
1724
1725	sub new_timer {
1726	$timer = AnyEvent->timer (after => 1, cb => sub {	1956	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1727	warn "timeout\n"; # print 'timeout' about every second	1957	warn "timeout\n"; # print 'timeout' at most every second
1728	&new_timer; # and restart the time
1729	});	1958	});
1730	}
1731
1732	new_timer; # create first timer
1733		1959
1734	$cv->recv; # wait until user enters /^q/i	1960	$cv->recv; # wait until user enters /^q/i
1735		1961
1736	=head1 REAL-WORLD EXAMPLE	1962	=head1 REAL-WORLD EXAMPLE
1737		1963
…		…
1868	through AnyEvent. The benchmark creates a lot of timers (with a zero	2094	through AnyEvent. The benchmark creates a lot of timers (with a zero
1869	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2095	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1870	which it is), lets them fire exactly once and destroys them again.	2096	which it is), lets them fire exactly once and destroys them again.
1871		2097
1872	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2098	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1873	distribution.	2099	distribution. It uses the L<AE> interface, which makes a real difference
		2100	for the EV and Perl backends only.
1874		2101
1875	=head3 Explanation of the columns	2102	=head3 Explanation of the columns
1876		2103
1877	I<watcher> is the number of event watchers created/destroyed. Since	2104	I<watcher> is the number of event watchers created/destroyed. Since
1878	different event models feature vastly different performances, each event	2105	different event models feature vastly different performances, each event
…		…
1899	watcher.	2126	watcher.
1900		2127
1901	=head3 Results	2128	=head3 Results
1902		2129
1903	name watchers bytes create invoke destroy comment	2130	name watchers bytes create invoke destroy comment
1904	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2131	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1905	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2132	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1906	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2133	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1907	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2134	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1908	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2135	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1909	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2136	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1910	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2137	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1911	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2138	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1912	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2139	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1913	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2140	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1914	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2141	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1915	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2142	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1916		2143
1917	=head3 Discussion	2144	=head3 Discussion
1918		2145
1919	The benchmark does I<not> measure scalability of the event loop very	2146	The benchmark does I<not> measure scalability of the event loop very
1920	well. For example, a select-based event loop (such as the pure perl one)	2147	well. For example, a select-based event loop (such as the pure perl one)
…		…
1932	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2159	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1933	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2160	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1934	cycles with POE.	2161	cycles with POE.
1935		2162
1936	C<EV> is the sole leader regarding speed and memory use, which are both	2163	C<EV> is the sole leader regarding speed and memory use, which are both
1937	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2164	maximal/minimal, respectively. When using the L<AE> API there is zero
		2165	overhead (when going through the AnyEvent API create is about 5-6 times
		2166	slower, with other times being equal, so still uses far less memory than
1938	far less memory than any other event loop and is still faster than Event	2167	any other event loop and is still faster than Event natively).
1939	natively.
1940		2168
1941	The pure perl implementation is hit in a few sweet spots (both the	2169	The pure perl implementation is hit in a few sweet spots (both the
1942	constant timeout and the use of a single fd hit optimisations in the perl	2170	constant timeout and the use of a single fd hit optimisations in the perl
1943	interpreter and the backend itself). Nevertheless this shows that it	2171	interpreter and the backend itself). Nevertheless this shows that it
1944	adds very little overhead in itself. Like any select-based backend its	2172	adds very little overhead in itself. Like any select-based backend its
…		…
2018	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2246	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2019	(1%) are active. This mirrors the activity of large servers with many	2247	(1%) are active. This mirrors the activity of large servers with many
2020	connections, most of which are idle at any one point in time.	2248	connections, most of which are idle at any one point in time.
2021		2249
2022	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2250	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2023	distribution.	2251	distribution. It uses the L<AE> interface, which makes a real difference
		2252	for the EV and Perl backends only.
2024		2253
2025	=head3 Explanation of the columns	2254	=head3 Explanation of the columns
2026		2255
2027	I<sockets> is the number of sockets, and twice the number of "servers" (as	2256	I<sockets> is the number of sockets, and twice the number of "servers" (as
2028	each server has a read and write socket end).	2257	each server has a read and write socket end).
…		…
2036	a new one that moves the timeout into the future.	2265	a new one that moves the timeout into the future.
2037		2266
2038	=head3 Results	2267	=head3 Results
2039		2268
2040	name sockets create request	2269	name sockets create request
2041	EV 20000 69.01 11.16	2270	EV 20000 62.66 7.99
2042	Perl 20000 73.32 35.87	2271	Perl 20000 68.32 32.64
2043	IOAsync 20000 157.00 98.14 epoll	2272	IOAsync 20000 174.06 101.15 epoll
2044	IOAsync 20000 159.31 616.06 poll	2273	IOAsync 20000 174.67 610.84 poll
2045	Event 20000 212.62 257.32	2274	Event 20000 202.69 242.91
2046	Glib 20000 651.16 1896.30	2275	Glib 20000 557.01 1689.52
2047	POE 20000 349.67 12317.24 uses POE::Loop::Event	2276	POE 20000 341.54 12086.32 uses POE::Loop::Event
2048		2277
2049	=head3 Discussion	2278	=head3 Discussion
2050		2279
2051	This benchmark I<does> measure scalability and overall performance of the	2280	This benchmark I<does> measure scalability and overall performance of the
2052	particular event loop.	2281	particular event loop.
…		…
2178	As you can see, the AnyEvent + EV combination even beats the	2407	As you can see, the AnyEvent + EV combination even beats the
2179	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2408	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2180	backend easily beats IO::Lambda and POE.	2409	backend easily beats IO::Lambda and POE.
2181		2410
2182	And even the 100% non-blocking version written using the high-level (and	2411	And even the 100% non-blocking version written using the high-level (and
2183	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2412	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2184	large margin, even though it does all of DNS, tcp-connect and socket I/O	2413	higher level ("unoptimised") abstractions by a large margin, even though
2185	in a non-blocking way.	2414	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2186		2415
2187	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2416	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2188	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2417	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2189	part of the IO::lambda distribution and were used without any changes.	2418	part of the IO::Lambda distribution and were used without any changes.
2190		2419
2191		2420
2192	=head1 SIGNALS	2421	=head1 SIGNALS
2193		2422
2194	AnyEvent currently installs handlers for these signals:	2423	AnyEvent currently installs handlers for these signals:
…		…
2236	it's built-in modules) are required to use it.	2465	it's built-in modules) are required to use it.
2237		2466
2238	That does not mean that AnyEvent won't take advantage of some additional	2467	That does not mean that AnyEvent won't take advantage of some additional
2239	modules if they are installed.	2468	modules if they are installed.
2240		2469
2241	This section epxlains which additional modules will be used, and how they	2470	This section explains which additional modules will be used, and how they
2242	affect AnyEvent's operetion.	2471	affect AnyEvent's operation.
2243		2472
2244	=over 4	2473	=over 4
2245		2474
2246	=item L<Async::Interrupt>	2475	=item L<Async::Interrupt>
2247		2476
2248	This slightly arcane module is used to implement fast signal handling: To	2477	This slightly arcane module is used to implement fast signal handling: To
2249	my knowledge, there is no way to do completely race-free and quick	2478	my knowledge, there is no way to do completely race-free and quick
2250	signal handling in pure perl. To ensure that signals still get	2479	signal handling in pure perl. To ensure that signals still get
2251	delivered, AnyEvent will start an interval timer to wake up perl (and	2480	delivered, AnyEvent will start an interval timer to wake up perl (and
2252	catch the signals) with soemd elay (default is 10 seconds, look for	2481	catch the signals) with some delay (default is 10 seconds, look for
2253	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2482	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2254		2483
2255	If this module is available, then it will be used to implement signal	2484	If this module is available, then it will be used to implement signal
2256	catching, which means that signals will not be delayed, and the event loop	2485	catching, which means that signals will not be delayed, and the event loop
2257	will not be interrupted regularly, which is more efficient (And good for	2486	will not be interrupted regularly, which is more efficient (and good for
2258	battery life on laptops).	2487	battery life on laptops).
2259		2488
2260	This affects not just the pure-perl event loop, but also other event loops	2489	This affects not just the pure-perl event loop, but also other event loops
2261	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2490	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2491
		2492	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2493	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2494	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2495	does nothing for those backends.
2262		2496
2263	=item L<EV>	2497	=item L<EV>
2264		2498
2265	This module isn't really "optional", as it is simply one of the backend	2499	This module isn't really "optional", as it is simply one of the backend
2266	event loops that AnyEvent can use. However, it is simply the best event	2500	event loops that AnyEvent can use. However, it is simply the best event
…		…
2278	lot less memory), but otherwise doesn't affect guard operation much. It is	2512	lot less memory), but otherwise doesn't affect guard operation much. It is
2279	purely used for performance.	2513	purely used for performance.
2280		2514
2281	=item L<JSON> and L<JSON::XS>	2515	=item L<JSON> and L<JSON::XS>
2282		2516
2283	This module is required when you want to read or write JSON data via	2517	One of these modules is required when you want to read or write JSON data
2284	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2518	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2285	advantage of the ulta-high-speed L<JSON::XS> module when it is installed.	2519	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2286		2520
2287	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2521	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2288	installed.	2522	installed.
2289		2523
2290	=item L<Net::SSLeay>	2524	=item L<Net::SSLeay>
…		…
2304		2538
2305		2539
2306	=head1 FORK	2540	=head1 FORK
2307		2541
2308	Most event libraries are not fork-safe. The ones who are usually are	2542	Most event libraries are not fork-safe. The ones who are usually are
2309	because they rely on inefficient but fork-safe C<select> or C<poll>	2543	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2310	calls. Only L<EV> is fully fork-aware.	2544	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2545	are usually badly thought-out hacks that are incompatible with fork in
		2546	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2547	continue event-processing in both parent and child (or both, if you know
		2548	what you are doing).
		2549
		2550	This means that, in general, you cannot fork and do event processing in
		2551	the child if the event library was initialised before the fork (which
		2552	usually happens when the first AnyEvent watcher is created, or the library
		2553	is loaded).
2311		2554
2312	If you have to fork, you must either do so I<before> creating your first	2555	If you have to fork, you must either do so I<before> creating your first
2313	watcher OR you must not use AnyEvent at all in the child OR you must do	2556	watcher OR you must not use AnyEvent at all in the child OR you must do
2314	something completely out of the scope of AnyEvent.	2557	something completely out of the scope of AnyEvent.
		2558
		2559	The problem of doing event processing in the parent I<and> the child
		2560	is much more complicated: even for backends that I<are> fork-aware or
		2561	fork-safe, their behaviour is not usually what you want: fork clones all
		2562	watchers, that means all timers, I/O watchers etc. are active in both
		2563	parent and child, which is almost never what you want. USing C<exec>
		2564	to start worker children from some kind of manage rprocess is usually
		2565	preferred, because it is much easier and cleaner, at the expense of having
		2566	to have another binary.
2315		2567
2316		2568
2317	=head1 SECURITY CONSIDERATIONS	2569	=head1 SECURITY CONSIDERATIONS
2318		2570
2319	AnyEvent can be forced to load any event model via	2571	AnyEvent can be forced to load any event model via
…		…
2357	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2609	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2358		2610
2359	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2611	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2360	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2612	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2361	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2613	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2362	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2614	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2363		2615
2364	Non-blocking file handles, sockets, TCP clients and	2616	Non-blocking file handles, sockets, TCP clients and
2365	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2617	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2366		2618
2367	Asynchronous DNS: L<AnyEvent::DNS>.	2619	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.243 by root, Fri Jul 17 23:12:20 2009 UTC vs. Revision 1.311 by root, Wed Feb 10 13:33:44 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.243 by root, Fri Jul 17 23:12:20 2009 UTC vs.
Revision 1.311 by root, Wed Feb 10 13:33:44 2010 UTC