[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.291 by root, Thu Sep 3 13:59:20 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
…		…
347		369
348	=back	370	=back
349		371
350	=head2 SIGNAL WATCHERS	372	=head2 SIGNAL WATCHERS
351		373
		374	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		375
352	You can watch for signals using a signal watcher, C<signal> is the signal	376	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	377	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
354	callback to be invoked whenever a signal occurs.	378	callback to be invoked whenever a signal occurs.
355		379
356	Although the callback might get passed parameters, their value and	380	Although the callback might get passed parameters, their value and
…		…
368		392
369	This watcher might use C<%SIG> (depending on the event loop used),	393	This watcher might use C<%SIG> (depending on the event loop used),
370	so programs overwriting those signals directly will likely not work	394	so programs overwriting those signals directly will likely not work
371	correctly.	395	correctly.
372		396
		397	Example: exit on SIGINT
		398
		399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		400
		401	=head3 Signal Races, Delays and Workarounds
		402
373	Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not	403	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	404	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	405	do race-free signal handling in perl, requiring C libraries for
		406	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	407	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	408	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
378	seconds). This variable can be changed only before the first signal	409	variable can be changed only before the first signal watcher is created,
379	watcher is created, and should be left alone otherwise. Higher values	410	and should be left alone otherwise. This variable determines how often
		411	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	412	will cause fewer spurious wake-ups, which is better for power and CPU
		413	saving.
		414
381	saving. All these problems can be avoided by installing the optional	415	All these problems can be avoided by installing the optional
382	L<Async::Interrupt> module.	416	L<Async::Interrupt> module, which works with most event loops. It will not
383		417	work with inherently broken event loops such as L<Event> or L<Event::Lib>
384	Example: exit on SIGINT	418	(and not with L<POE> currently, as POE does it's own workaround with
385		419	one-second latency). For those, you just have to suffer the delays.
386	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
387		420
388	=head2 CHILD PROCESS WATCHERS	421	=head2 CHILD PROCESS WATCHERS
389		422
		423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		424
390	You can also watch on a child process exit and catch its exit status.	425	You can also watch on a child process exit and catch its exit status.
391		426
392	The child process is specified by the C<pid> argument (if set to C<0>, it	427	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	428	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	429	croak). The watcher will be triggered only when the child process has
395	any trace events (stopped/continued).	430	finished and an exit status is available, not on any trace events
		431	(stopped/continued).
396		432
397	The callback will be called with the pid and exit status (as returned by	433	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	434	waitpid), so unlike other watcher types, you I<can> rely on child watcher
399	callback arguments.	435	callback arguments.
400		436
…		…
441	# do something else, then wait for process exit	477	# do something else, then wait for process exit
442	$done->recv;	478	$done->recv;
443		479
444	=head2 IDLE WATCHERS	480	=head2 IDLE WATCHERS
445		481
		482	$w = AnyEvent->idle (cb => <callback>);
		483
446	Sometimes there is a need to do something, but it is not so important	484	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	485	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	486	"nothing better to do" is usually defined to be "no other events need
449	attention by the event loop".	487	attention by the event loop".
450		488
…		…
476	});	514	});
477	});	515	});
478		516
479	=head2 CONDITION VARIABLES	517	=head2 CONDITION VARIABLES
480		518
		519	$cv = AnyEvent->condvar;
		520
		521	$cv->send (<list>);
		522	my @res = $cv->recv;
		523
481	If you are familiar with some event loops you will know that all of them	524	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	525	require you to run some blocking "loop", "run" or similar function that
483	will actively watch for new events and call your callbacks.	526	will actively watch for new events and call your callbacks.
484		527
485	AnyEvent is slightly different: it expects somebody else to run the event	528	AnyEvent is slightly different: it expects somebody else to run the event
…		…
504	Condition variables are similar to callbacks, except that you can	547	Condition variables are similar to callbacks, except that you can
505	optionally wait for them. They can also be called merge points - points	548	optionally wait for them. They can also be called merge points - points
506	in time where multiple outstanding events have been processed. And yet	549	in time where multiple outstanding events have been processed. And yet
507	another way to call them is transactions - each condition variable can be	550	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	551	used to represent a transaction, which finishes at some point and delivers
509	a result.	552	a result. And yet some people know them as "futures" - a promise to
		553	compute/deliver something that you can wait for.
