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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.276 by root, Sun Aug 9 10:53:33 2009 UTC vs.
Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC

…		…
363	might affect timers and time-outs.	363	might affect timers and time-outs.
364		364
365	When this is the case, you can call this method, which will update the	365	When this is the case, you can call this method, which will update the
366	event loop's idea of "current time".	366	event loop's idea of "current time".
367		367
		368	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		369	when mod_perl executes the script, then the event loop will have the wrong
		370	idea about the "current time" (being potentially far in the past, when the
		371	script ran the last time). In that case you should arrange a call to C<<
		372	AnyEvent->now_update >> each time the web server process wakes up again
		373	(e.g. at the start of your script, or in a handler).
		374
368	Note that updating the time I<might> cause some events to be handled.	375	Note that updating the time I<might> cause some events to be handled.
369		376
370	=back	377	=back
371		378
372	=head2 SIGNAL WATCHERS	379	=head2 SIGNAL WATCHERS
…		…
395	correctly.	402	correctly.
396		403
397	Example: exit on SIGINT	404	Example: exit on SIGINT
398		405
399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		407
		408	=head3 Restart Behaviour
		409
		410	While restart behaviour is up to the event loop implementation, most will
		411	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		412	pure perl implementation).
		413
		414	=head3 Safe/Unsafe Signals
		415
		416	Perl signals can be either "safe" (synchronous to opcode handling) or
		417	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		418	latter might corrupt your memory.
		419
		420	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		421	i.e. they will not interrupt your running perl program but will only be
		422	called as part of the normal event handling (just like timer, I/O etc.
		423	callbacks, too).
400		424
401	=head3 Signal Races, Delays and Workarounds	425	=head3 Signal Races, Delays and Workarounds
402		426
403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	427	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	428	callbacks to signals in a generic way, which is a pity, as you cannot
…		…
479		503
480	=head2 IDLE WATCHERS	504	=head2 IDLE WATCHERS
481		505
482	$w = AnyEvent->idle (cb => <callback>);	506	$w = AnyEvent->idle (cb => <callback>);
483		507
484	Sometimes there is a need to do something, but it is not so important	508	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	509	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		510
489	Idle watchers ideally get invoked when the event loop has nothing	511	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	512	is not so important (or wise) to do it instantly. The callback will be
491	events. Instead of blocking, the idle watcher is invoked.	513	invoked only when there is "nothing better to do", which is usually
		514	defined as "all outstanding events have been handled and no new events
		515	have been detected". That means that idle watchers ideally get invoked
		516	when the event loop has just polled for new events but none have been
		517	detected. Instead of blocking to wait for more events, the idle watchers
		518	will be invoked.
492		519
493	Most event loops unfortunately do not really support idle watchers (only	520	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	521	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
495	will simply call the callback "from time to time".	522	will simply call the callback "from time to time".
496		523
497	Example: read lines from STDIN, but only process them when the	524	Example: read lines from STDIN, but only process them when the
498	program is otherwise idle:	525	program is otherwise idle:
…		…
592	after => 1,	619	after => 1,
593	cb => sub { $result_ready->send },	620	cb => sub { $result_ready->send },
594	);	621	);
595		622
596	# this "blocks" (while handling events) till the callback	623	# this "blocks" (while handling events) till the callback
597	# calls -<send	624	# calls ->send
598	$result_ready->recv;	625	$result_ready->recv;
599		626
600	Example: wait for a timer, but take advantage of the fact that condition	627	Example: wait for a timer, but take advantage of the fact that condition
601	variables are also callable directly.	628	variables are also callable directly.
602		629
…		…
666	one. For example, a function that pings many hosts in parallel might want	693	one. For example, a function that pings many hosts in parallel might want
667	to use a condition variable for the whole process.	694	to use a condition variable for the whole process.
668		695
669	Every call to C<< ->begin >> will increment a counter, and every call to	696	Every call to C<< ->begin >> will increment a counter, and every call to
670	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	697	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
671	>>, the (last) callback passed to C<begin> will be executed. That callback	698	>>, the (last) callback passed to C<begin> will be executed, passing the
672	is I<supposed> to call C<< ->send >>, but that is not required. If no	699	condvar as first argument. That callback is I<supposed> to call C<< ->send
673	callback was set, C<send> will be called without any arguments.	700	>>, but that is not required. If no group callback was set, C<send> will
		701	be called without any arguments.
