[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.302 by root, Fri Dec 4 16:31:57 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
		506	$w = AnyEvent->idle (cb => <callback>);
		507
446	Sometimes there is a need to do something, but it is not so important	508	Sometimes there is a need to do something, but it is not so important
447	to do it instantly, but only when there is nothing better to do. This	509	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	510	"nothing better to do" is usually defined to be "no other events need
449	attention by the event loop".	511	attention by the event loop".
450		512
…		…
476	});	538	});
477	});	539	});
478		540
479	=head2 CONDITION VARIABLES	541	=head2 CONDITION VARIABLES
480		542
		543	$cv = AnyEvent->condvar;
		544
		545	$cv->send (<list>);
		546	my @res = $cv->recv;
		547
481	If you are familiar with some event loops you will know that all of them	548	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	549	require you to run some blocking "loop", "run" or similar function that
483	will actively watch for new events and call your callbacks.	550	will actively watch for new events and call your callbacks.
484		551
485	AnyEvent is slightly different: it expects somebody else to run the event	552	AnyEvent is slightly different: it expects somebody else to run the event
…		…
504	Condition variables are similar to callbacks, except that you can	571	Condition variables are similar to callbacks, except that you can
505	optionally wait for them. They can also be called merge points - points	572	optionally wait for them. They can also be called merge points - points
506	in time where multiple outstanding events have been processed. And yet	573	in time where multiple outstanding events have been processed. And yet
507	another way to call them is transactions - each condition variable can be	574	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	575	used to represent a transaction, which finishes at some point and delivers
509	a result.	576	a result. And yet some people know them as "futures" - a promise to
		577	compute/deliver something that you can wait for.
510		578
511	Condition variables are very useful to signal that something has finished,	579	Condition variables are very useful to signal that something has finished,
512	for example, if you write a module that does asynchronous http requests,	580	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	581	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	582	availability of results. The user can either act when the callback is
…		…
548	after => 1,	616	after => 1,
549	cb => sub { $result_ready->send },	617	cb => sub { $result_ready->send },
550	);	618	);
551		619
552	# this "blocks" (while handling events) till the callback	620	# this "blocks" (while handling events) till the callback
553	# calls -<send	621	# calls ->send
554	$result_ready->recv;	622	$result_ready->recv;
555		623
556	Example: wait for a timer, but take advantage of the fact that condition	624	Example: wait for a timer, but take advantage of the fact that condition
557	variables are also callable directly.	625	variables are also callable directly.
558		626
…		…
622	one. For example, a function that pings many hosts in parallel might want	690	one. For example, a function that pings many hosts in parallel might want
623	to use a condition variable for the whole process.	691	to use a condition variable for the whole process.
624		692
625	Every call to C<< ->begin >> will increment a counter, and every call to	693	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	694	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	695	>>, 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	696	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.	697	>>, but that is not required. If no group callback was set, C<send> will
		698	be called without any arguments.
