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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.242 by root, Fri Jul 17 22:05:12 2009 UTC vs.
Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6	event loops.	6	and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
40	=head1 INTRODUCTION/TUTORIAL	40	=head1 INTRODUCTION/TUTORIAL
41		41
42	This manpage is mainly a reference manual. If you are interested	42	This manpage is mainly a reference manual. If you are interested
43	in a tutorial or some gentle introduction, have a look at the	43	in a tutorial or some gentle introduction, have a look at the
44	L<AnyEvent::Intro> manpage.	44	L<AnyEvent::Intro> manpage.
		45
		46	=head1 SUPPORT
		47
		48	There is a mailinglist for discussing all things AnyEvent, and an IRC
		49	channel, too.
		50
		51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		52	Repository>, at L<http://anyevent.schmorp.de>, for more info.
45		53
46	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47		55
48	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
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
…		…
1041		1144
1042	=cut	1145	=cut
1043		1146
1044	package AnyEvent;	1147	package AnyEvent;
1045		1148
1046	no warnings;	1149	# basically a tuned-down version of common::sense
1047	use strict qw(vars subs);	1150	sub common_sense {
		1151	# from common:.sense 1.0
		1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
		1153	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
		1154	$^H \|= 0x00000600;
		1155	}
		1156
		1157	BEGIN { AnyEvent::common_sense }
1048		1158
1049	use Carp ();	1159	use Carp ();
1050		1160
1051	our $VERSION = 4.83;	1161	our $VERSION = '5.23';
1052	our $MODEL;	1162	our $MODEL;
1053		1163
1054	our $AUTOLOAD;	1164	our $AUTOLOAD;
1055	our @ISA;	1165	our @ISA;
1056		1166
1057	our @REGISTRY;	1167	our @REGISTRY;
1058
1059	our $WIN32;
1060		1168
1061	our $VERBOSE;	1169	our $VERBOSE;
1062		1170
1063	BEGIN {	1171	BEGIN {
1064	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1172	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
…		…
1081	for reverse split /\s,\s/,	1189	for reverse split /\s,\s/,
1082	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1190	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1083	}	1191	}
1084		1192
1085	my @models = (	1193	my @models = (
1086	[EV:: => AnyEvent::Impl::EV::],	1194	[EV:: => AnyEvent::Impl::EV:: , 1],
1087	[Event:: => AnyEvent::Impl::Event::],
1088	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1195	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1089	# everything below here will not be autoprobed	1196	# everything below here will not (normally) be autoprobed
1090	# as the pureperl backend should work everywhere	1197	# as the pureperl backend should work everywhere
1091	# and is usually faster	1198	# and is usually faster
		1199	[Event:: => AnyEvent::Impl::Event::, 1],
1092	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1200	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1093	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1201	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1202	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1094	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1203	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1095	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1204	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1096	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1205	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1097	[Wx:: => AnyEvent::Impl::POE::],	1206	[Wx:: => AnyEvent::Impl::POE::],
1098	[Prima:: => AnyEvent::Impl::POE::],	1207	[Prima:: => AnyEvent::Impl::POE::],
1099	# IO::Async is just too broken - we would need workarounds for its	1208	# IO::Async is just too broken - we would need workarounds for its
1100	# byzantine signal and broken child handling, among others.	1209	# byzantine signal and broken child handling, among others.
1101	# IO::Async is rather hard to detect, as it doesn't have any	1210	# IO::Async is rather hard to detect, as it doesn't have any
1102	# obvious default class.	1211	# obvious default class.
1103	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1212	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1104	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1213	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1105	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1214	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1215	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1106	);	1216	);
1107		1217
1108	our %method = map +($_ => 1),	1218	our %method = map +($_ => 1),
1109	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1110		1220
…		…
1114	my ($cb) = @_;	1224	my ($cb) = @_;
1115		1225
1116	if ($MODEL) {	1226	if ($MODEL) {
1117	$cb->();	1227	$cb->();
1118		1228
1119	1	1229	undef
1120	} else {	1230	} else {
1121	push @post_detect, $cb;	1231	push @post_detect, $cb;
1122		1232
1123	defined wantarray	1233	defined wantarray
1124	? bless \$cb, "AnyEvent::Util::postdetect"	1234	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1130	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1240	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1131	}	1241	}
1132		1242
1133	sub detect() {	1243	sub detect() {
1134	unless ($MODEL) {	1244	unless ($MODEL) {
1135	no strict 'refs';
1136	local $SIG{__DIE__};	1245	local $SIG{__DIE__};
1137		1246
1138	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1247	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1139	my $model = "AnyEvent::Impl::$1";	1248	my $model = "AnyEvent::Impl::$1";
1140	if (eval "require $model") {	1249	if (eval "require $model") {
…		…
1157	}	1266	}
1158	}	1267	}
1159	}	1268	}
1160		1269
1161	unless ($MODEL) {	1270	unless ($MODEL) {
1162	# try to load a model	1271	# try to autoload a model
1163
1164	for (@REGISTRY, @models) {	1272	for (@REGISTRY, @models) {
1165	my ($package, $model) = @$_;	1273	my ($package, $model, $autoload) = @$_;
		1274	if (
		1275	$autoload
1166	if (eval "require $package"	1276	and eval "require $package"
1167	and ${"$package\::VERSION"} > 0	1277	and ${"$package\::VERSION"} > 0
1168	and eval "require $model") {	1278	and eval "require $model"
		1279	) {
1169	$MODEL = $model;	1280	$MODEL = $model;
1170	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1281	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1171	last;	1282	last;
1172	}	1283	}
1173	}	1284	}
1174		1285
1175	$MODEL	1286	$MODEL
…		…
1216	# we assume CLOEXEC is already set by perl in all important cases	1327	# we assume CLOEXEC is already set by perl in all important cases
1217		1328
1218	($fh2, $rw)	1329	($fh2, $rw)
1219	}	1330	}
1220		1331
		1332	=head1 SIMPLIFIED AE API
		1333
		1334	Starting with version 5.0, AnyEvent officially supports a second, much
		1335	simpler, API that is designed to reduce the calling, typing and memory
		1336	overhead.
		1337
		1338	See the L<AE> manpage for details.
		1339
		1340	=cut
		1341
		1342	package AE;
		1343
		1344	our $VERSION = $AnyEvent::VERSION;
		1345
		1346	sub io($$$) {
		1347	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1348	}
		1349
		1350	sub timer($$$) {
		1351	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1352	}
		1353
		1354	sub signal($$) {
		1355	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1356	}
		1357
		1358	sub child($$) {
		1359	AnyEvent->child (pid => $_[0], cb => $_[1])
		1360	}
		1361
		1362	sub idle($) {
		1363	AnyEvent->idle (cb => $_[0])
		1364	}
		1365
		1366	sub cv(;&) {
		1367	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1368	}
		1369
		1370	sub now() {
		1371	AnyEvent->now
		1372	}
		1373
		1374	sub now_update() {
		1375	AnyEvent->now_update
		1376	}
		1377
		1378	sub time() {
		1379	AnyEvent->time
		1380	}
		1381
