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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.357 by root, Sat Aug 13 02:20:29 2011 UTC vs.
Revision 1.381 by root, Thu Sep 1 22:09:25 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::FLTK2 based on FLTK (fltk 2 binding).	883	AnyEvent::Impl::FLTK 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. Right now this happens when a
		1064	numerical loglevel is used and it is larger than the level specified via
		1065	C<$ENV{PERL_ANYEVENT_VERBOSE}>.
		1066
		1067	If you want to sprinkle loads of logging calls around your code, consider
		1068	creating a logger callback with the C<AnyEvent::Log::logger> function,
		1069	which can reduce typing, codesize and can reduce the logging overhead
		1070	enourmously.
		1071
1050	=back	1072	=back
1051		1073
1052	=head1 WHAT TO DO IN A MODULE	1074	=head1 WHAT TO DO IN A MODULE
1053		1075
1054	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1076	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1110		1132
1111		1133
1112	=head1 OTHER MODULES	1134	=head1 OTHER MODULES
1113		1135
1114	The following is a non-exhaustive list of additional modules that use	1136	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	1137	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	1138	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.	1139	modules come as part of AnyEvent, the others are available via CPAN (see
		1140	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1141	a longer non-exhaustive list), and the list is heavily biased towards
		1142	modules of the AnyEvent author himself :)
1118		1143
1119	=over 4	1144	=over 4
1120		1145
1121	=item L<AnyEvent::Util>	1146	=item L<AnyEvent::Util>
1122		1147
…		…
1142	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>	1167	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1143		1168
1144	Implement event-based interfaces to the protocols of the same name (for	1169	Implement event-based interfaces to the protocols of the same name (for
1145	the curious, IGS is the International Go Server and FCP is the Freenet	1170	the curious, IGS is the International Go Server and FCP is the Freenet
1146	Client Protocol).	1171	Client Protocol).
1147
1148	=item L<AnyEvent::Handle::UDP>
1149
1150	Here be danger!
1151
1152	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1153	there are so many things wrong with AnyEvent::Handle::UDP, most notably
1154	its use of a stream-based API with a protocol that isn't streamable, that
1155	the only way to improve it is to delete it.
1156
1157	It features data corruption (but typically only under load) and general
1158	confusion. On top, the author is not only clueless about UDP but also
1159	fact-resistant - some gems of his understanding: "connect doesn't work
1160	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1161	packets", "I don't need to implement proper error checking as UDP doesn't
1162	support error checking" and so on - he doesn't even understand what's
1163	wrong with his module when it is explained to him.
1164
1165	=item L<AnyEvent::DBI>
1166
1167	Executes L<DBI> requests asynchronously in a proxy process for you,
1168	notifying you in an event-based way when the operation is finished.
1169		1172
1170	=item L<AnyEvent::AIO>	1173	=item L<AnyEvent::AIO>
1171		1174
1172	Truly asynchronous (as opposed to non-blocking) I/O, should be in the	1175	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1173	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1176	toolbox of every event programmer. AnyEvent::AIO transparently fuses
1174	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based	1177	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1175	file I/O, and much more.	1178	file I/O, and much more.
1176		1179
		1180	=item L<AnyEvent::Filesys::Notify>
		1181
		1182	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1183	path changes (e.g. "watch this directory for new files", "watch this
		1184	file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
		1185	do just that in a portbale fashion, supporting inotify on GNU/Linux and
		1186	some weird, without doubt broken, stuff on OS X to monitor files. It can
		1187	fall back to blocking scans at regular intervals transparently on other
		1188	platforms, so it's about as portable as it gets.
		1189
		1190	(I haven't used it myself, but I haven't heard anybody complaining about
		1191	it yet).
		1192
		1193	=item L<AnyEvent::DBI>
		1194
		1195	Executes L<DBI> requests asynchronously in a proxy process for you,
		1196	notifying you in an event-based way when the operation is finished.
		1197
1177	=item L<AnyEvent::HTTPD>	1198	=item L<AnyEvent::HTTPD>
1178		1199
1179	A simple embedded webserver.	1200	A simple embedded webserver.
1180		1201
1181	=item L<AnyEvent::FastPing>	1202	=item L<AnyEvent::FastPing>
1182		1203
1183	The fastest ping in the west.	1204	The fastest ping in the west.
1184		1205
1185	=item L<Coro>	1206	=item L<Coro>
1186		1207
1187	Has special support for AnyEvent via L<Coro::AnyEvent>.	1208	Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
		1209	to simply invert the flow control - don't call us, we will call you:
		1210
		1211	async {
		1212	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1213	print "5 seconds later!\n";
		1214
		1215	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1216	my $line = <STDIN>; # works for ttys
		1217
		1218	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1219	my ($body, $hdr) = Coro::rouse_wait;
		1220	};
1188		1221
1189	=back	1222	=back
1190		1223
1191	=cut	1224	=cut
1192		1225
…		…
1202		1235
1203	BEGIN { AnyEvent::common_sense }	1236	BEGIN { AnyEvent::common_sense }
1204		1237
1205	use Carp ();	1238	use Carp ();
1206		1239
1207	our $VERSION = '5.34';	1240	our $VERSION = '6.02';
1208	our $MODEL;	1241	our $MODEL;
1209		1242
1210	our @ISA;	1243	our @ISA;
1211		1244
1212	our @REGISTRY;	1245	our @REGISTRY;
…		…
1219	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1252	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1220		1253
1221	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1254	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1222	if ${^TAINT};	1255	if ${^TAINT};
1223		1256
1224	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1257	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1258	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1225		1259
		1260	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1261	if ${^TAINT};
		1262
		1263	# $ENV{PERL_ANYEVENT_xxx} now valid
		1264
		1265	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1226	}	1266	}
