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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.354 by root, Thu Aug 11 21:26:39 2011 UTC vs.
Revision 1.376 by root, Thu Aug 25 06:34:11 2011 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - the DBI of event loop programming	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6	and POE are various supported event loops/environments.	6	FLTK and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
880	AnyEvent::Impl::Irssi used when running within irssi.	880	AnyEvent::Impl::Irssi used when running within irssi.
881	AnyEvent::Impl::IOAsync based on IO::Async.	881	AnyEvent::Impl::IOAsync based on IO::Async.
882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.	882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883	AnyEvent::Impl::FLTK based on FLTK.	883	AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
884		884
885	=item Backends with special needs.	885	=item Backends with special needs.
886		886
887	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
888	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
…		…
933		933
934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
935	if necessary. You should only call this function right before you would	935	if necessary. You should only call this function right before you would
936	have created an AnyEvent watcher anyway, that is, as late as possible at	936	have created an AnyEvent watcher anyway, that is, as late as possible at
937	runtime, and not e.g. during initialisation of your module.	937	runtime, and not e.g. during initialisation of your module.
		938
		939	The effect of calling this function is as if a watcher had been created
		940	(specifically, actions that happen "when the first watcher is created"
		941	happen when calling detetc as well).
938		942
939	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
940	created, use C<post_detect>.	944	created, use C<post_detect>.
941		945
942	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1045	It should use C<postpone>:	1049	It should use C<postpone>:
1046		1050
1047	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later	1051	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1048	if $some_error_condition;	1052	if $some_error_condition;
1049		1053
		1054	=item AnyEvent::log $level, $msg[, @args]
		1055
		1056	Log the given C<$msg> at the given C<$level>.
		1057
		1058	If L<AnyEvent::Log> is not loaded then this function makes a simple test
		1059	to see whether the message will be logged. If the test succeeds it will
		1060	load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
		1061	the L<AnyEvent::Log> documentation for details.
		1062
		1063	If the test fails it will simply return.
		1064
		1065	If you want to sprinkle loads of logging calls around your code, consider
		1066	creating a logger callback with the C<AnyEvent::Log::logger> function,
		1067	which can reduce typing, codesize and can reduce the logging overhead
		1068	enourmously.
		1069
1050	=back	1070	=back
1051		1071
1052	=head1 WHAT TO DO IN A MODULE	1072	=head1 WHAT TO DO IN A MODULE
1053		1073
1054	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1074	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1110		1130
1111		1131
1112	=head1 OTHER MODULES	1132	=head1 OTHER MODULES
1113		1133
1114	The following is a non-exhaustive list of additional modules that use	1134	The following is a non-exhaustive list of additional modules that use
1115	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1135	AnyEvent as a client and can therefore be mixed easily with other
1116	modules and other event loops in the same program. Some of the modules	1136	AnyEvent modules and other event loops in the same program. Some of the
1117	come as part of AnyEvent, the others are available via CPAN.	1137	modules come as part of AnyEvent, the others are available via CPAN (see
		1138	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1139	a longer non-exhaustive list), and the list is heavily biased towards
		1140	modules of the AnyEvent author himself :)
1118		1141
1119	=over 4	1142	=over 4
1120		1143
1121	=item L<AnyEvent::Util>	1144	=item L<AnyEvent::Util>
1122		1145
…		…
1202		1225
1203	BEGIN { AnyEvent::common_sense }	1226	BEGIN { AnyEvent::common_sense }
1204		1227
1205	use Carp ();	1228	use Carp ();
1206		1229
1207	our $VERSION = '5.34';	1230	our $VERSION = '6.01';
1208	our $MODEL;	1231	our $MODEL;
1209		1232
1210	our $AUTOLOAD;
1211	our @ISA;	1233	our @ISA;
1212		1234
1213	our @REGISTRY;	1235	our @REGISTRY;
1214		1236
1215	our $VERBOSE;	1237	our $VERBOSE;
…		…
1220	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1242	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1221		1243
1222	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1244	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1223	if ${^TAINT};	1245	if ${^TAINT};
1224		1246
		1247	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1248	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
		1249
		1250	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1251	if ${^TAINT};
		1252
1225	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1253	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1226
1227	}	1254	}
1228		1255
1229	our $MAX_SIGNAL_LATENCY = 10;	1256	our $MAX_SIGNAL_LATENCY = 10;
1230		1257
1231	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1258	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
1235	$PROTOCOL{$_} = ++$idx	1262	$PROTOCOL{$_} = ++$idx
1236	for reverse split /\s,\s/,	1263	for reverse split /\s,\s/,
1237	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1264	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1238	}	1265	}
1239		1266
		1267	our @post_detect;
		1268
		1269	sub post_detect(&) {
		1270	my ($cb) = @_;
		1271
		1272	push @post_detect, $cb;
		1273
		1274	defined wantarray
		1275	? bless \$cb, "AnyEvent::Util::postdetect"
		1276	: ()
		1277	}
		1278
		1279	sub AnyEvent::Util::postdetect::DESTROY {
		1280	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1281	}
		1282
		1283	our $POSTPONE_W;
		1284	our @POSTPONE;
		1285
		1286	sub _postpone_exec {
		1287	undef $POSTPONE_W;
		1288
		1289	&{ shift @POSTPONE }
		1290	while @POSTPONE;
		1291	}
		1292
		1293	sub postpone(&) {
		1294	push @POSTPONE, shift;
		1295
		1296	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1297
		1298	()
		1299	}
		1300
		1301	sub log($$;@) {
		1302	# only load the big bloated module when we actually are about to log something
		1303	if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
		1304	require AnyEvent::Log;
		1305	# AnyEvent::Log overwrites this function
		1306	goto &log;
		1307	}
		1308
		1309	0 # not logged
		1310	}
		1311
		1312	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1313	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1314	}
		1315
1240	my @models = (	1316	our @models = (
1241	[EV:: => AnyEvent::Impl::EV:: , 1],	1317	[EV:: => AnyEvent::Impl::EV:: , 1],
1242	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],	1318	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1243	# everything below here will not (normally) be autoprobed	1319	# everything below here will not (normally) be autoprobed
1244	# as the pure perl backend should work everywhere	1320	# as the pure perl backend should work everywhere
1245	# and is usually faster	1321	# and is usually faster
…		…
1250	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1326	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1251	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1327	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1252	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1328	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1253	[Wx:: => AnyEvent::Impl::POE::],	1329	[Wx:: => AnyEvent::Impl::POE::],
1254	[Prima:: => AnyEvent::Impl::POE::],	1330	[Prima:: => AnyEvent::Impl::POE::],
1255	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1331	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1256	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1332	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1257	[FLTK:: => AnyEvent::Impl::FLTK::],	1333	[FLTK:: => AnyEvent::Impl::FLTK2::],
1258	);	1334	);
1259		1335
1260	our %method = map +($_ => 1),	1336	our @isa_hook;
		1337
		1338	sub _isa_set {
		1339	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1340
		1341	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1342	for 1 .. $#pkg;
		1343
		1344	grep $_ && $_->[1], @isa_hook
		1345	and AE::_reset ();
		1346	}
		1347
		1348	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1349	sub _isa_hook($$;$) {
		1350	my ($i, $pkg, $reset_ae) = @_;
		1351
		1352	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1353
		1354	_isa_set;
		1355	}
		1356
		1357	# all autoloaded methods reserve the complete glob, not just the method slot.
		1358	# due to bugs in perls method cache implementation.
1261	qw(io timer time now now_update signal child idle condvar DESTROY);	1359	our @methods = qw(io timer time now now_update signal child idle condvar);
1262
1263	our @post_detect;
1264
1265	sub post_detect(&) {
1266	my ($cb) = @_;
1267
1268	push @post_detect, $cb;
1269
1270	defined wantarray
1271	? bless \$cb, "AnyEvent::Util::postdetect"
1272	: ()
1273	}
1274
1275	sub AnyEvent::Util::postdetect::DESTROY {
1276	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1277	}
1278		1360
1279	sub detect() {	1361	sub detect() {
		1362	return $MODEL if $MODEL; # some programs keep references to detect
		1363
		1364	local $!; # for good measure
		1365	local $SIG{__DIE__}; # we use eval
		1366
1280	# free some memory	1367	# free some memory
1281	*detect = sub () { $MODEL };	1368	*detect = sub () { $MODEL };
		1369	# undef &func doesn't correctly update the method cache. grmbl.
		1370	# so we delete the whole glob. grmbl.
		1371	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1372	# a glob with an active sub. hrm. i hope it works, but perl is
		1373	# usually buggy in this department. sigh.
		1374	delete @{"AnyEvent::"}{@methods};
		1375	undef @methods;
1282		1376
1283	local $!; # for good measure
1284	local $SIG{__DIE__};
1285
1286	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1377	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1287	my $model = "AnyEvent::Impl::$1";	1378	my $model = $1;
		1379	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1288	if (eval "require $model") {	1380	if (eval "require $model") {
		1381	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1289	$MODEL = $model;	1382	$MODEL = $model;
1290	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1291	} else {	1383	} else {
1292	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1384	AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1293	}	1385	}
1294	}	1386	}
1295		1387
1296	# check for already loaded models	1388	# check for already loaded models
1297	unless ($MODEL) {	1389	unless ($MODEL) {
1298	for (@REGISTRY, @models) {	1390	for (@REGISTRY, @models) {
1299	my ($package, $model) = @$_;	1391	my ($package, $model) = @$_;
1300	if (${"$package\::VERSION"} > 0) {	1392	if (${"$package\::VERSION"} > 0) {
1301	if (eval "require $model") {	1393	if (eval "require $model") {
		1394	AnyEvent::log 7 => "autodetected model '$model', using it.";
1302	$MODEL = $model;	1395	$MODEL = $model;
1303	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1304	last;	1396	last;
1305	}	1397	}
1306	}	1398	}
1307	}	1399	}
1308		1400
…		…
1314	$autoload	1406	$autoload
1315	and eval "require $package"	1407	and eval "require $package"
1316	and ${"$package\::VERSION"} > 0	1408	and ${"$package\::VERSION"} > 0
1317	and eval "require $model"	1409	and eval "require $model"
1318	) {	1410	) {
		1411	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1319	$MODEL = $model;	1412	$MODEL = $model;
1320	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1321	last;	1413	last;
1322	}	1414	}
1323	}	1415	}
1324		1416
1325	$MODEL	1417	$MODEL
1326	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1418	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1327	}	1419	}
1328	}	1420	}
1329		1421
1330	@models = (); # free probe data	1422	# free memory only needed for probing
		1423	undef @models;
		1424	undef @REGISTRY;
1331		1425
1332	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1426	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1333	unshift @ISA, $MODEL;
1334		1427
1335	# now nuke some methods that are overridden by the backend.	1428	# now nuke some methods that are overridden by the backend.
1336	# SUPER is not allowed.	1429	# SUPER usage is not allowed in these.
1337	for (qw(time signal child idle)) {	1430	for (qw(time signal child idle)) {
1338	undef &{"AnyEvent::Base::$_"}	1431	undef &{"AnyEvent::Base::$_"}
1339	if defined &{"$MODEL\::$_"};	1432	if defined &{"$MODEL\::$_"};
1340	}	1433	}
1341		1434
		1435	_isa_set;
		1436
		1437	# we're officially open!
		1438
1342	if ($ENV{PERL_ANYEVENT_STRICT}) {	1439	if ($ENV{PERL_ANYEVENT_STRICT}) {
1343	eval { require AnyEvent::Strict };	1440	require AnyEvent::Strict;
1344	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1345	if $@ && $VERBOSE;
1346	}	1441	}
1347		1442
		1443	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1444	require AnyEvent::Debug;
		1445	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1446	}
		1447
		1448	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1449	require AnyEvent::Socket;
		1450	require AnyEvent::Debug;
		1451
		1452	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1453	$shell =~ s/\$\$/$$/g;
		1454
		1455	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1456	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1457	}
		1458
		1459	# now the anyevent environment is set up as the user told us to, so
		1460	# call the actual user code - post detects
		1461
1348	(shift @post_detect)->() while @post_detect;	1462	(shift @post_detect)->() while @post_detect;
		1463	undef @post_detect;
1349		1464
1350	*post_detect = sub(&) {	1465	*post_detect = sub(&) {
1351	shift->();	1466	shift->();
1352		1467
1353	undef	1468	undef
1354	};	1469	};
1355		1470
1356	$MODEL	1471	$MODEL
1357	}	1472	}
1358		1473
1359	sub AUTOLOAD {	1474	for my $name (@methods) {
1360	(my $func = $AUTOLOAD) =~ s/.*://;	1475	*$name = sub {
1361
1362	$method{$func}
1363	or Carp::croak "$func: not a valid AnyEvent class method";
1364
1365	detect;	1476	detect;
1366		1477	# we use goto because
1367	my $class = shift;	1478	# a) it makes the thunk more transparent
1368	$class->$func (@_);	1479	# b) it allows us to delete the thunk later
1369	}	1480	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1370		1481	};
1371	our $POSTPONE_W;
1372	our @POSTPONE;
1373
1374	sub _postpone_exec {
1375	undef $POSTPONE_W;
1376	(pop @POSTPONE)->()
1377	while @POSTPONE;
1378	}
1379
1380	sub postpone(&) {
1381	push @POSTPONE, shift;
1382
1383	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
1384
1385	()
1386	}	1482	}
1387		1483
1388	# utility function to dup a filehandle. this is used by many backends	1484	# utility function to dup a filehandle. this is used by many backends
1389	# to support binding more than one watcher per filehandle (they usually	1485	# to support binding more than one watcher per filehandle (they usually
1390	# allow only one watcher per fd, so we dup it to get a different one).	1486	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1414		1510
1415	package AE;	1511	package AE;
1416		1512
1417	our $VERSION = $AnyEvent::VERSION;	1513	our $VERSION = $AnyEvent::VERSION;
1418		1514
		1515	sub _reset() {
		1516	eval q{
1419	# fall back to the main API by default - backends and AnyEvent::Base	1517	# fall back to the main API by default - backends and AnyEvent::Base
1420	# implementations can overwrite these.	1518	# implementations can overwrite these.
1421		1519
1422	sub io($$$) {	1520	sub io($$$) {
1423	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1521	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1424	}	1522	}
1425		1523
1426	sub timer($$$) {	1524	sub timer($$$) {
1427	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1525	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1428	}	1526	}
1429		1527
1430	sub signal($$) {	1528	sub signal($$) {
1431	AnyEvent->signal (signal => $_[0], cb => $_[1])	1529	AnyEvent->signal (signal => $_[0], cb => $_[1])
1432	}	1530	}
1433		1531
1434	sub child($$) {	1532	sub child($$) {
1435	AnyEvent->child (pid => $_[0], cb => $_[1])	1533	AnyEvent->child (pid => $_[0], cb => $_[1])
1436	}	1534	}
1437		1535
1438	sub idle($) {	1536	sub idle($) {
1439	AnyEvent->idle (cb => $_[0])	1537	AnyEvent->idle (cb => $_[0]);
1440	}	1538	}
1441		1539
1442	sub cv(;&) {	1540	sub cv(;&) {
1443	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1541	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1444	}	1542	}
1445		1543
1446	sub now() {	1544	sub now() {
1447	AnyEvent->now	1545	AnyEvent->now
1448	}	1546	}
1449		1547
1450	sub now_update() {	1548	sub now_update() {
1451	AnyEvent->now_update	1549	AnyEvent->now_update
1452	}	1550	}
1453		1551
1454	sub time() {	1552	sub time() {
1455	AnyEvent->time	1553	AnyEvent->time
1456	}	1554	}
1457		1555
1458	*postpone = \&AnyEvent::postpone;	1556	*postpone = \&AnyEvent::postpone;
		1557	*log = \&AnyEvent::log;
		1558	};
		1559	die if $@;
		1560	}
		1561
		1562	BEGIN { _reset }
1459		1563
1460	package AnyEvent::Base;	1564	package AnyEvent::Base;
1461		1565
1462	# default implementations for many methods	1566	# default implementations for many methods
1463		1567
1464	sub time {	1568	sub time {
1465	eval q{ # poor man's autoloading {}	1569	eval q{ # poor man's autoloading {}
1466	# probe for availability of Time::HiRes	1570	# probe for availability of Time::HiRes
1467	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1571	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1468	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1572	*time = sub { Time::HiRes::time () };
1469	*AE::time = \&Time::HiRes::time;	1573	*AE::time = \& Time::HiRes::time ;
		1574	*now = \&time;
		1575	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1470	# if (eval "use POSIX (); (POSIX::times())...	1576	# if (eval "use POSIX (); (POSIX::times())...
1471	} else {	1577	} else {
		1578	*time = sub { CORE::time };
		1579	*AE::time = sub (){ CORE::time };
		1580	*now = \&time;
1472	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1581	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1473	*AE::time = sub (){ time }; # epic fail
1474	}	1582	}
1475
1476	*time = sub { AE::time }; # different prototypes
1477	};	1583	};
1478	die if $@;	1584	die if $@;
1479		1585
1480	&time	1586	&time
1481	}	1587	}
1482		1588
1483	*now = \&time;	1589	*now = \&time;
1484
1485	sub now_update { }	1590	sub now_update { }
1486		1591
1487	sub _poll {	1592	sub _poll {
1488	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";	1593	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1489	}	1594	}
…		…
1575		1680
1576	sub signal {	1681	sub signal {
1577	eval q{ # poor man's autoloading {}	1682	eval q{ # poor man's autoloading {}
1578	# probe for availability of Async::Interrupt	1683	# probe for availability of Async::Interrupt
1579	if (_have_async_interrupt) {	1684	if (_have_async_interrupt) {
1580	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1685	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1581		1686
1582	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1687	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1583	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1688	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1584		1689
1585	} else {	1690	} else {
1586	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1691	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1587		1692
1588	if (AnyEvent::WIN32) {	1693	if (AnyEvent::WIN32) {
1589	require AnyEvent::Util;	1694	require AnyEvent::Util;
1590		1695
1591	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1696	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1667	: sysread $SIGPIPE_R, (my $dummy), 9;	1772	: sysread $SIGPIPE_R, (my $dummy), 9;
1668		1773
1669	while (%SIG_EV) {	1774	while (%SIG_EV) {
1670	for (keys %SIG_EV) {	1775	for (keys %SIG_EV) {
1671	delete $SIG_EV{$_};	1776	delete $SIG_EV{$_};
1672	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1777	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1673	}	1778	}
1674	}	1779	}
1675	};	1780	};
1676	};	1781	};
1677	die if $@;	1782	die if $@;
…		…
1744		1849
1745	my ($cb, $w, $rcb) = $arg{cb};	1850	my ($cb, $w, $rcb) = $arg{cb};
1746		1851
1747	$rcb = sub {	1852	$rcb = sub {
1748	if ($cb) {	1853	if ($cb) {
1749	$w = _time;	1854	$w = AE::time;
1750	&$cb;	1855	&$cb;
1751	$w = _time - $w;	1856	$w = AE::time - $w;
1752		1857
1753	# never use more then 50% of the time for the idle watcher,	1858	# never use more then 50% of the time for the idle watcher,
1754	# within some limits	1859	# within some limits
1755	$w = 0.0001 if $w < 0.0001;	1860	$w = 0.0001 if $w < 0.0001;
1756	$w = 5 if $w > 5;	1861	$w = 5 if $w > 5;
…		…
1885	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	1990	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1886	so on.	1991	so on.
1887		1992
1888	=head1 ENVIRONMENT VARIABLES	1993	=head1 ENVIRONMENT VARIABLES
1889		1994
1890	The following environment variables are used by this module or its	1995	AnyEvent supports a number of environment variables that tune the
1891	submodules.	1996	runtime behaviour. They are usually evaluated when AnyEvent is
		1997	loaded, initialised, or a submodule that uses them is loaded. Many of
		1998	them also cause AnyEvent to load additional modules - for example,
		1999	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2000	loaded.
1892		2001
1893	Note that AnyEvent will remove I<all> environment variables starting with	2002	All the environment variables documented here start with
1894	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2003	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1895	enabled.	2004	namespace. Other modules are encouraged (but by no means required) to use
		2005	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2006	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2007	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2008	variables starting with C<AE_>, see below).
		2009
		2010	All variables can also be set via the C<AE_> prefix, that is, instead
		2011	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2012	case there is a clash btween anyevent and another program that uses
		2013	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2014	variable to the empty string, as those variables take precedence.
		2015
		2016	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2017	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2018	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2019	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2020	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2021	is set).
		2022
		2023	The exact algorithm is currently:
		2024
		2025	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2026	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2027	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2028
		2029	This ensures that child processes will not see the C<AE_> variables.
		2030
		2031	The following environment variables are currently known to AnyEvent:
1896		2032
1897	=over 4	2033	=over 4
1898		2034
1899	=item C<PERL_ANYEVENT_VERBOSE>	2035	=item C<PERL_ANYEVENT_VERBOSE>
1900		2036
1901	By default, AnyEvent will be completely silent except in fatal	2037	By default, AnyEvent will be completely silent except in fatal
1902	conditions. You can set this environment variable to make AnyEvent more	2038	conditions. You can set this environment variable to make AnyEvent more
1903	talkative.	2039	talkative. If you want to do more than just set the global logging level
		2040	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2041	complex specifications.
1904		2042
1905	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2043	When set to C<5> or higher (warn), causes AnyEvent to warn about unexpected
1906	conditions, such as not being able to load the event model specified by	2044	conditions, such as not being able to load the event model specified by
1907	C<PERL_ANYEVENT_MODEL>.	2045	C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
		2046	is the minimum recommended level.
1908		2047
1909	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2048	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1910	model it chooses.	2049	chooses.
1911		2050
1912	When set to C<8> or higher, then AnyEvent will report extra information on	2051	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1913	which optional modules it loads and how it implements certain features.	2052	which optional modules it loads and how it implements certain features.
		2053
		2054	=item C<PERL_ANYEVENT_LOG>
		2055
		2056	Accepts rather complex logging specifications. For example, you could log
		2057	all C<debug> messages of some module to stderr, warnings and above to
		2058	stderr, and errors and above to syslog, with:
		2059
		2060	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2061
		2062	For the rather extensive details, see L<AnyEvent::Log>.
		2063
		2064	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2065	so will take effect even before AnyEvent has initialised itself.
		2066
		2067	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2068	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2069	using the latter saves a few hundred kB of memory until the first message
		2070	is being logged.
1914		2071
1915	=item C<PERL_ANYEVENT_STRICT>	2072	=item C<PERL_ANYEVENT_STRICT>
1916		2073
1917	AnyEvent does not do much argument checking by default, as thorough	2074	AnyEvent does not do much argument checking by default, as thorough
1918	argument checking is very costly. Setting this variable to a true value	2075	argument checking is very costly. Setting this variable to a true value
…		…
1925	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2082	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1926	>>, it is definitely recommended to keep it off in production. Keeping	2083	>>, it is definitely recommended to keep it off in production. Keeping
1927	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2084	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1928	can be very useful, however.	2085	can be very useful, however.
1929		2086
		2087	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2088
		2089	If this env variable is set, then its contents will be interpreted by
		2090	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2091	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2092	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2093
		2094	This happens when the first watcher is created.
		2095
		2096	For example, to bind a debug shell on a unix domain socket in
		2097	F<< /tmp/debug<pid>.sock >>, you could use this:
		2098
		2099	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2100
		2101	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2102	systems.
		2103
		2104	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2105
		2106	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2107	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2108
1930	=item C<PERL_ANYEVENT_MODEL>	2109	=item C<PERL_ANYEVENT_MODEL>
1931		2110
1932	This can be used to specify the event model to be used by AnyEvent, before	2111	This can be used to specify the event model to be used by AnyEvent, before
1933	auto detection and -probing kicks in. It must be a string consisting	2112	auto detection and -probing kicks in.
1934	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2113
		2114	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2115	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1935	and the resulting module name is loaded and if the load was successful,	2116	resulting module name is loaded and - if the load was successful - used as
1936	used as event model. If it fails to load AnyEvent will proceed with	2117	event model backend. If it fails to load then AnyEvent will proceed with
1937	auto detection and -probing.	2118	auto detection and -probing.
1938		2119
1939	This functionality might change in future versions.	2120	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2121	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2122	the end of a string designates a module name and quotes it appropriately).
1940		2123
1941	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you	2124	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1942	could start your program like this:	2125	could start your program like this:
1943		2126
1944	PERL_ANYEVENT_MODEL=Perl perl ...	2127	PERL_ANYEVENT_MODEL=Perl perl ...
…		…
1962	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2145	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1963	- only support IPv4, never try to resolve or contact IPv6	2146	- only support IPv4, never try to resolve or contact IPv6
1964	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2147	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1965	IPv6, but prefer IPv6 over IPv4.	2148	IPv6, but prefer IPv6 over IPv4.
1966		2149
		2150	=item C<PERL_ANYEVENT_HOSTS>
		2151
		2152	This variable, if specified, overrides the F</etc/hosts> file used by
		2153	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2154	from that file instead.
		2155
1967	=item C<PERL_ANYEVENT_EDNS0>	2156	=item C<PERL_ANYEVENT_EDNS0>
1968		2157
1969	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2158	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1970	for DNS. This extension is generally useful to reduce DNS traffic, but	2159	DNS. This extension is generally useful to reduce DNS traffic, especially
1971	some (broken) firewalls drop such DNS packets, which is why it is off by	2160	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1972	default.	2161	packets, which is why it is off by default.
1973		2162
1974	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2163	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1975	EDNS0 in its DNS requests.	2164	EDNS0 in its DNS requests.
1976		2165
1977	=item C<PERL_ANYEVENT_MAX_FORKS>	2166	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1985	resolver - this is the maximum number of parallel DNS requests that are	2174	resolver - this is the maximum number of parallel DNS requests that are
1986	sent to the DNS server.	2175	sent to the DNS server.
1987		2176
1988	=item C<PERL_ANYEVENT_RESOLV_CONF>	2177	=item C<PERL_ANYEVENT_RESOLV_CONF>
1989		2178
1990	The file to use instead of F</etc/resolv.conf> (or OS-specific	2179	The absolute path to a F<resolv.conf>-style file to use instead of
1991	configuration) in the default resolver. When set to the empty string, no	2180	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1992	default config will be used.	2181	resolver, or the empty string to select the default configuration.
1993		2182
1994	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2183	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1995		2184
1996	When neither C<ca_file> nor C<ca_path> was specified during	2185	When neither C<ca_file> nor C<ca_path> was specified during
1997	L<AnyEvent::TLS> context creation, and either of these environment	2186	L<AnyEvent::TLS> context creation, and either of these environment
1998	variables exist, they will be used to specify CA certificate locations	2187	variables are nonempty, they will be used to specify CA certificate
1999	instead of a system-dependent default.	2188	locations instead of a system-dependent default.
2000		2189
2001	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2190	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2002		2191
2003	When these are set to C<1>, then the respective modules are not	2192	When these are set to C<1>, then the respective modules are not
2004	loaded. Mostly good for testing AnyEvent itself.	2193	loaded. Mostly good for testing AnyEvent itself.
…		…
2336	(even when used without AnyEvent), but most event loops have acceptable	2525	(even when used without AnyEvent), but most event loops have acceptable
2337	performance with or without AnyEvent.	2526	performance with or without AnyEvent.
2338		2527
2339	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2528	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2340	the actual event loop, only with extremely fast event loops such as EV	2529	the actual event loop, only with extremely fast event loops such as EV
2341	adds AnyEvent significant overhead.	2530	does AnyEvent add significant overhead.
2342		2531
2343	=item * You should avoid POE like the plague if you want performance or	2532	=item * You should avoid POE like the plague if you want performance or
2344	reasonable memory usage.	2533	reasonable memory usage.
2345		2534
2346	=back	2535	=back
…		…
2721		2910
2722	Tutorial/Introduction: L<AnyEvent::Intro>.	2911	Tutorial/Introduction: L<AnyEvent::Intro>.
2723		2912
2724	FAQ: L<AnyEvent::FAQ>.	2913	FAQ: L<AnyEvent::FAQ>.
2725		2914
2726	Utility functions: L<AnyEvent::Util>.	2915	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2916	(simply logging).
2727		2917
		2918	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2919	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2920
2728	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,	2921	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2729	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2922	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2923	L<Qt>, L<POE>, L<FLTK>.
2730		2924
2731	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2925	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2732	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2926	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2733	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2927	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2734	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2928	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2929	L<AnyEvent::Impl::FLTK>.
2735		2930
2736	Non-blocking file handles, sockets, TCP clients and	2931	Non-blocking handles, pipes, stream sockets, TCP clients and
2737	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2932	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2738		2933
2739	Asynchronous DNS: L<AnyEvent::DNS>.	2934	Asynchronous DNS: L<AnyEvent::DNS>.
2740		2935
2741	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	2936	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.354 by root, Thu Aug 11 21:26:39 2011 UTC vs. Revision 1.376 by root, Thu Aug 25 06:34:11 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.354 by root, Thu Aug 11 21:26:39 2011 UTC vs.
Revision 1.376 by root, Thu Aug 25 06:34:11 2011 UTC