1221	package AnyEvent::Base;	1382	package AnyEvent::Base;
1222		1383
1223	# default implementations for many methods	1384	# default implementations for many methods
1224		1385
1225	sub _time {	1386	sub _time() {
1226	# probe for availability of Time::HiRes	1387	# probe for availability of Time::HiRes
1227	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1388	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1228	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1389	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1229	*_time = \&Time::HiRes::time;	1390	*_time = \&Time::HiRes::time;
1230	# if (eval "use POSIX (); (POSIX::times())...	1391	# if (eval "use POSIX (); (POSIX::times())...
…		…
1247	}	1408	}
1248		1409
1249	# default implementation for ->signal	1410	# default implementation for ->signal
1250		1411
1251	our $HAVE_ASYNC_INTERRUPT;	1412	our $HAVE_ASYNC_INTERRUPT;
		1413
		1414	sub _have_async_interrupt() {
		1415	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1416	&& eval "use Async::Interrupt 1.02 (); 1")
		1417	unless defined $HAVE_ASYNC_INTERRUPT;
		1418
		1419	$HAVE_ASYNC_INTERRUPT
		1420	}
		1421
1252	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1422	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1253	our (%SIG_ASY, %SIG_ASY_W);	1423	our (%SIG_ASY, %SIG_ASY_W);
1254	our ($SIG_COUNT, $SIG_TW);	1424	our ($SIG_COUNT, $SIG_TW);
1255		1425
1256	sub _signal_exec {	1426	sub _signal_exec {
1257	$HAVE_ASYNC_INTERRUPT	1427	$HAVE_ASYNC_INTERRUPT
1258	? $SIGPIPE_R->drain	1428	? $SIGPIPE_R->drain
1259	: sysread $SIGPIPE_R, my $dummy, 9;	1429	: sysread $SIGPIPE_R, (my $dummy), 9;
1260		1430
1261	while (%SIG_EV) {	1431	while (%SIG_EV) {
1262	for (keys %SIG_EV) {	1432	for (keys %SIG_EV) {
1263	delete $SIG_EV{$_};	1433	delete $SIG_EV{$_};
1264	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1434	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1265	}	1435	}
1266	}	1436	}
1267	}	1437	}
1268		1438
		1439	# install a dummy wakeup watcher to reduce signal catching latency