1227		1267
1228	our $MAX_SIGNAL_LATENCY = 10;	1268	our $MAX_SIGNAL_LATENCY = 10;
1229		1269
1230	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1270	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
1266	push @POSTPONE, shift;	1306	push @POSTPONE, shift;
1267		1307
1268	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);	1308	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
1269		1309
1270	()	1310	()
		1311	}
		1312
		1313	sub log($$;@) {
		1314	# only load the big bloated module when we actually are about to log something
		1315	if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
		1316	require AnyEvent::Log;
		1317	# AnyEvent::Log overwrites this function
		1318	goto &log;
		1319	}
		1320
		1321	0 # not logged
		1322	}
		1323
		1324	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1325	require AnyEvent::Log; # AnyEvent::Log does the thing for us
1271	}	1326	}
1272		1327
1273	our @models = (	1328	our @models = (
1274	[EV:: => AnyEvent::Impl::EV:: , 1],	1329	[EV:: => AnyEvent::Impl::EV:: , 1],
1275	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],	1330	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
…		…
1285	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1340	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1286	[Wx:: => AnyEvent::Impl::POE::],	1341	[Wx:: => AnyEvent::Impl::POE::],
1287	[Prima:: => AnyEvent::Impl::POE::],	1342	[Prima:: => AnyEvent::Impl::POE::],
1288	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect	1343	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1289	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1344	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1290	[FLTK:: => AnyEvent::Impl::FLTK2::],	1345	[FLTK:: => AnyEvent::Impl::FLTK::],
1291	);	1346	);
		1347
		1348	our @isa_hook;
		1349
		1350	sub _isa_set {
		1351	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1352
		1353	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1354	for 1 .. $#pkg;
		1355
		1356	grep $_ && $_->[1], @isa_hook
		1357	and AE::_reset ();
		1358	}
		1359
		1360	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1361	sub _isa_hook($$;$) {
		1362	my ($i, $pkg, $reset_ae) = @_;
		1363
		1364	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1365
		1366	_isa_set;
		1367	}