674		702
675	You can think of C<< $cv->send >> giving you an OR condition (one call	703	You can think of C<< $cv->send >> giving you an OR condition (one call
676	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	704	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
677	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	705	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
678		706
…		…
705	begung can potentially be zero:	733	begung can potentially be zero:
706		734
707	my $cv = AnyEvent->condvar;	735	my $cv = AnyEvent->condvar;
708		736
709	my %result;	737	my %result;
710	$cv->begin (sub { $cv->send (\%result) });	738	$cv->begin (sub { shift->send (\%result) });
711		739
712	for my $host (@list_of_hosts) {	740	for my $host (@list_of_hosts) {
713	$cv->begin;	741	$cv->begin;
714	ping_host_then_call_callback $host, sub {	742	ping_host_then_call_callback $host, sub {
715	$result{$host} = ...;	743	$result{$host} = ...;
…		…
941	You should check C<$AnyEvent::MODEL> before adding to this array, though:	969	You should check C<$AnyEvent::MODEL> before adding to this array, though:
942	if it is defined then the event loop has already been detected, and the	970	if it is defined then the event loop has already been detected, and the
943	array will be ignored.	971	array will be ignored.
944		972
945	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	973	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946	it,as it takes care of these details.	974	it, as it takes care of these details.
947		975
948	This variable is mainly useful for modules that can do something useful	976	This variable is mainly useful for modules that can do something useful
949	when AnyEvent is used and thus want to know when it is initialised, but do	977	when AnyEvent is used and thus want to know when it is initialised, but do
950	not need to even load it by default. This array provides the means to hook	978	not need to even load it by default. This array provides the means to hook
951	into AnyEvent passively, without loading it.	979	into AnyEvent passively, without loading it.
		980
		981	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		982	together, you could put this into Coro (this is the actual code used by
		983	Coro to accomplish this):
		984
		985	if (defined $AnyEvent::MODEL) {
		986	# AnyEvent already initialised, so load Coro::AnyEvent
		987	require Coro::AnyEvent;
		988	} else {
		989	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		990	# as soon as it is
		991	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		992	}
952		993
953	=back	994	=back
954		995
955	=head1 WHAT TO DO IN A MODULE	996	=head1 WHAT TO DO IN A MODULE
956		997
…		…
1105		1146
1106	package AnyEvent;	1147	package AnyEvent;
1107		1148
1108	# basically a tuned-down version of common::sense	1149	# basically a tuned-down version of common::sense
1109	sub common_sense {	1150	sub common_sense {
1110	# no warnings	1151	# from common:.sense 1.0
1111	${^WARNING_BITS} ^= ${^WARNING_BITS};	1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1112	# use strict vars subs	1153	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1113	$^H \|= 0x00000600;	1154	$^H \|= 0x00000600;
1114	}	1155	}
1115		1156
1116	BEGIN { AnyEvent::common_sense }	1157	BEGIN { AnyEvent::common_sense }
1117		1158
1118	use Carp ();	1159	use Carp ();
1119		1160
1120	our $VERSION = 4.92;	1161	our $VERSION = '5.24';
1121	our $MODEL;	1162	our $MODEL;
1122		1163
1123	our $AUTOLOAD;	1164	our $AUTOLOAD;
1124	our @ISA;	1165	our @ISA;
1125		1166
1126	our @REGISTRY;	1167	our @REGISTRY;
1127		1168
1128	our $WIN32;
1129
1130	our $VERBOSE;	1169	our $VERBOSE;
1131		1170
1132	BEGIN {	1171	BEGIN {
		1172	eval "sub CYGWIN(){" . (($^O =~ /cygwin/i) *1) . "}";
1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1173	eval "sub WIN32 (){" . (($^O =~ /mswin32/i)*1) . "}";
1134	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1174	eval "sub TAINT (){" . (${^TAINT} *1) . "}";
1135		1175
1136	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137	if ${^TAINT};	1177	if ${^TAINT};
1138		1178
1139	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1168	[Prima:: => AnyEvent::Impl::POE::],	1208	[Prima:: => AnyEvent::Impl::POE::],
1169	# IO::Async is just too broken - we would need workarounds for its	1209	# IO::Async is just too broken - we would need workarounds for its
1170	# byzantine signal and broken child handling, among others.	1210	# byzantine signal and broken child handling, among others.
1171	# IO::Async is rather hard to detect, as it doesn't have any	1211	# IO::Async is rather hard to detect, as it doesn't have any
1172	# obvious default class.	1212	# obvious default class.
1173	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1213	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1215	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1216	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176	);	1217	);
1177		1218
1178	our %method = map +($_ => 1),	1219	our %method = map +($_ => 1),
1179	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1220	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1180		1221
…		…
1199	sub AnyEvent::Util::postdetect::DESTROY {	1240	sub AnyEvent::Util::postdetect::DESTROY {
1200	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1241	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1201	}	1242	}
1202		1243
1203	sub detect() {	1244	sub detect() {
		1245	# free some memory
		1246	*detect = sub () { $MODEL };
		1247
		1248	local $!; # for good measure
		1249	local $SIG{__DIE__};
		1250
		1251	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1252	my $model = "AnyEvent::Impl::$1";
		1253	if (eval "require $model") {
		1254	$MODEL = $model;
		1255	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1256	} else {
		1257	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1258	}
		1259	}
		1260
		1261	# check for already loaded models
1204	unless ($MODEL) {	1262	unless ($MODEL) {
1205	local $SIG{__DIE__};	1263	for (@REGISTRY, @models) {
1206		1264	my ($package, $model) = @$_;
1207	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1265	if (${"$package\::VERSION"} > 0) {
1208	my $model = "AnyEvent::Impl::$1";
1209	if (eval "require $model") {	1266	if (eval "require $model") {
1210	$MODEL = $model;	1267	$MODEL = $model;
1211	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1268	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1212	} else {	1269	last;
1213	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1270	}
1214	}	1271	}
1215	}	1272	}
1216		1273
1217	# check for already loaded models
1218	unless ($MODEL) {	1274	unless ($MODEL) {
		1275	# try to autoload a model
1219	for (@REGISTRY, @models) {	1276	for (@REGISTRY, @models) {
1220	my ($package, $model) = @$_;	1277	my ($package, $model, $autoload) = @$_;
		1278	if (
		1279	$autoload
		1280	and eval "require $package"
1221	if (${"$package\::VERSION"} > 0) {	1281	and ${"$package\::VERSION"} > 0
1222	if (eval "require $model") {	1282	and eval "require $model"
		1283	) {
1223	$MODEL = $model;	1284	$MODEL = $model;
1224	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1285	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1225	last;	1286	last;
1226	}
1227	}	1287	}
1228	}	1288	}
1229		1289
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	1290	$MODEL
1247	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1291	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1248	}
1249	}	1292	}
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	}	1293	}
		1294
		1295	@models = (); # free probe data
		1296
		1297	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1298	unshift @ISA, $MODEL;
		1299
		1300	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1301
		1302	(shift @post_detect)->() while @post_detect;
1259		1303
1260	$MODEL	1304	$MODEL
1261	}	1305	}
1262		1306
1263	sub AUTOLOAD {	1307	sub AUTOLOAD {
1264	(my $func = $AUTOLOAD) =~ s/.*://;	1308	(my $func = $AUTOLOAD) =~ s/.*://;
1265		1309
1266	$method{$func}	1310	$method{$func}
1267	or Carp::croak "$func: not a valid method for AnyEvent objects";	1311	or Carp::croak "$func: not a valid AnyEvent class method";
1268		1312
1269	detect unless $MODEL;	1313	detect;
1270		1314
1271	my $class = shift;	1315	my $class = shift;
1272	$class->$func (@_);	1316	$class->$func (@_);
1273	}	1317	}
1274		1318
…		…
1287	# we assume CLOEXEC is already set by perl in all important cases	1331	# we assume CLOEXEC is already set by perl in all important cases
1288		1332
1289	($fh2, $rw)	1333	($fh2, $rw)
1290	}	1334	}
1291		1335
1292	#############################################################################	1336	=head1 SIMPLIFIED AE API
1293	# "new" API, currently only emulation of it	1337
1294	#############################################################################	1338	Starting with version 5.0, AnyEvent officially supports a second, much
		1339	simpler, API that is designed to reduce the calling, typing and memory
		1340	overhead.
		1341
		1342	See the L<AE> manpage for details.
		1343
		1344	=cut
1295		1345
1296	package AE;	1346	package AE;
1297		1347
1298	our $VERSION = $AnyEvent::VERSION;	1348	our $VERSION = $AnyEvent::VERSION;
1299		1349
1300	sub io($$$) {	1350	sub io($$$) {
1301	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1351	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1302	}	1352	}
1303		1353
1304	sub timer($$$) {	1354	sub timer($$$) {
1305	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);	1355	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1306	}	1356	}
1307		1357
1308	sub signal($$) {	1358	sub signal($$) {
1309	AnyEvent->signal (signal => $_[0], cb => $_[1]);	1359	AnyEvent->signal (signal => $_[0], cb => $_[1])
1310	}	1360	}
1311		1361
1312	sub child($$) {	1362	sub child($$) {
1313	AnyEvent->child (pid => $_[0], cb => $_[1]);	1363	AnyEvent->child (pid => $_[0], cb => $_[1])
1314	}	1364	}
1315		1365
1316	sub idle($) {	1366	sub idle($) {
1317	AnyEvent->idle (cb => $_[0]);	1367	AnyEvent->idle (cb => $_[0])
1318	}	1368	}
1319		1369
1320	sub cv(;&) {	1370	sub cv(;&) {
1321	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1371	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1322	}	1372	}
…		…
1335		1385
1336	package AnyEvent::Base;	1386	package AnyEvent::Base;
1337		1387
1338	# default implementations for many methods	1388	# default implementations for many methods
1339		1389
1340	sub _time {	1390	sub _time() {
		1391	eval q{ # poor man's autoloading
1341	# probe for availability of Time::HiRes	1392	# probe for availability of Time::HiRes
1342	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1393	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1343	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1394	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1344	*_time = \&Time::HiRes::time;	1395	*_time = \&Time::HiRes::time;
1345	# if (eval "use POSIX (); (POSIX::times())...	1396	# if (eval "use POSIX (); (POSIX::times())...
1346	} else {	1397	} else {
1347	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1398	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1348	*_time = sub { time }; # epic fail	1399	*_time = sub (){ time }; # epic fail
		1400	}
1349	}	1401	};
		1402	die if $@;