630		699
631	You can think of C<< $cv->send >> giving you an OR condition (one call	700	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	701	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).	702	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
634		703
…		…
661	begung can potentially be zero:	730	begung can potentially be zero:
662		731
663	my $cv = AnyEvent->condvar;	732	my $cv = AnyEvent->condvar;
664		733
665	my %result;	734	my %result;
666	$cv->begin (sub { $cv->send (\%result) });	735	$cv->begin (sub { shift->send (\%result) });
667		736
668	for my $host (@list_of_hosts) {	737	for my $host (@list_of_hosts) {
669	$cv->begin;	738	$cv->begin;
670	ping_host_then_call_callback $host, sub {	739	ping_host_then_call_callback $host, sub {
671	$result{$host} = ...;	740	$result{$host} = ...;
…		…
746	=item $cb = $cv->cb ($cb->($cv))	815	=item $cb = $cv->cb ($cb->($cv))
747		816
748	This is a mutator function that returns the callback set and optionally	817	This is a mutator function that returns the callback set and optionally
749	replaces it before doing so.	818	replaces it before doing so.
750		819
751	The callback will be called when the condition becomes "true", i.e. when	820	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	821	"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	822	the only argument being the condition variable itself. Calling C<recv>
754	is guaranteed not to block.	823	inside the callback or at any later time is guaranteed not to block.
755		824
756	=back	825	=back
757		826
758	=head1 SUPPORTED EVENT LOOPS/BACKENDS	827	=head1 SUPPORTED EVENT LOOPS/BACKENDS
759		828
…		…
762	=over 4	831	=over 4
763		832
764	=item Backends that are autoprobed when no other event loop can be found.	833	=item Backends that are autoprobed when no other event loop can be found.
765		834
766	EV is the preferred backend when no other event loop seems to be in	835	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	836	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	837	pure-perl implementation, which is available everywhere as it comes with
769	available everywhere as it comes with AnyEvent itself.	838	AnyEvent itself.
770		839
771	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	840	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.	841	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
774		842
775	=item Backends that are transparently being picked up when they are used.	843	=item Backends that are transparently being picked up when they are used.
776		844
777	These will be used when they are currently loaded when the first watcher	845	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	846	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	847	them. This means that AnyEvent will automatically pick the right backend
780	when the main program loads an event module before anything starts to	848	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.	849	create watchers. Nothing special needs to be done by the main program.
782		850
		851	AnyEvent::Impl::Event based on Event, very stable, few glitches.
783	AnyEvent::Impl::Glib based on Glib, slow but very stable.	852	AnyEvent::Impl::Glib based on Glib, slow but very stable.
784	AnyEvent::Impl::Tk based on Tk, very broken.	853	AnyEvent::Impl::Tk based on Tk, very broken.
785	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	854	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786	AnyEvent::Impl::POE based on POE, very slow, some limitations.	855	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		856	AnyEvent::Impl::Irssi used when running within irssi.
787		857
788	=item Backends with special needs.	858	=item Backends with special needs.
789		859
790	Qt requires the Qt::Application to be instantiated first, but will	860	Qt requires the Qt::Application to be instantiated first, but will
791	otherwise be picked up automatically. As long as the main program	861	otherwise be picked up automatically. As long as the main program
…		…
865	event module detection too early, for example, L<AnyEvent::AIO> creates	935	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	936	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867	avoid autodetecting the event module at load time.	937	avoid autodetecting the event module at load time.
868		938
869	If called in scalar or list context, then it creates and returns an object	939	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	940	that automatically removes the callback again when it is destroyed (or
		941	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
871	L<Coro::BDB> for a case where this is useful.	942	a case where this is useful.
		943
		944	Example: Create a watcher for the IO::AIO module and store it in
		945	C<$WATCHER>. Only do so after the event loop is initialised, though.
		946
		947	our WATCHER;
		948
		949	my $guard = AnyEvent::post_detect {
		950	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		951	};
		952
		953	# the \|\|= is important in case post_detect immediately runs the block,
		954	# as to not clobber the newly-created watcher. assigning both watcher and
		955	# post_detect guard to the same variable has the advantage of users being
		956	# able to just C<undef $WATCHER> if the watcher causes them grief.
		957
		958	$WATCHER \|\|= $guard;
872		959
873	=item @AnyEvent::post_detect	960	=item @AnyEvent::post_detect
874		961
875	If there are any code references in this array (you can C<push> to it	962	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	963	before or after loading AnyEvent), then they will called directly after
…		…
1041		1128
1042	=cut	1129	=cut
1043		1130
1044	package AnyEvent;	1131	package AnyEvent;
1045		1132
1046	no warnings;	1133	# basically a tuned-down version of common::sense
		1134	sub common_sense {
		1135	# from common:.sense 1.0
		1136	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1047	use strict qw(vars subs);	1137	# use strict vars subs
		1138	$^H \|= 0x00000600;
		1139	}
		1140
		1141	BEGIN { AnyEvent::common_sense }
1048		1142
1049	use Carp ();	1143	use Carp ();
1050		1144
1051	our $VERSION = 4.83;	1145	our $VERSION = '5.21';
1052	our $MODEL;	1146	our $MODEL;
1053		1147
1054	our $AUTOLOAD;	1148	our $AUTOLOAD;
1055	our @ISA;	1149	our @ISA;
1056		1150
1057	our @REGISTRY;	1151	our @REGISTRY;
1058
1059	our $WIN32;
1060		1152
1061	our $VERBOSE;	1153	our $VERBOSE;
1062		1154
1063	BEGIN {	1155	BEGIN {
1064	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1156	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
…		…
1081	for reverse split /\s,\s/,	1173	for reverse split /\s,\s/,
1082	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1174	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1083	}	1175	}
1084		1176
1085	my @models = (	1177	my @models = (
1086	[EV:: => AnyEvent::Impl::EV::],	1178	[EV:: => AnyEvent::Impl::EV:: , 1],
1087	[Event:: => AnyEvent::Impl::Event::],
1088	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1179	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1089	# everything below here will not be autoprobed	1180	# everything below here will not (normally) be autoprobed
1090	# as the pureperl backend should work everywhere	1181	# as the pureperl backend should work everywhere
1091	# and is usually faster	1182	# and is usually faster
		1183	[Event:: => AnyEvent::Impl::Event::, 1],
1092	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1184	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1093	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1185	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1186	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1094	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1187	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1095	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1188	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1096	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1189	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1097	[Wx:: => AnyEvent::Impl::POE::],	1190	[Wx:: => AnyEvent::Impl::POE::],
1098	[Prima:: => AnyEvent::Impl::POE::],	1191	[Prima:: => AnyEvent::Impl::POE::],
1099	# IO::Async is just too broken - we would need workarounds for its	1192	# IO::Async is just too broken - we would need workarounds for its
1100	# byzantine signal and broken child handling, among others.	1193	# byzantine signal and broken child handling, among others.
1101	# IO::Async is rather hard to detect, as it doesn't have any	1194	# IO::Async is rather hard to detect, as it doesn't have any
1102	# obvious default class.	1195	# obvious default class.
1103	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1196	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1104	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1197	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1105	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1198	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1199	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1106	);	1200	);
1107		1201
1108	our %method = map +($_ => 1),	1202	our %method = map +($_ => 1),
1109	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1203	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1110		1204
…		…
1114	my ($cb) = @_;	1208	my ($cb) = @_;
1115		1209
1116	if ($MODEL) {	1210	if ($MODEL) {
1117	$cb->();	1211	$cb->();
1118		1212
1119	1	1213	undef
1120	} else {	1214	} else {
1121	push @post_detect, $cb;	1215	push @post_detect, $cb;
1122		1216
1123	defined wantarray	1217	defined wantarray
1124	? bless \$cb, "AnyEvent::Util::postdetect"	1218	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1130	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1224	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1131	}	1225	}
1132		1226
1133	sub detect() {	1227	sub detect() {
1134	unless ($MODEL) {	1228	unless ($MODEL) {
1135	no strict 'refs';
1136	local $SIG{__DIE__};	1229	local $SIG{__DIE__};
1137		1230
1138	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1231	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1139	my $model = "AnyEvent::Impl::$1";	1232	my $model = "AnyEvent::Impl::$1";
1140	if (eval "require $model") {	1233	if (eval "require $model") {
…		…
1157	}	1250	}
1158	}	1251	}
1159	}	1252	}
1160		1253
1161	unless ($MODEL) {	1254	unless ($MODEL) {
1162	# try to load a model	1255	# try to autoload a model
1163
1164	for (@REGISTRY, @models) {	1256	for (@REGISTRY, @models) {
1165	my ($package, $model) = @$_;	1257	my ($package, $model, $autoload) = @$_;
		1258	if (
		1259	$autoload
1166	if (eval "require $package"	1260	and eval "require $package"
1167	and ${"$package\::VERSION"} > 0	1261	and ${"$package\::VERSION"} > 0
1168	and eval "require $model") {	1262	and eval "require $model"
		1263	) {
1169	$MODEL = $model;	1264	$MODEL = $model;
1170	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1265	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1171	last;	1266	last;
1172	}	1267	}
1173	}	1268	}
1174		1269
1175	$MODEL	1270	$MODEL
…		…
1216	# we assume CLOEXEC is already set by perl in all important cases	1311	# we assume CLOEXEC is already set by perl in all important cases
1217		1312
1218	($fh2, $rw)	1313	($fh2, $rw)
1219	}	1314	}
1220		1315
		1316	=head1 SIMPLIFIED AE API
		1317
		1318	Starting with version 5.0, AnyEvent officially supports a second, much
		1319	simpler, API that is designed to reduce the calling, typing and memory
		1320	overhead.
		1321
		1322	See the L<AE> manpage for details.
		1323
		1324	=cut
		1325
		1326	package AE;
		1327
		1328	our $VERSION = $AnyEvent::VERSION;
		1329
		1330	sub io($$$) {
		1331	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1332	}
		1333
		1334	sub timer($$$) {
		1335	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1336	}
		1337
		1338	sub signal($$) {
		1339	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1340	}
		1341
		1342	sub child($$) {
		1343	AnyEvent->child (pid => $_[0], cb => $_[1])
		1344	}
		1345
		1346	sub idle($) {
		1347	AnyEvent->idle (cb => $_[0])
		1348	}
		1349
		1350	sub cv(;&) {
		1351	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1352	}
		1353
		1354	sub now() {
		1355	AnyEvent->now
		1356	}
		1357
		1358	sub now_update() {
		1359	AnyEvent->now_update
		1360	}
		1361
		1362	sub time() {
		1363	AnyEvent->time
		1364	}
		1365
1221	package AnyEvent::Base;	1366	package AnyEvent::Base;
1222		1367
1223	# default implementations for many methods	1368	# default implementations for many methods
1224		1369
1225	sub _time {	1370	sub _time() {
1226	# probe for availability of Time::HiRes	1371	# probe for availability of Time::HiRes
1227	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1372	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1228	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1373	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1229	*_time = \&Time::HiRes::time;	1374	*_time = \&Time::HiRes::time;
1230	# if (eval "use POSIX (); (POSIX::times())...	1375	# if (eval "use POSIX (); (POSIX::times())...
…		…
1247	}	1392	}
1248		1393
1249	# default implementation for ->signal	1394	# default implementation for ->signal
1250		1395
1251	our $HAVE_ASYNC_INTERRUPT;	1396	our $HAVE_ASYNC_INTERRUPT;
		1397
		1398	sub _have_async_interrupt() {
		1399	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1400	&& eval "use Async::Interrupt 1.02 (); 1")
		1401	unless defined $HAVE_ASYNC_INTERRUPT;
		1402
		1403	$HAVE_ASYNC_INTERRUPT
		1404	}
		1405
1252	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1406	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1253	our (%SIG_ASY, %SIG_ASY_W);	1407	our (%SIG_ASY, %SIG_ASY_W);
1254	our ($SIG_COUNT, $SIG_TW);	1408	our ($SIG_COUNT, $SIG_TW);
1255		1409
1256	sub _signal_exec {	1410	sub _signal_exec {
1257	$HAVE_ASYNC_INTERRUPT	1411	$HAVE_ASYNC_INTERRUPT
1258	? $SIGPIPE_R->drain	1412	? $SIGPIPE_R->drain
1259	: sysread $SIGPIPE_R, my $dummy, 9;	1413	: sysread $SIGPIPE_R, (my $dummy), 9;
1260		1414
1261	while (%SIG_EV) {	1415	while (%SIG_EV) {
1262	for (keys %SIG_EV) {	1416	for (keys %SIG_EV) {
1263	delete $SIG_EV{$_};	1417	delete $SIG_EV{$_};
1264	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1418	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1265	}	1419	}
1266	}	1420	}
1267	}	1421	}
1268		1422
		1423	# install a dummy wakeup watcher to reduce signal catching latency
1269	sub _signal {	1424	sub _sig_add() {
1270	my (undef, %arg) = @_;	1425	unless ($SIG_COUNT++) {
		1426	# try to align timer on a full-second boundary, if possible
		1427	my $NOW = AE::now;
1271		1428
1272	my $signal = uc $arg{signal}	1429	$SIG_TW = AE::timer
1273	or Carp::croak "required option 'signal' is missing";	1430	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1274		1431	$MAX_SIGNAL_LATENCY,
1275	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1432	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	};	1433	;
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	}	1434	}
1309
1310	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1311	}	1435	}
1312		1436
1313	sub signal {	1437	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	1438	undef $SIG_TW
1357	unless --$SIG_COUNT;	1439	unless --$SIG_COUNT;
		1440	}
1358		1441
		1442	our $_sig_name_init; $_sig_name_init = sub {
		1443	eval q{ # poor man's autoloading
		1444	undef $_sig_name_init;
		1445
		1446	if (_have_async_interrupt) {
		1447	*sig2num = \&Async::Interrupt::sig2num;
		1448	*sig2name = \&Async::Interrupt::sig2name;
		1449	} else {
		1450	require Config;
		1451
		1452	my %signame2num;
		1453	@signame2num{ split ' ', $Config::Config{sig_name} }
		1454	= split ' ', $Config::Config{sig_num};
		1455
		1456	my @signum2name;
		1457	@signum2name[values %signame2num] = keys %signame2num;
		1458
		1459	*sig2num = sub($) {
		1460	$_[0] > 0 ? shift : $signame2num{+shift}
		1461	};
		1462	*sig2name = sub ($) {
		1463	$_[0] > 0 ? $signum2name[+shift] : shift
		1464	};
		1465	}
		1466	};
		1467	die if $@;
		1468	};
		1469
		1470	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1471	sub sig2name($) { &$_sig_name_init; &sig2name }
		1472
		1473	sub signal {
		1474	eval q{ # poor man's autoloading {}
		1475	# probe for availability of Async::Interrupt
		1476	if (_have_async_interrupt) {
		1477	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1478
		1479	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1480	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1481
		1482	} else {
		1483	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1484
		1485	require Fcntl;
		1486
		1487	if (AnyEvent::WIN32) {
		1488	require AnyEvent::Util;
		1489
		1490	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1491	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1492	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1493	} else {
		1494	pipe $SIGPIPE_R, $SIGPIPE_W;
		1495	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1496	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1497
		1498	# not strictly required, as $^F is normally 2, but let's make sure...
		1499	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1500	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1501	}
		1502
		1503	$SIGPIPE_R
		1504	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1505
		1506	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1507	}
		1508
		1509	*signal = sub {
		1510	my (undef, %arg) = @_;
		1511
		1512	my $signal = uc $arg{signal}
		1513	or Carp::croak "required option 'signal' is missing";
		1514
		1515	if ($HAVE_ASYNC_INTERRUPT) {
		1516	# async::interrupt
		1517
		1518	$signal = sig2num $signal;
		1519	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1520
		1521	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1522	cb => sub { undef $SIG_EV{$signal} },
		1523	signal => $signal,
		1524	pipe => [$SIGPIPE_R->filenos],
		1525	pipe_autodrain => 0,
		1526	;
		1527
		1528	} else {
		1529	# pure perl
		1530
		1531	# AE::Util has been loaded in signal
		1532	$signal = sig2name $signal;
		1533	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1534
		1535	$SIG{$signal} \|\|= sub {
		1536	local $!;
		1537	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1538	undef $SIG_EV{$signal};
		1539	};
		1540
		1541	# can't do signal processing without introducing races in pure perl,
		1542	# so limit the signal latency.
		1543	_sig_add;
		1544	}
		1545
		1546	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1547	};
		1548
		1549	*AnyEvent::Base::signal::DESTROY = sub {
		1550	my ($signal, $cb) = @{$_[0]};
		1551
		1552	_sig_del;
		1553
1359	delete $SIG_CB{$signal}{$cb};	1554	delete $SIG_CB{$signal}{$cb};
1360		1555
		1556	$HAVE_ASYNC_INTERRUPT
		1557	? delete $SIG_ASY{$signal}
1361	# delete doesn't work with older perls - they then	1558	: # delete doesn't work with older perls - they then
1362	# print weird messages, or just unconditionally exit	1559	# print weird messages, or just unconditionally exit
1363	# instead of getting the default action.	1560	# instead of getting the default action.
1364	undef $SIG{$signal}	1561	undef $SIG{$signal}
1365	unless keys %{ $SIG_CB{$signal} };	1562	unless keys %{ $SIG_CB{$signal} };
		1563	};
		1564	};
		1565	die if $@;
		1566	&signal
1366	}	1567	}
1367		1568
1368	# default implementation for ->child	1569	# default implementation for ->child
1369		1570
1370	our %PID_CB;	1571	our %PID_CB;
1371	our $CHLD_W;	1572	our $CHLD_W;
1372	our $CHLD_DELAY_W;	1573	our $CHLD_DELAY_W;
1373	our $WNOHANG;	1574	our $WNOHANG;
1374		1575
		1576	sub _emit_childstatus($$) {
		1577	my (undef, $rpid, $rstatus) = @_;
		1578
		1579	$_->($rpid, $rstatus)
		1580	for values %{ $PID_CB{$rpid} \|\| {} },
		1581	values %{ $PID_CB{0} \|\| {} };
		1582	}
		1583
1375	sub _sigchld {	1584	sub _sigchld {
		1585	my $pid;
		1586
		1587	AnyEvent->_emit_childstatus ($pid, $?)
1376	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1588	while ($pid = waitpid -1, $WNOHANG) > 0;
1377	$_->($pid, $?)
1378	for values %{ $PID_CB{$pid} \|\| {} },
1379	values %{ $PID_CB{0} \|\| {} };
1380	}
1381	}	1589	}
1382		1590
1383	sub child {	1591	sub child {
1384	my (undef, %arg) = @_;	1592	my (undef, %arg) = @_;
1385		1593
1386	defined (my $pid = $arg{pid} + 0)	1594	defined (my $pid = $arg{pid} + 0)
1387	or Carp::croak "required option 'pid' is missing";	1595	or Carp::croak "required option 'pid' is missing";
1388		1596
1389	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1597	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1390		1598
		1599	# WNOHANG is almost cetrainly 1 everywhere
		1600	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1601	? 1
1391	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1602	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1392		1603
1393	unless ($CHLD_W) {	1604	unless ($CHLD_W) {
1394	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1605	$CHLD_W = AE::signal CHLD => \&_sigchld;
1395	# child could be a zombie already, so make at least one round	1606	# child could be a zombie already, so make at least one round
1396	&_sigchld;	1607	&_sigchld;
1397	}	1608	}
1398		1609
1399	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1610	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1425	# never use more then 50% of the time for the idle watcher,	1636	# never use more then 50% of the time for the idle watcher,
1426	# within some limits	1637	# within some limits
1427	$w = 0.0001 if $w < 0.0001;	1638	$w = 0.0001 if $w < 0.0001;
1428	$w = 5 if $w > 5;	1639	$w = 5 if $w > 5;
1429		1640
1430	$w = AnyEvent->timer (after => $w, cb => $rcb);	1641	$w = AE::timer $w, 0, $rcb;
1431	} else {	1642	} else {
1432	# clean up...	1643	# clean up...
1433	undef $w;	1644	undef $w;
1434	undef $rcb;	1645	undef $rcb;
1435	}	1646	}
1436	};	1647	};
1437		1648
1438	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1649	$w = AE::timer 0.05, 0, $rcb;
1439		1650
1440	bless \\$cb, "AnyEvent::Base::idle"	1651	bless \\$cb, "AnyEvent::Base::idle"
1441	}	1652	}
1442		1653
1443	sub AnyEvent::Base::idle::DESTROY {	1654	sub AnyEvent::Base::idle::DESTROY {
…		…
1448		1659
1449	our @ISA = AnyEvent::CondVar::Base::;	1660	our @ISA = AnyEvent::CondVar::Base::;
1450		1661
1451	package AnyEvent::CondVar::Base;	1662	package AnyEvent::CondVar::Base;
1452		1663
1453	use overload	1664	#use overload
1454	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1665	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1455	fallback => 1;	1666	# fallback => 1;
		1667
		1668	# save 300+ kilobytes by dirtily hardcoding overloading
		1669	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1670	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1671	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1672	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1456		1673
1457	our $WAITING;	1674	our $WAITING;
1458		1675
1459	sub _send {	1676	sub _send {
1460	# nop	1677	# nop
…		…
1491	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1708	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1492	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1709	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1493	}	1710	}
1494		1711
1495	sub cb {	1712	sub cb {
1496	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1713	my $cv = shift;
		1714
		1715	@_
		1716	and $cv->{_ae_cb} = shift
		1717	and $cv->{_ae_sent}
		1718	and (delete $cv->{_ae_cb})->($cv);
		1719
1497	$_[0]{_ae_cb}	1720	$cv->{_ae_cb}
1498	}	1721	}
1499		1722
1500	sub begin {	1723	sub begin {
1501	++$_[0]{_ae_counter};	1724	++$_[0]{_ae_counter};
1502	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1725	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1551	C<PERL_ANYEVENT_MODEL>.	1774	C<PERL_ANYEVENT_MODEL>.
1552		1775
1553	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1776	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1554	model it chooses.	1777	model it chooses.
1555		1778
		1779	When set to C<8> or higher, then AnyEvent will report extra information on
		1780	which optional modules it loads and how it implements certain features.
		1781
1556	=item C<PERL_ANYEVENT_STRICT>	1782	=item C<PERL_ANYEVENT_STRICT>
1557		1783
1558	AnyEvent does not do much argument checking by default, as thorough	1784	AnyEvent does not do much argument checking by default, as thorough
1559	argument checking is very costly. Setting this variable to a true value	1785	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	1786	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,	1787	check the arguments passed to most method calls. If it finds any problems,
1562	it will croak.	1788	it will croak.
1563		1789
1564	In other words, enables "strict" mode.	1790	In other words, enables "strict" mode.
1565		1791
1566	Unlike C<use strict>, it is definitely recommended to keep it off in	1792	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	1793	>>, it is definitely recommended to keep it off in production. Keeping
1568	developing programs can be very useful, however.	1794	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1795	can be very useful, however.
1569		1796
1570	=item C<PERL_ANYEVENT_MODEL>	1797	=item C<PERL_ANYEVENT_MODEL>
1571		1798
1572	This can be used to specify the event model to be used by AnyEvent, before	1799	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	1800	auto detection and -probing kicks in. It must be a string consisting
…		…
1635		1862
1636	When neither C<ca_file> nor C<ca_path> was specified during	1863	When neither C<ca_file> nor C<ca_path> was specified during
1637	L<AnyEvent::TLS> context creation, and either of these environment	1864	L<AnyEvent::TLS> context creation, and either of these environment
1638	variables exist, they will be used to specify CA certificate locations	1865	variables exist, they will be used to specify CA certificate locations
1639	instead of a system-dependent default.	1866	instead of a system-dependent default.
		1867
		1868	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1869
		1870	When these are set to C<1>, then the respective modules are not
		1871	loaded. Mostly good for testing AnyEvent itself.
1640		1872
1641	=back	1873	=back
1642		1874
1643	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1875	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1644		1876
…		…
1702	warn "read: $input\n"; # output what has been read	1934	warn "read: $input\n"; # output what has been read
1703	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1935	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1704	},	1936	},
1705	);	1937	);
1706		1938
1707	my $time_watcher; # can only be used once
1708
1709	sub new_timer {
1710	$timer = AnyEvent->timer (after => 1, cb => sub {	1939	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1711	warn "timeout\n"; # print 'timeout' about every second	1940	warn "timeout\n"; # print 'timeout' at most every second
1712	&new_timer; # and restart the time
1713	});	1941	});
1714	}
1715
1716	new_timer; # create first timer
1717		1942
1718	$cv->recv; # wait until user enters /^q/i	1943	$cv->recv; # wait until user enters /^q/i
1719		1944
1720	=head1 REAL-WORLD EXAMPLE	1945	=head1 REAL-WORLD EXAMPLE
1721		1946
…		…
1852	through AnyEvent. The benchmark creates a lot of timers (with a zero	2077	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,	2078	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.	2079	which it is), lets them fire exactly once and destroys them again.
1855		2080
1856	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2081	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1857	distribution.	2082	distribution. It uses the L<AE> interface, which makes a real difference
		2083	for the EV and Perl backends only.
