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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.356 by root, Fri Aug 12 18:41:25 2011 UTC vs.
Revision 1.379 by root, Fri Aug 26 18:09:04 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.
		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
…		…
1142	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>	1165	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1143		1166
1144	Implement event-based interfaces to the protocols of the same name (for	1167	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	1168	the curious, IGS is the International Go Server and FCP is the Freenet
1146	Client Protocol).	1169	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		1170
1170	=item L<AnyEvent::AIO>	1171	=item L<AnyEvent::AIO>
1171		1172
1172	Truly asynchronous (as opposed to non-blocking) I/O, should be in the	1173	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1173	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1174	toolbox of every event programmer. AnyEvent::AIO transparently fuses
1174	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based	1175	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1175	file I/O, and much more.	1176	file I/O, and much more.
1176		1177
		1178	=item L<AnyEvent::Filesys::Notify>
		1179
		1180	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1181	path changes (e.g. "watch this directory for new files", "watch this
		1182	file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
		1183	do just that in a portbale fashion, supporting inotify on GNU/Linux and
		1184	some weird, without doubt broken, stuff on OS X to monitor files. It can
		1185	fall back to blocking scans at regular intervals transparently on other
		1186	platforms, so it's about as portable as it gets.
		1187
		1188	(I haven't used it myself, but I haven't heard anybody complaining about
		1189	it yet).
		1190
		1191	=item L<AnyEvent::DBI>
		1192
		1193	Executes L<DBI> requests asynchronously in a proxy process for you,
		1194	notifying you in an event-based way when the operation is finished.
		1195
1177	=item L<AnyEvent::HTTPD>	1196	=item L<AnyEvent::HTTPD>
1178		1197
1179	A simple embedded webserver.	1198	A simple embedded webserver.
1180		1199
1181	=item L<AnyEvent::FastPing>	1200	=item L<AnyEvent::FastPing>
1182		1201
1183	The fastest ping in the west.	1202	The fastest ping in the west.
1184		1203
1185	=item L<Coro>	1204	=item L<Coro>
1186		1205
1187	Has special support for AnyEvent via L<Coro::AnyEvent>.	1206	Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
		1207	to simply invert the flow control - don't call us, we will call you:
		1208
		1209	async {
		1210	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1211	print "5 seconds later!\n";
		1212
		1213	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1214	my $line = <STDIN>; # works for ttys
		1215
		1216	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1217	my ($body, $hdr) = Coro::rouse_wait;
		1218	};
1188		1219
1189	=back	1220	=back
1190		1221
1191	=cut	1222	=cut
1192		1223
…		…
1202		1233
1203	BEGIN { AnyEvent::common_sense }	1234	BEGIN { AnyEvent::common_sense }
1204		1235
1205	use Carp ();	1236	use Carp ();
1206		1237
1207	our $VERSION = '5.34';	1238	our $VERSION = '6.02';
1208	our $MODEL;	1239	our $MODEL;
1209		1240
1210	our $AUTOLOAD;
1211	our @ISA;	1241	our @ISA;
1212		1242
1213	our @REGISTRY;	1243	our @REGISTRY;
1214		1244
1215	our $VERBOSE;	1245	our $VERBOSE;
…		…
1220	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1250	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1221		1251
1222	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1252	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1223	if ${^TAINT};	1253	if ${^TAINT};
1224		1254
		1255	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1256	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
		1257
		1258	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1259	if ${^TAINT};
		1260
1225	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1261	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1226
1227	}	1262	}
1228		1263
1229	our $MAX_SIGNAL_LATENCY = 10;	1264	our $MAX_SIGNAL_LATENCY = 10;
1230		1265
1231	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1266	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
1267	push @POSTPONE, shift;	1302	push @POSTPONE, shift;
1268		1303
1269	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);	1304	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
1270		1305
1271	()	1306	()
		1307	}
		1308
		1309	sub log($$;@) {
		1310	# only load the big bloated module when we actually are about to log something
		1311	if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
		1312	require AnyEvent::Log;
		1313	# AnyEvent::Log overwrites this function
		1314	goto &log;
		1315	}
		1316
		1317	0 # not logged
		1318	}
		1319
		1320	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1321	require AnyEvent::Log; # AnyEvent::Log does the thing for us
1272	}	1322	}
1273		1323
1274	our @models = (	1324	our @models = (
1275	[EV:: => AnyEvent::Impl::EV:: , 1],	1325	[EV:: => AnyEvent::Impl::EV:: , 1],
1276	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],	1326	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
…		…
1286	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1336	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1287	[Wx:: => AnyEvent::Impl::POE::],	1337	[Wx:: => AnyEvent::Impl::POE::],
1288	[Prima:: => AnyEvent::Impl::POE::],	1338	[Prima:: => AnyEvent::Impl::POE::],
1289	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect	1339	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1290	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1340	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1291	[FLTK:: => AnyEvent::Impl::FLTK2::],	1341	[FLTK:: => AnyEvent::Impl::FLTK::],
1292	);	1342	);
1293		1343
		1344	our @isa_hook;
		1345
		1346	sub _isa_set {
		1347	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1348
		1349	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1350	for 1 .. $#pkg;
		1351
		1352	grep $_ && $_->[1], @isa_hook
		1353	and AE::_reset ();
		1354	}
		1355
		1356	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1357	sub _isa_hook($$;$) {
		1358	my ($i, $pkg, $reset_ae) = @_;
		1359
		1360	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1361
		1362	_isa_set;
		1363	}
		1364
		1365	# all autoloaded methods reserve the complete glob, not just the method slot.
		1366	# due to bugs in perls method cache implementation.
		1367	our @methods = qw(io timer time now now_update signal child idle condvar);
		1368
1294	sub detect() {	1369	sub detect() {
		1370	return $MODEL if $MODEL; # some programs keep references to detect
		1371
		1372	local $!; # for good measure
		1373	local $SIG{__DIE__}; # we use eval
		1374
1295	# free some memory	1375	# free some memory
1296	*detect = sub () { $MODEL };	1376	*detect = sub () { $MODEL };
1297		1377	# undef &func doesn't correctly update the method cache. grmbl.
1298	local $!; # for good measure	1378	# so we delete the whole glob. grmbl.
1299	local $SIG{__DIE__};	1379	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1380	# a glob with an active sub. hrm. i hope it works, but perl is
		1381	# usually buggy in this department. sigh.
		1382	delete @{"AnyEvent::"}{@methods};
		1383	undef @methods;
1300		1384
1301	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {	1385	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1302	my $model = $1;	1386	my $model = $1;
1303	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;	1387	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1304	if (eval "require $model") {	1388	if (eval "require $model") {
		1389	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1305	$MODEL = $model;	1390	$MODEL = $model;
1306	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1307	} else {	1391	} else {
1308	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1392	AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1309	}	1393	}
1310	}	1394	}
1311		1395
1312	# check for already loaded models	1396	# check for already loaded models
1313	unless ($MODEL) {	1397	unless ($MODEL) {
1314	for (@REGISTRY, @models) {	1398	for (@REGISTRY, @models) {
1315	my ($package, $model) = @$_;	1399	my ($package, $model) = @$_;
1316	if (${"$package\::VERSION"} > 0) {	1400	if (${"$package\::VERSION"} > 0) {
1317	if (eval "require $model") {	1401	if (eval "require $model") {
		1402	AnyEvent::log 7 => "autodetected model '$model', using it.";
1318	$MODEL = $model;	1403	$MODEL = $model;
1319	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1320	last;	1404	last;
1321	}	1405	}
1322	}	1406	}
1323	}	1407	}
1324		1408
…		…
1330	$autoload	1414	$autoload
1331	and eval "require $package"	1415	and eval "require $package"
1332	and ${"$package\::VERSION"} > 0	1416	and ${"$package\::VERSION"} > 0
1333	and eval "require $model"	1417	and eval "require $model"
1334	) {	1418	) {
		1419	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1335	$MODEL = $model;	1420	$MODEL = $model;
1336	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1337	last;	1421	last;
1338	}	1422	}
1339	}	1423	}
1340		1424
1341	$MODEL	1425	$MODEL
1342	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1426	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1343	}	1427	}
1344	}	1428	}
1345		1429
1346	# free memory only needed for probing	1430	# free memory only needed for probing
1347	undef @models;	1431	undef @models;
1348	undef @REGISTRY;	1432	undef @REGISTRY;
1349		1433
1350	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1434	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1351	unshift @ISA, $MODEL;
1352		1435
1353	# now nuke some methods that are overridden by the backend.	1436	# now nuke some methods that are overridden by the backend.
1354	# SUPER usage is not allowed in these.	1437	# SUPER usage is not allowed in these.
1355	for (qw(time signal child idle)) {	1438	for (qw(time signal child idle)) {
1356	undef &{"AnyEvent::Base::$_"}	1439	undef &{"AnyEvent::Base::$_"}
1357	if defined &{"$MODEL\::$_"};	1440	if defined &{"$MODEL\::$_"};
1358	}	1441	}
1359		1442
		1443	_isa_set;
		1444
		1445	# we're officially open!
		1446
1360	if ($ENV{PERL_ANYEVENT_STRICT}) {	1447	if ($ENV{PERL_ANYEVENT_STRICT}) {
1361	eval { require AnyEvent::Strict };	1448	require AnyEvent::Strict;
1362	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1363	if $@ && $VERBOSE;
1364	}	1449	}
		1450
		1451	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1452	require AnyEvent::Debug;
		1453	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1454	}
		1455
		1456	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1457	require AnyEvent::Socket;
		1458	require AnyEvent::Debug;
		1459
		1460	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1461	$shell =~ s/\$\$/$$/g;
		1462
		1463	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1464	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1465	}
		1466
		1467	# now the anyevent environment is set up as the user told us to, so
		1468	# call the actual user code - post detects
1365		1469
1366	(shift @post_detect)->() while @post_detect;	1470	(shift @post_detect)->() while @post_detect;
1367	undef @post_detect;	1471	undef @post_detect;
1368		1472
1369	*post_detect = sub(&) {	1473	*post_detect = sub(&) {
1370	shift->();	1474	shift->();
1371		1475
1372	undef	1476	undef
1373	};	1477	};
1374		1478
1375	# recover a few more bytes	1479	$MODEL
1376	postpone {	1480	}
1377	undef &AUTOLOAD;	1481
		1482	for my $name (@methods) {
		1483	*$name = sub {
		1484	detect;
		1485	# we use goto because
		1486	# a) it makes the thunk more transparent
		1487	# b) it allows us to delete the thunk later
		1488	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1378	};	1489	};
1379
1380	$MODEL
1381	}
1382
1383	our %method = map +($_ => 1),
1384	qw(io timer time now now_update signal child idle condvar DESTROY);
1385
1386	sub AUTOLOAD {
1387	(my $func = $AUTOLOAD) =~ s/.*://;
1388
1389	$method{$func}
1390	or Carp::croak "$func: not a valid AnyEvent class method";
1391
1392	# free some memory
1393	undef %method;
1394
1395	detect;
1396
1397	my $class = shift;
1398	$class->$func (@_);
1399	}	1490	}
1400		1491
1401	# utility function to dup a filehandle. this is used by many backends	1492	# utility function to dup a filehandle. this is used by many backends
1402	# to support binding more than one watcher per filehandle (they usually	1493	# to support binding more than one watcher per filehandle (they usually
1403	# allow only one watcher per fd, so we dup it to get a different one).	1494	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1427		1518
1428	package AE;	1519	package AE;
1429		1520
1430	our $VERSION = $AnyEvent::VERSION;	1521	our $VERSION = $AnyEvent::VERSION;
1431		1522
1432
1433	sub _reset() {	1523	sub _reset() {
1434	eval q{	1524	eval q{
1435	# fall back to the main API by default - backends and AnyEvent::Base	1525	# fall back to the main API by default - backends and AnyEvent::Base
1436	# implementations can overwrite these.	1526	# implementations can overwrite these.
1437		1527
…		…
1450	sub child($$) {	1540	sub child($$) {
1451	AnyEvent->child (pid => $_[0], cb => $_[1])	1541	AnyEvent->child (pid => $_[0], cb => $_[1])
1452	}	1542	}
1453		1543
1454	sub idle($) {	1544	sub idle($) {
1455	AnyEvent->idle (cb => $_[0])	1545	AnyEvent->idle (cb => $_[0]);
1456	}	1546	}
1457		1547
1458	sub cv(;&) {	1548	sub cv(;&) {
1459	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1549	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1460	}	1550	}
…		…
1470	sub time() {	1560	sub time() {
1471	AnyEvent->time	1561	AnyEvent->time
1472	}	1562	}
1473		1563
1474	*postpone = \&AnyEvent::postpone;	1564	*postpone = \&AnyEvent::postpone;
		1565	*log = \&AnyEvent::log;
1475	};	1566	};
1476	die if $@;	1567	die if $@;
1477	}	1568	}
1478		1569
1479	BEGIN { _reset }	1570	BEGIN { _reset }
…		…
1484		1575
1485	sub time {	1576	sub time {
1486	eval q{ # poor man's autoloading {}	1577	eval q{ # poor man's autoloading {}
1487	# probe for availability of Time::HiRes	1578	# probe for availability of Time::HiRes
1488	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1579	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1489	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1580	*time = sub { Time::HiRes::time () };
1490	*AE::time = \&Time::HiRes::time;	1581	*AE::time = \& Time::HiRes::time ;
		1582	*now = \&time;
		1583	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1491	# if (eval "use POSIX (); (POSIX::times())...	1584	# if (eval "use POSIX (); (POSIX::times())...
1492	} else {	1585	} else {
		1586	*time = sub { CORE::time };
		1587	*AE::time = sub (){ CORE::time };
		1588	*now = \&time;
1493	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1589	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1494	*AE::time = sub (){ time }; # epic fail
1495	}	1590	}
1496
1497	*time = sub { AE::time }; # different prototypes
1498	};	1591	};
1499	die if $@;	1592	die if $@;
1500		1593
1501	&time	1594	&time
1502	}	1595	}
1503		1596
1504	*now = \&time;	1597	*now = \&time;
1505
1506	sub now_update { }	1598	sub now_update { }
1507		1599
1508	sub _poll {	1600	sub _poll {
1509	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";	1601	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1510	}	1602	}
…		…
1596		1688
1597	sub signal {	1689	sub signal {
1598	eval q{ # poor man's autoloading {}	1690	eval q{ # poor man's autoloading {}
1599	# probe for availability of Async::Interrupt	1691	# probe for availability of Async::Interrupt
1600	if (_have_async_interrupt) {	1692	if (_have_async_interrupt) {
1601	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1693	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1602		1694
1603	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1695	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1604	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1696	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1605		1697
1606	} else {	1698	} else {
1607	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1699	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1608		1700
1609	if (AnyEvent::WIN32) {	1701	if (AnyEvent::WIN32) {
1610	require AnyEvent::Util;	1702	require AnyEvent::Util;
1611		1703
1612	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1704	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1906	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	1998	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1907	so on.	1999	so on.
1908		2000
1909	=head1 ENVIRONMENT VARIABLES	2001	=head1 ENVIRONMENT VARIABLES
1910		2002
1911	The following environment variables are used by this module or its	2003	AnyEvent supports a number of environment variables that tune the
1912	submodules.	2004	runtime behaviour. They are usually evaluated when AnyEvent is
		2005	loaded, initialised, or a submodule that uses them is loaded. Many of
		2006	them also cause AnyEvent to load additional modules - for example,
		2007	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2008	loaded.
1913		2009
1914	Note that AnyEvent will remove I<all> environment variables starting with	2010	All the environment variables documented here start with
1915	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2011	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1916	enabled.	2012	namespace. Other modules are encouraged (but by no means required) to use
		2013	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2014	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2015	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2016	variables starting with C<AE_>, see below).
		2017
		2018	All variables can also be set via the C<AE_> prefix, that is, instead
		2019	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2020	case there is a clash btween anyevent and another program that uses
		2021	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2022	variable to the empty string, as those variables take precedence.
		2023
		2024	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2025	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2026	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2027	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2028	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2029	is set).
		2030
		2031	The exact algorithm is currently:
		2032
		2033	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2034	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2035	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2036
		2037	This ensures that child processes will not see the C<AE_> variables.
		2038
		2039	The following environment variables are currently known to AnyEvent:
1917		2040
1918	=over 4	2041	=over 4
1919		2042
1920	=item C<PERL_ANYEVENT_VERBOSE>	2043	=item C<PERL_ANYEVENT_VERBOSE>
1921		2044
1922	By default, AnyEvent will be completely silent except in fatal	2045	By default, AnyEvent will be completely silent except in fatal
1923	conditions. You can set this environment variable to make AnyEvent more	2046	conditions. You can set this environment variable to make AnyEvent more
1924	talkative.	2047	talkative. If you want to do more than just set the global logging level
		2048	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2049	complex specifications.
1925		2050
1926	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2051	When set to C<5> or higher (warn), causes AnyEvent to warn about unexpected
1927	conditions, such as not being able to load the event model specified by	2052	conditions, such as not being able to load the event model specified by
1928	C<PERL_ANYEVENT_MODEL>.	2053	C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
		2054	is the minimum recommended level.
1929		2055
1930	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2056	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1931	model it chooses.	2057	chooses.
1932		2058
1933	When set to C<8> or higher, then AnyEvent will report extra information on	2059	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1934	which optional modules it loads and how it implements certain features.	2060	which optional modules it loads and how it implements certain features.
		2061
		2062	=item C<PERL_ANYEVENT_LOG>
		2063
		2064	Accepts rather complex logging specifications. For example, you could log
		2065	all C<debug> messages of some module to stderr, warnings and above to
		2066	stderr, and errors and above to syslog, with:
		2067
		2068	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2069
		2070	For the rather extensive details, see L<AnyEvent::Log>.
		2071
		2072	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2073	so will take effect even before AnyEvent has initialised itself.
		2074
		2075	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2076	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2077	using the latter saves a few hundred kB of memory until the first message
		2078	is being logged.
1935		2079
1936	=item C<PERL_ANYEVENT_STRICT>	2080	=item C<PERL_ANYEVENT_STRICT>
1937		2081
1938	AnyEvent does not do much argument checking by default, as thorough	2082	AnyEvent does not do much argument checking by default, as thorough
1939	argument checking is very costly. Setting this variable to a true value	2083	argument checking is very costly. Setting this variable to a true value
…		…
1946	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2090	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1947	>>, it is definitely recommended to keep it off in production. Keeping	2091	>>, it is definitely recommended to keep it off in production. Keeping
1948	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2092	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1949	can be very useful, however.	2093	can be very useful, however.
1950		2094
		2095	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2096
		2097	If this env variable is set, then its contents will be interpreted by
		2098	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2099	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2100	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2101
		2102	This happens when the first watcher is created.
		2103
		2104	For example, to bind a debug shell on a unix domain socket in
		2105	F<< /tmp/debug<pid>.sock >>, you could use this:
		2106
		2107	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2108
		2109	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2110	systems.
		2111
		2112	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2113
		2114	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2115	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2116
1951	=item C<PERL_ANYEVENT_MODEL>	2117	=item C<PERL_ANYEVENT_MODEL>
1952		2118
1953	This can be used to specify the event model to be used by AnyEvent, before	2119	This can be used to specify the event model to be used by AnyEvent, before
1954	auto detection and -probing kicks in.	2120	auto detection and -probing kicks in.
1955		2121
…		…
1987	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2153	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1988	- only support IPv4, never try to resolve or contact IPv6	2154	- only support IPv4, never try to resolve or contact IPv6
1989	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2155	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1990	IPv6, but prefer IPv6 over IPv4.	2156	IPv6, but prefer IPv6 over IPv4.
1991		2157
		2158	=item C<PERL_ANYEVENT_HOSTS>
		2159
		2160	This variable, if specified, overrides the F</etc/hosts> file used by
		2161	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2162	from that file instead.
		2163
1992	=item C<PERL_ANYEVENT_EDNS0>	2164	=item C<PERL_ANYEVENT_EDNS0>
1993		2165
1994	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2166	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1995	for DNS. This extension is generally useful to reduce DNS traffic, but	2167	DNS. This extension is generally useful to reduce DNS traffic, especially
1996	some (broken) firewalls drop such DNS packets, which is why it is off by	2168	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1997	default.	2169	packets, which is why it is off by default.
1998		2170
1999	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2171	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
2000	EDNS0 in its DNS requests.	2172	EDNS0 in its DNS requests.
2001		2173
2002	=item C<PERL_ANYEVENT_MAX_FORKS>	2174	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
2010	resolver - this is the maximum number of parallel DNS requests that are	2182	resolver - this is the maximum number of parallel DNS requests that are
2011	sent to the DNS server.	2183	sent to the DNS server.
2012		2184
2013	=item C<PERL_ANYEVENT_RESOLV_CONF>	2185	=item C<PERL_ANYEVENT_RESOLV_CONF>
2014		2186
2015	The file to use instead of F</etc/resolv.conf> (or OS-specific	2187	The absolute path to a F<resolv.conf>-style file to use instead of
2016	configuration) in the default resolver. When set to the empty string, no	2188	F</etc/resolv.conf> (or the OS-specific configuration) in the default
2017	default config will be used.	2189	resolver, or the empty string to select the default configuration.
2018		2190
2019	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2191	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
2020		2192
2021	When neither C<ca_file> nor C<ca_path> was specified during	2193	When neither C<ca_file> nor C<ca_path> was specified during
2022	L<AnyEvent::TLS> context creation, and either of these environment	2194	L<AnyEvent::TLS> context creation, and either of these environment
2023	variables exist, they will be used to specify CA certificate locations	2195	variables are nonempty, they will be used to specify CA certificate
2024	instead of a system-dependent default.	2196	locations instead of a system-dependent default.
2025		2197
2026	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2198	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2027		2199
2028	When these are set to C<1>, then the respective modules are not	2200	When these are set to C<1>, then the respective modules are not
2029	loaded. Mostly good for testing AnyEvent itself.	2201	loaded. Mostly good for testing AnyEvent itself.
…		…
2361	(even when used without AnyEvent), but most event loops have acceptable	2533	(even when used without AnyEvent), but most event loops have acceptable
2362	performance with or without AnyEvent.	2534	performance with or without AnyEvent.
2363		2535
2364	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2536	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2365	the actual event loop, only with extremely fast event loops such as EV	2537	the actual event loop, only with extremely fast event loops such as EV
2366	adds AnyEvent significant overhead.	2538	does AnyEvent add significant overhead.
2367		2539
2368	=item * You should avoid POE like the plague if you want performance or	2540	=item * You should avoid POE like the plague if you want performance or
2369	reasonable memory usage.	2541	reasonable memory usage.
2370		2542
2371	=back	2543	=back
…		…
2746		2918
2747	Tutorial/Introduction: L<AnyEvent::Intro>.	2919	Tutorial/Introduction: L<AnyEvent::Intro>.
2748		2920
2749	FAQ: L<AnyEvent::FAQ>.	2921	FAQ: L<AnyEvent::FAQ>.
2750		2922
2751	Utility functions: L<AnyEvent::Util>.	2923	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2924	(simply logging).
2752		2925
		2926	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2927	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2928
2753	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,	2929	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2754	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2930	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2931	L<Qt>, L<POE>, L<FLTK>.
2755		2932
2756	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2933	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2757	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2934	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2758	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2935	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2759	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2936	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2937	L<AnyEvent::Impl::FLTK>.
2760		2938
2761	Non-blocking file handles, sockets, TCP clients and	2939	Non-blocking handles, pipes, stream sockets, TCP clients and
2762	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2940	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2763		2941
2764	Asynchronous DNS: L<AnyEvent::DNS>.	2942	Asynchronous DNS: L<AnyEvent::DNS>.
2765		2943
2766	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	2944	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.356 by root, Fri Aug 12 18:41:25 2011 UTC vs. Revision 1.379 by root, Fri Aug 26 18:09:04 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.356 by root, Fri Aug 12 18:41:25 2011 UTC vs.
Revision 1.379 by root, Fri Aug 26 18:09:04 2011 UTC