1350		1403
1351	&_time	1404	&_time
1352	}	1405	}
1353		1406
1354	sub time { _time }	1407	sub time { _time }
…		…
1365		1418
1366	our $HAVE_ASYNC_INTERRUPT;	1419	our $HAVE_ASYNC_INTERRUPT;
1367		1420
1368	sub _have_async_interrupt() {	1421	sub _have_async_interrupt() {
1369	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1422	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1370	&& eval "use Async::Interrupt 1.0 (); 1")	1423	&& eval "use Async::Interrupt 1.02 (); 1")
1371	unless defined $HAVE_ASYNC_INTERRUPT;	1424	unless defined $HAVE_ASYNC_INTERRUPT;
1372		1425
1373	$HAVE_ASYNC_INTERRUPT	1426	$HAVE_ASYNC_INTERRUPT
1374	}	1427	}
1375		1428
1376	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1429	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1377	our (%SIG_ASY, %SIG_ASY_W);	1430	our (%SIG_ASY, %SIG_ASY_W);
1378	our ($SIG_COUNT, $SIG_TW);	1431	our ($SIG_COUNT, $SIG_TW);
1379		1432
1380	sub _signal_exec {
1381	$HAVE_ASYNC_INTERRUPT
1382	? $SIGPIPE_R->drain
1383	: sysread $SIGPIPE_R, my $dummy, 9;
1384
1385	while (%SIG_EV) {
1386	for (keys %SIG_EV) {
1387	delete $SIG_EV{$_};
1388	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1389	}
1390	}
1391	}
1392
1393	# install a dummy wakeup watcher to reduce signal catching latency	1433	# install a dummy wakeup watcher to reduce signal catching latency
		1434	# used by Impls