1858		2084
1859	=head3 Explanation of the columns	2085	=head3 Explanation of the columns
1860		2086
1861	I<watcher> is the number of event watchers created/destroyed. Since	2087	I<watcher> is the number of event watchers created/destroyed. Since
1862	different event models feature vastly different performances, each event	2088	different event models feature vastly different performances, each event
…		…
1883	watcher.	2109	watcher.
1884		2110
1885	=head3 Results	2111	=head3 Results
1886		2112
1887	name watchers bytes create invoke destroy comment	2113	name watchers bytes create invoke destroy comment
1888	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2114	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	2115	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	2116	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	2117	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	2118	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	2119	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	2120	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	2121	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	2122	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	2123	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	2124	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	2125	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1900		2126
1901	=head3 Discussion	2127	=head3 Discussion
1902		2128
1903	The benchmark does I<not> measure scalability of the event loop very	2129	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)	2130	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	2142	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	2143	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1918	cycles with POE.	2144	cycles with POE.
1919		2145
1920	C<EV> is the sole leader regarding speed and memory use, which are both	2146	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	2147	maximal/minimal, respectively. When using the L<AE> API there is zero
		2148	overhead (when going through the AnyEvent API create is about 5-6 times
		2149	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	2150	any other event loop and is still faster than Event natively).