510		554
511	Condition variables are very useful to signal that something has finished,	555	Condition variables are very useful to signal that something has finished,
512	for example, if you write a module that does asynchronous http requests,	556	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	557	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	558	availability of results. The user can either act when the callback is
…		…
548	after => 1,	592	after => 1,
549	cb => sub { $result_ready->send },	593	cb => sub { $result_ready->send },
550	);	594	);
551		595
552	# this "blocks" (while handling events) till the callback	596	# this "blocks" (while handling events) till the callback
553	# calls -<send	597	# calls ->send
554	$result_ready->recv;	598	$result_ready->recv;
555		599
556	Example: wait for a timer, but take advantage of the fact that condition	600	Example: wait for a timer, but take advantage of the fact that condition
557	variables are also callable directly.	601	variables are also callable directly.
558		602
…		…
622	one. For example, a function that pings many hosts in parallel might want	666	one. For example, a function that pings many hosts in parallel might want
623	to use a condition variable for the whole process.	667	to use a condition variable for the whole process.
624		668
625	Every call to C<< ->begin >> will increment a counter, and every call to	669	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	670	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	671	>>, 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	672	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.	673	>>, but that is not required. If no group callback was set, C<send> will
		674	be called without any arguments.
630		675
631	You can think of C<< $cv->send >> giving you an OR condition (one call	676	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	677	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).	678	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
634		679
…		…
661	begung can potentially be zero:	706	begung can potentially be zero:
662		707
663	my $cv = AnyEvent->condvar;	708	my $cv = AnyEvent->condvar;
664		709
665	my %result;	710	my %result;
666	$cv->begin (sub { $cv->send (\%result) });	711	$cv->begin (sub { shift->send (\%result) });
667		712
668	for my $host (@list_of_hosts) {	713	for my $host (@list_of_hosts) {
669	$cv->begin;	714	$cv->begin;
670	ping_host_then_call_callback $host, sub {	715	ping_host_then_call_callback $host, sub {
671	$result{$host} = ...;	716	$result{$host} = ...;
…		…
746	=item $cb = $cv->cb ($cb->($cv))	791	=item $cb = $cv->cb ($cb->($cv))
747		792
748	This is a mutator function that returns the callback set and optionally	793	This is a mutator function that returns the callback set and optionally
749	replaces it before doing so.	794	replaces it before doing so.
750		795
751	The callback will be called when the condition becomes "true", i.e. when	796	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	797	"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	798	the only argument being the condition variable itself. Calling C<recv>
754	is guaranteed not to block.	799	inside the callback or at any later time is guaranteed not to block.
755		800
756	=back	801	=back
757		802
758	=head1 SUPPORTED EVENT LOOPS/BACKENDS	803	=head1 SUPPORTED EVENT LOOPS/BACKENDS
759		804
…		…
762	=over 4	807	=over 4
763		808
764	=item Backends that are autoprobed when no other event loop can be found.	809	=item Backends that are autoprobed when no other event loop can be found.
765		810
766	EV is the preferred backend when no other event loop seems to be in	811	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	812	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	813	pure-perl implementation, which is available everywhere as it comes with
769	available everywhere as it comes with AnyEvent itself.	814	AnyEvent itself.
770		815
771	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	816	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.	817	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
774		818
775	=item Backends that are transparently being picked up when they are used.	819	=item Backends that are transparently being picked up when they are used.
776		820
777	These will be used when they are currently loaded when the first watcher	821	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	822	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	823	them. This means that AnyEvent will automatically pick the right backend
780	when the main program loads an event module before anything starts to	824	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.	825	create watchers. Nothing special needs to be done by the main program.
782		826
		827	AnyEvent::Impl::Event based on Event, very stable, few glitches.
783	AnyEvent::Impl::Glib based on Glib, slow but very stable.	828	AnyEvent::Impl::Glib based on Glib, slow but very stable.
784	AnyEvent::Impl::Tk based on Tk, very broken.	829	AnyEvent::Impl::Tk based on Tk, very broken.
785	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	830	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786	AnyEvent::Impl::POE based on POE, very slow, some limitations.	831	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		832	AnyEvent::Impl::Irssi used when running within irssi.
787		833
788	=item Backends with special needs.	834	=item Backends with special needs.
789		835
790	Qt requires the Qt::Application to be instantiated first, but will	836	Qt requires the Qt::Application to be instantiated first, but will
791	otherwise be picked up automatically. As long as the main program	837	otherwise be picked up automatically. As long as the main program
…		…
865	event module detection too early, for example, L<AnyEvent::AIO> creates	911	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	912	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867	avoid autodetecting the event module at load time.	913	avoid autodetecting the event module at load time.
868		914
869	If called in scalar or list context, then it creates and returns an object	915	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	916	that automatically removes the callback again when it is destroyed (or
		917	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
871	L<Coro::BDB> for a case where this is useful.	918	a case where this is useful.
		919
		920	Example: Create a watcher for the IO::AIO module and store it in
		921	C<$WATCHER>. Only do so after the event loop is initialised, though.
		922
		923	our WATCHER;
		924
		925	my $guard = AnyEvent::post_detect {
		926	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		927	};
		928
		929	# the \|\|= is important in case post_detect immediately runs the block,
		930	# as to not clobber the newly-created watcher. assigning both watcher and
		931	# post_detect guard to the same variable has the advantage of users being
		932	# able to just C<undef $WATCHER> if the watcher causes them grief.
		933
		934	$WATCHER \|\|= $guard;
872		935
873	=item @AnyEvent::post_detect	936	=item @AnyEvent::post_detect
874		937
875	If there are any code references in this array (you can C<push> to it	938	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	939	before or after loading AnyEvent), then they will called directly after
…		…
1041		1104
1042	=cut	1105	=cut
1043		1106
1044	package AnyEvent;	1107	package AnyEvent;
1045		1108
1046	no warnings;	1109	# basically a tuned-down version of common::sense
		1110	sub common_sense {
		1111	# from common:.sense 1.0
		1112	${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1047	use strict qw(vars subs);	1113	# use strict vars subs
		1114	$^H \|= 0x00000600;
		1115	}
		1116
		1117	BEGIN { AnyEvent::common_sense }
1048		1118
1049	use Carp ();	1119	use Carp ();
1050		1120
1051	our $VERSION = 4.83;	1121	our $VERSION = '5.12';
1052	our $MODEL;	1122	our $MODEL;
1053		1123
1054	our $AUTOLOAD;	1124	our $AUTOLOAD;
1055	our @ISA;	1125	our @ISA;
1056		1126
…		…
1081	for reverse split /\s,\s/,	1151	for reverse split /\s,\s/,
1082	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1152	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1083	}	1153	}
1084		1154
1085	my @models = (	1155	my @models = (
1086	[EV:: => AnyEvent::Impl::EV::],	1156	[EV:: => AnyEvent::Impl::EV:: , 1],
1087	[Event:: => AnyEvent::Impl::Event::],
1088	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1089	# everything below here will not be autoprobed	1158	# everything below here will not (normally) be autoprobed
1090	# as the pureperl backend should work everywhere	1159	# as the pureperl backend should work everywhere
1091	# and is usually faster	1160	# and is usually faster
		1161	[Event:: => AnyEvent::Impl::Event::, 1],
1092	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1162	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1093	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1163	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1164	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1094	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1165	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1095	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1166	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1096	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1167	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1097	[Wx:: => AnyEvent::Impl::POE::],	1168	[Wx:: => AnyEvent::Impl::POE::],
1098	[Prima:: => AnyEvent::Impl::POE::],	1169	[Prima:: => AnyEvent::Impl::POE::],
1099	# IO::Async is just too broken - we would need workarounds for its	1170	# IO::Async is just too broken - we would need workarounds for its
1100	# byzantine signal and broken child handling, among others.	1171	# byzantine signal and broken child handling, among others.
1101	# IO::Async is rather hard to detect, as it doesn't have any	1172	# IO::Async is rather hard to detect, as it doesn't have any
1102	# obvious default class.	1173	# obvious default class.
1103	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1104	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1105	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1176	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1177	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1106	);	1178	);
1107		1179
1108	our %method = map +($_ => 1),	1180	our %method = map +($_ => 1),
1109	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1181	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1110		1182
…		…
1114	my ($cb) = @_;	1186	my ($cb) = @_;
1115		1187
1116	if ($MODEL) {	1188	if ($MODEL) {
1117	$cb->();	1189	$cb->();
1118		1190
1119	1	1191	undef
1120	} else {	1192	} else {
1121	push @post_detect, $cb;	1193	push @post_detect, $cb;
1122		1194
1123	defined wantarray	1195	defined wantarray
1124	? bless \$cb, "AnyEvent::Util::postdetect"	1196	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1130	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1202	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1131	}	1203	}
1132		1204
1133	sub detect() {	1205	sub detect() {
1134	unless ($MODEL) {	1206	unless ($MODEL) {
1135	no strict 'refs';
1136	local $SIG{__DIE__};	1207	local $SIG{__DIE__};
1137		1208
1138	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1209	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1139	my $model = "AnyEvent::Impl::$1";	1210	my $model = "AnyEvent::Impl::$1";
1140	if (eval "require $model") {	1211	if (eval "require $model") {
…		…
1157	}	1228	}
1158	}	1229	}
1159	}	1230	}
1160		1231
1161	unless ($MODEL) {	1232	unless ($MODEL) {
1162	# try to load a model	1233	# try to autoload a model
1163
1164	for (@REGISTRY, @models) {	1234	for (@REGISTRY, @models) {
1165	my ($package, $model) = @$_;	1235	my ($package, $model, $autoload) = @$_;
		1236	if (
		1237	$autoload
1166	if (eval "require $package"	1238	and eval "require $package"
1167	and ${"$package\::VERSION"} > 0	1239	and ${"$package\::VERSION"} > 0
1168	and eval "require $model") {	1240	and eval "require $model"
		1241	) {
1169	$MODEL = $model;	1242	$MODEL = $model;
1170	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1243	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1171	last;	1244	last;
1172	}	1245	}
1173	}	1246	}
1174		1247
1175	$MODEL	1248	$MODEL
…		…
1216	# we assume CLOEXEC is already set by perl in all important cases	1289	# we assume CLOEXEC is already set by perl in all important cases
1217		1290
1218	($fh2, $rw)	1291	($fh2, $rw)
1219	}	1292	}
1220		1293
		1294	=head1 SIMPLIFIED AE API
		1295
		1296	Starting with version 5.0, AnyEvent officially supports a second, much
		1297	simpler, API that is designed to reduce the calling, typing and memory
		1298	overhead.
		1299
		1300	See the L<AE> manpage for details.
		1301
		1302	=cut
		1303
		1304	package AE;
		1305
		1306	our $VERSION = $AnyEvent::VERSION;
		1307
		1308	sub io($$$) {
		1309	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1310	}
		1311
		1312	sub timer($$$) {
		1313	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1314	}
		1315
		1316	sub signal($$) {
		1317	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1318	}
		1319
		1320	sub child($$) {
		1321	AnyEvent->child (pid => $_[0], cb => $_[1])
		1322	}
		1323
		1324	sub idle($) {
		1325	AnyEvent->idle (cb => $_[0])
		1326	}
		1327
		1328	sub cv(;&) {
		1329	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1330	}
		1331
		1332	sub now() {
		1333	AnyEvent->now
		1334	}
		1335
		1336	sub now_update() {
		1337	AnyEvent->now_update
		1338	}
		1339
		1340	sub time() {
		1341	AnyEvent->time
		1342	}
		1343
1221	package AnyEvent::Base;	1344	package AnyEvent::Base;
1222		1345
1223	# default implementations for many methods	1346	# default implementations for many methods
1224		1347
1225	sub _time {	1348	sub _time() {
1226	# probe for availability of Time::HiRes	1349	# probe for availability of Time::HiRes
1227	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1350	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1228	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1351	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1229	*_time = \&Time::HiRes::time;	1352	*_time = \&Time::HiRes::time;
1230	# if (eval "use POSIX (); (POSIX::times())...	1353	# if (eval "use POSIX (); (POSIX::times())...
…		…
1247	}	1370	}
1248		1371
1249	# default implementation for ->signal	1372	# default implementation for ->signal
1250		1373
1251	our $HAVE_ASYNC_INTERRUPT;	1374	our $HAVE_ASYNC_INTERRUPT;
		1375
		1376	sub _have_async_interrupt() {
		1377	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1378	&& eval "use Async::Interrupt 1.02 (); 1")
		1379	unless defined $HAVE_ASYNC_INTERRUPT;
		1380
		1381	$HAVE_ASYNC_INTERRUPT
		1382	}
		1383
1252	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1384	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1253	our (%SIG_ASY, %SIG_ASY_W);	1385	our (%SIG_ASY, %SIG_ASY_W);
1254	our ($SIG_COUNT, $SIG_TW);	1386	our ($SIG_COUNT, $SIG_TW);
1255		1387
1256	sub _signal_exec {	1388	sub _signal_exec {
…		…
1264	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1396	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1265	}	1397	}
1266	}	1398	}
1267	}	1399	}
1268		1400
		1401	# install a dummy wakeup watcher to reduce signal catching latency
