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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.279 by root, Sun Aug 9 16:05:11 2009 UTC vs.
Revision 1.317 by root, Wed Mar 24 21:22:57 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 = '5.0';	1161	our $VERSION = '5.251';
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 {
1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1172	require "AnyEvent/constants.pl";
		1173
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;
…		…
1182	our @post_detect;	1222	our @post_detect;
1183		1223
1184	sub post_detect(&) {	1224	sub post_detect(&) {
1185	my ($cb) = @_;	1225	my ($cb) = @_;
1186		1226
1187	if ($MODEL) {
1188	$cb->();
1189
1190	undef
1191	} else {
1192	push @post_detect, $cb;	1227	push @post_detect, $cb;
1193		1228
1194	defined wantarray	1229	defined wantarray
1195	? bless \$cb, "AnyEvent::Util::postdetect"	1230	? bless \$cb, "AnyEvent::Util::postdetect"
1196	: ()	1231	: ()
1197	}
1198	}	1232	}
1199		1233
1200	sub AnyEvent::Util::postdetect::DESTROY {	1234	sub AnyEvent::Util::postdetect::DESTROY {
1201	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1235	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1202	}	1236	}
1203		1237
1204	sub detect() {	1238	sub detect() {
		1239	# free some memory
		1240	*detect = sub () { $MODEL };
		1241
		1242	local $!; # for good measure
		1243	local $SIG{__DIE__};
		1244
		1245	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1246	my $model = "AnyEvent::Impl::$1";
		1247	if (eval "require $model") {
		1248	$MODEL = $model;
		1249	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1250	} else {
		1251	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1252	}
		1253	}
		1254
		1255	# check for already loaded models
1205	unless ($MODEL) {	1256	unless ($MODEL) {
1206	local $SIG{__DIE__};	1257	for (@REGISTRY, @models) {
1207		1258	my ($package, $model) = @$_;
1208	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1259	if (${"$package\::VERSION"} > 0) {
1209	my $model = "AnyEvent::Impl::$1";
1210	if (eval "require $model") {	1260	if (eval "require $model") {
1211	$MODEL = $model;	1261	$MODEL = $model;
1212	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1262	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1213	} else {	1263	last;
1214	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1264	}
1215	}	1265	}
1216	}	1266	}
1217		1267
1218	# check for already loaded models
1219	unless ($MODEL) {	1268	unless ($MODEL) {
		1269	# try to autoload a model
1220	for (@REGISTRY, @models) {	1270	for (@REGISTRY, @models) {
1221	my ($package, $model) = @$_;	1271	my ($package, $model, $autoload) = @$_;
		1272	if (
		1273	$autoload
		1274	and eval "require $package"
1222	if (${"$package\::VERSION"} > 0) {	1275	and ${"$package\::VERSION"} > 0
1223	if (eval "require $model") {	1276	and eval "require $model"
		1277	) {
1224	$MODEL = $model;	1278	$MODEL = $model;
1225	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1279	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1226	last;	1280	last;
1227	}
1228	}	1281	}
1229	}	1282	}
1230		1283
1231	unless ($MODEL) {
1232	# try to autoload a model
1233	for (@REGISTRY, @models) {
1234	my ($package, $model, $autoload) = @$_;
1235	if (
1236	$autoload
1237	and eval "require $package"
1238	and ${"$package\::VERSION"} > 0
1239	and eval "require $model"
1240	) {
1241	$MODEL = $model;
1242	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1243	last;
1244	}
1245	}
1246
1247	$MODEL	1284	$MODEL
1248	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1285	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1249	}
1250	}	1286	}
1251
1252	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1253
1254	unshift @ISA, $MODEL;
1255
1256	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1257
1258	(shift @post_detect)->() while @post_detect;
1259	}	1287	}
		1288
		1289	@models = (); # free probe data
		1290
		1291	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1292	unshift @ISA, $MODEL;
		1293
		1294	# now nuke some methods that are overriden by the backend.
		1295	# SUPER is not allowed.
		1296	for (qw(time signal child idle)) {
		1297	undef &{"AnyEvent::Base::$_"}
		1298	if defined &{"$MODEL\::$_"};
		1299	}
		1300
		1301	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1302
		1303	(shift @post_detect)->() while @post_detect;
		1304
		1305	*post_detect = sub(&) {
		1306	shift->();
		1307
		1308	undef
		1309	};
1260		1310
1261	$MODEL	1311	$MODEL
1262	}	1312	}
1263		1313
1264	sub AUTOLOAD {	1314	sub AUTOLOAD {
1265	(my $func = $AUTOLOAD) =~ s/.*://;	1315	(my $func = $AUTOLOAD) =~ s/.*://;
1266		1316
1267	$method{$func}	1317	$method{$func}
1268	or Carp::croak "$func: not a valid method for AnyEvent objects";	1318	or Carp::croak "$func: not a valid AnyEvent class method";
1269		1319
1270	detect unless $MODEL;	1320	detect;
1271		1321
1272	my $class = shift;	1322	my $class = shift;
1273	$class->$func (@_);	1323	$class->$func (@_);
1274	}	1324	}
1275		1325
…		…
1342		1392
1343	package AnyEvent::Base;	1393	package AnyEvent::Base;
1344		1394
1345	# default implementations for many methods	1395	# default implementations for many methods
1346		1396
1347	sub _time {	1397	sub time {
		1398	eval q{ # poor man's autoloading {}
1348	# probe for availability of Time::HiRes	1399	# probe for availability of Time::HiRes
1349	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1400	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1350	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1401	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1351	*_time = \&Time::HiRes::time;	1402	*AE::time = \&Time::HiRes::time;
1352	# if (eval "use POSIX (); (POSIX::times())...	1403	# if (eval "use POSIX (); (POSIX::times())...
1353	} else {	1404	} else {
1354	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1405	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1355	*_time = sub { time }; # epic fail	1406	*AE::time = sub (){ time }; # epic fail
		1407	}
		1408
		1409	*time = sub { AE::time }; # different prototypes
1356	}	1410	};
		1411	die if $@;
1357		1412
1358	&_time	1413	&time
1359	}	1414	}
1360		1415
1361	sub time { _time }	1416	*now = \&time;
1362	sub now { _time }	1417
1363	sub now_update { }	1418	sub now_update { }
1364		1419
1365	# default implementation for ->condvar	1420	# default implementation for ->condvar
1366		1421
1367	sub condvar {	1422	sub condvar {
		1423	eval q{ # poor man's autoloading {}
		1424	*condvar = sub {
1368	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1425	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1426	};
		1427
		1428	*AE::cv = sub (;&) {
		1429	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1430	};
		1431	};
		1432	die if $@;
		1433
		1434	&condvar
1369	}	1435	}
1370		1436
1371	# default implementation for ->signal	1437	# default implementation for ->signal
1372		1438
1373	our $HAVE_ASYNC_INTERRUPT;	1439	our $HAVE_ASYNC_INTERRUPT;
1374		1440
1375	sub _have_async_interrupt() {	1441	sub _have_async_interrupt() {
1376	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1442	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1377	&& eval "use Async::Interrupt 1.0 (); 1")	1443	&& eval "use Async::Interrupt 1.02 (); 1")
1378	unless defined $HAVE_ASYNC_INTERRUPT;	1444	unless defined $HAVE_ASYNC_INTERRUPT;
1379		1445
1380	$HAVE_ASYNC_INTERRUPT	1446	$HAVE_ASYNC_INTERRUPT
1381	}	1447	}
1382		1448
1383	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1449	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1384	our (%SIG_ASY, %SIG_ASY_W);	1450	our (%SIG_ASY, %SIG_ASY_W);
1385	our ($SIG_COUNT, $SIG_TW);	1451	our ($SIG_COUNT, $SIG_TW);
1386		1452
1387	sub _signal_exec {
1388	$HAVE_ASYNC_INTERRUPT
1389	? $SIGPIPE_R->drain
1390	: sysread $SIGPIPE_R, my $dummy, 9;
1391
1392	while (%SIG_EV) {
1393	for (keys %SIG_EV) {
1394	delete $SIG_EV{$_};
1395	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1396	}
1397	}
1398	}
1399
1400	# install a dummy wakeup watcher to reduce signal catching latency	1453	# install a dummy wakeup watcher to reduce signal catching latency
		1454	# used by Impls
1401	sub _sig_add() {	1455	sub _sig_add() {
1402	unless ($SIG_COUNT++) {	1456	unless ($SIG_COUNT++) {
1403	# try to align timer on a full-second boundary, if possible	1457	# try to align timer on a full-second boundary, if possible
1404	my $NOW = AE::now;	1458	my $NOW = AE::now;
1405		1459
…		…
1415	undef $SIG_TW	1469	undef $SIG_TW
1416	unless --$SIG_COUNT;	1470	unless --$SIG_COUNT;
1417	}	1471	}
1418		1472
1419	our $_sig_name_init; $_sig_name_init = sub {	1473	our $_sig_name_init; $_sig_name_init = sub {
1420	eval q{ # poor man's autoloading	1474	eval q{ # poor man's autoloading {}
1421	undef $_sig_name_init;	1475	undef $_sig_name_init;
1422		1476
1423	if (_have_async_interrupt) {	1477	if (_have_async_interrupt) {
1424	*sig2num = \&Async::Interrupt::sig2num;	1478	*sig2num = \&Async::Interrupt::sig2num;
1425	*sig2name = \&Async::Interrupt::sig2name;	1479	*sig2name = \&Async::Interrupt::sig2name;
…		…
1457	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1511	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1458		1512
1459	} else {	1513	} else {
1460	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1514	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1461		1515
1462	require Fcntl;
1463
1464	if (AnyEvent::WIN32) {	1516	if (AnyEvent::WIN32) {
1465	require AnyEvent::Util;	1517	require AnyEvent::Util;
1466		1518
1467	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1519	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1468	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1520	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1521	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1470	} else {	1522	} else {
1471	pipe $SIGPIPE_R, $SIGPIPE_W;	1523	pipe $SIGPIPE_R, $SIGPIPE_W;
1472	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1524	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1473	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1525	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1474		1526
1475	# not strictly required, as $^F is normally 2, but let's make sure...	1527	# not strictly required, as $^F is normally 2, but let's make sure...
1476	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1528	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1477	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1529	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1478	}	1530	}
1479		1531
1480	$SIGPIPE_R	1532	$SIGPIPE_R
1481	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1533	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1482		1534
1483	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1535	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1484	}	1536	}
1485		1537
1486	*signal = sub {	1538	*signal = $HAVE_ASYNC_INTERRUPT
		1539	? sub {
1487	my (undef, %arg) = @_;	1540	my (undef, %arg) = @_;
1488		1541
1489	my $signal = uc $arg{signal}
1490	or Carp::croak "required option 'signal' is missing";
1491
1492	if ($HAVE_ASYNC_INTERRUPT) {
1493	# async::interrupt	1542	# async::interrupt
1494
1495	$signal = sig2num $signal;	1543	my $signal = sig2num $arg{signal};
1496	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1544	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1497		1545
1498	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1546	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1499	cb => sub { undef $SIG_EV{$signal} },	1547	cb => sub { undef $SIG_EV{$signal} },
1500	signal => $signal,	1548	signal => $signal,
1501	pipe => [$SIGPIPE_R->filenos],	1549	pipe => [$SIGPIPE_R->filenos],
1502	pipe_autodrain => 0,	1550	pipe_autodrain => 0,
1503	;	1551	;
1504		1552
1505	} else {	1553	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1554	}
		1555	: sub {
		1556	my (undef, %arg) = @_;
		1557
1506	# pure perl	1558	# pure perl
1507
1508	# AE::Util has been loaded in signal
1509	$signal = sig2name $signal;	1559	my $signal = sig2name $arg{signal};
1510	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1560	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1511		1561
1512	$SIG{$signal} \|\|= sub {	1562	$SIG{$signal} \|\|= sub {
1513	local $!;	1563	local $!;
1514	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1564	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1515	undef $SIG_EV{$signal};	1565	undef $SIG_EV{$signal};
1516	};	1566	};
1517		1567
1518	# can't do signal processing without introducing races in pure perl,	1568	# can't do signal processing without introducing races in pure perl,
1519	# so limit the signal latency.	1569	# so limit the signal latency.
1520	_sig_add;	1570	_sig_add;
1521	}
1522		1571
1523	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1572	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1573	}
1524	};	1574	;
1525		1575
1526	*AnyEvent::Base::signal::DESTROY = sub {	1576	*AnyEvent::Base::signal::DESTROY = sub {
1527	my ($signal, $cb) = @{$_[0]};	1577	my ($signal, $cb) = @{$_[0]};
1528		1578
1529	_sig_del;	1579	_sig_del;
…		…
1536	# print weird messages, or just unconditionally exit	1586	# print weird messages, or just unconditionally exit
1537	# instead of getting the default action.	1587	# instead of getting the default action.
1538	undef $SIG{$signal}	1588	undef $SIG{$signal}
1539	unless keys %{ $SIG_CB{$signal} };	1589	unless keys %{ $SIG_CB{$signal} };
1540	};	1590	};
		1591
		1592	*_signal_exec = sub {
		1593	$HAVE_ASYNC_INTERRUPT
		1594	? $SIGPIPE_R->drain
		1595	: sysread $SIGPIPE_R, (my $dummy), 9;
		1596
		1597	while (%SIG_EV) {
		1598	for (keys %SIG_EV) {
		1599	delete $SIG_EV{$_};
		1600	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1601	}
		1602	}
		1603	};
1541	};	1604	};
1542	die if $@;	1605	die if $@;
		1606
1543	&signal	1607	&signal
1544	}	1608	}
1545		1609
1546	# default implementation for ->child	1610	# default implementation for ->child
1547		1611
1548	our %PID_CB;	1612	our %PID_CB;
1549	our $CHLD_W;	1613	our $CHLD_W;
1550	our $CHLD_DELAY_W;	1614	our $CHLD_DELAY_W;
1551	our $WNOHANG;	1615	our $WNOHANG;
1552		1616
		1617	# used by many Impl's
1553	sub _emit_childstatus($$) {	1618	sub _emit_childstatus($$) {
1554	my (undef, $rpid, $rstatus) = @_;	1619	my (undef, $rpid, $rstatus) = @_;
1555		1620
1556	$_->($rpid, $rstatus)	1621	$_->($rpid, $rstatus)
1557	for values %{ $PID_CB{$rpid} \|\| {} },	1622	for values %{ $PID_CB{$rpid} \|\| {} },
1558	values %{ $PID_CB{0} \|\| {} };	1623	values %{ $PID_CB{0} \|\| {} };
1559	}	1624	}
1560		1625
1561	sub _sigchld {
1562	my $pid;
1563
1564	AnyEvent->_emit_childstatus ($pid, $?)
1565	while ($pid = waitpid -1, $WNOHANG) > 0;
1566	}
1567
1568	sub child {	1626	sub child {
		1627	eval q{ # poor man's autoloading {}
		1628	*_sigchld = sub {
		1629	my $pid;
		1630
		1631	AnyEvent->_emit_childstatus ($pid, $?)
		1632	while ($pid = waitpid -1, $WNOHANG) > 0;
		1633	};
		1634
		1635	*child = sub {
1569	my (undef, %arg) = @_;	1636	my (undef, %arg) = @_;
1570		1637
1571	defined (my $pid = $arg{pid} + 0)	1638	defined (my $pid = $arg{pid} + 0)
1572	or Carp::croak "required option 'pid' is missing";	1639	or Carp::croak "required option 'pid' is missing";
1573		1640
1574	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1641	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1575		1642
1576	# WNOHANG is almost cetrainly 1 everywhere	1643	# WNOHANG is almost cetrainly 1 everywhere
1577	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1644	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1578	? 1	1645	? 1
1579	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1646	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1580		1647
1581	unless ($CHLD_W) {	1648	unless ($CHLD_W) {
1582	$CHLD_W = AE::signal CHLD => \&_sigchld;	1649	$CHLD_W = AE::signal CHLD => \&_sigchld;
1583	# child could be a zombie already, so make at least one round	1650	# child could be a zombie already, so make at least one round
1584	&_sigchld;	1651	&_sigchld;
1585	}	1652	}
1586		1653
1587	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1654	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1588	}	1655	};
1589		1656
1590	sub AnyEvent::Base::child::DESTROY {	1657	*AnyEvent::Base::child::DESTROY = sub {
1591	my ($pid, $cb) = @{$_[0]};	1658	my ($pid, $cb) = @{$_[0]};
1592		1659
1593	delete $PID_CB{$pid}{$cb};	1660	delete $PID_CB{$pid}{$cb};
1594	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1661	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1595		1662
1596	undef $CHLD_W unless keys %PID_CB;	1663	undef $CHLD_W unless keys %PID_CB;
		1664	};
		1665	};
		1666	die if $@;
		1667
		1668	&child
1597	}	1669	}
1598		1670
1599	# idle emulation is done by simply using a timer, regardless	1671	# idle emulation is done by simply using a timer, regardless
1600	# of whether the process is idle or not, and not letting	1672	# of whether the process is idle or not, and not letting
1601	# the callback use more than 50% of the time.	1673	# the callback use more than 50% of the time.
1602	sub idle {	1674	sub idle {
		1675	eval q{ # poor man's autoloading {}
		1676	*idle = sub {
1603	my (undef, %arg) = @_;	1677	my (undef, %arg) = @_;
1604		1678
1605	my ($cb, $w, $rcb) = $arg{cb};	1679	my ($cb, $w, $rcb) = $arg{cb};
1606		1680
1607	$rcb = sub {	1681	$rcb = sub {
1608	if ($cb) {	1682	if ($cb) {
1609	$w = _time;	1683	$w = _time;
1610	&$cb;	1684	&$cb;
1611	$w = _time - $w;	1685	$w = _time - $w;
1612		1686
1613	# never use more then 50% of the time for the idle watcher,	1687	# never use more then 50% of the time for the idle watcher,
1614	# within some limits	1688	# within some limits
1615	$w = 0.0001 if $w < 0.0001;	1689	$w = 0.0001 if $w < 0.0001;
1616	$w = 5 if $w > 5;	1690	$w = 5 if $w > 5;
1617		1691
1618	$w = AE::timer $w, 0, $rcb;	1692	$w = AE::timer $w, 0, $rcb;
1619	} else {	1693	} else {
1620	# clean up...	1694	# clean up...
1621	undef $w;	1695	undef $w;
1622	undef $rcb;	1696	undef $rcb;
		1697	}
		1698	};
		1699
		1700	$w = AE::timer 0.05, 0, $rcb;
		1701
		1702	bless \\$cb, "AnyEvent::Base::idle"
1623	}	1703	};
		1704
		1705	*AnyEvent::Base::idle::DESTROY = sub {
		1706	undef $${$_[0]};
		1707	};
1624	};	1708	};
		1709	die if $@;
1625		1710
1626	$w = AE::timer 0.05, 0, $rcb;	1711	&idle
1627
1628	bless \\$cb, "AnyEvent::Base::idle"
1629	}
1630
1631	sub AnyEvent::Base::idle::DESTROY {
1632	undef $${$_[0]};
1633	}	1712	}
1634		1713
1635	package AnyEvent::CondVar;	1714	package AnyEvent::CondVar;
1636		1715
1637	our @ISA = AnyEvent::CondVar::Base::;	1716	our @ISA = AnyEvent::CondVar::Base::;
…		…
1911	warn "read: $input\n"; # output what has been read	1990	warn "read: $input\n"; # output what has been read
1912	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1991	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1913	},	1992	},
1914	);	1993	);
1915		1994
1916	my $time_watcher; # can only be used once
1917
1918	sub new_timer {
1919	$timer = AnyEvent->timer (after => 1, cb => sub {	1995	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1920	warn "timeout\n"; # print 'timeout' about every second	1996	warn "timeout\n"; # print 'timeout' at most every second
1921	&new_timer; # and restart the time
1922	});	1997	});
1923	}
1924
1925	new_timer; # create first timer
1926		1998
1927	$cv->recv; # wait until user enters /^q/i	1999	$cv->recv; # wait until user enters /^q/i
1928		2000
1929	=head1 REAL-WORLD EXAMPLE	2001	=head1 REAL-WORLD EXAMPLE
1930		2002
…		…
2374	As you can see, the AnyEvent + EV combination even beats the	2446	As you can see, the AnyEvent + EV combination even beats the
2375	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2447	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2376	backend easily beats IO::Lambda and POE.	2448	backend easily beats IO::Lambda and POE.
2377		2449
2378	And even the 100% non-blocking version written using the high-level (and	2450	And even the 100% non-blocking version written using the high-level (and
2379	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2451	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2380	large margin, even though it does all of DNS, tcp-connect and socket I/O	2452	higher level ("unoptimised") abstractions by a large margin, even though
2381	in a non-blocking way.	2453	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2382		2454
2383	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2455	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2384	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2456	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2385	part of the IO::lambda distribution and were used without any changes.	2457	part of the IO::Lambda distribution and were used without any changes.
2386		2458
2387		2459
2388	=head1 SIGNALS	2460	=head1 SIGNALS
2389		2461
2390	AnyEvent currently installs handlers for these signals:	2462	AnyEvent currently installs handlers for these signals:
…		…
2432	it's built-in modules) are required to use it.	2504	it's built-in modules) are required to use it.
2433		2505
2434	That does not mean that AnyEvent won't take advantage of some additional	2506	That does not mean that AnyEvent won't take advantage of some additional
2435	modules if they are installed.	2507	modules if they are installed.
2436		2508
2437	This section epxlains which additional modules will be used, and how they	2509	This section explains which additional modules will be used, and how they
2438	affect AnyEvent's operetion.	2510	affect AnyEvent's operation.
2439		2511
2440	=over 4	2512	=over 4
2441		2513
2442	=item L<Async::Interrupt>	2514	=item L<Async::Interrupt>
2443		2515
…		…
2448	catch the signals) with some delay (default is 10 seconds, look for	2520	catch the signals) with some delay (default is 10 seconds, look for
2449	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2521	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2450		2522
2451	If this module is available, then it will be used to implement signal	2523	If this module is available, then it will be used to implement signal
2452	catching, which means that signals will not be delayed, and the event loop	2524	catching, which means that signals will not be delayed, and the event loop
2453	will not be interrupted regularly, which is more efficient (And good for	2525	will not be interrupted regularly, which is more efficient (and good for
2454	battery life on laptops).	2526	battery life on laptops).
2455		2527
2456	This affects not just the pure-perl event loop, but also other event loops	2528	This affects not just the pure-perl event loop, but also other event loops
2457	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2529	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2458		2530
…		…
2470	automatic timer adjustments even when no monotonic clock is available,	2542	automatic timer adjustments even when no monotonic clock is available,
2471	can take avdantage of advanced kernel interfaces such as C<epoll> and	2543	can take avdantage of advanced kernel interfaces such as C<epoll> and
2472	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2544	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2473	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2545	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2474		2546
		2547	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2548	then this module will do nothing for you.
		2549
2475	=item L<Guard>	2550	=item L<Guard>
2476		2551
2477	The guard module, when used, will be used to implement	2552	The guard module, when used, will be used to implement
2478	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2553	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2479	lot less memory), but otherwise doesn't affect guard operation much. It is	2554	lot less memory), but otherwise doesn't affect guard operation much. It is
2480	purely used for performance.	2555	purely used for performance.
2481		2556
2482	=item L<JSON> and L<JSON::XS>	2557	=item L<JSON> and L<JSON::XS>
2483		2558
2484	This module is required when you want to read or write JSON data via	2559	One of these modules is required when you want to read or write JSON data
2485	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2560	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2486	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2561	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2487
2488	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2489	installed.
2490		2562
2491	=item L<Net::SSLeay>	2563	=item L<Net::SSLeay>
2492		2564
2493	Implementing TLS/SSL in Perl is certainly interesting, but not very	2565	Implementing TLS/SSL in Perl is certainly interesting, but not very
2494	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2566	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2505		2577
2506		2578
2507	=head1 FORK	2579	=head1 FORK
2508		2580
2509	Most event libraries are not fork-safe. The ones who are usually are	2581	Most event libraries are not fork-safe. The ones who are usually are
2510	because they rely on inefficient but fork-safe C<select> or C<poll>	2582	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2511	calls. Only L<EV> is fully fork-aware.	2583	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2584	are usually badly thought-out hacks that are incompatible with fork in
		2585	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2586	continue event-processing in both parent and child (or both, if you know
		2587	what you are doing).
		2588
		2589	This means that, in general, you cannot fork and do event processing in
		2590	the child if the event library was initialised before the fork (which
		2591	usually happens when the first AnyEvent watcher is created, or the library
		2592	is loaded).
2512		2593
2513	If you have to fork, you must either do so I<before> creating your first	2594	If you have to fork, you must either do so I<before> creating your first
2514	watcher OR you must not use AnyEvent at all in the child OR you must do	2595	watcher OR you must not use AnyEvent at all in the child OR you must do
2515	something completely out of the scope of AnyEvent.	2596	something completely out of the scope of AnyEvent.
		2597
		2598	The problem of doing event processing in the parent I<and> the child
		2599	is much more complicated: even for backends that I<are> fork-aware or
		2600	fork-safe, their behaviour is not usually what you want: fork clones all
		2601	watchers, that means all timers, I/O watchers etc. are active in both
		2602	parent and child, which is almost never what you want. USing C<exec>
		2603	to start worker children from some kind of manage rprocess is usually
		2604	preferred, because it is much easier and cleaner, at the expense of having
		2605	to have another binary.
2516		2606
2517		2607
2518	=head1 SECURITY CONSIDERATIONS	2608	=head1 SECURITY CONSIDERATIONS
2519		2609
2520	AnyEvent can be forced to load any event model via	2610	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.279 by root, Sun Aug 9 16:05:11 2009 UTC vs. Revision 1.317 by root, Wed Mar 24 21:22:57 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.279 by root, Sun Aug 9 16:05:11 2009 UTC vs.
Revision 1.317 by root, Wed Mar 24 21:22:57 2010 UTC