1923	natively.
1924		2151
1925	The pure perl implementation is hit in a few sweet spots (both the	2152	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	2153	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	2154	interpreter and the backend itself). Nevertheless this shows that it
1928	adds very little overhead in itself. Like any select-based backend its	2155	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	2229	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	2230	(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.	2231	connections, most of which are idle at any one point in time.
2005		2232
2006	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2233	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2007	distribution.	2234	distribution. It uses the L<AE> interface, which makes a real difference
		2235	for the EV and Perl backends only.
2008		2236
2009	=head3 Explanation of the columns	2237	=head3 Explanation of the columns
2010		2238
2011	I<sockets> is the number of sockets, and twice the number of "servers" (as	2239	I<sockets> is the number of sockets, and twice the number of "servers" (as
2012	each server has a read and write socket end).	2240	each server has a read and write socket end).
…		…
2020	a new one that moves the timeout into the future.	2248	a new one that moves the timeout into the future.
2021		2249
2022	=head3 Results	2250	=head3 Results
2023		2251
2024	name sockets create request	2252	name sockets create request
2025	EV 20000 69.01 11.16	2253	EV 20000 62.66 7.99
2026	Perl 20000 73.32 35.87	2254	Perl 20000 68.32 32.64
2027	IOAsync 20000 157.00 98.14 epoll	2255	IOAsync 20000 174.06 101.15 epoll
2028	IOAsync 20000 159.31 616.06 poll	2256	IOAsync 20000 174.67 610.84 poll
2029	Event 20000 212.62 257.32	2257	Event 20000 202.69 242.91
2030	Glib 20000 651.16 1896.30	2258	Glib 20000 557.01 1689.52
2031	POE 20000 349.67 12317.24 uses POE::Loop::Event	2259	POE 20000 341.54 12086.32 uses POE::Loop::Event
2032		2260
2033	=head3 Discussion	2261	=head3 Discussion
2034		2262
2035	This benchmark I<does> measure scalability and overall performance of the	2263	This benchmark I<does> measure scalability and overall performance of the
2036	particular event loop.	2264	particular event loop.
…		…
2162	As you can see, the AnyEvent + EV combination even beats the	2390	As you can see, the AnyEvent + EV combination even beats the
2163	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2391	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2164	backend easily beats IO::Lambda and POE.	2392	backend easily beats IO::Lambda and POE.
2165		2393
2166	And even the 100% non-blocking version written using the high-level (and	2394	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	2395	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	2396	higher level ("unoptimised") abstractions by a large margin, even though
2169	in a non-blocking way.	2397	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2170		2398
2171	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2399	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	2400	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.	2401	part of the IO::Lambda distribution and were used without any changes.
2174		2402
2175		2403
2176	=head1 SIGNALS	2404	=head1 SIGNALS
2177		2405
2178	AnyEvent currently installs handlers for these signals:	2406	AnyEvent currently installs handlers for these signals:
…		…
2220	it's built-in modules) are required to use it.	2448	it's built-in modules) are required to use it.
2221		2449
2222	That does not mean that AnyEvent won't take advantage of some additional	2450	That does not mean that AnyEvent won't take advantage of some additional
2223	modules if they are installed.	2451	modules if they are installed.
2224		2452
2225	This section epxlains which additional modules will be used, and how they	2453	This section explains which additional modules will be used, and how they
2226	affect AnyEvent's operetion.	2454	affect AnyEvent's operation.
2227		2455
2228	=over 4	2456	=over 4
2229		2457
2230	=item L<Async::Interrupt>	2458	=item L<Async::Interrupt>
2231		2459
2232	This slightly arcane module is used to implement fast signal handling: To	2460	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	2461	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	2462	signal handling in pure perl. To ensure that signals still get
2235	delivered, AnyEvent will start an interval timer to wake up perl (and	2463	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	2464	catch the signals) with some delay (default is 10 seconds, look for
2237	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2465	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2238		2466
2239	If this module is available, then it will be used to implement signal	2467	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	2468	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	2469	will not be interrupted regularly, which is more efficient (and good for
2242	battery life on laptops).	2470	battery life on laptops).
2243		2471
2244	This affects not just the pure-perl event loop, but also other event loops	2472	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).	2473	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2474
		2475	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2476	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2477	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2478	does nothing for those backends.