1394	sub _sig_add() {	1435	sub _sig_add() {
1395	unless ($SIG_COUNT++) {	1436	unless ($SIG_COUNT++) {
1396	# try to align timer on a full-second boundary, if possible	1437	# try to align timer on a full-second boundary, if possible
1397	my $NOW = AE::now;	1438	my $NOW = AE::now;
1398		1439
…		…
1529	# print weird messages, or just unconditionally exit	1570	# print weird messages, or just unconditionally exit
1530	# instead of getting the default action.	1571	# instead of getting the default action.
1531	undef $SIG{$signal}	1572	undef $SIG{$signal}
1532	unless keys %{ $SIG_CB{$signal} };	1573	unless keys %{ $SIG_CB{$signal} };
1533	};	1574	};
		1575
		1576	*_signal_exec = sub {
		1577	$HAVE_ASYNC_INTERRUPT
		1578	? $SIGPIPE_R->drain
		1579	: sysread $SIGPIPE_R, (my $dummy), 9;
		1580
		1581	while (%SIG_EV) {
		1582	for (keys %SIG_EV) {
		1583	delete $SIG_EV{$_};
		1584	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1585	}
		1586	}
		1587	};
1534	};	1588	};
1535	die if $@;	1589	die if $@;
		1590
1536	&signal	1591	&signal
1537	}	1592	}
1538		1593
1539	# default implementation for ->child	1594	# default implementation for ->child
1540		1595
1541	our %PID_CB;	1596	our %PID_CB;
1542	our $CHLD_W;	1597	our $CHLD_W;
1543	our $CHLD_DELAY_W;	1598	our $CHLD_DELAY_W;
1544	our $WNOHANG;	1599	our $WNOHANG;
1545		1600
		1601	# used by many Impl's
