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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.270 by root, Fri Jul 31 20:16:34 2009 UTC vs.
Revision 1.320 by root, Mon Apr 12 02:50:31 2010 UTC

…		…
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
		12	# if you prefer function calls, look at the L<AE> manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
…		…
363	might affect timers and time-outs.	366	might affect timers and time-outs.
364		367
365	When this is the case, you can call this method, which will update the	368	When this is the case, you can call this method, which will update the
366	event loop's idea of "current time".	369	event loop's idea of "current time".
367		370
		371	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		372	when mod_perl executes the script, then the event loop will have the wrong
		373	idea about the "current time" (being potentially far in the past, when the
		374	script ran the last time). In that case you should arrange a call to C<<
		375	AnyEvent->now_update >> each time the web server process wakes up again
		376	(e.g. at the start of your script, or in a handler).
		377
368	Note that updating the time I<might> cause some events to be handled.	378	Note that updating the time I<might> cause some events to be handled.
369		379
370	=back	380	=back
371		381
372	=head2 SIGNAL WATCHERS	382	=head2 SIGNAL WATCHERS
…		…
395	correctly.	405	correctly.
396		406
397	Example: exit on SIGINT	407	Example: exit on SIGINT
398		408
399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	409	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		410
		411	=head3 Restart Behaviour
		412
		413	While restart behaviour is up to the event loop implementation, most will
		414	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		415	pure perl implementation).
		416
		417	=head3 Safe/Unsafe Signals
		418
		419	Perl signals can be either "safe" (synchronous to opcode handling) or
		420	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		421	latter might corrupt your memory.
		422
		423	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		424	i.e. they will not interrupt your running perl program but will only be
		425	called as part of the normal event handling (just like timer, I/O etc.
		426	callbacks, too).
400		427
401	=head3 Signal Races, Delays and Workarounds	428	=head3 Signal Races, Delays and Workarounds
402		429
403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	430	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
404	callbacks to signals in a generic way, which is a pity, as you cannot	431	callbacks to signals in a generic way, which is a pity, as you cannot
…		…
479		506
480	=head2 IDLE WATCHERS	507	=head2 IDLE WATCHERS
481		508
482	$w = AnyEvent->idle (cb => <callback>);	509	$w = AnyEvent->idle (cb => <callback>);
483		510
484	Sometimes there is a need to do something, but it is not so important	511	Repeatedly invoke the callback after the process becomes idle, until
485	to do it instantly, but only when there is nothing better to do. This	512	either the watcher is destroyed or new events have been detected.
486	"nothing better to do" is usually defined to be "no other events need
487	attention by the event loop".
488		513
489	Idle watchers ideally get invoked when the event loop has nothing	514	Idle watchers are useful when there is a need to do something, but it
490	better to do, just before it would block the process to wait for new	515	is not so important (or wise) to do it instantly. The callback will be
491	events. Instead of blocking, the idle watcher is invoked.	516	invoked only when there is "nothing better to do", which is usually
		517	defined as "all outstanding events have been handled and no new events
		518	have been detected". That means that idle watchers ideally get invoked
		519	when the event loop has just polled for new events but none have been
		520	detected. Instead of blocking to wait for more events, the idle watchers
		521	will be invoked.
492		522
493	Most event loops unfortunately do not really support idle watchers (only	523	Unfortunately, most event loops do not really support idle watchers (only
494	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	524	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
495	will simply call the callback "from time to time".	525	will simply call the callback "from time to time".
496		526
497	Example: read lines from STDIN, but only process them when the	527	Example: read lines from STDIN, but only process them when the
498	program is otherwise idle:	528	program is otherwise idle:
…		…
579	eventually calls C<< -> send >>, and the "consumer side", which waits	609	eventually calls C<< -> send >>, and the "consumer side", which waits
580	for the send to occur.	610	for the send to occur.
581		611
582	Example: wait for a timer.	612	Example: wait for a timer.
583		613
584	# wait till the result is ready	614	# condition: "wait till the timer is fired"
585	my $result_ready = AnyEvent->condvar;	615	my $timer_fired = AnyEvent->condvar;
586		616
587	# do something such as adding a timer	617	# create the timer - we could wait for, say
588	# or socket watcher the calls $result_ready->send	618	# a handle becomign ready, or even an
589	# when the "result" is ready.	619	# AnyEvent::HTTP request to finish, but
590	# in this case, we simply use a timer:	620	# in this case, we simply use a timer:
591	my $w = AnyEvent->timer (	621	my $w = AnyEvent->timer (
592	after => 1,	622	after => 1,
593	cb => sub { $result_ready->send },	623	cb => sub { $timer_fired->send },
594	);	624	);
595		625
596	# this "blocks" (while handling events) till the callback	626	# this "blocks" (while handling events) till the callback
597	# calls -<send	627	# calls ->send
598	$result_ready->recv;	628	$timer_fired->recv;
599		629
600	Example: wait for a timer, but take advantage of the fact that condition	630	Example: wait for a timer, but take advantage of the fact that condition
601	variables are also callable directly.	631	variables are also callable directly.
602		632
603	my $done = AnyEvent->condvar;	633	my $done = AnyEvent->condvar;
…		…
666	one. For example, a function that pings many hosts in parallel might want	696	one. For example, a function that pings many hosts in parallel might want
667	to use a condition variable for the whole process.	697	to use a condition variable for the whole process.
668		698
669	Every call to C<< ->begin >> will increment a counter, and every call to	699	Every call to C<< ->begin >> will increment a counter, and every call to
670	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	700	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
671	>>, the (last) callback passed to C<begin> will be executed. That callback	701	>>, the (last) callback passed to C<begin> will be executed, passing the
672	is I<supposed> to call C<< ->send >>, but that is not required. If no	702	condvar as first argument. That callback is I<supposed> to call C<< ->send
673	callback was set, C<send> will be called without any arguments.	703	>>, but that is not required. If no group callback was set, C<send> will
		704	be called without any arguments.
674		705
675	You can think of C<< $cv->send >> giving you an OR condition (one call	706	You can think of C<< $cv->send >> giving you an OR condition (one call
676	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	707	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
677	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	708	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
678		709
…		…
705	begung can potentially be zero:	736	begung can potentially be zero:
706		737
707	my $cv = AnyEvent->condvar;	738	my $cv = AnyEvent->condvar;
708		739
709	my %result;	740	my %result;
710	$cv->begin (sub { $cv->send (\%result) });	741	$cv->begin (sub { shift->send (\%result) });
711		742
712	for my $host (@list_of_hosts) {	743	for my $host (@list_of_hosts) {
713	$cv->begin;	744	$cv->begin;
714	ping_host_then_call_callback $host, sub {	745	ping_host_then_call_callback $host, sub {
715	$result{$host} = ...;	746	$result{$host} = ...;
…		…
806	=over 4	837	=over 4
807		838
808	=item Backends that are autoprobed when no other event loop can be found.	839	=item Backends that are autoprobed when no other event loop can be found.
809		840
810	EV is the preferred backend when no other event loop seems to be in	841	EV is the preferred backend when no other event loop seems to be in
811	use. If EV is not installed, then AnyEvent will try Event, and, failing	842	use. If EV is not installed, then AnyEvent will fall back to its own
812	that, will fall back to its own pure-perl implementation, which is	843	pure-perl implementation, which is available everywhere as it comes with
813	available everywhere as it comes with AnyEvent itself.	844	AnyEvent itself.
814		845
815	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	846	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
816	AnyEvent::Impl::Event based on Event, very stable, few glitches.
817	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	847	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
818		848
819	=item Backends that are transparently being picked up when they are used.	849	=item Backends that are transparently being picked up when they are used.
820		850
821	These will be used when they are currently loaded when the first watcher	851	These will be used when they are currently loaded when the first watcher
822	is created, in which case it is assumed that the application is using	852	is created, in which case it is assumed that the application is using
823	them. This means that AnyEvent will automatically pick the right backend	853	them. This means that AnyEvent will automatically pick the right backend
824	when the main program loads an event module before anything starts to	854	when the main program loads an event module before anything starts to
825	create watchers. Nothing special needs to be done by the main program.	855	create watchers. Nothing special needs to be done by the main program.
826		856
		857	AnyEvent::Impl::Event based on Event, very stable, few glitches.
827	AnyEvent::Impl::Glib based on Glib, slow but very stable.	858	AnyEvent::Impl::Glib based on Glib, slow but very stable.
828	AnyEvent::Impl::Tk based on Tk, very broken.	859	AnyEvent::Impl::Tk based on Tk, very broken.
829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	860	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
830	AnyEvent::Impl::POE based on POE, very slow, some limitations.	861	AnyEvent::Impl::POE based on POE, very slow, some limitations.
831	AnyEvent::Impl::Irssi used when running within irssi.	862	AnyEvent::Impl::Irssi used when running within irssi.
…		…
941	You should check C<$AnyEvent::MODEL> before adding to this array, though:	972	You should check C<$AnyEvent::MODEL> before adding to this array, though:
942	if it is defined then the event loop has already been detected, and the	973	if it is defined then the event loop has already been detected, and the
943	array will be ignored.	974	array will be ignored.
944		975
945	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	976	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946	it,as it takes care of these details.	977	it, as it takes care of these details.
947		978
948	This variable is mainly useful for modules that can do something useful	979	This variable is mainly useful for modules that can do something useful
949	when AnyEvent is used and thus want to know when it is initialised, but do	980	when AnyEvent is used and thus want to know when it is initialised, but do
950	not need to even load it by default. This array provides the means to hook	981	not need to even load it by default. This array provides the means to hook
951	into AnyEvent passively, without loading it.	982	into AnyEvent passively, without loading it.
		983
		984	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		985	together, you could put this into Coro (this is the actual code used by
		986	Coro to accomplish this):
		987
		988	if (defined $AnyEvent::MODEL) {
		989	# AnyEvent already initialised, so load Coro::AnyEvent
		990	require Coro::AnyEvent;
		991	} else {
		992	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		993	# as soon as it is
		994	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		995	}
952		996
953	=back	997	=back
954		998
955	=head1 WHAT TO DO IN A MODULE	999	=head1 WHAT TO DO IN A MODULE
956		1000
…		…
1105		1149
1106	package AnyEvent;	1150	package AnyEvent;
1107		1151
1108	# basically a tuned-down version of common::sense	1152	# basically a tuned-down version of common::sense
1109	sub common_sense {	1153	sub common_sense {
1110	# no warnings	1154	# from common:.sense 1.0
1111	${^WARNING_BITS} ^= ${^WARNING_BITS};	1155	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1112	# use strict vars subs	1156	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1113	$^H \|= 0x00000600;	1157	$^H \|= 0x00000600;
1114	}	1158	}
1115		1159
1116	BEGIN { AnyEvent::common_sense }	1160	BEGIN { AnyEvent::common_sense }
1117		1161
1118	use Carp ();	1162	use Carp ();
1119		1163
1120	our $VERSION = 4.9;	1164	our $VERSION = '5.26';
1121	our $MODEL;	1165	our $MODEL;
1122		1166
1123	our $AUTOLOAD;	1167	our $AUTOLOAD;
1124	our @ISA;	1168	our @ISA;
1125		1169
1126	our @REGISTRY;	1170	our @REGISTRY;
1127		1171
1128	our $WIN32;
1129
1130	our $VERBOSE;	1172	our $VERBOSE;
1131		1173
1132	BEGIN {	1174	BEGIN {
1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1175	require "AnyEvent/constants.pl";
		1176
1134	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1177	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1135		1178
1136	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1179	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137	if ${^TAINT};	1180	if ${^TAINT};
1138		1181
1139	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1182	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1194	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1152	}	1195	}
1153		1196
1154	my @models = (	1197	my @models = (
1155	[EV:: => AnyEvent::Impl::EV:: , 1],	1198	[EV:: => AnyEvent::Impl::EV:: , 1],
1156	[Event:: => AnyEvent::Impl::Event::, 1],
1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1199	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1158	# everything below here will not (normally) be autoprobed	1200	# everything below here will not (normally) be autoprobed
1159	# as the pureperl backend should work everywhere	1201	# as the pureperl backend should work everywhere
1160	# and is usually faster	1202	# and is usually faster
		1203	[Event:: => AnyEvent::Impl::Event::, 1],
1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1204	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1205	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1206	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1207	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1208	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
…		…
1168	[Prima:: => AnyEvent::Impl::POE::],	1211	[Prima:: => AnyEvent::Impl::POE::],
1169	# IO::Async is just too broken - we would need workarounds for its	1212	# IO::Async is just too broken - we would need workarounds for its
1170	# byzantine signal and broken child handling, among others.	1213	# byzantine signal and broken child handling, among others.
1171	# IO::Async is rather hard to detect, as it doesn't have any	1214	# IO::Async is rather hard to detect, as it doesn't have any
1172	# obvious default class.	1215	# obvious default class.
1173	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1216	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1217	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1218	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1219	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176	);	1220	);
1177		1221
1178	our %method = map +($_ => 1),	1222	our %method = map +($_ => 1),
1179	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1223	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1180		1224
1181	our @post_detect;	1225	our @post_detect;
1182		1226
1183	sub post_detect(&) {	1227	sub post_detect(&) {
1184	my ($cb) = @_;	1228	my ($cb) = @_;
1185		1229
1186	if ($MODEL) {
1187	$cb->();
1188
1189	undef
1190	} else {
1191	push @post_detect, $cb;	1230	push @post_detect, $cb;
1192		1231
1193	defined wantarray	1232	defined wantarray
1194	? bless \$cb, "AnyEvent::Util::postdetect"	1233	? bless \$cb, "AnyEvent::Util::postdetect"
1195	: ()	1234	: ()
1196	}
1197	}	1235	}
1198		1236
1199	sub AnyEvent::Util::postdetect::DESTROY {	1237	sub AnyEvent::Util::postdetect::DESTROY {
1200	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1238	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1201	}	1239	}
1202		1240
1203	sub detect() {	1241	sub detect() {
		1242	# free some memory
		1243	*detect = sub () { $MODEL };
		1244
		1245	local $!; # for good measure
		1246	local $SIG{__DIE__};
		1247
		1248	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1249	my $model = "AnyEvent::Impl::$1";
		1250	if (eval "require $model") {
		1251	$MODEL = $model;
		1252	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1253	} else {
		1254	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1255	}
		1256	}
		1257
		1258	# check for already loaded models
1204	unless ($MODEL) {	1259	unless ($MODEL) {
1205	local $SIG{__DIE__};	1260	for (@REGISTRY, @models) {
1206		1261	my ($package, $model) = @$_;
1207	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1262	if (${"$package\::VERSION"} > 0) {
1208	my $model = "AnyEvent::Impl::$1";
1209	if (eval "require $model") {	1263	if (eval "require $model") {
1210	$MODEL = $model;	1264	$MODEL = $model;
1211	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1265	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1212	} else {	1266	last;
1213	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1267	}
1214	}	1268	}
1215	}	1269	}
1216		1270
1217	# check for already loaded models
1218	unless ($MODEL) {	1271	unless ($MODEL) {
		1272	# try to autoload a model
1219	for (@REGISTRY, @models) {	1273	for (@REGISTRY, @models) {
1220	my ($package, $model) = @$_;	1274	my ($package, $model, $autoload) = @$_;
		1275	if (
		1276	$autoload
		1277	and eval "require $package"
1221	if (${"$package\::VERSION"} > 0) {	1278	and ${"$package\::VERSION"} > 0
1222	if (eval "require $model") {	1279	and eval "require $model"
		1280	) {
1223	$MODEL = $model;	1281	$MODEL = $model;
1224	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1282	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1225	last;	1283	last;
1226	}
1227	}	1284	}
1228	}	1285	}
1229		1286
1230	unless ($MODEL) {
1231	# try to autoload a model
1232	for (@REGISTRY, @models) {
1233	my ($package, $model, $autoload) = @$_;
1234	if (
1235	$autoload
1236	and eval "require $package"
1237	and ${"$package\::VERSION"} > 0
1238	and eval "require $model"
1239	) {
1240	$MODEL = $model;
1241	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1242	last;
1243	}
1244	}
1245
1246	$MODEL	1287	$MODEL
1247	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1288	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1248	}
1249	}	1289	}
1250
1251	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1252
1253	unshift @ISA, $MODEL;
1254
1255	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1256
1257	(shift @post_detect)->() while @post_detect;
1258	}	1290	}
		1291
		1292	@models = (); # free probe data
		1293
		1294	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1295	unshift @ISA, $MODEL;
		1296
		1297	# now nuke some methods that are overriden by the backend.
		1298	# SUPER is not allowed.
		1299	for (qw(time signal child idle)) {
		1300	undef &{"AnyEvent::Base::$_"}
		1301	if defined &{"$MODEL\::$_"};
		1302	}
		1303
		1304	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1305
		1306	(shift @post_detect)->() while @post_detect;
		1307
		1308	*post_detect = sub(&) {
		1309	shift->();
		1310
		1311	undef
		1312	};
1259		1313
1260	$MODEL	1314	$MODEL
1261	}	1315	}
1262		1316
1263	sub AUTOLOAD {	1317	sub AUTOLOAD {
1264	(my $func = $AUTOLOAD) =~ s/.*://;	1318	(my $func = $AUTOLOAD) =~ s/.*://;
1265		1319
1266	$method{$func}	1320	$method{$func}
1267	or Carp::croak "$func: not a valid method for AnyEvent objects";	1321	or Carp::croak "$func: not a valid AnyEvent class method";
1268		1322
1269	detect unless $MODEL;	1323	detect;
1270		1324
1271	my $class = shift;	1325	my $class = shift;
1272	$class->$func (@_);	1326	$class->$func (@_);
1273	}	1327	}
1274		1328
…		…
1287	# we assume CLOEXEC is already set by perl in all important cases	1341	# we assume CLOEXEC is already set by perl in all important cases
1288		1342
1289	($fh2, $rw)	1343	($fh2, $rw)
1290	}	1344	}
1291		1345
		1346	=head1 SIMPLIFIED AE API
		1347
		1348	Starting with version 5.0, AnyEvent officially supports a second, much
		1349	simpler, API that is designed to reduce the calling, typing and memory
		1350	overhead by using function call syntax and a fixed number of parameters.
		1351
		1352	See the L<AE> manpage for details.
		1353
		1354	=cut
		1355
		1356	package AE;
		1357
		1358	our $VERSION = $AnyEvent::VERSION;
		1359
		1360	# fall back to the main API by default - backends and AnyEvent::Base
		1361	# implementations can overwrite these.
		1362
		1363	sub io($$$) {
		1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1365	}
		1366
		1367	sub timer($$$) {
		1368	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1369	}
		1370
		1371	sub signal($$) {
		1372	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1373	}
		1374
		1375	sub child($$) {
		1376	AnyEvent->child (pid => $_[0], cb => $_[1])
		1377	}
		1378
		1379	sub idle($) {
		1380	AnyEvent->idle (cb => $_[0])
		1381	}
		1382
		1383	sub cv(;&) {
		1384	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1385	}
		1386
		1387	sub now() {
		1388	AnyEvent->now
		1389	}
		1390
		1391	sub now_update() {
		1392	AnyEvent->now_update
		1393	}
		1394
		1395	sub time() {
		1396	AnyEvent->time
		1397	}
		1398
1292	package AnyEvent::Base;	1399	package AnyEvent::Base;
1293		1400
1294	# default implementations for many methods	1401	# default implementations for many methods
1295		1402
1296	sub _time {	1403	sub time {
		1404	eval q{ # poor man's autoloading {}
1297	# probe for availability of Time::HiRes	1405	# probe for availability of Time::HiRes
1298	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1299	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1407	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1300	*_time = \&Time::HiRes::time;	1408	*AE::time = \&Time::HiRes::time;
1301	# if (eval "use POSIX (); (POSIX::times())...	1409	# if (eval "use POSIX (); (POSIX::times())...
1302	} else {	1410	} else {
1303	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1411	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1304	*_time = sub { time }; # epic fail	1412	*AE::time = sub (){ time }; # epic fail
		1413	}
		1414
		1415	*time = sub { AE::time }; # different prototypes
1305	}	1416	};
		1417	die if $@;
1306		1418
1307	&_time	1419	&time
1308	}	1420	}
1309		1421
1310	sub time { _time }	1422	*now = \&time;
1311	sub now { _time }	1423
1312	sub now_update { }	1424	sub now_update { }
1313		1425
1314	# default implementation for ->condvar	1426	# default implementation for ->condvar
1315		1427
1316	sub condvar {	1428	sub condvar {
		1429	eval q{ # poor man's autoloading {}
		1430	*condvar = sub {
1317	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1431	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1432	};
		1433
		1434	*AE::cv = sub (;&) {
		1435	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1436	};
		1437	};
		1438	die if $@;
		1439
		1440	&condvar
1318	}	1441	}
1319		1442
1320	# default implementation for ->signal	1443	# default implementation for ->signal
1321		1444
1322	our $HAVE_ASYNC_INTERRUPT;	1445	our $HAVE_ASYNC_INTERRUPT;
1323		1446
1324	sub _have_async_interrupt() {	1447	sub _have_async_interrupt() {
1325	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1448	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1326	&& eval "use Async::Interrupt 1.0 (); 1")	1449	&& eval "use Async::Interrupt 1.02 (); 1")
1327	unless defined $HAVE_ASYNC_INTERRUPT;	1450	unless defined $HAVE_ASYNC_INTERRUPT;
1328		1451
1329	$HAVE_ASYNC_INTERRUPT	1452	$HAVE_ASYNC_INTERRUPT
1330	}	1453	}
1331		1454
1332	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1455	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1333	our (%SIG_ASY, %SIG_ASY_W);	1456	our (%SIG_ASY, %SIG_ASY_W);
1334	our ($SIG_COUNT, $SIG_TW);	1457	our ($SIG_COUNT, $SIG_TW);
1335		1458
1336	sub _signal_exec {
1337	$HAVE_ASYNC_INTERRUPT
1338	? $SIGPIPE_R->drain
1339	: sysread $SIGPIPE_R, my $dummy, 9;
1340
1341	while (%SIG_EV) {
1342	for (keys %SIG_EV) {
1343	delete $SIG_EV{$_};
1344	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1345	}
1346	}
1347	}
1348
1349	# install a dummy wakeup watcher to reduce signal catching latency	1459	# install a dummy wakeup watcher to reduce signal catching latency
		1460	# used by Impls