2246		2479
2247	=item L<EV>	2480	=item L<EV>
2248		2481
2249	This module isn't really "optional", as it is simply one of the backend	2482	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	2483	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	2495	lot less memory), but otherwise doesn't affect guard operation much. It is
2263	purely used for performance.	2496	purely used for performance.
2264		2497
2265	=item L<JSON> and L<JSON::XS>	2498	=item L<JSON> and L<JSON::XS>
2266		2499
2267	This module is required when you want to read or write JSON data via	2500	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	2501	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.	2502	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2270		2503
2271	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2504	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2272	installed.	2505	installed.
2273		2506
2274	=item L<Net::SSLeay>	2507	=item L<Net::SSLeay>
…		…
2291		2524
2292	Most event libraries are not fork-safe. The ones who are usually are	2525	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>	2526	because they rely on inefficient but fork-safe C<select> or C<poll>
2294	calls. Only L<EV> is fully fork-aware.	2527	calls. Only L<EV> is fully fork-aware.
2295		2528
		2529	This means that, in general, you cannot fork and do event processing
		2530	in the child if a watcher was created before the fork (which in turn
		2531	initialises the event library).
		2532
2296	If you have to fork, you must either do so I<before> creating your first	2533	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	2534	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.	2535	something completely out of the scope of AnyEvent.
		2536
		2537	The problem of doing event processing in the parent I<and> the child
		2538	is much more complicated: even for backends that I<are> fork-aware or
		2539	fork-safe, their behaviour is not usually what you want: fork clones all
		2540	watchers, that means all timers, I/O watchers etc. are active in both
		2541	parent and child, which is almost never what you want.
2299		2542
2300		2543
2301	=head1 SECURITY CONSIDERATIONS	2544	=head1 SECURITY CONSIDERATIONS
2302		2545
2303	AnyEvent can be forced to load any event model via	2546	AnyEvent can be forced to load any event model via
…		…
2341	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2584	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2342		2585
2343	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2586	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2344	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2587	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2345	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2588	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2346	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2589	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2347		2590
2348	Non-blocking file handles, sockets, TCP clients and	2591	Non-blocking file handles, sockets, TCP clients and
2349	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2592	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2350		2593
2351	Asynchronous DNS: L<AnyEvent::DNS>.	2594	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.302 by root, Fri Dec 4 16:31:57 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.302 by root, Fri Dec 4 16:31:57 2009 UTC