1269	sub _signal {	1402	sub _sig_add() {
1270	my (undef, %arg) = @_;	1403	unless ($SIG_COUNT++) {
		1404	# try to align timer on a full-second boundary, if possible
		1405	my $NOW = AE::now;
1271		1406
1272	my $signal = uc $arg{signal}	1407	$SIG_TW = AE::timer
1273	or Carp::croak "required option 'signal' is missing";	1408	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1274		1409	$MAX_SIGNAL_LATENCY,
1275	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1410	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	};	1411	;
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	}	1412	}
1309
1310	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1311	}	1413	}
1312		1414
1313	sub signal {	1415	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	1416	undef $SIG_TW
1357	unless --$SIG_COUNT;	1417	unless --$SIG_COUNT;
		1418	}
1358		1419
		1420	our $_sig_name_init; $_sig_name_init = sub {
		1421	eval q{ # poor man's autoloading
		1422	undef $_sig_name_init;
		1423
		1424	if (_have_async_interrupt) {
		1425	*sig2num = \&Async::Interrupt::sig2num;
		1426	*sig2name = \&Async::Interrupt::sig2name;
		1427	} else {
		1428	require Config;
		1429
		1430	my %signame2num;
		1431	@signame2num{ split ' ', $Config::Config{sig_name} }
		1432	= split ' ', $Config::Config{sig_num};
		1433
		1434	my @signum2name;
		1435	@signum2name[values %signame2num] = keys %signame2num;
		1436
		1437	*sig2num = sub($) {
		1438	$_[0] > 0 ? shift : $signame2num{+shift}
		1439	};
		1440	*sig2name = sub ($) {
		1441	$_[0] > 0 ? $signum2name[+shift] : shift
		1442	};
		1443	}
		1444	};
		1445	die if $@;
		1446	};
		1447
		1448	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1449	sub sig2name($) { &$_sig_name_init; &sig2name }
		1450
		1451	sub signal {
		1452	eval q{ # poor man's autoloading {}
		1453	# probe for availability of Async::Interrupt
		1454	if (_have_async_interrupt) {
		1455	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1456
		1457	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1458	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1459
		1460	} else {
		1461	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1462
		1463	require Fcntl;
		1464
		1465	if (AnyEvent::WIN32) {
		1466	require AnyEvent::Util;
		1467
		1468	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1470	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1471	} else {
		1472	pipe $SIGPIPE_R, $SIGPIPE_W;
		1473	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1474	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1475
		1476	# not strictly required, as $^F is normally 2, but let's make sure...
		1477	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1478	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1479	}
		1480
		1481	$SIGPIPE_R
		1482	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1483
		1484	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1485	}
		1486
		1487	*signal = sub {
		1488	my (undef, %arg) = @_;
		1489
		1490	my $signal = uc $arg{signal}
		1491	or Carp::croak "required option 'signal' is missing";
		1492
		1493	if ($HAVE_ASYNC_INTERRUPT) {
		1494	# async::interrupt
		1495
		1496	$signal = sig2num $signal;
		1497	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1498
		1499	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1500	cb => sub { undef $SIG_EV{$signal} },
		1501	signal => $signal,
		1502	pipe => [$SIGPIPE_R->filenos],
		1503	pipe_autodrain => 0,
		1504	;
		1505
		1506	} else {
		1507	# pure perl
		1508
		1509	# AE::Util has been loaded in signal
		1510	$signal = sig2name $signal;
		1511	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1512
		1513	$SIG{$signal} \|\|= sub {
		1514	local $!;
		1515	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1516	undef $SIG_EV{$signal};
		1517	};
		1518
		1519	# can't do signal processing without introducing races in pure perl,
		1520	# so limit the signal latency.
		1521	_sig_add;
		1522	}
		1523
		1524	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1525	};
		1526
		1527	*AnyEvent::Base::signal::DESTROY = sub {
		1528	my ($signal, $cb) = @{$_[0]};
		1529
		1530	_sig_del;
		1531
1359	delete $SIG_CB{$signal}{$cb};	1532	delete $SIG_CB{$signal}{$cb};
1360		1533
		1534	$HAVE_ASYNC_INTERRUPT
		1535	? delete $SIG_ASY{$signal}
1361	# delete doesn't work with older perls - they then	1536	: # delete doesn't work with older perls - they then
1362	# print weird messages, or just unconditionally exit	1537	# print weird messages, or just unconditionally exit
1363	# instead of getting the default action.	1538	# instead of getting the default action.
1364	undef $SIG{$signal}	1539	undef $SIG{$signal}
1365	unless keys %{ $SIG_CB{$signal} };	1540	unless keys %{ $SIG_CB{$signal} };
		1541	};
		1542	};
		1543	die if $@;
		1544	&signal
1366	}	1545	}
1367		1546
1368	# default implementation for ->child	1547	# default implementation for ->child
1369		1548
1370	our %PID_CB;	1549	our %PID_CB;
1371	our $CHLD_W;	1550	our $CHLD_W;
1372	our $CHLD_DELAY_W;	1551	our $CHLD_DELAY_W;
1373	our $WNOHANG;	1552	our $WNOHANG;
1374		1553
		1554	sub _emit_childstatus($$) {
		1555	my (undef, $rpid, $rstatus) = @_;
		1556
		1557	$_->($rpid, $rstatus)
		1558	for values %{ $PID_CB{$rpid} \|\| {} },
		1559	values %{ $PID_CB{0} \|\| {} };
		1560	}
		1561