1292		1368
1293	# all autoloaded methods reserve the complete glob, not just the method slot.	1369	# all autoloaded methods reserve the complete glob, not just the method slot.
1294	# due to bugs in perls method cache implementation.	1370	# due to bugs in perls method cache implementation.
1295	our @methods = qw(io timer time now now_update signal child idle condvar);	1371	our @methods = qw(io timer time now now_update signal child idle condvar);
1296		1372
1297	sub detect() {	1373	sub detect() {
		1374	return $MODEL if $MODEL; # some programs keep references to detect
		1375
1298	local $!; # for good measure	1376	local $!; # for good measure
1299	local $SIG{__DIE__}; # we use eval	1377	local $SIG{__DIE__}; # we use eval
1300		1378
1301	# free some memory	1379	# free some memory
1302	*detect = sub () { $MODEL };	1380	*detect = sub () { $MODEL };
…		…
1310		1388
1311	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {	1389	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1312	my $model = $1;	1390	my $model = $1;
1313	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;	1391	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1314	if (eval "require $model") {	1392	if (eval "require $model") {
		1393	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1315	$MODEL = $model;	1394	$MODEL = $model;
1316	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1317	} else {	1395	} else {
1318	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1396	AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1319	}	1397	}
1320	}	1398	}
1321		1399
1322	# check for already loaded models	1400	# check for already loaded models
1323	unless ($MODEL) {	1401	unless ($MODEL) {
1324	for (@REGISTRY, @models) {	1402	for (@REGISTRY, @models) {
1325	my ($package, $model) = @$_;	1403	my ($package, $model) = @$_;
1326	if (${"$package\::VERSION"} > 0) {	1404	if (${"$package\::VERSION"} > 0) {
1327	if (eval "require $model") {	1405	if (eval "require $model") {
		1406	AnyEvent::log 7 => "autodetected model '$model', using it.";
1328	$MODEL = $model;	1407	$MODEL = $model;
1329	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1330	last;	1408	last;
1331	}	1409	}
1332	}	1410	}
1333	}	1411	}
1334		1412
…		…
1340	$autoload	1418	$autoload
1341	and eval "require $package"	1419	and eval "require $package"
1342	and ${"$package\::VERSION"} > 0	1420	and ${"$package\::VERSION"} > 0
1343	and eval "require $model"	1421	and eval "require $model"
1344	) {	1422	) {
		1423	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1345	$MODEL = $model;	1424	$MODEL = $model;
1346	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1347	last;	1425	last;
1348	}	1426	}
1349	}	1427	}
1350		1428
1351	$MODEL	1429	$MODEL
1352	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1430	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1353	}	1431	}
1354	}	1432	}
1355		1433
1356	# free memory only needed for probing	1434	# free memory only needed for probing
1357	undef @models;	1435	undef @models;
1358	undef @REGISTRY;	1436	undef @REGISTRY;
1359		1437
1360	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1438	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1361	unshift @ISA, $MODEL;
1362		1439
1363	# now nuke some methods that are overridden by the backend.	1440	# now nuke some methods that are overridden by the backend.
1364	# SUPER usage is not allowed in these.	1441	# SUPER usage is not allowed in these.
1365	for (qw(time signal child idle)) {	1442	for (qw(time signal child idle)) {
1366	undef &{"AnyEvent::Base::$_"}	1443	undef &{"AnyEvent::Base::$_"}
1367	if defined &{"$MODEL\::$_"};	1444	if defined &{"$MODEL\::$_"};
1368	}	1445	}
1369		1446
		1447	_isa_set;
		1448
		1449	# we're officially open!
		1450
1370	if ($ENV{PERL_ANYEVENT_STRICT}) {	1451	if ($ENV{PERL_ANYEVENT_STRICT}) {
1371	require AnyEvent::Strict;	1452	require AnyEvent::Strict;
1372	}	1453	}
1373		1454
1374	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {	1455	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1375	require AnyEvent::Debug;	1456	require AnyEvent::Debug;
1376	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});	1457	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1377	}	1458	}
1378		1459
1379	if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {	1460	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1461	require AnyEvent::Socket;
1380	require AnyEvent::Debug;	1462	require AnyEvent::Debug;
1381	#d#	1463
		1464	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1465	$shell =~ s/\$\$/$$/g;
		1466
		1467	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1468	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1382	}	1469	}
		1470
		1471	# now the anyevent environment is set up as the user told us to, so
		1472	# call the actual user code - post detects
1383		1473
1384	(shift @post_detect)->() while @post_detect;	1474	(shift @post_detect)->() while @post_detect;
1385	undef @post_detect;	1475	undef @post_detect;
1386		1476
1387	*post_detect = sub(&) {	1477	*post_detect = sub(&) {
…		…
1474	sub time() {	1564	sub time() {
1475	AnyEvent->time	1565	AnyEvent->time
1476	}	1566	}
1477		1567
1478	*postpone = \&AnyEvent::postpone;	1568	*postpone = \&AnyEvent::postpone;
		1569	*log = \&AnyEvent::log;
1479	};	1570	};
1480	die if $@;	1571	die if $@;
1481	}	1572	}
1482		1573
1483	BEGIN { _reset }	1574	BEGIN { _reset }
…		…
1488		1579
1489	sub time {	1580	sub time {
1490	eval q{ # poor man's autoloading {}	1581	eval q{ # poor man's autoloading {}
1491	# probe for availability of Time::HiRes	1582	# probe for availability of Time::HiRes
1492	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1583	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1493	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1584	*time = sub { Time::HiRes::time () };
1494	*AE::time = \&Time::HiRes::time;	1585	*AE::time = \& Time::HiRes::time ;
		1586	*now = \&time;
		1587	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1495	# if (eval "use POSIX (); (POSIX::times())...	1588	# if (eval "use POSIX (); (POSIX::times())...
1496	} else {	1589	} else {
		1590	*time = sub { CORE::time };
		1591	*AE::time = sub (){ CORE::time };
		1592	*now = \&time;
1497	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1593	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1498	*AE::time = sub (){ time }; # epic fail
1499	}	1594	}
1500
1501	*time = sub { AE::time }; # different prototypes
1502	};	1595	};
1503	die if $@;	1596	die if $@;
1504		1597
1505	&time	1598	&time
1506	}	1599	}
1507		1600
1508	*now = \&time;	1601	*now = \&time;
1509
1510	sub now_update { }	1602	sub now_update { }
1511		1603
1512	sub _poll {	1604	sub _poll {
1513	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";	1605	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1514	}	1606	}
…		…
1600		1692
1601	sub signal {	1693	sub signal {
1602	eval q{ # poor man's autoloading {}	1694	eval q{ # poor man's autoloading {}
1603	# probe for availability of Async::Interrupt	1695	# probe for availability of Async::Interrupt
1604	if (_have_async_interrupt) {	1696	if (_have_async_interrupt) {
1605	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1697	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1606		1698
1607	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1699	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1608	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1700	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1609		1701
1610	} else {	1702	} else {
1611	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1703	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1612		1704
1613	if (AnyEvent::WIN32) {	1705	if (AnyEvent::WIN32) {
1614	require AnyEvent::Util;	1706	require AnyEvent::Util;
1615		1707
1616	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1708	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1910	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2002	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1911	so on.	2003	so on.
1912		2004
1913	=head1 ENVIRONMENT VARIABLES	2005	=head1 ENVIRONMENT VARIABLES
1914		2006
1915	The following environment variables are used by this module or its	2007	AnyEvent supports a number of environment variables that tune the
1916	submodules.	2008	runtime behaviour. They are usually evaluated when AnyEvent is
		2009	loaded, initialised, or a submodule that uses them is loaded. Many of
		2010	them also cause AnyEvent to load additional modules - for example,
		2011	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2012	loaded.
1917		2013
1918	Note that AnyEvent will remove I<all> environment variables starting with	2014	All the environment variables documented here start with
1919	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2015	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1920	enabled.	2016	namespace. Other modules are encouraged (but by no means required) to use
		2017	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2018	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2019	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2020	variables starting with C<AE_>, see below).
		2021
		2022	All variables can also be set via the C<AE_> prefix, that is, instead
		2023	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2024	case there is a clash btween anyevent and another program that uses
		2025	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2026	variable to the empty string, as those variables take precedence.
		2027
		2028	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2029	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2030	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2031	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2032	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2033	is set).
		2034
		2035	The exact algorithm is currently:
		2036
		2037	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2038	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2039	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2040
		2041	This ensures that child processes will not see the C<AE_> variables.
		2042
		2043	The following environment variables are currently known to AnyEvent:
1921		2044
1922	=over 4	2045	=over 4
1923		2046
1924	=item C<PERL_ANYEVENT_VERBOSE>	2047	=item C<PERL_ANYEVENT_VERBOSE>
1925		2048
1926	By default, AnyEvent will be completely silent except in fatal	2049	By default, AnyEvent will only log messages with loglevel C<3>
1927	conditions. You can set this environment variable to make AnyEvent more	2050	(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
		2051	environment variable to a numerical loglevel to make AnyEvent more (or
1928	talkative.	2052	less) talkative.
1929		2053
		2054	If you want to do more than just set the global logging level
		2055	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2056	complex specifications.
		2057
		2058	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2059	the default logging settings.
		2060
1930	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2061	When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1931	conditions, such as not being able to load the event model specified by	2062	unexpected conditions, such as not being able to load the event model
1932	C<PERL_ANYEVENT_MODEL>.	2063	specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
		2064	exception - this is the minimum recommended level.
1933		2065
1934	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2066	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1935	model it chooses.	2067	chooses.
1936		2068
1937	When set to C<8> or higher, then AnyEvent will report extra information on	2069	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1938	which optional modules it loads and how it implements certain features.	2070	which optional modules it loads and how it implements certain features.
		2071
		2072	=item C<PERL_ANYEVENT_LOG>
		2073
		2074	Accepts rather complex logging specifications. For example, you could log
		2075	all C<debug> messages of some module to stderr, warnings and above to
		2076	stderr, and errors and above to syslog, with:
		2077
		2078	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2079
		2080	For the rather extensive details, see L<AnyEvent::Log>.
		2081
		2082	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2083	so will take effect even before AnyEvent has initialised itself.
		2084
		2085	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2086	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2087	using the latter saves a few hundred kB of memory until the first message
		2088	is being logged.
1939		2089
1940	=item C<PERL_ANYEVENT_STRICT>	2090	=item C<PERL_ANYEVENT_STRICT>
1941		2091
1942	AnyEvent does not do much argument checking by default, as thorough	2092	AnyEvent does not do much argument checking by default, as thorough
1943	argument checking is very costly. Setting this variable to a true value	2093	argument checking is very costly. Setting this variable to a true value
…		…
1950	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2100	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1951	>>, it is definitely recommended to keep it off in production. Keeping	2101	>>, it is definitely recommended to keep it off in production. Keeping
1952	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2102	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1953	can be very useful, however.	2103	can be very useful, however.
1954		2104
		2105	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2106
		2107	If this env variable is set, then its contents will be interpreted by
		2108	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2109	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2110	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2111
		2112	This happens when the first watcher is created.
		2113
		2114	For example, to bind a debug shell on a unix domain socket in
		2115	F<< /tmp/debug<pid>.sock >>, you could use this:
		2116
		2117	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2118
		2119	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2120	systems.
		2121
		2122	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2123
		2124	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2125	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2126
1955	=item C<PERL_ANYEVENT_MODEL>	2127	=item C<PERL_ANYEVENT_MODEL>
1956		2128
1957	This can be used to specify the event model to be used by AnyEvent, before	2129	This can be used to specify the event model to be used by AnyEvent, before
1958	auto detection and -probing kicks in.	2130	auto detection and -probing kicks in.
1959		2131
…		…
1991	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2163	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1992	- only support IPv4, never try to resolve or contact IPv6	2164	- only support IPv4, never try to resolve or contact IPv6
1993	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2165	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1994	IPv6, but prefer IPv6 over IPv4.	2166	IPv6, but prefer IPv6 over IPv4.
1995		2167
		2168	=item C<PERL_ANYEVENT_HOSTS>
		2169
		2170	This variable, if specified, overrides the F</etc/hosts> file used by
		2171	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2172	from that file instead.
		2173
1996	=item C<PERL_ANYEVENT_EDNS0>	2174	=item C<PERL_ANYEVENT_EDNS0>
1997		2175
1998	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2176	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1999	for DNS. This extension is generally useful to reduce DNS traffic, but	2177	DNS. This extension is generally useful to reduce DNS traffic, especially
2000	some (broken) firewalls drop such DNS packets, which is why it is off by	2178	when DNSSEC is involved, but some (broken) firewalls drop such DNS
2001	default.	2179	packets, which is why it is off by default.
2002		2180
2003	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2181	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
2004	EDNS0 in its DNS requests.	2182	EDNS0 in its DNS requests.
2005		2183
2006	=item C<PERL_ANYEVENT_MAX_FORKS>	2184	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
2014	resolver - this is the maximum number of parallel DNS requests that are	2192	resolver - this is the maximum number of parallel DNS requests that are
2015	sent to the DNS server.	2193	sent to the DNS server.
2016		2194
2017	=item C<PERL_ANYEVENT_RESOLV_CONF>	2195	=item C<PERL_ANYEVENT_RESOLV_CONF>
2018		2196
2019	The file to use instead of F</etc/resolv.conf> (or OS-specific	2197	The absolute path to a F<resolv.conf>-style file to use instead of
2020	configuration) in the default resolver. When set to the empty string, no	2198	F</etc/resolv.conf> (or the OS-specific configuration) in the default
2021	default config will be used.	2199	resolver, or the empty string to select the default configuration.
2022		2200
2023	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2201	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
2024		2202
2025	When neither C<ca_file> nor C<ca_path> was specified during	2203	When neither C<ca_file> nor C<ca_path> was specified during
2026	L<AnyEvent::TLS> context creation, and either of these environment	2204	L<AnyEvent::TLS> context creation, and either of these environment
2027	variables exist, they will be used to specify CA certificate locations	2205	variables are nonempty, they will be used to specify CA certificate
2028	instead of a system-dependent default.	2206	locations instead of a system-dependent default.
2029		2207
2030	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2208	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2031		2209
2032	When these are set to C<1>, then the respective modules are not	2210	When these are set to C<1>, then the respective modules are not
2033	loaded. Mostly good for testing AnyEvent itself.	2211	loaded. Mostly good for testing AnyEvent itself.
…		…
2365	(even when used without AnyEvent), but most event loops have acceptable	2543	(even when used without AnyEvent), but most event loops have acceptable
2366	performance with or without AnyEvent.	2544	performance with or without AnyEvent.
2367		2545
2368	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2546	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2369	the actual event loop, only with extremely fast event loops such as EV	2547	the actual event loop, only with extremely fast event loops such as EV
2370	adds AnyEvent significant overhead.	2548	does AnyEvent add significant overhead.
2371		2549
2372	=item * You should avoid POE like the plague if you want performance or	2550	=item * You should avoid POE like the plague if you want performance or
2373	reasonable memory usage.	2551	reasonable memory usage.
2374		2552
2375	=back	2553	=back
…		…
2750		2928
2751	Tutorial/Introduction: L<AnyEvent::Intro>.	2929	Tutorial/Introduction: L<AnyEvent::Intro>.
2752		2930
2753	FAQ: L<AnyEvent::FAQ>.	2931	FAQ: L<AnyEvent::FAQ>.
2754		2932
2755	Utility functions: L<AnyEvent::Util>.	2933	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2934	(simply logging).
2756		2935
		2936	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2937	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2938
2757	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,	2939	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2758	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2940	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2941	L<Qt>, L<POE>, L<FLTK>.
2759		2942
2760	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2943	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2761	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2944	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2762	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2945	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2763	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2946	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2947	L<AnyEvent::Impl::FLTK>.
2764		2948
2765	Non-blocking file handles, sockets, TCP clients and	2949	Non-blocking handles, pipes, stream sockets, TCP clients and
2766	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2950	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2767		2951
2768	Asynchronous DNS: L<AnyEvent::DNS>.	2952	Asynchronous DNS: L<AnyEvent::DNS>.
2769		2953
2770	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	2954	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.357 by root, Sat Aug 13 02:20:29 2011 UTC vs. Revision 1.381 by root, Thu Sep 1 22:09:25 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.357 by root, Sat Aug 13 02:20:29 2011 UTC vs.
Revision 1.381 by root, Thu Sep 1 22:09:25 2011 UTC