1546	sub _emit_childstatus($$) {	1602	sub _emit_childstatus($$) {
1547	my (undef, $rpid, $rstatus) = @_;	1603	my (undef, $rpid, $rstatus) = @_;
1548		1604
1549	$_->($rpid, $rstatus)	1605	$_->($rpid, $rstatus)
1550	for values %{ $PID_CB{$rpid} \|\| {} },	1606	for values %{ $PID_CB{$rpid} \|\| {} },
1551	values %{ $PID_CB{0} \|\| {} };	1607	values %{ $PID_CB{0} \|\| {} };
1552	}	1608	}
1553		1609
1554	sub _sigchld {
1555	my $pid;
1556
1557	AnyEvent->_emit_childstatus ($pid, $?)
1558	while ($pid = waitpid -1, $WNOHANG) > 0;
1559	}
1560
1561	sub child {	1610	sub child {
		1611	eval q{ # poor man's autoloading {}
		1612	*_sigchld = sub {
		1613	my $pid;
		1614
		1615	AnyEvent->_emit_childstatus ($pid, $?)
		1616	while ($pid = waitpid -1, $WNOHANG) > 0;
		1617	};
		1618
		1619	*child = sub {
1562	my (undef, %arg) = @_;	1620	my (undef, %arg) = @_;
1563		1621
1564	defined (my $pid = $arg{pid} + 0)	1622	defined (my $pid = $arg{pid} + 0)
1565	or Carp::croak "required option 'pid' is missing";	1623	or Carp::croak "required option 'pid' is missing";
1566		1624
1567	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1625	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1568		1626
1569	# WNOHANG is almost cetrainly 1 everywhere	1627	# WNOHANG is almost cetrainly 1 everywhere
1570	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1628	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1571	? 1	1629	? 1
1572	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1630	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1573		1631
1574	unless ($CHLD_W) {	1632	unless ($CHLD_W) {
1575	$CHLD_W = AE::signal CHLD => \&_sigchld;	1633	$CHLD_W = AE::signal CHLD => \&_sigchld;
1576	# child could be a zombie already, so make at least one round	1634	# child could be a zombie already, so make at least one round
1577	&_sigchld;	1635	&_sigchld;
1578	}	1636	}
1579		1637
1580	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1638	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1581	}	1639	};
1582		1640
1583	sub AnyEvent::Base::child::DESTROY {	1641	*AnyEvent::Base::child::DESTROY = sub {
1584	my ($pid, $cb) = @{$_[0]};	1642	my ($pid, $cb) = @{$_[0]};
1585		1643
1586	delete $PID_CB{$pid}{$cb};	1644	delete $PID_CB{$pid}{$cb};
1587	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1645	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1588		1646
1589	undef $CHLD_W unless keys %PID_CB;	1647	undef $CHLD_W unless keys %PID_CB;
		1648	};
		1649	};
		1650	die if $@;
		1651
		1652	&child
1590	}	1653	}
1591		1654
1592	# idle emulation is done by simply using a timer, regardless	1655	# idle emulation is done by simply using a timer, regardless
1593	# of whether the process is idle or not, and not letting	1656	# of whether the process is idle or not, and not letting
1594	# the callback use more than 50% of the time.	1657	# the callback use more than 50% of the time.
1595	sub idle {	1658	sub idle {
		1659	eval q{ # poor man's autoloading {}
		1660	*idle = sub {
1596	my (undef, %arg) = @_;	1661	my (undef, %arg) = @_;
1597		1662
1598	my ($cb, $w, $rcb) = $arg{cb};	1663	my ($cb, $w, $rcb) = $arg{cb};
1599		1664
1600	$rcb = sub {	1665	$rcb = sub {
1601	if ($cb) {	1666	if ($cb) {
1602	$w = _time;	1667	$w = _time;
1603	&$cb;	1668	&$cb;
1604	$w = _time - $w;	1669	$w = _time - $w;
1605		1670
1606	# never use more then 50% of the time for the idle watcher,	1671	# never use more then 50% of the time for the idle watcher,
1607	# within some limits	1672	# within some limits
1608	$w = 0.0001 if $w < 0.0001;	1673	$w = 0.0001 if $w < 0.0001;
1609	$w = 5 if $w > 5;	1674	$w = 5 if $w > 5;
1610		1675
1611	$w = AE::timer $w, 0, $rcb;	1676	$w = AE::timer $w, 0, $rcb;
1612	} else {	1677	} else {
1613	# clean up...	1678	# clean up...
1614	undef $w;	1679	undef $w;
1615	undef $rcb;	1680	undef $rcb;
		1681	}
		1682	};
		1683
		1684	$w = AE::timer 0.05, 0, $rcb;
		1685
		1686	bless \\$cb, "AnyEvent::Base::idle"
1616	}	1687	};
		1688
		1689	*AnyEvent::Base::idle::DESTROY = sub {
		1690	undef $${$_[0]};
		1691	};
1617	};	1692	};
		1693	die if $@;
1618		1694
1619	$w = AE::timer 0.05, 0, $rcb;	1695	&idle
1620
1621	bless \\$cb, "AnyEvent::Base::idle"
1622	}
1623
1624	sub AnyEvent::Base::idle::DESTROY {
1625	undef $${$_[0]};
1626	}	1696	}
1627		1697
1628	package AnyEvent::CondVar;	1698	package AnyEvent::CondVar;
1629		1699
1630	our @ISA = AnyEvent::CondVar::Base::;	1700	our @ISA = AnyEvent::CondVar::Base::;
…		…
1904	warn "read: $input\n"; # output what has been read	1974	warn "read: $input\n"; # output what has been read
1905	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1975	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1906	},	1976	},
1907	);	1977	);
1908		1978
1909	my $time_watcher; # can only be used once
1910
1911	sub new_timer {
1912	$timer = AnyEvent->timer (after => 1, cb => sub {	1979	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1913	warn "timeout\n"; # print 'timeout' about every second	1980	warn "timeout\n"; # print 'timeout' at most every second
1914	&new_timer; # and restart the time
1915	});	1981	});
1916	}
1917
1918	new_timer; # create first timer
1919		1982
1920	$cv->recv; # wait until user enters /^q/i	1983	$cv->recv; # wait until user enters /^q/i
1921		1984
1922	=head1 REAL-WORLD EXAMPLE	1985	=head1 REAL-WORLD EXAMPLE
1923		1986
…		…
2054	through AnyEvent. The benchmark creates a lot of timers (with a zero	2117	through AnyEvent. The benchmark creates a lot of timers (with a zero
2055	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2118	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2056	which it is), lets them fire exactly once and destroys them again.	2119	which it is), lets them fire exactly once and destroys them again.
2057		2120
2058	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2121	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2059	distribution.	2122	distribution. It uses the L<AE> interface, which makes a real difference
		2123	for the EV and Perl backends only.