1350	sub _sig_add() {	1461	sub _sig_add() {
1351	unless ($SIG_COUNT++) {	1462	unless ($SIG_COUNT++) {
1352	# try to align timer on a full-second boundary, if possible	1463	# try to align timer on a full-second boundary, if possible
1353	my $NOW = AnyEvent->now;	1464	my $NOW = AE::now;
1354		1465
1355	$SIG_TW = AnyEvent->timer (	1466	$SIG_TW = AE::timer
1356	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1467	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1357	interval => $MAX_SIGNAL_LATENCY,	1468	$MAX_SIGNAL_LATENCY,
1358	cb => sub { }, # just for the PERL_ASYNC_CHECK	1469	sub { } # just for the PERL_ASYNC_CHECK
1359	);	1470	;
1360	}	1471	}
1361	}	1472	}
1362		1473
1363	sub _sig_del {	1474	sub _sig_del {
1364	undef $SIG_TW	1475	undef $SIG_TW
1365	unless --$SIG_COUNT;	1476	unless --$SIG_COUNT;
1366	}	1477	}
1367		1478
1368	our $_sig_name_init; $_sig_name_init = sub {	1479	our $_sig_name_init; $_sig_name_init = sub {
1369	eval q{ # poor man's autoloading	1480	eval q{ # poor man's autoloading {}
1370	undef $_sig_name_init;	1481	undef $_sig_name_init;
1371		1482
1372	if (_have_async_interrupt) {	1483	if (_have_async_interrupt) {
1373	*sig2num = \&Async::Interrupt::sig2num;	1484	*sig2num = \&Async::Interrupt::sig2num;
1374	*sig2name = \&Async::Interrupt::sig2name;	1485	*sig2name = \&Async::Interrupt::sig2name;
…		…
1401	# probe for availability of Async::Interrupt	1512	# probe for availability of Async::Interrupt
1402	if (_have_async_interrupt) {	1513	if (_have_async_interrupt) {
1403	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1514	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1404		1515
1405	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1516	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1406	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);	1517	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1407		1518
1408	} else {	1519	} else {
1409	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1520	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1410
1411	require Fcntl;
1412		1521
1413	if (AnyEvent::WIN32) {	1522	if (AnyEvent::WIN32) {
1414	require AnyEvent::Util;	1523	require AnyEvent::Util;
1415		1524
1416	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1525	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1417	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1526	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1418	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1527	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1419	} else {	1528	} else {
1420	pipe $SIGPIPE_R, $SIGPIPE_W;	1529	pipe $SIGPIPE_R, $SIGPIPE_W;
1421	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1530	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1422	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1531	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1423		1532
1424	# not strictly required, as $^F is normally 2, but let's make sure...	1533	# not strictly required, as $^F is normally 2, but let's make sure...
1425	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1534	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1426	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1535	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1427	}	1536	}
1428		1537
1429	$SIGPIPE_R	1538	$SIGPIPE_R
1430	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1539	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1431		1540
1432	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1541	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1433	}	1542	}
1434		1543
1435	*signal = sub {	1544	*signal = $HAVE_ASYNC_INTERRUPT
		1545	? sub {
1436	my (undef, %arg) = @_;	1546	my (undef, %arg) = @_;
1437		1547
1438	my $signal = uc $arg{signal}
1439	or Carp::croak "required option 'signal' is missing";
1440
1441	if ($HAVE_ASYNC_INTERRUPT) {
1442	# async::interrupt	1548	# async::interrupt
1443
1444	$signal = sig2num $signal;	1549	my $signal = sig2num $arg{signal};
1445	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1550	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1446		1551
1447	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1552	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1448	cb => sub { undef $SIG_EV{$signal} },	1553	cb => sub { undef $SIG_EV{$signal} },
1449	signal => $signal,	1554	signal => $signal,
1450	pipe => [$SIGPIPE_R->filenos],	1555	pipe => [$SIGPIPE_R->filenos],
1451	pipe_autodrain => 0,	1556	pipe_autodrain => 0,
1452	;	1557	;
1453		1558
1454	} else {	1559	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1560	}
		1561	: sub {
		1562	my (undef, %arg) = @_;
		1563
1455	# pure perl	1564	# pure perl
1456
1457	# AE::Util has been loaded in signal
1458	$signal = sig2name $signal;	1565	my $signal = sig2name $arg{signal};
1459	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1566	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1460		1567
1461	$SIG{$signal} \|\|= sub {	1568	$SIG{$signal} \|\|= sub {
1462	local $!;	1569	local $!;
1463	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1570	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1464	undef $SIG_EV{$signal};	1571	undef $SIG_EV{$signal};
1465	};	1572	};
1466		1573
1467	# can't do signal processing without introducing races in pure perl,	1574	# can't do signal processing without introducing races in pure perl,
1468	# so limit the signal latency.	1575	# so limit the signal latency.
1469	_sig_add;	1576	_sig_add;
1470	}
1471		1577
1472	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1578	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1579	}
1473	};	1580	;
1474		1581
1475	*AnyEvent::Base::signal::DESTROY = sub {	1582	*AnyEvent::Base::signal::DESTROY = sub {
1476	my ($signal, $cb) = @{$_[0]};	1583	my ($signal, $cb) = @{$_[0]};
1477		1584
1478	_sig_del;	1585	_sig_del;
…		…
1485	# print weird messages, or just unconditionally exit	1592	# print weird messages, or just unconditionally exit
1486	# instead of getting the default action.	1593	# instead of getting the default action.
1487	undef $SIG{$signal}	1594	undef $SIG{$signal}
1488	unless keys %{ $SIG_CB{$signal} };	1595	unless keys %{ $SIG_CB{$signal} };
1489	};	1596	};
		1597
		1598	*_signal_exec = sub {
		1599	$HAVE_ASYNC_INTERRUPT
		1600	? $SIGPIPE_R->drain
		1601	: sysread $SIGPIPE_R, (my $dummy), 9;
		1602
		1603	while (%SIG_EV) {
		1604	for (keys %SIG_EV) {
		1605	delete $SIG_EV{$_};
		1606	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1607	}
		1608	}
		1609	};
1490	};	1610	};
1491	die if $@;	1611	die if $@;
		1612
1492	&signal	1613	&signal
1493	}	1614	}
1494		1615
1495	# default implementation for ->child	1616	# default implementation for ->child
1496		1617
1497	our %PID_CB;	1618	our %PID_CB;
1498	our $CHLD_W;	1619	our $CHLD_W;
1499	our $CHLD_DELAY_W;	1620	our $CHLD_DELAY_W;
1500	our $WNOHANG;	1621	our $WNOHANG;
1501		1622
		1623	# used by many Impl's
1502	sub _emit_childstatus($$) {	1624	sub _emit_childstatus($$) {
1503	my (undef, $rpid, $rstatus) = @_;	1625	my (undef, $rpid, $rstatus) = @_;
1504		1626
1505	$_->($rpid, $rstatus)	1627	$_->($rpid, $rstatus)
1506	for values %{ $PID_CB{$rpid} \|\| {} },	1628	for values %{ $PID_CB{$rpid} \|\| {} },
1507	values %{ $PID_CB{0} \|\| {} };	1629	values %{ $PID_CB{0} \|\| {} };
1508	}	1630	}
1509		1631
1510	sub _sigchld {
1511	my $pid;
1512
1513	AnyEvent->_emit_childstatus ($pid, $?)
1514	while ($pid = waitpid -1, $WNOHANG) > 0;
1515	}
1516
1517	sub child {	1632	sub child {
		1633	eval q{ # poor man's autoloading {}
		1634	*_sigchld = sub {
		1635	my $pid;
		1636
		1637	AnyEvent->_emit_childstatus ($pid, $?)
		1638	while ($pid = waitpid -1, $WNOHANG) > 0;
		1639	};
		1640
		1641	*child = sub {
1518	my (undef, %arg) = @_;	1642	my (undef, %arg) = @_;
1519		1643
1520	defined (my $pid = $arg{pid} + 0)	1644	defined (my $pid = $arg{pid} + 0)
1521	or Carp::croak "required option 'pid' is missing";	1645	or Carp::croak "required option 'pid' is missing";
1522		1646
1523	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1647	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1524		1648
1525	# WNOHANG is almost cetrainly 1 everywhere	1649	# WNOHANG is almost cetrainly 1 everywhere
1526	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1650	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1527	? 1	1651	? 1
1528	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1652	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1529		1653
1530	unless ($CHLD_W) {	1654	unless ($CHLD_W) {
1531	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1655	$CHLD_W = AE::signal CHLD => \&_sigchld;
1532	# child could be a zombie already, so make at least one round	1656	# child could be a zombie already, so make at least one round
1533	&_sigchld;	1657	&_sigchld;
1534	}	1658	}
1535		1659
1536	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1660	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1537	}	1661	};
1538		1662
1539	sub AnyEvent::Base::child::DESTROY {	1663	*AnyEvent::Base::child::DESTROY = sub {
1540	my ($pid, $cb) = @{$_[0]};	1664	my ($pid, $cb) = @{$_[0]};
1541		1665
1542	delete $PID_CB{$pid}{$cb};	1666	delete $PID_CB{$pid}{$cb};
1543	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1667	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1544		1668
1545	undef $CHLD_W unless keys %PID_CB;	1669	undef $CHLD_W unless keys %PID_CB;
		1670	};
		1671	};
		1672	die if $@;
		1673
		1674	&child
1546	}	1675	}
1547		1676
1548	# idle emulation is done by simply using a timer, regardless	1677	# idle emulation is done by simply using a timer, regardless
1549	# of whether the process is idle or not, and not letting	1678	# of whether the process is idle or not, and not letting
1550	# the callback use more than 50% of the time.	1679	# the callback use more than 50% of the time.
1551	sub idle {	1680	sub idle {
		1681	eval q{ # poor man's autoloading {}
		1682	*idle = sub {
1552	my (undef, %arg) = @_;	1683	my (undef, %arg) = @_;
1553		1684
1554	my ($cb, $w, $rcb) = $arg{cb};	1685	my ($cb, $w, $rcb) = $arg{cb};
1555		1686
1556	$rcb = sub {	1687	$rcb = sub {
1557	if ($cb) {	1688	if ($cb) {
1558	$w = _time;	1689	$w = _time;
1559	&$cb;	1690	&$cb;
1560	$w = _time - $w;	1691	$w = _time - $w;
1561		1692
1562	# never use more then 50% of the time for the idle watcher,	1693	# never use more then 50% of the time for the idle watcher,
1563	# within some limits	1694	# within some limits
1564	$w = 0.0001 if $w < 0.0001;	1695	$w = 0.0001 if $w < 0.0001;
1565	$w = 5 if $w > 5;	1696	$w = 5 if $w > 5;
1566		1697
1567	$w = AnyEvent->timer (after => $w, cb => $rcb);	1698	$w = AE::timer $w, 0, $rcb;
1568	} else {	1699	} else {
1569	# clean up...	1700	# clean up...
1570	undef $w;	1701	undef $w;
1571	undef $rcb;	1702	undef $rcb;
		1703	}
		1704	};
		1705
		1706	$w = AE::timer 0.05, 0, $rcb;
		1707
		1708	bless \\$cb, "AnyEvent::Base::idle"
1572	}	1709	};
		1710
		1711	*AnyEvent::Base::idle::DESTROY = sub {
		1712	undef $${$_[0]};
		1713	};
1573	};	1714	};
		1715	die if $@;
1574		1716
1575	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1717	&idle
1576
1577	bless \\$cb, "AnyEvent::Base::idle"
1578	}
1579
1580	sub AnyEvent::Base::idle::DESTROY {
1581	undef $${$_[0]};
1582	}	1718	}
1583		1719
1584	package AnyEvent::CondVar;	1720	package AnyEvent::CondVar;
1585		1721
1586	our @ISA = AnyEvent::CondVar::Base::;	1722	our @ISA = AnyEvent::CondVar::Base::;
…		…
1657	}	1793	}
1658		1794
1659	# undocumented/compatibility with pre-3.4	1795	# undocumented/compatibility with pre-3.4
1660	*broadcast = \&send;	1796	*broadcast = \&send;
1661	*wait = \&_wait;	1797	*wait = \&_wait;
1662
1663	#############################################################################
1664	# "new" API, currently only emulation of it
1665	#############################################################################
1666
1667	package AE;
1668
1669	sub io($$$) {
1670	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1671	}
1672
1673	sub timer($$$) {
1674	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1675	}
1676
1677	sub signal($$) {
1678	AnyEvent->signal (signal => $_[0], cb => $_[1]);
1679	}
1680
1681	sub child($$) {
1682	AnyEvent->child (pid => $_[0], cb => $_[1]);
1683	}
1684
1685	sub idle($) {
1686	AnyEvent->idle (cb => $_[0]);
1687	}
1688
1689	sub cv() {
1690	AnyEvent->condvar
1691	}
1692
1693	sub now() {
1694	AnyEvent->now
1695	}
1696
1697	sub now_update() {
1698	AnyEvent->now_update
1699	}
1700
1701	sub time() {
1702	AnyEvent->time
1703	}
1704		1798
1705	=head1 ERROR AND EXCEPTION HANDLING	1799	=head1 ERROR AND EXCEPTION HANDLING
1706		1800
1707	In general, AnyEvent does not do any error handling - it relies on the	1801	In general, AnyEvent does not do any error handling - it relies on the
1708	caller to do that if required. The L<AnyEvent::Strict> module (see also	1802	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1902	warn "read: $input\n"; # output what has been read	1996	warn "read: $input\n"; # output what has been read
1903	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1997	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1904	},	1998	},
1905	);	1999	);
1906		2000
1907	my $time_watcher; # can only be used once
1908
1909	sub new_timer {
1910	$timer = AnyEvent->timer (after => 1, cb => sub {	2001	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1911	warn "timeout\n"; # print 'timeout' about every second	2002	warn "timeout\n"; # print 'timeout' at most every second
1912	&new_timer; # and restart the time
1913	});	2003	});
1914	}
1915
1916	new_timer; # create first timer
1917		2004
1918	$cv->recv; # wait until user enters /^q/i	2005	$cv->recv; # wait until user enters /^q/i
1919		2006
1920	=head1 REAL-WORLD EXAMPLE	2007	=head1 REAL-WORLD EXAMPLE
1921		2008
…		…
1994		2081
1995	The actual code goes further and collects all errors (C<die>s, exceptions)	2082	The actual code goes further and collects all errors (C<die>s, exceptions)
1996	that occurred during request processing. The C<result> method detects	2083	that occurred during request processing. The C<result> method detects
1997	whether an exception as thrown (it is stored inside the $txn object)	2084	whether an exception as thrown (it is stored inside the $txn object)
1998	and just throws the exception, which means connection errors and other	2085	and just throws the exception, which means connection errors and other
1999	problems get reported tot he code that tries to use the result, not in a	2086	problems get reported to the code that tries to use the result, not in a
2000	random callback.	2087	random callback.
2001		2088
2002	All of this enables the following usage styles:	2089	All of this enables the following usage styles:
2003		2090
2004	1. Blocking:	2091	1. Blocking:
…		…
2052	through AnyEvent. The benchmark creates a lot of timers (with a zero	2139	through AnyEvent. The benchmark creates a lot of timers (with a zero
2053	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2140	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2054	which it is), lets them fire exactly once and destroys them again.	2141	which it is), lets them fire exactly once and destroys them again.
2055		2142
2056	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2143	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2057	distribution.	2144	distribution. It uses the L<AE> interface, which makes a real difference
		2145	for the EV and Perl backends only.
2058		2146
2059	=head3 Explanation of the columns	2147	=head3 Explanation of the columns
2060		2148
2061	I<watcher> is the number of event watchers created/destroyed. Since	2149	I<watcher> is the number of event watchers created/destroyed. Since
2062	different event models feature vastly different performances, each event	2150	different event models feature vastly different performances, each event
…		…
2083	watcher.	2171	watcher.
2084		2172
2085	=head3 Results	2173	=head3 Results
2086		2174
2087	name watchers bytes create invoke destroy comment	2175	name watchers bytes create invoke destroy comment
2088	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2176	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2089	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2177	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2090	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2178	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2091	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2179	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2092	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2180	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2093	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2181	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2094	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2182	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2095	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2183	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2096	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2184	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2097	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2185	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2098	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2186	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2099	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2187	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2100		2188
2101	=head3 Discussion	2189	=head3 Discussion
2102		2190
2103	The benchmark does I<not> measure scalability of the event loop very	2191	The benchmark does I<not> measure scalability of the event loop very
2104	well. For example, a select-based event loop (such as the pure perl one)	2192	well. For example, a select-based event loop (such as the pure perl one)
…		…
2116	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2204	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2117	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2205	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2118	cycles with POE.	2206	cycles with POE.
2119		2207
2120	C<EV> is the sole leader regarding speed and memory use, which are both	2208	C<EV> is the sole leader regarding speed and memory use, which are both
2121	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2209	maximal/minimal, respectively. When using the L<AE> API there is zero
		2210	overhead (when going through the AnyEvent API create is about 5-6 times
		2211	slower, with other times being equal, so still uses far less memory than
2122	far less memory than any other event loop and is still faster than Event	2212	any other event loop and is still faster than Event natively).
2123	natively.
2124		2213
2125	The pure perl implementation is hit in a few sweet spots (both the	2214	The pure perl implementation is hit in a few sweet spots (both the
2126	constant timeout and the use of a single fd hit optimisations in the perl	2215	constant timeout and the use of a single fd hit optimisations in the perl
2127	interpreter and the backend itself). Nevertheless this shows that it	2216	interpreter and the backend itself). Nevertheless this shows that it
2128	adds very little overhead in itself. Like any select-based backend its	2217	adds very little overhead in itself. Like any select-based backend its
…		…
2202	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2291	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2203	(1%) are active. This mirrors the activity of large servers with many	2292	(1%) are active. This mirrors the activity of large servers with many
2204	connections, most of which are idle at any one point in time.	2293	connections, most of which are idle at any one point in time.
2205		2294
2206	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2295	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2207	distribution.	2296	distribution. It uses the L<AE> interface, which makes a real difference
		2297	for the EV and Perl backends only.
2208		2298
2209	=head3 Explanation of the columns	2299	=head3 Explanation of the columns
2210		2300
2211	I<sockets> is the number of sockets, and twice the number of "servers" (as	2301	I<sockets> is the number of sockets, and twice the number of "servers" (as
2212	each server has a read and write socket end).	2302	each server has a read and write socket end).
…		…
2220	a new one that moves the timeout into the future.	2310	a new one that moves the timeout into the future.
2221		2311
2222	=head3 Results	2312	=head3 Results
2223		2313
2224	name sockets create request	2314	name sockets create request
2225	EV 20000 69.01 11.16	2315	EV 20000 62.66 7.99
2226	Perl 20000 73.32 35.87	2316	Perl 20000 68.32 32.64
2227	IOAsync 20000 157.00 98.14 epoll	2317	IOAsync 20000 174.06 101.15 epoll
2228	IOAsync 20000 159.31 616.06 poll	2318	IOAsync 20000 174.67 610.84 poll
2229	Event 20000 212.62 257.32	2319	Event 20000 202.69 242.91
2230	Glib 20000 651.16 1896.30	2320	Glib 20000 557.01 1689.52
2231	POE 20000 349.67 12317.24 uses POE::Loop::Event	2321	POE 20000 341.54 12086.32 uses POE::Loop::Event
2232		2322
2233	=head3 Discussion	2323	=head3 Discussion
2234		2324
2235	This benchmark I<does> measure scalability and overall performance of the	2325	This benchmark I<does> measure scalability and overall performance of the
2236	particular event loop.	2326	particular event loop.
…		…
2362	As you can see, the AnyEvent + EV combination even beats the	2452	As you can see, the AnyEvent + EV combination even beats the
2363	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2453	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2364	backend easily beats IO::Lambda and POE.	2454	backend easily beats IO::Lambda and POE.
2365		2455
2366	And even the 100% non-blocking version written using the high-level (and	2456	And even the 100% non-blocking version written using the high-level (and
2367	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2457	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2368	large margin, even though it does all of DNS, tcp-connect and socket I/O	2458	higher level ("unoptimised") abstractions by a large margin, even though
2369	in a non-blocking way.	2459	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2370		2460
2371	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2461	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2372	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2462	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2373	part of the IO::lambda distribution and were used without any changes.	2463	part of the IO::Lambda distribution and were used without any changes.
2374		2464
2375		2465
2376	=head1 SIGNALS	2466	=head1 SIGNALS
2377		2467
2378	AnyEvent currently installs handlers for these signals:	2468	AnyEvent currently installs handlers for these signals:
…		…
2420	it's built-in modules) are required to use it.	2510	it's built-in modules) are required to use it.
2421		2511
2422	That does not mean that AnyEvent won't take advantage of some additional	2512	That does not mean that AnyEvent won't take advantage of some additional
2423	modules if they are installed.	2513	modules if they are installed.
2424		2514
2425	This section epxlains which additional modules will be used, and how they	2515	This section explains which additional modules will be used, and how they
2426	affect AnyEvent's operetion.	2516	affect AnyEvent's operation.
2427		2517
2428	=over 4	2518	=over 4
2429		2519
2430	=item L<Async::Interrupt>	2520	=item L<Async::Interrupt>
2431		2521
…		…
2436	catch the signals) with some delay (default is 10 seconds, look for	2526	catch the signals) with some delay (default is 10 seconds, look for
2437	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2527	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2438		2528
2439	If this module is available, then it will be used to implement signal	2529	If this module is available, then it will be used to implement signal
2440	catching, which means that signals will not be delayed, and the event loop	2530	catching, which means that signals will not be delayed, and the event loop
2441	will not be interrupted regularly, which is more efficient (And good for	2531	will not be interrupted regularly, which is more efficient (and good for
2442	battery life on laptops).	2532	battery life on laptops).
2443		2533
2444	This affects not just the pure-perl event loop, but also other event loops	2534	This affects not just the pure-perl event loop, but also other event loops
2445	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2535	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2446		2536
…		…
2458	automatic timer adjustments even when no monotonic clock is available,	2548	automatic timer adjustments even when no monotonic clock is available,
2459	can take avdantage of advanced kernel interfaces such as C<epoll> and	2549	can take avdantage of advanced kernel interfaces such as C<epoll> and
2460	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2550	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2461	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2551	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2462		2552
		2553	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2554	then this module will do nothing for you.
		2555
2463	=item L<Guard>	2556	=item L<Guard>
2464		2557
2465	The guard module, when used, will be used to implement	2558	The guard module, when used, will be used to implement
2466	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2559	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2467	lot less memory), but otherwise doesn't affect guard operation much. It is	2560	lot less memory), but otherwise doesn't affect guard operation much. It is
2468	purely used for performance.	2561	purely used for performance.
2469		2562
2470	=item L<JSON> and L<JSON::XS>	2563	=item L<JSON> and L<JSON::XS>
2471		2564
2472	This module is required when you want to read or write JSON data via	2565	One of these modules is required when you want to read or write JSON data
2473	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2566	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2474	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2567	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2475
2476	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2477	installed.
2478		2568
2479	=item L<Net::SSLeay>	2569	=item L<Net::SSLeay>
2480		2570
2481	Implementing TLS/SSL in Perl is certainly interesting, but not very	2571	Implementing TLS/SSL in Perl is certainly interesting, but not very
2482	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2572	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2493		2583
2494		2584
2495	=head1 FORK	2585	=head1 FORK
2496		2586
2497	Most event libraries are not fork-safe. The ones who are usually are	2587	Most event libraries are not fork-safe. The ones who are usually are
2498	because they rely on inefficient but fork-safe C<select> or C<poll>	2588	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2499	calls. Only L<EV> is fully fork-aware.	2589	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2590	are usually badly thought-out hacks that are incompatible with fork in
		2591	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2592	continue event-processing in both parent and child (or both, if you know
		2593	what you are doing).
		2594
		2595	This means that, in general, you cannot fork and do event processing in
		2596	the child if the event library was initialised before the fork (which
		2597	usually happens when the first AnyEvent watcher is created, or the library
		2598	is loaded).
2500		2599
2501	If you have to fork, you must either do so I<before> creating your first	2600	If you have to fork, you must either do so I<before> creating your first
2502	watcher OR you must not use AnyEvent at all in the child OR you must do	2601	watcher OR you must not use AnyEvent at all in the child OR you must do
2503	something completely out of the scope of AnyEvent.	2602	something completely out of the scope of AnyEvent.
		2603
		2604	The problem of doing event processing in the parent I<and> the child
		2605	is much more complicated: even for backends that I<are> fork-aware or
		2606	fork-safe, their behaviour is not usually what you want: fork clones all
		2607	watchers, that means all timers, I/O watchers etc. are active in both
		2608	parent and child, which is almost never what you want. USing C<exec>
		2609	to start worker children from some kind of manage rprocess is usually
		2610	preferred, because it is much easier and cleaner, at the expense of having
		2611	to have another binary.
2504		2612
2505		2613
2506	=head1 SECURITY CONSIDERATIONS	2614	=head1 SECURITY CONSIDERATIONS
2507		2615
2508	AnyEvent can be forced to load any event model via	2616	AnyEvent can be forced to load any event model via

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.270 by root, Fri Jul 31 20:16:34 2009 UTC vs. Revision 1.320 by root, Mon Apr 12 02:50:31 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.270 by root, Fri Jul 31 20:16:34 2009 UTC vs.
Revision 1.320 by root, Mon Apr 12 02:50:31 2010 UTC