1375	sub _sigchld {	1562	sub _sigchld {
		1563	my $pid;
		1564
		1565	AnyEvent->_emit_childstatus ($pid, $?)
1376	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1566	while ($pid = waitpid -1, $WNOHANG) > 0;
1377	$_->($pid, $?)
1378	for values %{ $PID_CB{$pid} \|\| {} },
1379	values %{ $PID_CB{0} \|\| {} };
1380	}
1381	}	1567	}
1382		1568
1383	sub child {	1569	sub child {
1384	my (undef, %arg) = @_;	1570	my (undef, %arg) = @_;
1385		1571
1386	defined (my $pid = $arg{pid} + 0)	1572	defined (my $pid = $arg{pid} + 0)
1387	or Carp::croak "required option 'pid' is missing";	1573	or Carp::croak "required option 'pid' is missing";
1388		1574
1389	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1575	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1390		1576
		1577	# WNOHANG is almost cetrainly 1 everywhere
		1578	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1579	? 1
1391	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1580	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1392		1581
1393	unless ($CHLD_W) {	1582	unless ($CHLD_W) {
1394	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1583	$CHLD_W = AE::signal CHLD => \&_sigchld;
1395	# child could be a zombie already, so make at least one round	1584	# child could be a zombie already, so make at least one round
1396	&_sigchld;	1585	&_sigchld;
1397	}	1586	}
1398		1587
1399	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1588	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1425	# never use more then 50% of the time for the idle watcher,	1614	# never use more then 50% of the time for the idle watcher,
1426	# within some limits	1615	# within some limits
1427	$w = 0.0001 if $w < 0.0001;	1616	$w = 0.0001 if $w < 0.0001;
1428	$w = 5 if $w > 5;	1617	$w = 5 if $w > 5;
1429		1618
1430	$w = AnyEvent->timer (after => $w, cb => $rcb);	1619	$w = AE::timer $w, 0, $rcb;
1431	} else {	1620	} else {
1432	# clean up...	1621	# clean up...
1433	undef $w;	1622	undef $w;
1434	undef $rcb;	1623	undef $rcb;
1435	}	1624	}
1436	};	1625	};
1437		1626
1438	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1627	$w = AE::timer 0.05, 0, $rcb;
1439		1628
1440	bless \\$cb, "AnyEvent::Base::idle"	1629	bless \\$cb, "AnyEvent::Base::idle"
1441	}	1630	}
1442		1631
1443	sub AnyEvent::Base::idle::DESTROY {	1632	sub AnyEvent::Base::idle::DESTROY {
…		…
1448		1637
1449	our @ISA = AnyEvent::CondVar::Base::;	1638	our @ISA = AnyEvent::CondVar::Base::;
1450		1639
1451	package AnyEvent::CondVar::Base;	1640	package AnyEvent::CondVar::Base;
1452		1641
1453	use overload	1642	#use overload
1454	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1643	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1455	fallback => 1;	1644	# fallback => 1;
		1645
		1646	# save 300+ kilobytes by dirtily hardcoding overloading
		1647	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1648	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1649	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1650	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1456		1651
1457	our $WAITING;	1652	our $WAITING;
1458		1653
1459	sub _send {	1654	sub _send {
1460	# nop	1655	# nop
…		…
1491	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1686	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1492	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1687	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1493	}	1688	}
1494		1689
1495	sub cb {	1690	sub cb {
1496	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1691	my $cv = shift;
		1692
		1693	@_
		1694	and $cv->{_ae_cb} = shift
		1695	and $cv->{_ae_sent}
		1696	and (delete $cv->{_ae_cb})->($cv);
		1697
1497	$_[0]{_ae_cb}	1698	$cv->{_ae_cb}
1498	}	1699	}
1499		1700
1500	sub begin {	1701	sub begin {
1501	++$_[0]{_ae_counter};	1702	++$_[0]{_ae_counter};
1502	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1703	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1551	C<PERL_ANYEVENT_MODEL>.	1752	C<PERL_ANYEVENT_MODEL>.
1552		1753
1553	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1754	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1554	model it chooses.	1755	model it chooses.
1555		1756
		1757	When set to C<8> or higher, then AnyEvent will report extra information on
		1758	which optional modules it loads and how it implements certain features.
		1759
1556	=item C<PERL_ANYEVENT_STRICT>	1760	=item C<PERL_ANYEVENT_STRICT>
1557		1761
1558	AnyEvent does not do much argument checking by default, as thorough	1762	AnyEvent does not do much argument checking by default, as thorough
1559	argument checking is very costly. Setting this variable to a true value	1763	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	1764	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,	1765	check the arguments passed to most method calls. If it finds any problems,
1562	it will croak.	1766	it will croak.
1563		1767
1564	In other words, enables "strict" mode.	1768	In other words, enables "strict" mode.
1565		1769
1566	Unlike C<use strict>, it is definitely recommended to keep it off in	1770	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	1771	>>, it is definitely recommended to keep it off in production. Keeping
1568	developing programs can be very useful, however.	1772	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1773	can be very useful, however.
1569		1774
1570	=item C<PERL_ANYEVENT_MODEL>	1775	=item C<PERL_ANYEVENT_MODEL>
1571		1776
1572	This can be used to specify the event model to be used by AnyEvent, before	1777	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	1778	auto detection and -probing kicks in. It must be a string consisting
…		…
1635		1840
1636	When neither C<ca_file> nor C<ca_path> was specified during	1841	When neither C<ca_file> nor C<ca_path> was specified during
1637	L<AnyEvent::TLS> context creation, and either of these environment	1842	L<AnyEvent::TLS> context creation, and either of these environment
1638	variables exist, they will be used to specify CA certificate locations	1843	variables exist, they will be used to specify CA certificate locations
1639	instead of a system-dependent default.	1844	instead of a system-dependent default.
		1845
		1846	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1847
		1848	When these are set to C<1>, then the respective modules are not
		1849	loaded. Mostly good for testing AnyEvent itself.
1640		1850
1641	=back	1851	=back
1642		1852
1643	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1853	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1644		1854
…		…
1702	warn "read: $input\n"; # output what has been read	1912	warn "read: $input\n"; # output what has been read
1703	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1913	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1704	},	1914	},
1705	);	1915	);
1706		1916
1707	my $time_watcher; # can only be used once
1708
1709	sub new_timer {
1710	$timer = AnyEvent->timer (after => 1, cb => sub {	1917	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1711	warn "timeout\n"; # print 'timeout' about every second	1918	warn "timeout\n"; # print 'timeout' at most every second
1712	&new_timer; # and restart the time
1713	});	1919	});
1714	}
1715
1716	new_timer; # create first timer
1717		1920
1718	$cv->recv; # wait until user enters /^q/i	1921	$cv->recv; # wait until user enters /^q/i
1719		1922
1720	=head1 REAL-WORLD EXAMPLE	1923	=head1 REAL-WORLD EXAMPLE
1721		1924
…		…
1852	through AnyEvent. The benchmark creates a lot of timers (with a zero	2055	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,	2056	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.	2057	which it is), lets them fire exactly once and destroys them again.
1855		2058
1856	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2059	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1857	distribution.	2060	distribution. It uses the L<AE> interface, which makes a real difference
		2061	for the EV and Perl backends only.
1858		2062
1859	=head3 Explanation of the columns	2063	=head3 Explanation of the columns
1860		2064
1861	I<watcher> is the number of event watchers created/destroyed. Since	2065	I<watcher> is the number of event watchers created/destroyed. Since
1862	different event models feature vastly different performances, each event	2066	different event models feature vastly different performances, each event
…		…
1883	watcher.	2087	watcher.
1884		2088
1885	=head3 Results	2089	=head3 Results
1886		2090
1887	name watchers bytes create invoke destroy comment	2091	name watchers bytes create invoke destroy comment
1888	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2092	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	2093	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	2094	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	2095	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	2096	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	2097	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	2098	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	2099	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	2100	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	2101	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	2102	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	2103	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1900		2104
1901	=head3 Discussion	2105	=head3 Discussion
1902		2106
1903	The benchmark does I<not> measure scalability of the event loop very	2107	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)	2108	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	2120	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	2121	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1918	cycles with POE.	2122	cycles with POE.
1919		2123
1920	C<EV> is the sole leader regarding speed and memory use, which are both	2124	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	2125	maximal/minimal, respectively. When using the L<AE> API there is zero
		2126	overhead (when going through the AnyEvent API create is about 5-6 times
		2127	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	2128	any other event loop and is still faster than Event natively).
1923	natively.
1924		2129
1925	The pure perl implementation is hit in a few sweet spots (both the	2130	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	2131	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	2132	interpreter and the backend itself). Nevertheless this shows that it
1928	adds very little overhead in itself. Like any select-based backend its	2133	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	2207	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	2208	(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.	2209	connections, most of which are idle at any one point in time.
2005		2210
2006	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2211	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2007	distribution.	2212	distribution. It uses the L<AE> interface, which makes a real difference
		2213	for the EV and Perl backends only.
2008		2214
2009	=head3 Explanation of the columns	2215	=head3 Explanation of the columns
2010		2216
2011	I<sockets> is the number of sockets, and twice the number of "servers" (as	2217	I<sockets> is the number of sockets, and twice the number of "servers" (as
2012	each server has a read and write socket end).	2218	each server has a read and write socket end).
…		…
2020	a new one that moves the timeout into the future.	2226	a new one that moves the timeout into the future.
2021		2227
2022	=head3 Results	2228	=head3 Results
2023		2229
2024	name sockets create request	2230	name sockets create request
2025	EV 20000 69.01 11.16	2231	EV 20000 62.66 7.99
2026	Perl 20000 73.32 35.87	2232	Perl 20000 68.32 32.64
2027	IOAsync 20000 157.00 98.14 epoll	2233	IOAsync 20000 174.06 101.15 epoll
2028	IOAsync 20000 159.31 616.06 poll	2234	IOAsync 20000 174.67 610.84 poll
2029	Event 20000 212.62 257.32	2235	Event 20000 202.69 242.91
2030	Glib 20000 651.16 1896.30	2236	Glib 20000 557.01 1689.52
2031	POE 20000 349.67 12317.24 uses POE::Loop::Event	2237	POE 20000 341.54 12086.32 uses POE::Loop::Event
2032		2238
2033	=head3 Discussion	2239	=head3 Discussion
2034		2240
2035	This benchmark I<does> measure scalability and overall performance of the	2241	This benchmark I<does> measure scalability and overall performance of the
2036	particular event loop.	2242	particular event loop.
…		…
2162	As you can see, the AnyEvent + EV combination even beats the	2368	As you can see, the AnyEvent + EV combination even beats the
2163	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2369	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2164	backend easily beats IO::Lambda and POE.	2370	backend easily beats IO::Lambda and POE.
2165		2371
2166	And even the 100% non-blocking version written using the high-level (and	2372	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	2373	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	2374	higher level ("unoptimised") abstractions by a large margin, even though
2169	in a non-blocking way.	2375	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2170		2376
2171	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2377	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	2378	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.	2379	part of the IO::Lambda distribution and were used without any changes.
2174		2380
2175		2381
2176	=head1 SIGNALS	2382	=head1 SIGNALS
2177		2383
2178	AnyEvent currently installs handlers for these signals:	2384	AnyEvent currently installs handlers for these signals:
…		…
2231		2437
2232	This slightly arcane module is used to implement fast signal handling: To	2438	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	2439	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	2440	signal handling in pure perl. To ensure that signals still get
2235	delivered, AnyEvent will start an interval timer to wake up perl (and	2441	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	2442	catch the signals) with some delay (default is 10 seconds, look for
2237	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2443	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2238		2444
2239	If this module is available, then it will be used to implement signal	2445	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	2446	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	2447	will not be interrupted regularly, which is more efficient (And good for
2242	battery life on laptops).	2448	battery life on laptops).
2243		2449
2244	This affects not just the pure-perl event loop, but also other event loops	2450	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).	2451	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2452
		2453	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2454	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2455	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2456	does nothing for those backends.
2246		2457
2247	=item L<EV>	2458	=item L<EV>
2248		2459
2249	This module isn't really "optional", as it is simply one of the backend	2460	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	2461	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	2473	lot less memory), but otherwise doesn't affect guard operation much. It is
2263	purely used for performance.	2474	purely used for performance.
2264		2475
2265	=item L<JSON> and L<JSON::XS>	2476	=item L<JSON> and L<JSON::XS>
2266		2477
2267	This module is required when you want to read or write JSON data via	2478	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	2479	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.	2480	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2270		2481
2271	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2482	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2272	installed.	2483	installed.
2273		2484
2274	=item L<Net::SSLeay>	2485	=item L<Net::SSLeay>
…		…
2341	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2552	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2342		2553
2343	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2554	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2344	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2555	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2345	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2556	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2346	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2557	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2347		2558
2348	Non-blocking file handles, sockets, TCP clients and	2559	Non-blocking file handles, sockets, TCP clients and
2349	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2560	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2350		2561
2351	Asynchronous DNS: L<AnyEvent::DNS>.	2562	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.291 by root, Thu Sep 3 13:59:20 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.291 by root, Thu Sep 3 13:59:20 2009 UTC