2060		2124
2061	=head3 Explanation of the columns	2125	=head3 Explanation of the columns
2062		2126
2063	I<watcher> is the number of event watchers created/destroyed. Since	2127	I<watcher> is the number of event watchers created/destroyed. Since
2064	different event models feature vastly different performances, each event	2128	different event models feature vastly different performances, each event
…		…
2085	watcher.	2149	watcher.
2086		2150
2087	=head3 Results	2151	=head3 Results
2088		2152
2089	name watchers bytes create invoke destroy comment	2153	name watchers bytes create invoke destroy comment
2090	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2154	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2091	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2155	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2092	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2156	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2093	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2157	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2094	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2158	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2095	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2159	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2096	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2160	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2097	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2161	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2098	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2162	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2099	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2163	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2100	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2164	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2101	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2165	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2102		2166
2103	=head3 Discussion	2167	=head3 Discussion
2104		2168
2105	The benchmark does I<not> measure scalability of the event loop very	2169	The benchmark does I<not> measure scalability of the event loop very
2106	well. For example, a select-based event loop (such as the pure perl one)	2170	well. For example, a select-based event loop (such as the pure perl one)
…		…
2118	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2182	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2119	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2183	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2120	cycles with POE.	2184	cycles with POE.
2121		2185
2122	C<EV> is the sole leader regarding speed and memory use, which are both	2186	C<EV> is the sole leader regarding speed and memory use, which are both
2123	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2187	maximal/minimal, respectively. When using the L<AE> API there is zero
		2188	overhead (when going through the AnyEvent API create is about 5-6 times
		2189	slower, with other times being equal, so still uses far less memory than
2124	far less memory than any other event loop and is still faster than Event	2190	any other event loop and is still faster than Event natively).
2125	natively.
2126		2191
2127	The pure perl implementation is hit in a few sweet spots (both the	2192	The pure perl implementation is hit in a few sweet spots (both the
2128	constant timeout and the use of a single fd hit optimisations in the perl	2193	constant timeout and the use of a single fd hit optimisations in the perl
2129	interpreter and the backend itself). Nevertheless this shows that it	2194	interpreter and the backend itself). Nevertheless this shows that it
2130	adds very little overhead in itself. Like any select-based backend its	2195	adds very little overhead in itself. Like any select-based backend its
…		…
2204	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2269	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2205	(1%) are active. This mirrors the activity of large servers with many	2270	(1%) are active. This mirrors the activity of large servers with many
2206	connections, most of which are idle at any one point in time.	2271	connections, most of which are idle at any one point in time.
2207		2272
2208	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2273	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2209	distribution.	2274	distribution. It uses the L<AE> interface, which makes a real difference
		2275	for the EV and Perl backends only.