1269	sub _signal {	1440	sub _sig_add() {
1270	my (undef, %arg) = @_;	1441	unless ($SIG_COUNT++) {
		1442	# try to align timer on a full-second boundary, if possible
		1443	my $NOW = AE::now;
1271		1444
1272	my $signal = uc $arg{signal}	1445	$SIG_TW = AE::timer
1273	or Carp::croak "required option 'signal' is missing";	1446	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1274		1447	$MAX_SIGNAL_LATENCY,
1275	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1448	sub { } # just for the PERL_ASYNC_CHECK
1276
1277	if ($HAVE_ASYNC_INTERRUPT) {
1278	# async::interrupt
1279
1280	$SIG_ASY{$signal} \|\|= do {
1281	my $asy = new Async::Interrupt
1282	cb => sub { undef $SIG_EV{$signal} },
1283	signal => $signal,
1284	pipe => [$SIGPIPE_R->filenos],
1285	;
1286	$asy->pipe_autodrain (0);
1287
1288	$asy
1289	};	1449	;
1290
1291	} else {
1292	# pure perl
1293
1294	$SIG{$signal} \|\|= sub {
1295	local $!;
1296	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1297	undef $SIG_EV{$signal};
1298	};
1299
1300	# can't do signal processing without introducing races in pure perl,
1301	# so limit the signal latency.
1302	++$SIG_COUNT;
1303	$SIG_TW \|\|= AnyEvent->timer (
1304	after => $MAX_SIGNAL_LATENCY,
1305	interval => $MAX_SIGNAL_LATENCY,
1306	cb => sub { }, # just for the PERL_ASYNC_CHECK
1307	);
1308	}	1450	}
1309
1310	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1311	}	1451	}
1312		1452
1313	sub signal {	1453	sub _sig_del {
1314	# probe for availability of Async::Interrupt
1315	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1316	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1317
1318	$HAVE_ASYNC_INTERRUPT = 1;
1319	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1320	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1321
1322	} else {
1323	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1324
1325	require Fcntl;
1326
1327	if (AnyEvent::WIN32) {
1328	require AnyEvent::Util;
1329
1330	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1331	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1332	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1333	} else {
1334	pipe $SIGPIPE_R, $SIGPIPE_W;
1335	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1336	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1337
1338	# not strictly required, as $^F is normally 2, but let's make sure...
1339	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1340	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1341	}
1342
1343	$SIGPIPE_R
1344	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1345
1346	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1347	}
1348
1349	*signal = \&_signal;
1350	&signal
1351	}
1352
1353	sub AnyEvent::Base::signal::DESTROY {
1354	my ($signal, $cb) = @{$_[0]};
1355
1356	undef $SIG_TW	1454	undef $SIG_TW
1357	unless --$SIG_COUNT;	1455	unless --$SIG_COUNT;
		1456	}
1358		1457
		1458	our $_sig_name_init; $_sig_name_init = sub {
		1459	eval q{ # poor man's autoloading
		1460	undef $_sig_name_init;
		1461
		1462	if (_have_async_interrupt) {
		1463	*sig2num = \&Async::Interrupt::sig2num;
		1464	*sig2name = \&Async::Interrupt::sig2name;
		1465	} else {
		1466	require Config;
		1467
		1468	my %signame2num;
		1469	@signame2num{ split ' ', $Config::Config{sig_name} }
		1470	= split ' ', $Config::Config{sig_num};
		1471
		1472	my @signum2name;
		1473	@signum2name[values %signame2num] = keys %signame2num;
		1474
		1475	*sig2num = sub($) {
		1476	$_[0] > 0 ? shift : $signame2num{+shift}
		1477	};
		1478	*sig2name = sub ($) {
		1479	$_[0] > 0 ? $signum2name[+shift] : shift
		1480	};
		1481	}
		1482	};
		1483	die if $@;
		1484	};
		1485
		1486	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1487	sub sig2name($) { &$_sig_name_init; &sig2name }
		1488
		1489	sub signal {
		1490	eval q{ # poor man's autoloading {}
		1491	# probe for availability of Async::Interrupt
		1492	if (_have_async_interrupt) {
		1493	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1494
		1495	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1496	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1497
		1498	} else {
		1499	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1500
		1501	require Fcntl;
		1502
		1503	if (AnyEvent::WIN32) {
		1504	require AnyEvent::Util;
		1505
		1506	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1507	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1508	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1509	} else {
		1510	pipe $SIGPIPE_R, $SIGPIPE_W;
		1511	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1512	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1513
		1514	# not strictly required, as $^F is normally 2, but let's make sure...
		1515	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1516	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1517	}
		1518
		1519	$SIGPIPE_R
		1520	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1521
		1522	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1523	}
		1524
		1525	*signal = sub {
		1526	my (undef, %arg) = @_;
		1527
		1528	my $signal = uc $arg{signal}
		1529	or Carp::croak "required option 'signal' is missing";
		1530
		1531	if ($HAVE_ASYNC_INTERRUPT) {
		1532	# async::interrupt
		1533
		1534	$signal = sig2num $signal;
		1535	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1536
		1537	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1538	cb => sub { undef $SIG_EV{$signal} },
		1539	signal => $signal,
		1540	pipe => [$SIGPIPE_R->filenos],
		1541	pipe_autodrain => 0,
		1542	;
		1543
		1544	} else {
		1545	# pure perl
		1546
		1547	# AE::Util has been loaded in signal
		1548	$signal = sig2name $signal;
		1549	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1550
		1551	$SIG{$signal} \|\|= sub {
		1552	local $!;
		1553	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1554	undef $SIG_EV{$signal};
		1555	};
		1556
		1557	# can't do signal processing without introducing races in pure perl,
		1558	# so limit the signal latency.
		1559	_sig_add;
		1560	}
		1561
		1562	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1563	};
		1564
		1565	*AnyEvent::Base::signal::DESTROY = sub {
		1566	my ($signal, $cb) = @{$_[0]};
		1567
		1568	_sig_del;
		1569
1359	delete $SIG_CB{$signal}{$cb};	1570	delete $SIG_CB{$signal}{$cb};
1360		1571
		1572	$HAVE_ASYNC_INTERRUPT
		1573	? delete $SIG_ASY{$signal}
1361	# delete doesn't work with older perls - they then	1574	: # delete doesn't work with older perls - they then
1362	# print weird messages, or just unconditionally exit	1575	# print weird messages, or just unconditionally exit
1363	# instead of getting the default action.	1576	# instead of getting the default action.
1364	undef $SIG{$signal}	1577	undef $SIG{$signal}
1365	unless keys %{ $SIG_CB{$signal} };	1578	unless keys %{ $SIG_CB{$signal} };
		1579	};
		1580	};
		1581	die if $@;
		1582	&signal
1366	}	1583	}
1367		1584
1368	# default implementation for ->child	1585	# default implementation for ->child
1369		1586
1370	our %PID_CB;	1587	our %PID_CB;
1371	our $CHLD_W;	1588	our $CHLD_W;
1372	our $CHLD_DELAY_W;	1589	our $CHLD_DELAY_W;
1373	our $WNOHANG;	1590	our $WNOHANG;
1374		1591
		1592	sub _emit_childstatus($$) {
		1593	my (undef, $rpid, $rstatus) = @_;
		1594
		1595	$_->($rpid, $rstatus)
		1596	for values %{ $PID_CB{$rpid} \|\| {} },
		1597	values %{ $PID_CB{0} \|\| {} };
		1598	}
		1599
1375	sub _sigchld {	1600	sub _sigchld {
		1601	my $pid;
		1602
		1603	AnyEvent->_emit_childstatus ($pid, $?)
1376	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1604	while ($pid = waitpid -1, $WNOHANG) > 0;
1377	$_->($pid, $?)
1378	for values %{ $PID_CB{$pid} \|\| {} },
1379	values %{ $PID_CB{0} \|\| {} };
1380	}
1381	}	1605	}
1382		1606
1383	sub child {	1607	sub child {
1384	my (undef, %arg) = @_;	1608	my (undef, %arg) = @_;
1385		1609
1386	defined (my $pid = $arg{pid} + 0)	1610	defined (my $pid = $arg{pid} + 0)
1387	or Carp::croak "required option 'pid' is missing";	1611	or Carp::croak "required option 'pid' is missing";
1388		1612
1389	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1613	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1390		1614
		1615	# WNOHANG is almost cetrainly 1 everywhere
		1616	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1617	? 1
1391	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1618	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1392		1619
1393	unless ($CHLD_W) {	1620	unless ($CHLD_W) {
1394	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1621	$CHLD_W = AE::signal CHLD => \&_sigchld;
1395	# child could be a zombie already, so make at least one round	1622	# child could be a zombie already, so make at least one round
1396	&_sigchld;	1623	&_sigchld;
1397	}	1624	}
1398		1625
1399	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1626	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1425	# never use more then 50% of the time for the idle watcher,	1652	# never use more then 50% of the time for the idle watcher,
1426	# within some limits	1653	# within some limits
1427	$w = 0.0001 if $w < 0.0001;	1654	$w = 0.0001 if $w < 0.0001;
1428	$w = 5 if $w > 5;	1655	$w = 5 if $w > 5;
1429		1656
1430	$w = AnyEvent->timer (after => $w, cb => $rcb);	1657	$w = AE::timer $w, 0, $rcb;
1431	} else {	1658	} else {
1432	# clean up...	1659	# clean up...
1433	undef $w;	1660	undef $w;
1434	undef $rcb;	1661	undef $rcb;
1435	}	1662	}
1436	};	1663	};
1437		1664
1438	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1665	$w = AE::timer 0.05, 0, $rcb;
1439		1666
1440	bless \\$cb, "AnyEvent::Base::idle"	1667	bless \\$cb, "AnyEvent::Base::idle"
1441	}	1668	}
1442		1669
1443	sub AnyEvent::Base::idle::DESTROY {	1670	sub AnyEvent::Base::idle::DESTROY {
…		…
1448		1675
1449	our @ISA = AnyEvent::CondVar::Base::;	1676	our @ISA = AnyEvent::CondVar::Base::;
1450		1677
1451	package AnyEvent::CondVar::Base;	1678	package AnyEvent::CondVar::Base;
1452		1679
1453	use overload	1680	#use overload
1454	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1681	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1455	fallback => 1;	1682	# fallback => 1;
		1683
		1684	# save 300+ kilobytes by dirtily hardcoding overloading
		1685	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1686	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1687	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1688	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1456		1689
1457	our $WAITING;	1690	our $WAITING;
1458		1691
1459	sub _send {	1692	sub _send {
1460	# nop	1693	# nop
…		…
1491	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1724	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1492	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1725	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1493	}	1726	}
1494		1727
1495	sub cb {	1728	sub cb {
1496	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1729	my $cv = shift;
		1730
		1731	@_
		1732	and $cv->{_ae_cb} = shift
		1733	and $cv->{_ae_sent}
		1734	and (delete $cv->{_ae_cb})->($cv);
		1735
1497	$_[0]{_ae_cb}	1736	$cv->{_ae_cb}
1498	}	1737	}
1499		1738
1500	sub begin {	1739	sub begin {
1501	++$_[0]{_ae_counter};	1740	++$_[0]{_ae_counter};
1502	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1741	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1551	C<PERL_ANYEVENT_MODEL>.	1790	C<PERL_ANYEVENT_MODEL>.
1552		1791
1553	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1792	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1554	model it chooses.	1793	model it chooses.
1555		1794
		1795	When set to C<8> or higher, then AnyEvent will report extra information on
		1796	which optional modules it loads and how it implements certain features.
		1797
1556	=item C<PERL_ANYEVENT_STRICT>	1798	=item C<PERL_ANYEVENT_STRICT>
1557		1799
1558	AnyEvent does not do much argument checking by default, as thorough	1800	AnyEvent does not do much argument checking by default, as thorough
1559	argument checking is very costly. Setting this variable to a true value	1801	argument checking is very costly. Setting this variable to a true value
1560	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1802	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1561	check the arguments passed to most method calls. If it finds any problems,	1803	check the arguments passed to most method calls. If it finds any problems,
1562	it will croak.	1804	it will croak.
1563		1805
1564	In other words, enables "strict" mode.	1806	In other words, enables "strict" mode.
1565		1807
1566	Unlike C<use strict>, it is definitely recommended to keep it off in	1808	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1567	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1809	>>, it is definitely recommended to keep it off in production. Keeping
1568	developing programs can be very useful, however.	1810	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1811	can be very useful, however.
1569		1812
1570	=item C<PERL_ANYEVENT_MODEL>	1813	=item C<PERL_ANYEVENT_MODEL>
1571		1814
1572	This can be used to specify the event model to be used by AnyEvent, before	1815	This can be used to specify the event model to be used by AnyEvent, before
1573	auto detection and -probing kicks in. It must be a string consisting	1816	auto detection and -probing kicks in. It must be a string consisting
…		…
1635		1878
1636	When neither C<ca_file> nor C<ca_path> was specified during	1879	When neither C<ca_file> nor C<ca_path> was specified during
1637	L<AnyEvent::TLS> context creation, and either of these environment	1880	L<AnyEvent::TLS> context creation, and either of these environment
1638	variables exist, they will be used to specify CA certificate locations	1881	variables exist, they will be used to specify CA certificate locations
1639	instead of a system-dependent default.	1882	instead of a system-dependent default.
		1883
		1884	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1885
		1886	When these are set to C<1>, then the respective modules are not
		1887	loaded. Mostly good for testing AnyEvent itself.
1640		1888
1641	=back	1889	=back
1642		1890
1643	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1891	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1644		1892
…		…
1702	warn "read: $input\n"; # output what has been read	1950	warn "read: $input\n"; # output what has been read
1703	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1951	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1704	},	1952	},
1705	);	1953	);
1706		1954
1707	my $time_watcher; # can only be used once
1708
1709	sub new_timer {
1710	$timer = AnyEvent->timer (after => 1, cb => sub {	1955	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1711	warn "timeout\n"; # print 'timeout' about every second	1956	warn "timeout\n"; # print 'timeout' at most every second
1712	&new_timer; # and restart the time
1713	});	1957	});
1714	}
1715
1716	new_timer; # create first timer
1717		1958
1718	$cv->recv; # wait until user enters /^q/i	1959	$cv->recv; # wait until user enters /^q/i
1719		1960
1720	=head1 REAL-WORLD EXAMPLE	1961	=head1 REAL-WORLD EXAMPLE
1721		1962
…		…
1852	through AnyEvent. The benchmark creates a lot of timers (with a zero	2093	through AnyEvent. The benchmark creates a lot of timers (with a zero
1853	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2094	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1854	which it is), lets them fire exactly once and destroys them again.	2095	which it is), lets them fire exactly once and destroys them again.
1855		2096
1856	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2097	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1857	distribution.	2098	distribution. It uses the L<AE> interface, which makes a real difference
		2099	for the EV and Perl backends only.
1858		2100
1859	=head3 Explanation of the columns	2101	=head3 Explanation of the columns
1860		2102
1861	I<watcher> is the number of event watchers created/destroyed. Since	2103	I<watcher> is the number of event watchers created/destroyed. Since
1862	different event models feature vastly different performances, each event	2104	different event models feature vastly different performances, each event
…		…
1883	watcher.	2125	watcher.
1884		2126
1885	=head3 Results	2127	=head3 Results
1886		2128
1887	name watchers bytes create invoke destroy comment	2129	name watchers bytes create invoke destroy comment
1888	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2130	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1889	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2131	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1890	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2132	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1891	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2133	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1892	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2134	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1893	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2135	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1894	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2136	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1895	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2137	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1896	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2138	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1897	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2139	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1898	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2140	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1899	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2141	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1900		2142
1901	=head3 Discussion	2143	=head3 Discussion
1902		2144
1903	The benchmark does I<not> measure scalability of the event loop very	2145	The benchmark does I<not> measure scalability of the event loop very
1904	well. For example, a select-based event loop (such as the pure perl one)	2146	well. For example, a select-based event loop (such as the pure perl one)
…		…
1916	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2158	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1917	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2159	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1918	cycles with POE.	2160	cycles with POE.
1919		2161
1920	C<EV> is the sole leader regarding speed and memory use, which are both	2162	C<EV> is the sole leader regarding speed and memory use, which are both
1921	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2163	maximal/minimal, respectively. When using the L<AE> API there is zero
		2164	overhead (when going through the AnyEvent API create is about 5-6 times
		2165	slower, with other times being equal, so still uses far less memory than
1922	far less memory than any other event loop and is still faster than Event	2166	any other event loop and is still faster than Event natively).
1923	natively.
1924		2167
1925	The pure perl implementation is hit in a few sweet spots (both the	2168	The pure perl implementation is hit in a few sweet spots (both the
1926	constant timeout and the use of a single fd hit optimisations in the perl	2169	constant timeout and the use of a single fd hit optimisations in the perl
1927	interpreter and the backend itself). Nevertheless this shows that it	2170	interpreter and the backend itself). Nevertheless this shows that it
1928	adds very little overhead in itself. Like any select-based backend its	2171	adds very little overhead in itself. Like any select-based backend its
…		…
2002	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2245	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2003	(1%) are active. This mirrors the activity of large servers with many	2246	(1%) are active. This mirrors the activity of large servers with many
2004	connections, most of which are idle at any one point in time.	2247	connections, most of which are idle at any one point in time.
2005		2248
2006	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2249	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2007	distribution.	2250	distribution. It uses the L<AE> interface, which makes a real difference
		2251	for the EV and Perl backends only.
2008		2252
2009	=head3 Explanation of the columns	2253	=head3 Explanation of the columns
2010		2254
2011	I<sockets> is the number of sockets, and twice the number of "servers" (as	2255	I<sockets> is the number of sockets, and twice the number of "servers" (as
2012	each server has a read and write socket end).	2256	each server has a read and write socket end).
…		…
2020	a new one that moves the timeout into the future.	2264	a new one that moves the timeout into the future.
2021		2265
2022	=head3 Results	2266	=head3 Results
2023		2267
2024	name sockets create request	2268	name sockets create request
2025	EV 20000 69.01 11.16	2269	EV 20000 62.66 7.99
2026	Perl 20000 73.32 35.87	2270	Perl 20000 68.32 32.64
2027	IOAsync 20000 157.00 98.14 epoll	2271	IOAsync 20000 174.06 101.15 epoll
2028	IOAsync 20000 159.31 616.06 poll	2272	IOAsync 20000 174.67 610.84 poll
2029	Event 20000 212.62 257.32	2273	Event 20000 202.69 242.91
2030	Glib 20000 651.16 1896.30	2274	Glib 20000 557.01 1689.52
2031	POE 20000 349.67 12317.24 uses POE::Loop::Event	2275	POE 20000 341.54 12086.32 uses POE::Loop::Event
2032		2276
2033	=head3 Discussion	2277	=head3 Discussion
2034		2278
2035	This benchmark I<does> measure scalability and overall performance of the	2279	This benchmark I<does> measure scalability and overall performance of the
2036	particular event loop.	2280	particular event loop.
…		…
2162	As you can see, the AnyEvent + EV combination even beats the	2406	As you can see, the AnyEvent + EV combination even beats the
2163	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2407	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2164	backend easily beats IO::Lambda and POE.	2408	backend easily beats IO::Lambda and POE.
2165		2409
2166	And even the 100% non-blocking version written using the high-level (and	2410	And even the 100% non-blocking version written using the high-level (and
2167	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2411	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2168	large margin, even though it does all of DNS, tcp-connect and socket I/O	2412	higher level ("unoptimised") abstractions by a large margin, even though
2169	in a non-blocking way.	2413	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2170		2414
2171	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2415	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2172	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2416	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2173	part of the IO::lambda distribution and were used without any changes.	2417	part of the IO::Lambda distribution and were used without any changes.
2174		2418
2175		2419
2176	=head1 SIGNALS	2420	=head1 SIGNALS
2177		2421
2178	AnyEvent currently installs handlers for these signals:	2422	AnyEvent currently installs handlers for these signals:
…		…
2220	it's built-in modules) are required to use it.	2464	it's built-in modules) are required to use it.
2221		2465
2222	That does not mean that AnyEvent won't take advantage of some additional	2466	That does not mean that AnyEvent won't take advantage of some additional
2223	modules if they are installed.	2467	modules if they are installed.
2224		2468
2225	This section epxlains which additional modules will be used, and how they	2469	This section explains which additional modules will be used, and how they
2226	affect AnyEvent's operetion.	2470	affect AnyEvent's operation.
2227		2471
2228	=over 4	2472	=over 4
2229		2473
2230	=item L<Async::Interrupt>	2474	=item L<Async::Interrupt>
2231		2475
2232	This slightly arcane module is used to implement fast signal handling: To	2476	This slightly arcane module is used to implement fast signal handling: To
2233	my knowledge, there is no way to do completely race-free and quick	2477	my knowledge, there is no way to do completely race-free and quick
2234	signal handling in pure perl. To ensure that signals still get	2478	signal handling in pure perl. To ensure that signals still get
2235	delivered, AnyEvent will start an interval timer to wake up perl (and	2479	delivered, AnyEvent will start an interval timer to wake up perl (and
2236	catch the signals) with soemd elay (default is 10 seconds, look for	2480	catch the signals) with some delay (default is 10 seconds, look for
2237	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2481	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2238		2482
2239	If this module is available, then it will be used to implement signal	2483	If this module is available, then it will be used to implement signal
2240	catching, which means that signals will not be delayed, and the event loop	2484	catching, which means that signals will not be delayed, and the event loop
2241	will not be interrupted regularly, which is more efficient (And good for	2485	will not be interrupted regularly, which is more efficient (and good for
2242	battery life on laptops).	2486	battery life on laptops).
2243		2487
2244	This affects not just the pure-perl event loop, but also other event loops	2488	This affects not just the pure-perl event loop, but also other event loops
2245	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2489	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2490
		2491	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2492	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2493	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2494	does nothing for those backends.
2246		2495
2247	=item L<EV>	2496	=item L<EV>
2248		2497
2249	This module isn't really "optional", as it is simply one of the backend	2498	This module isn't really "optional", as it is simply one of the backend
2250	event loops that AnyEvent can use. However, it is simply the best event	2499	event loops that AnyEvent can use. However, it is simply the best event
…		…
2262	lot less memory), but otherwise doesn't affect guard operation much. It is	2511	lot less memory), but otherwise doesn't affect guard operation much. It is
2263	purely used for performance.	2512	purely used for performance.
2264		2513
2265	=item L<JSON> and L<JSON::XS>	2514	=item L<JSON> and L<JSON::XS>
2266		2515
2267	This module is required when you want to read or write JSON data via	2516	One of these modules is required when you want to read or write JSON data
2268	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2517	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2269	advantage of the ulta-high-speed L<JSON::XS> module when it is installed.	2518	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2270		2519
2271	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2520	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2272	installed.	2521	installed.
2273		2522
2274	=item L<Net::SSLeay>	2523	=item L<Net::SSLeay>
…		…
2288		2537
2289		2538
2290	=head1 FORK	2539	=head1 FORK
2291		2540
2292	Most event libraries are not fork-safe. The ones who are usually are	2541	Most event libraries are not fork-safe. The ones who are usually are
2293	because they rely on inefficient but fork-safe C<select> or C<poll>	2542	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2294	calls. Only L<EV> is fully fork-aware.	2543	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2544	are usually badly thought-out hacks that are incompatible with fork in
		2545	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2546	continue event-processing in both parent and child (or both, if you know
		2547	what you are doing).
		2548
		2549	This means that, in general, you cannot fork and do event processing in
		2550	the child if the event library was initialised before the fork (which
		2551	usually happens when the first AnyEvent watcher is created, or the library
		2552	is loaded).
2295		2553
2296	If you have to fork, you must either do so I<before> creating your first	2554	If you have to fork, you must either do so I<before> creating your first
2297	watcher OR you must not use AnyEvent at all in the child OR you must do	2555	watcher OR you must not use AnyEvent at all in the child OR you must do
2298	something completely out of the scope of AnyEvent.	2556	something completely out of the scope of AnyEvent.
		2557
		2558	The problem of doing event processing in the parent I<and> the child
		2559	is much more complicated: even for backends that I<are> fork-aware or
		2560	fork-safe, their behaviour is not usually what you want: fork clones all
		2561	watchers, that means all timers, I/O watchers etc. are active in both
		2562	parent and child, which is almost never what you want. USing C<exec>
		2563	to start worker children from some kind of manage rprocess is usually
		2564	preferred, because it is much easier and cleaner, at the expense of having
		2565	to have another binary.
2299		2566
2300		2567
2301	=head1 SECURITY CONSIDERATIONS	2568	=head1 SECURITY CONSIDERATIONS
2302		2569
2303	AnyEvent can be forced to load any event model via	2570	AnyEvent can be forced to load any event model via
…		…
2341	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2608	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2342		2609
2343	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2610	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2344	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2611	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2345	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2612	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2346	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2613	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2347		2614
2348	Non-blocking file handles, sockets, TCP clients and	2615	Non-blocking file handles, sockets, TCP clients and
2349	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2616	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2350		2617
2351	Asynchronous DNS: L<AnyEvent::DNS>.	2618	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.242 by root, Fri Jul 17 22:05:12 2009 UTC vs. Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.242 by root, Fri Jul 17 22:05:12 2009 UTC vs.
Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC