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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.355 by root, Fri Aug 12 00:53:29 2011 UTC vs.
Revision 1.373 by root, Thu Aug 25 03:08:48 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	Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> -
		1059	consequently, look at the L<AnyEvent::Log> documentation for details.
		1060
		1061	If you want to sprinkle loads of logging calls around your code, consider
		1062	creating a logger callback with the C<AnyEvent::Log::logger> function.
		1063
1050	=back	1064	=back
1051		1065
1052	=head1 WHAT TO DO IN A MODULE	1066	=head1 WHAT TO DO IN A MODULE
1053		1067
1054	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1068	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1110		1124
1111		1125
1112	=head1 OTHER MODULES	1126	=head1 OTHER MODULES
1113		1127
1114	The following is a non-exhaustive list of additional modules that use	1128	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	1129	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	1130	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.	1131	modules come as part of AnyEvent, the others are available via CPAN (see
		1132	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1133	a longer non-exhaustive list), and the list is heavily biased towards
		1134	modules of the AnyEvent author himself :)
1118		1135
1119	=over 4	1136	=over 4
1120		1137
1121	=item L<AnyEvent::Util>	1138	=item L<AnyEvent::Util>
1122		1139
…		…
1202		1219
1203	BEGIN { AnyEvent::common_sense }	1220	BEGIN { AnyEvent::common_sense }
1204		1221
1205	use Carp ();	1222	use Carp ();
1206		1223
1207	our $VERSION = '5.34';	1224	our $VERSION = '6.01';
1208	our $MODEL;	1225	our $MODEL;
1209		1226
1210	our $AUTOLOAD;
1211	our @ISA;	1227	our @ISA;
1212		1228
1213	our @REGISTRY;	1229	our @REGISTRY;
1214		1230
1215	our $VERBOSE;	1231	our $VERBOSE;
…		…
1220	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1236	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1221		1237
1222	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1238	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1223	if ${^TAINT};	1239	if ${^TAINT};
1224		1240
		1241	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1242	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
		1243
		1244	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1245	if ${^TAINT};
		1246
1225	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1247	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1226
1227	}	1248	}
1228		1249
1229	our $MAX_SIGNAL_LATENCY = 10;	1250	our $MAX_SIGNAL_LATENCY = 10;
1230		1251
1231	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1252	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
1267	push @POSTPONE, shift;	1288	push @POSTPONE, shift;
1268		1289
1269	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);	1290	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
1270		1291
1271	()	1292	()
		1293	}
		1294
		1295	sub log($$;@) {
		1296	# only load the bug bloated module when we actually are about to log something
		1297	if ($_[0] <= $VERBOSE) {
		1298	require AnyEvent::Log;
		1299	# AnyEvent::Log overwrites this function
		1300	goto &log;
		1301	}
		1302	}
		1303
		1304	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1305	require AnyEvent::Log; # AnyEvent::Log does the thing for us
1272	}	1306	}
1273		1307
1274	our @models = (	1308	our @models = (
1275	[EV:: => AnyEvent::Impl::EV:: , 1],	1309	[EV:: => AnyEvent::Impl::EV:: , 1],
1276	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],	1310	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
…		…
1286	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1320	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1287	[Wx:: => AnyEvent::Impl::POE::],	1321	[Wx:: => AnyEvent::Impl::POE::],
1288	[Prima:: => AnyEvent::Impl::POE::],	1322	[Prima:: => AnyEvent::Impl::POE::],
1289	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect	1323	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1290	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1324	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1291	[FLTK:: => AnyEvent::Impl::FLTK::],	1325	[FLTK:: => AnyEvent::Impl::FLTK2::],
1292	);	1326	);
1293		1327
1294	our %method = map +($_ => 1),	1328	our @isa_hook;
		1329
		1330	sub _isa_set {
		1331	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1332
		1333	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1334	for 1 .. $#pkg;
		1335
		1336	grep $_ && $_->[1], @isa_hook
		1337	and AE::_reset ();
		1338	}
		1339
		1340	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1341	sub _isa_hook($$;$) {
		1342	my ($i, $pkg, $reset_ae) = @_;
		1343
		1344	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1345
		1346	_isa_set;
		1347	}
		1348
		1349	# all autoloaded methods reserve the complete glob, not just the method slot.
		1350	# due to bugs in perls method cache implementation.
1295	qw(io timer time now now_update signal child idle condvar DESTROY);	1351	our @methods = qw(io timer time now now_update signal child idle condvar);
1296		1352
1297	sub detect() {	1353	sub detect() {
		1354	return $MODEL if $MODEL; # some programs keep references to detect
		1355
		1356	local $!; # for good measure
		1357	local $SIG{__DIE__}; # we use eval
		1358
1298	# free some memory	1359	# free some memory
1299	*detect = sub () { $MODEL };	1360	*detect = sub () { $MODEL };
1300		1361	# undef &func doesn't correctly update the method cache. grmbl.
1301	local $!; # for good measure	1362	# so we delete the whole glob. grmbl.
1302	local $SIG{__DIE__};	1363	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1364	# a glob with an active sub. hrm. i hope it works, but perl is
		1365	# usually buggy in this department. sigh.
		1366	delete @{"AnyEvent::"}{@methods};
		1367	undef @methods;
1303		1368
1304	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {	1369	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1305	my $model = $1;	1370	my $model = $1;
1306	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;	1371	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1307	if (eval "require $model") {	1372	if (eval "require $model") {
		1373	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1308	$MODEL = $model;	1374	$MODEL = $model;
1309	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1310	} else {	1375	} else {
1311	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1376	AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1312	}	1377	}
1313	}	1378	}
1314		1379
1315	# check for already loaded models	1380	# check for already loaded models
1316	unless ($MODEL) {	1381	unless ($MODEL) {
1317	for (@REGISTRY, @models) {	1382	for (@REGISTRY, @models) {
1318	my ($package, $model) = @$_;	1383	my ($package, $model) = @$_;
1319	if (${"$package\::VERSION"} > 0) {	1384	if (${"$package\::VERSION"} > 0) {
1320	if (eval "require $model") {	1385	if (eval "require $model") {
		1386	AnyEvent::log 7 => "autodetected model '$model', using it.";
1321	$MODEL = $model;	1387	$MODEL = $model;
1322	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1323	last;	1388	last;
1324	}	1389	}
1325	}	1390	}
1326	}	1391	}
1327		1392
…		…
1333	$autoload	1398	$autoload
1334	and eval "require $package"	1399	and eval "require $package"
1335	and ${"$package\::VERSION"} > 0	1400	and ${"$package\::VERSION"} > 0
1336	and eval "require $model"	1401	and eval "require $model"
1337	) {	1402	) {
		1403	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1338	$MODEL = $model;	1404	$MODEL = $model;
1339	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1340	last;	1405	last;
1341	}	1406	}
1342	}	1407	}
1343		1408
1344	$MODEL	1409	$MODEL
1345	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1410	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1346	}	1411	}
1347	}	1412	}
1348		1413
1349	# free memory only needed for probing	1414	# free memory only needed for probing
1350	undef @models;	1415	undef @models;
1351	undef @REGISTRY;	1416	undef @REGISTRY;
1352		1417
1353	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1418	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1354	unshift @ISA, $MODEL;
1355		1419
1356	# now nuke some methods that are overridden by the backend.	1420	# now nuke some methods that are overridden by the backend.
1357	# SUPER usage is not allowed in these.	1421	# SUPER usage is not allowed in these.
1358	for (qw(time signal child idle)) {	1422	for (qw(time signal child idle)) {
1359	undef &{"AnyEvent::Base::$_"}	1423	undef &{"AnyEvent::Base::$_"}
1360	if defined &{"$MODEL\::$_"};	1424	if defined &{"$MODEL\::$_"};
1361	}	1425	}
1362		1426
		1427	_isa_set;
		1428
		1429	# we're officially open!
		1430
1363	if ($ENV{PERL_ANYEVENT_STRICT}) {	1431	if ($ENV{PERL_ANYEVENT_STRICT}) {
1364	eval { require AnyEvent::Strict };	1432	require AnyEvent::Strict;
1365	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1366	if $@ && $VERBOSE;
1367	}	1433	}
		1434
		1435	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1436	require AnyEvent::Debug;
		1437	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1438	}
		1439
		1440	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1441	require AnyEvent::Socket;
		1442	require AnyEvent::Debug;
		1443
		1444	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1445	$shell =~ s/\$\$/$$/g;
		1446
		1447	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1448	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1449	}
		1450
		1451	# now the anyevent environment is set up as the user told us to, so
		1452	# call the actual user code - post detects
1368		1453
1369	(shift @post_detect)->() while @post_detect;	1454	(shift @post_detect)->() while @post_detect;
1370	undef @post_detect;	1455	undef @post_detect;
1371		1456
1372	*post_detect = sub(&) {	1457	*post_detect = sub(&) {
1373	shift->();	1458	shift->();
1374		1459
1375	undef	1460	undef
1376	};	1461	};
1377		1462
1378	# recover a few more bytes	1463	$MODEL
1379	postpone {	1464	}
1380	undef &AUTOLOAD;	1465
		1466	for my $name (@methods) {
		1467	*$name = sub {
		1468	detect;
		1469	# we use goto because
		1470	# a) it makes the thunk more transparent
		1471	# b) it allows us to delete the thunk later
		1472	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1381	};	1473	};
1382
1383	$MODEL
1384	}
1385
1386	our %method = map +($_ => 1),
1387	qw(io timer time now now_update signal child idle condvar DESTROY);
1388
1389	sub AUTOLOAD {
1390	(my $func = $AUTOLOAD) =~ s/.*://;
1391
1392	$method{$func}
1393	or Carp::croak "$func: not a valid AnyEvent class method";
1394
1395	# free some memory
1396	undef %method;
1397
1398	detect;
1399
1400	my $class = shift;
1401	$class->$func (@_);
1402	}	1474	}
1403		1475
1404	# utility function to dup a filehandle. this is used by many backends	1476	# utility function to dup a filehandle. this is used by many backends
1405	# to support binding more than one watcher per filehandle (they usually	1477	# to support binding more than one watcher per filehandle (they usually
1406	# allow only one watcher per fd, so we dup it to get a different one).	1478	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1430		1502
1431	package AE;	1503	package AE;
1432		1504
1433	our $VERSION = $AnyEvent::VERSION;	1505	our $VERSION = $AnyEvent::VERSION;
1434		1506
1435
1436	sub _reset() {	1507	sub _reset() {
1437	eval q{	1508	eval q{
1438	# fall back to the main API by default - backends and AnyEvent::Base	1509	# fall back to the main API by default - backends and AnyEvent::Base
1439	# implementations can overwrite these.	1510	# implementations can overwrite these.
1440		1511
…		…
1453	sub child($$) {	1524	sub child($$) {
1454	AnyEvent->child (pid => $_[0], cb => $_[1])	1525	AnyEvent->child (pid => $_[0], cb => $_[1])
1455	}	1526	}
1456		1527
1457	sub idle($) {	1528	sub idle($) {
1458	AnyEvent->idle (cb => $_[0])	1529	AnyEvent->idle (cb => $_[0]);
1459	}	1530	}
1460		1531
1461	sub cv(;&) {	1532	sub cv(;&) {
1462	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1533	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1463	}	1534	}
…		…
1473	sub time() {	1544	sub time() {
1474	AnyEvent->time	1545	AnyEvent->time
1475	}	1546	}
1476		1547
1477	*postpone = \&AnyEvent::postpone;	1548	*postpone = \&AnyEvent::postpone;
		1549	*log = \&AnyEvent::log;
1478	};	1550	};
1479	die if $@;	1551	die if $@;
1480	}	1552	}
1481		1553
1482	BEGIN { _reset }	1554	BEGIN { _reset }
…		…
1487		1559
1488	sub time {	1560	sub time {
1489	eval q{ # poor man's autoloading {}	1561	eval q{ # poor man's autoloading {}
1490	# probe for availability of Time::HiRes	1562	# probe for availability of Time::HiRes
1491	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1563	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1492	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1564	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
		1565	if $AnyEvent::VERBOSE >= 8;
		1566	*time = sub { Time::HiRes::time () };
1493	*AE::time = \&Time::HiRes::time;	1567	*AE::time = \& Time::HiRes::time ;
1494	# if (eval "use POSIX (); (POSIX::times())...	1568	# if (eval "use POSIX (); (POSIX::times())...
1495	} else {	1569	} else {
1496	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1570	AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
		1571	*time = sub { CORE::time };
1497	*AE::time = sub (){ time }; # epic fail	1572	*AE::time = sub (){ CORE::time };
1498	}	1573	}
1499		1574
1500	*time = sub { AE::time }; # different prototypes	1575	*now = \&time;
1501	};	1576	};
1502	die if $@;	1577	die if $@;
1503		1578
1504	&time	1579	&time
1505	}	1580	}
1506		1581
1507	*now = \&time;	1582	*now = \&time;
1508
1509	sub now_update { }	1583	sub now_update { }
1510		1584
1511	sub _poll {	1585	sub _poll {
1512	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";	1586	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1513	}	1587	}
…		…
1599		1673
1600	sub signal {	1674	sub signal {
1601	eval q{ # poor man's autoloading {}	1675	eval q{ # poor man's autoloading {}
1602	# probe for availability of Async::Interrupt	1676	# probe for availability of Async::Interrupt
1603	if (_have_async_interrupt) {	1677	if (_have_async_interrupt) {
1604	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1678	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
		1679	if $AnyEvent::VERBOSE >= 8;
1605		1680
1606	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1681	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1607	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1682	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1608		1683
1609	} else {	1684	} else {
1610	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1685	AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
		1686	if $AnyEvent::VERBOSE >= 8;
1611		1687
1612	if (AnyEvent::WIN32) {	1688	if (AnyEvent::WIN32) {
1613	require AnyEvent::Util;	1689	require AnyEvent::Util;
1614		1690
1615	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1691	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1768		1844
1769	my ($cb, $w, $rcb) = $arg{cb};	1845	my ($cb, $w, $rcb) = $arg{cb};
1770		1846
1771	$rcb = sub {	1847	$rcb = sub {
1772	if ($cb) {	1848	if ($cb) {
1773	$w = _time;	1849	$w = AE::time;
1774	&$cb;	1850	&$cb;
1775	$w = _time - $w;	1851	$w = AE::time - $w;
1776		1852
1777	# never use more then 50% of the time for the idle watcher,	1853	# never use more then 50% of the time for the idle watcher,
1778	# within some limits	1854	# within some limits
1779	$w = 0.0001 if $w < 0.0001;	1855	$w = 0.0001 if $w < 0.0001;
1780	$w = 5 if $w > 5;	1856	$w = 5 if $w > 5;
…		…
1909	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	1985	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1910	so on.	1986	so on.
1911		1987
1912	=head1 ENVIRONMENT VARIABLES	1988	=head1 ENVIRONMENT VARIABLES
1913		1989
1914	The following environment variables are used by this module or its	1990	AnyEvent supports a number of environment variables that tune the
1915	submodules.	1991	runtime behaviour. They are usually evaluated when AnyEvent is
		1992	loaded, initialised, or a submodule that uses them is loaded. Many of
		1993	them also cause AnyEvent to load additional modules - for example,
		1994	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		1995	loaded.
1916		1996
1917	Note that AnyEvent will remove I<all> environment variables starting with	1997	All the environment variables documented here start with
1918	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	1998	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1919	enabled.	1999	namespace. Other modules are encouraged (but by no means required) to use
		2000	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2001	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2002	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2003	variables starting with C<AE_>, see below).
		2004
		2005	All variables can also be set via the C<AE_> prefix, that is, instead
		2006	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2007	case there is a clash btween anyevent and another program that uses
		2008	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2009	variable to the empty string, as those variables take precedence.
		2010
		2011	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2012	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2013	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2014	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2015	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2016	is set).
		2017
		2018	The exact algorithm is currently:
		2019
		2020	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2021	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2022	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2023
		2024	This ensures that child processes will not see the C<AE_> variables.
		2025
		2026	The following environment variables are currently known to AnyEvent:
1920		2027
1921	=over 4	2028	=over 4
1922		2029
1923	=item C<PERL_ANYEVENT_VERBOSE>	2030	=item C<PERL_ANYEVENT_VERBOSE>
1924		2031
1925	By default, AnyEvent will be completely silent except in fatal	2032	By default, AnyEvent will be completely silent except in fatal
1926	conditions. You can set this environment variable to make AnyEvent more	2033	conditions. You can set this environment variable to make AnyEvent more
1927	talkative.	2034	talkative. If you want to do more than just set the global logging level
		2035	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2036	complex specifications.
1928		2037
1929	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2038	When set to C<5> or higher, causes AnyEvent to warn about unexpected
1930	conditions, such as not being able to load the event model specified by	2039	conditions, such as not being able to load the event model specified by
1931	C<PERL_ANYEVENT_MODEL>.	2040	C<PERL_ANYEVENT_MODEL>.
1932		2041
1933	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2042	When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1934	model it chooses.	2043	model it chooses.
1935		2044
1936	When set to C<8> or higher, then AnyEvent will report extra information on	2045	When set to C<8> or higher, then AnyEvent will report extra information on
1937	which optional modules it loads and how it implements certain features.	2046	which optional modules it loads and how it implements certain features.
		2047
		2048	=item C<PERL_ANYEVENT_LOG>
		2049
		2050	Accepts rather complex logging specifications. For example, you could log
		2051	all C<debug> messages of some module to stderr, warnings and above to
		2052	stderr, and errors and above to syslog, with:
		2053
		2054	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2055
		2056	For the rather extensive details, see L<AnyEvent::Log>.
		2057
		2058	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2059	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2060	using the latter saves a few hundred kB of memory until the first message
		2061	is being logged.
1938		2062
1939	=item C<PERL_ANYEVENT_STRICT>	2063	=item C<PERL_ANYEVENT_STRICT>
1940		2064
1941	AnyEvent does not do much argument checking by default, as thorough	2065	AnyEvent does not do much argument checking by default, as thorough
1942	argument checking is very costly. Setting this variable to a true value	2066	argument checking is very costly. Setting this variable to a true value
…		…
1949	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2073	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1950	>>, it is definitely recommended to keep it off in production. Keeping	2074	>>, it is definitely recommended to keep it off in production. Keeping
1951	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2075	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1952	can be very useful, however.	2076	can be very useful, however.
1953		2077
		2078	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2079
		2080	If this env variable is set, then its contents will be interpreted by
		2081	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2082	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2083	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2084
		2085	This takes place when the first watcher is created.
		2086
		2087	For example, to bind a debug shell on a unix domain socket in
		2088	F<< /tmp/debug<pid>.sock >>, you could use this:
		2089
		2090	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2091
		2092	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2093	systems.
		2094
		2095	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2096
		2097	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2098	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2099
1954	=item C<PERL_ANYEVENT_MODEL>	2100	=item C<PERL_ANYEVENT_MODEL>
1955		2101
1956	This can be used to specify the event model to be used by AnyEvent, before	2102	This can be used to specify the event model to be used by AnyEvent, before
1957	auto detection and -probing kicks in.	2103	auto detection and -probing kicks in.
1958		2104
…		…
1990	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2136	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1991	- only support IPv4, never try to resolve or contact IPv6	2137	- only support IPv4, never try to resolve or contact IPv6
1992	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2138	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1993	IPv6, but prefer IPv6 over IPv4.	2139	IPv6, but prefer IPv6 over IPv4.
1994		2140
		2141	=item C<PERL_ANYEVENT_HOSTS>
		2142
		2143	This variable, if specified, overrides the F</etc/hosts> file used by
		2144	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2145	from that file instead.
		2146
1995	=item C<PERL_ANYEVENT_EDNS0>	2147	=item C<PERL_ANYEVENT_EDNS0>
1996		2148
1997	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2149	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1998	for DNS. This extension is generally useful to reduce DNS traffic, but	2150	DNS. This extension is generally useful to reduce DNS traffic, especially
1999	some (broken) firewalls drop such DNS packets, which is why it is off by	2151	when DNSSEC is involved, but some (broken) firewalls drop such DNS
2000	default.	2152	packets, which is why it is off by default.
2001		2153
2002	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2154	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
2003	EDNS0 in its DNS requests.	2155	EDNS0 in its DNS requests.
2004		2156
2005	=item C<PERL_ANYEVENT_MAX_FORKS>	2157	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
2013	resolver - this is the maximum number of parallel DNS requests that are	2165	resolver - this is the maximum number of parallel DNS requests that are
2014	sent to the DNS server.	2166	sent to the DNS server.
2015		2167
2016	=item C<PERL_ANYEVENT_RESOLV_CONF>	2168	=item C<PERL_ANYEVENT_RESOLV_CONF>
2017		2169
2018	The file to use instead of F</etc/resolv.conf> (or OS-specific	2170	The absolute path to a F<resolv.conf>-style file to use instead of
2019	configuration) in the default resolver. When set to the empty string, no	2171	F</etc/resolv.conf> (or the OS-specific configuration) in the default
2020	default config will be used.	2172	resolver, or the empty string to select the default configuration.
2021		2173
2022	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2174	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
2023		2175
2024	When neither C<ca_file> nor C<ca_path> was specified during	2176	When neither C<ca_file> nor C<ca_path> was specified during
2025	L<AnyEvent::TLS> context creation, and either of these environment	2177	L<AnyEvent::TLS> context creation, and either of these environment
2026	variables exist, they will be used to specify CA certificate locations	2178	variables are nonempty, they will be used to specify CA certificate
2027	instead of a system-dependent default.	2179	locations instead of a system-dependent default.
2028		2180
2029	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2181	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2030		2182
2031	When these are set to C<1>, then the respective modules are not	2183	When these are set to C<1>, then the respective modules are not
2032	loaded. Mostly good for testing AnyEvent itself.	2184	loaded. Mostly good for testing AnyEvent itself.
…		…
2364	(even when used without AnyEvent), but most event loops have acceptable	2516	(even when used without AnyEvent), but most event loops have acceptable
2365	performance with or without AnyEvent.	2517	performance with or without AnyEvent.
2366		2518
2367	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2519	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2368	the actual event loop, only with extremely fast event loops such as EV	2520	the actual event loop, only with extremely fast event loops such as EV
2369	adds AnyEvent significant overhead.	2521	does AnyEvent add significant overhead.
2370		2522
2371	=item * You should avoid POE like the plague if you want performance or	2523	=item * You should avoid POE like the plague if you want performance or
2372	reasonable memory usage.	2524	reasonable memory usage.
2373		2525
2374	=back	2526	=back
…		…
2749		2901
2750	Tutorial/Introduction: L<AnyEvent::Intro>.	2902	Tutorial/Introduction: L<AnyEvent::Intro>.
2751		2903
2752	FAQ: L<AnyEvent::FAQ>.	2904	FAQ: L<AnyEvent::FAQ>.
2753		2905
2754	Utility functions: L<AnyEvent::Util>.	2906	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2907	(simply logging).
2755		2908
		2909	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2910	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2911
2756	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,	2912	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2757	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2913	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2914	L<Qt>, L<POE>, L<FLTK>.
2758		2915
2759	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2916	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2760	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2917	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2761	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2918	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2762	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2919	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2920	L<AnyEvent::Impl::FLTK>.
2763		2921
2764	Non-blocking file handles, sockets, TCP clients and	2922	Non-blocking handles, pipes, stream sockets, TCP clients and
2765	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2923	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2766		2924
2767	Asynchronous DNS: L<AnyEvent::DNS>.	2925	Asynchronous DNS: L<AnyEvent::DNS>.
2768		2926
2769	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	2927	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.355 by root, Fri Aug 12 00:53:29 2011 UTC vs. Revision 1.373 by root, Thu Aug 25 03:08:48 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.355 by root, Fri Aug 12 00:53:29 2011 UTC vs.
Revision 1.373 by root, Thu Aug 25 03:08:48 2011 UTC