2210		2276
2211	=head3 Explanation of the columns	2277	=head3 Explanation of the columns
2212		2278
2213	I<sockets> is the number of sockets, and twice the number of "servers" (as	2279	I<sockets> is the number of sockets, and twice the number of "servers" (as
2214	each server has a read and write socket end).	2280	each server has a read and write socket end).
…		…
2222	a new one that moves the timeout into the future.	2288	a new one that moves the timeout into the future.
2223		2289
2224	=head3 Results	2290	=head3 Results
2225		2291
2226	name sockets create request	2292	name sockets create request
2227	EV 20000 69.01 11.16	2293	EV 20000 62.66 7.99
2228	Perl 20000 73.32 35.87	2294	Perl 20000 68.32 32.64
2229	IOAsync 20000 157.00 98.14 epoll	2295	IOAsync 20000 174.06 101.15 epoll
2230	IOAsync 20000 159.31 616.06 poll	2296	IOAsync 20000 174.67 610.84 poll
2231	Event 20000 212.62 257.32	2297	Event 20000 202.69 242.91
2232	Glib 20000 651.16 1896.30	2298	Glib 20000 557.01 1689.52
2233	POE 20000 349.67 12317.24 uses POE::Loop::Event	2299	POE 20000 341.54 12086.32 uses POE::Loop::Event
2234		2300
2235	=head3 Discussion	2301	=head3 Discussion
2236		2302
2237	This benchmark I<does> measure scalability and overall performance of the	2303	This benchmark I<does> measure scalability and overall performance of the
2238	particular event loop.	2304	particular event loop.
…		…
2364	As you can see, the AnyEvent + EV combination even beats the	2430	As you can see, the AnyEvent + EV combination even beats the
2365	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2431	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2366	backend easily beats IO::Lambda and POE.	2432	backend easily beats IO::Lambda and POE.
2367		2433
2368	And even the 100% non-blocking version written using the high-level (and	2434	And even the 100% non-blocking version written using the high-level (and
2369	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2435	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2370	large margin, even though it does all of DNS, tcp-connect and socket I/O	2436	higher level ("unoptimised") abstractions by a large margin, even though
2371	in a non-blocking way.	2437	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2372		2438
2373	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2439	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2374	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2440	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2375	part of the IO::lambda distribution and were used without any changes.	2441	part of the IO::Lambda distribution and were used without any changes.
2376		2442
2377		2443
2378	=head1 SIGNALS	2444	=head1 SIGNALS
2379		2445
2380	AnyEvent currently installs handlers for these signals:	2446	AnyEvent currently installs handlers for these signals:
…		…
2422	it's built-in modules) are required to use it.	2488	it's built-in modules) are required to use it.
2423		2489
2424	That does not mean that AnyEvent won't take advantage of some additional	2490	That does not mean that AnyEvent won't take advantage of some additional
2425	modules if they are installed.	2491	modules if they are installed.
2426		2492
2427	This section epxlains which additional modules will be used, and how they	2493	This section explains which additional modules will be used, and how they
2428	affect AnyEvent's operetion.	2494	affect AnyEvent's operation.
2429		2495
2430	=over 4	2496	=over 4
2431		2497
2432	=item L<Async::Interrupt>	2498	=item L<Async::Interrupt>
2433		2499
…		…
2438	catch the signals) with some delay (default is 10 seconds, look for	2504	catch the signals) with some delay (default is 10 seconds, look for
2439	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2505	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2440		2506
2441	If this module is available, then it will be used to implement signal	2507	If this module is available, then it will be used to implement signal
2442	catching, which means that signals will not be delayed, and the event loop	2508	catching, which means that signals will not be delayed, and the event loop
2443	will not be interrupted regularly, which is more efficient (And good for	2509	will not be interrupted regularly, which is more efficient (and good for
2444	battery life on laptops).	2510	battery life on laptops).
2445		2511
2446	This affects not just the pure-perl event loop, but also other event loops	2512	This affects not just the pure-perl event loop, but also other event loops
2447	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2513	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2448		2514
…		…
2469	lot less memory), but otherwise doesn't affect guard operation much. It is	2535	lot less memory), but otherwise doesn't affect guard operation much. It is
2470	purely used for performance.	2536	purely used for performance.
2471		2537
2472	=item L<JSON> and L<JSON::XS>	2538	=item L<JSON> and L<JSON::XS>
2473		2539
2474	This module is required when you want to read or write JSON data via	2540	One of these modules is required when you want to read or write JSON data
2475	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2541	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2476	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2542	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2477		2543
2478	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2544	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2479	installed.	2545	installed.
2480		2546
…		…
2495		2561
2496		2562
2497	=head1 FORK	2563	=head1 FORK
2498		2564
2499	Most event libraries are not fork-safe. The ones who are usually are	2565	Most event libraries are not fork-safe. The ones who are usually are
2500	because they rely on inefficient but fork-safe C<select> or C<poll>	2566	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2501	calls. Only L<EV> is fully fork-aware.	2567	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2568	are usually badly thought-out hacks that are incompatible with fork in
		2569	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2570	continue event-processing in both parent and child (or both, if you know
		2571	what you are doing).
		2572
		2573	This means that, in general, you cannot fork and do event processing in
		2574	the child if the event library was initialised before the fork (which
		2575	usually happens when the first AnyEvent watcher is created, or the library
		2576	is loaded).
2502		2577
2503	If you have to fork, you must either do so I<before> creating your first	2578	If you have to fork, you must either do so I<before> creating your first
2504	watcher OR you must not use AnyEvent at all in the child OR you must do	2579	watcher OR you must not use AnyEvent at all in the child OR you must do
2505	something completely out of the scope of AnyEvent.	2580	something completely out of the scope of AnyEvent.
		2581
		2582	The problem of doing event processing in the parent I<and> the child
		2583	is much more complicated: even for backends that I<are> fork-aware or
		2584	fork-safe, their behaviour is not usually what you want: fork clones all
		2585	watchers, that means all timers, I/O watchers etc. are active in both
		2586	parent and child, which is almost never what you want. USing C<exec>
		2587	to start worker children from some kind of manage rprocess is usually
		2588	preferred, because it is much easier and cleaner, at the expense of having
		2589	to have another binary.
2506		2590
2507		2591
2508	=head1 SECURITY CONSIDERATIONS	2592	=head1 SECURITY CONSIDERATIONS
2509		2593
2510	AnyEvent can be forced to load any event model via	2594	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.276 by root, Sun Aug 9 10:53:33 2009 UTC vs. Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.276 by root, Sun Aug 9 10:53:33 2009 UTC vs.
Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC