[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.382 by root, Thu Sep 1 23:46:26 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::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
1210	our $AUTOLOAD;
1211	our @ISA;	1242	our @ISA;
1212
1213	our @REGISTRY;	1243	our @REGISTRY;
1214
1215	our $VERBOSE;	1244	our $VERBOSE;
		1245	our $MAX_SIGNAL_LATENCY = 10;
		1246	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
1216		1247
1217	BEGIN {	1248	BEGIN {
1218	require "AnyEvent/constants.pl";	1249	require "AnyEvent/constants.pl";
1219		1250
1220	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1251	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1221		1252
1222	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1253	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1223	if ${^TAINT};	1254	if ${^TAINT};
1224		1255
1225	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1256	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1257	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1226		1258
1227	}	1259	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1260	if ${^TAINT};
1228		1261
1229	our $MAX_SIGNAL_LATENCY = 10;	1262	# $ENV{PERL_ANYEVENT_xxx} now valid
1230		1263
1231	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1264	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1232		1265
1233	{
1234	my $idx;	1266	my $idx;
1235	$PROTOCOL{$_} = ++$idx	1267	$PROTOCOL{$_} = ++$idx
1236	for reverse split /\s,\s/,	1268	for reverse split /\s,\s/,
1237	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1269	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1238	}	1270	}
…		…
1267	push @POSTPONE, shift;	1299	push @POSTPONE, shift;
1268		1300
1269	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);	1301	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
1270		1302
1271	()	1303	()
		1304	}
		1305
		1306	sub log($$;@) {
		1307	# only load the big bloated module when we actually are about to log something
		1308	if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
		1309	require AnyEvent::Log;
		1310	# AnyEvent::Log overwrites this function
		1311	goto &log;
		1312	}
		1313
		1314	0 # not logged
		1315	}
		1316
		1317	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1318	require AnyEvent::Log; # AnyEvent::Log does the thing for us
1272	}	1319	}
1273		1320
1274	our @models = (	1321	our @models = (
1275	[EV:: => AnyEvent::Impl::EV:: , 1],	1322	[EV:: => AnyEvent::Impl::EV:: , 1],
1276	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],	1323	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
…		…
1289	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect	1336	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1290	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1337	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1291	[FLTK:: => AnyEvent::Impl::FLTK::],	1338	[FLTK:: => AnyEvent::Impl::FLTK::],
1292	);	1339	);
1293		1340
1294	our %method = map +($_ => 1),	1341	our @isa_hook;
		1342
		1343	sub _isa_set {
		1344	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1345
		1346	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1347	for 1 .. $#pkg;
		1348
		1349	grep $_ && $_->[1], @isa_hook
		1350	and AE::_reset ();
		1351	}
		1352
		1353	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1354	sub _isa_hook($$;$) {
		1355	my ($i, $pkg, $reset_ae) = @_;
		1356
		1357	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1358
		1359	_isa_set;
		1360	}
		1361
		1362	# all autoloaded methods reserve the complete glob, not just the method slot.
		1363	# due to bugs in perls method cache implementation.
1295	qw(io timer time now now_update signal child idle condvar DESTROY);	1364	our @methods = qw(io timer time now now_update signal child idle condvar);
1296		1365
1297	sub detect() {	1366	sub detect() {
		1367	return $MODEL if $MODEL; # some programs keep references to detect
		1368
		1369	local $!; # for good measure
		1370	local $SIG{__DIE__}; # we use eval
		1371
1298	# free some memory	1372	# free some memory
1299	*detect = sub () { $MODEL };	1373	*detect = sub () { $MODEL };
1300		1374	# undef &func doesn't correctly update the method cache. grmbl.
1301	local $!; # for good measure	1375	# so we delete the whole glob. grmbl.
1302	local $SIG{__DIE__};	1376	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1377	# a glob with an active sub. hrm. i hope it works, but perl is
		1378	# usually buggy in this department. sigh.
		1379	delete @{"AnyEvent::"}{@methods};
		1380	undef @methods;
1303		1381
1304	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {	1382	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1305	my $model = $1;	1383	my $model = $1;
1306	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;	1384	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1307	if (eval "require $model") {	1385	if (eval "require $model") {
		1386	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1308	$MODEL = $model;	1387	$MODEL = $model;
1309	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1310	} else {	1388	} else {
1311	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1389	AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1312	}	1390	}
1313	}	1391	}
1314		1392
1315	# check for already loaded models	1393	# check for already loaded models
1316	unless ($MODEL) {	1394	unless ($MODEL) {
1317	for (@REGISTRY, @models) {	1395	for (@REGISTRY, @models) {
1318	my ($package, $model) = @$_;	1396	my ($package, $model) = @$_;
1319	if (${"$package\::VERSION"} > 0) {	1397	if (${"$package\::VERSION"} > 0) {
1320	if (eval "require $model") {	1398	if (eval "require $model") {
		1399	AnyEvent::log 7 => "autodetected model '$model', using it.";
1321	$MODEL = $model;	1400	$MODEL = $model;
1322	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1323	last;	1401	last;
1324	}	1402	}
1325	}	1403	}
1326	}	1404	}
1327		1405
…		…
1333	$autoload	1411	$autoload
1334	and eval "require $package"	1412	and eval "require $package"
1335	and ${"$package\::VERSION"} > 0	1413	and ${"$package\::VERSION"} > 0
1336	and eval "require $model"	1414	and eval "require $model"
1337	) {	1415	) {
		1416	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1338	$MODEL = $model;	1417	$MODEL = $model;
1339	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1340	last;	1418	last;
1341	}	1419	}
1342	}	1420	}
1343		1421
1344	$MODEL	1422	$MODEL
1345	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1423	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1346	}	1424	}
1347	}	1425	}
1348		1426
1349	# free memory only needed for probing	1427	# free memory only needed for probing
1350	undef @models;	1428	undef @models;
1351	undef @REGISTRY;	1429	undef @REGISTRY;
1352		1430
1353	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1431	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1354	unshift @ISA, $MODEL;
1355		1432
1356	# now nuke some methods that are overridden by the backend.	1433	# now nuke some methods that are overridden by the backend.
1357	# SUPER usage is not allowed in these.	1434	# SUPER usage is not allowed in these.
1358	for (qw(time signal child idle)) {	1435	for (qw(time signal child idle)) {
1359	undef &{"AnyEvent::Base::$_"}	1436	undef &{"AnyEvent::Base::$_"}
1360	if defined &{"$MODEL\::$_"};	1437	if defined &{"$MODEL\::$_"};
1361	}	1438	}
1362		1439
		1440	_isa_set;
		1441
		1442	# we're officially open!
		1443
1363	if ($ENV{PERL_ANYEVENT_STRICT}) {	1444	if ($ENV{PERL_ANYEVENT_STRICT}) {
1364	eval { require AnyEvent::Strict };	1445	require AnyEvent::Strict;
1365	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1366	if $@ && $VERBOSE;
1367	}	1446	}
		1447
		1448	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1449	require AnyEvent::Debug;
		1450	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1451	}
		1452
		1453	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1454	require AnyEvent::Socket;
		1455	require AnyEvent::Debug;
		1456
		1457	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1458	$shell =~ s/\$\$/$$/g;
		1459
		1460	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1461	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1462	}
		1463
		1464	# now the anyevent environment is set up as the user told us to, so
		1465	# call the actual user code - post detects
1368		1466
1369	(shift @post_detect)->() while @post_detect;	1467	(shift @post_detect)->() while @post_detect;
1370	undef @post_detect;	1468	undef @post_detect;
1371		1469
1372	*post_detect = sub(&) {	1470	*post_detect = sub(&) {
1373	shift->();	1471	shift->();
1374		1472
1375	undef	1473	undef
1376	};	1474	};
1377		1475
1378	# recover a few more bytes	1476	$MODEL
1379	postpone {	1477	}
1380	undef &AUTOLOAD;	1478
		1479	for my $name (@methods) {
		1480	*$name = sub {
		1481	detect;
		1482	# we use goto because
		1483	# a) it makes the thunk more transparent
		1484	# b) it allows us to delete the thunk later
		1485	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1381	};	1486	};
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	}	1487	}
1403		1488
1404	# utility function to dup a filehandle. this is used by many backends	1489	# utility function to dup a filehandle. this is used by many backends
1405	# to support binding more than one watcher per filehandle (they usually	1490	# 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).	1491	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1430		1515
1431	package AE;	1516	package AE;
1432		1517
1433	our $VERSION = $AnyEvent::VERSION;	1518	our $VERSION = $AnyEvent::VERSION;
1434		1519
1435
1436	sub _reset() {	1520	sub _reset() {
1437	eval q{	1521	eval q{
1438	# fall back to the main API by default - backends and AnyEvent::Base	1522	# fall back to the main API by default - backends and AnyEvent::Base
1439	# implementations can overwrite these.	1523	# implementations can overwrite these.
1440		1524
…		…
1453	sub child($$) {	1537	sub child($$) {
1454	AnyEvent->child (pid => $_[0], cb => $_[1])	1538	AnyEvent->child (pid => $_[0], cb => $_[1])
1455	}	1539	}
1456		1540
1457	sub idle($) {	1541	sub idle($) {
1458	AnyEvent->idle (cb => $_[0])	1542	AnyEvent->idle (cb => $_[0]);
1459	}	1543	}
1460		1544
1461	sub cv(;&) {	1545	sub cv(;&) {
1462	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1546	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1463	}	1547	}
…		…
1473	sub time() {	1557	sub time() {
1474	AnyEvent->time	1558	AnyEvent->time
1475	}	1559	}
1476		1560
1477	*postpone = \&AnyEvent::postpone;	1561	*postpone = \&AnyEvent::postpone;
		1562	*log = \&AnyEvent::log;
1478	};	1563	};
1479	die if $@;	1564	die if $@;
1480	}	1565	}
1481		1566
1482	BEGIN { _reset }	1567	BEGIN { _reset }
…		…
1487		1572
1488	sub time {	1573	sub time {
1489	eval q{ # poor man's autoloading {}	1574	eval q{ # poor man's autoloading {}
1490	# probe for availability of Time::HiRes	1575	# probe for availability of Time::HiRes
1491	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1576	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1492	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1577	*time = sub { Time::HiRes::time () };
1493	*AE::time = \&Time::HiRes::time;	1578	*AE::time = \& Time::HiRes::time ;
		1579	*now = \&time;
		1580	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1494	# if (eval "use POSIX (); (POSIX::times())...	1581	# if (eval "use POSIX (); (POSIX::times())...
1495	} else {	1582	} else {
		1583	*time = sub { CORE::time };
		1584	*AE::time = sub (){ CORE::time };
		1585	*now = \&time;
1496	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1586	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1497	*AE::time = sub (){ time }; # epic fail
1498	}	1587	}
1499
1500	*time = sub { AE::time }; # different prototypes
1501	};	1588	};
1502	die if $@;	1589	die if $@;
1503		1590
1504	&time	1591	&time
1505	}	1592	}
1506		1593
1507	*now = \&time;	1594	*now = \&time;
1508
1509	sub now_update { }	1595	sub now_update { }
1510		1596
1511	sub _poll {	1597	sub _poll {
1512	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";	1598	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1513	}	1599	}
…		…
1599		1685
1600	sub signal {	1686	sub signal {
1601	eval q{ # poor man's autoloading {}	1687	eval q{ # poor man's autoloading {}
1602	# probe for availability of Async::Interrupt	1688	# probe for availability of Async::Interrupt
1603	if (_have_async_interrupt) {	1689	if (_have_async_interrupt) {
1604	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1690	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1605		1691
1606	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1692	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1607	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1693	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1608		1694
1609	} else {	1695	} else {
1610	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1696	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1611		1697
1612	if (AnyEvent::WIN32) {	1698	if (AnyEvent::WIN32) {
1613	require AnyEvent::Util;	1699	require AnyEvent::Util;
1614		1700
1615	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1701	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1768		1854
1769	my ($cb, $w, $rcb) = $arg{cb};	1855	my ($cb, $w, $rcb) = $arg{cb};
1770		1856
1771	$rcb = sub {	1857	$rcb = sub {
1772	if ($cb) {	1858	if ($cb) {
1773	$w = _time;	1859	$w = AE::time;
1774	&$cb;	1860	&$cb;
1775	$w = _time - $w;	1861	$w = AE::time - $w;
1776		1862
1777	# never use more then 50% of the time for the idle watcher,	1863	# never use more then 50% of the time for the idle watcher,
1778	# within some limits	1864	# within some limits
1779	$w = 0.0001 if $w < 0.0001;	1865	$w = 0.0001 if $w < 0.0001;
1780	$w = 5 if $w > 5;	1866	$w = 5 if $w > 5;
…		…
1909	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	1995	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1910	so on.	1996	so on.
1911		1997
1912	=head1 ENVIRONMENT VARIABLES	1998	=head1 ENVIRONMENT VARIABLES
1913		1999
1914	The following environment variables are used by this module or its	2000	AnyEvent supports a number of environment variables that tune the
1915	submodules.	2001	runtime behaviour. They are usually evaluated when AnyEvent is
		2002	loaded, initialised, or a submodule that uses them is loaded. Many of
		2003	them also cause AnyEvent to load additional modules - for example,
		2004	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2005	loaded.
1916		2006
1917	Note that AnyEvent will remove I<all> environment variables starting with	2007	All the environment variables documented here start with
1918	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2008	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1919	enabled.	2009	namespace. Other modules are encouraged (but by no means required) to use
		2010	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2011	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2012	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2013	variables starting with C<AE_>, see below).
		2014
		2015	All variables can also be set via the C<AE_> prefix, that is, instead
		2016	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2017	case there is a clash btween anyevent and another program that uses
		2018	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2019	variable to the empty string, as those variables take precedence.
		2020
		2021	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2022	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2023	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2024	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2025	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2026	is set).
		2027
		2028	The exact algorithm is currently:
		2029
		2030	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2031	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2032	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2033
		2034	This ensures that child processes will not see the C<AE_> variables.
		2035
		2036	The following environment variables are currently known to AnyEvent:
1920		2037
1921	=over 4	2038	=over 4
1922		2039
1923	=item C<PERL_ANYEVENT_VERBOSE>	2040	=item C<PERL_ANYEVENT_VERBOSE>
1924		2041
1925	By default, AnyEvent will be completely silent except in fatal	2042	By default, AnyEvent will only log messages with loglevel C<3>
1926	conditions. You can set this environment variable to make AnyEvent more	2043	(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
		2044	environment variable to a numerical loglevel to make AnyEvent more (or
1927	talkative.	2045	less) talkative.
1928		2046
		2047	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.
		2050
		2051	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2052	the default logging settings.
		2053
1929	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2054	When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1930	conditions, such as not being able to load the event model specified by	2055	unexpected conditions, such as not being able to load the event model
1931	C<PERL_ANYEVENT_MODEL>.	2056	specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
		2057	exception - this is the minimum recommended level.
1932		2058
1933	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2059	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1934	model it chooses.	2060	chooses.
1935		2061
1936	When set to C<8> or higher, then AnyEvent will report extra information on	2062	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1937	which optional modules it loads and how it implements certain features.	2063	which optional modules it loads and how it implements certain features.
		2064
		2065	=item C<PERL_ANYEVENT_LOG>
		2066
		2067	Accepts rather complex logging specifications. For example, you could log
		2068	all C<debug> messages of some module to stderr, warnings and above to
		2069	stderr, and errors and above to syslog, with:
		2070
		2071	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2072
		2073	For the rather extensive details, see L<AnyEvent::Log>.
		2074
		2075	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2076	so will take effect even before AnyEvent has initialised itself.
		2077
		2078	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2079	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2080	using the latter saves a few hundred kB of memory until the first message
		2081	is being logged.
1938		2082
1939	=item C<PERL_ANYEVENT_STRICT>	2083	=item C<PERL_ANYEVENT_STRICT>
1940		2084
1941	AnyEvent does not do much argument checking by default, as thorough	2085	AnyEvent does not do much argument checking by default, as thorough
1942	argument checking is very costly. Setting this variable to a true value	2086	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>	2093	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	2094	>>, it is definitely recommended to keep it off in production. Keeping
1951	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2095	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1952	can be very useful, however.	2096	can be very useful, however.
1953		2097
		2098	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2099
		2100	If this env variable is set, then its contents will be interpreted by
		2101	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2102	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2103	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2104
		2105	This happens when the first watcher is created.
		2106
		2107	For example, to bind a debug shell on a unix domain socket in
		2108	F<< /tmp/debug<pid>.sock >>, you could use this:
		2109
		2110	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2111
		2112	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2113	systems.
		2114
		2115	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2116
		2117	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2118	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2119
1954	=item C<PERL_ANYEVENT_MODEL>	2120	=item C<PERL_ANYEVENT_MODEL>
1955		2121
1956	This can be used to specify the event model to be used by AnyEvent, before	2122	This can be used to specify the event model to be used by AnyEvent, before
1957	auto detection and -probing kicks in.	2123	auto detection and -probing kicks in.
1958		2124
…		…
1990	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2156	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1991	- only support IPv4, never try to resolve or contact IPv6	2157	- only support IPv4, never try to resolve or contact IPv6
1992	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2158	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1993	IPv6, but prefer IPv6 over IPv4.	2159	IPv6, but prefer IPv6 over IPv4.
1994		2160
		2161	=item C<PERL_ANYEVENT_HOSTS>
		2162
		2163	This variable, if specified, overrides the F</etc/hosts> file used by
		2164	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2165	from that file instead.
		2166
1995	=item C<PERL_ANYEVENT_EDNS0>	2167	=item C<PERL_ANYEVENT_EDNS0>
1996		2168
1997	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2169	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	2170	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	2171	when DNSSEC is involved, but some (broken) firewalls drop such DNS
2000	default.	2172	packets, which is why it is off by default.
2001		2173
2002	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2174	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
2003	EDNS0 in its DNS requests.	2175	EDNS0 in its DNS requests.
2004		2176
2005	=item C<PERL_ANYEVENT_MAX_FORKS>	2177	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
2013	resolver - this is the maximum number of parallel DNS requests that are	2185	resolver - this is the maximum number of parallel DNS requests that are
2014	sent to the DNS server.	2186	sent to the DNS server.
2015		2187
2016	=item C<PERL_ANYEVENT_RESOLV_CONF>	2188	=item C<PERL_ANYEVENT_RESOLV_CONF>
2017		2189
2018	The file to use instead of F</etc/resolv.conf> (or OS-specific	2190	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	2191	F</etc/resolv.conf> (or the OS-specific configuration) in the default
2020	default config will be used.	2192	resolver, or the empty string to select the default configuration.
2021		2193
2022	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2194	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
2023		2195
2024	When neither C<ca_file> nor C<ca_path> was specified during	2196	When neither C<ca_file> nor C<ca_path> was specified during
2025	L<AnyEvent::TLS> context creation, and either of these environment	2197	L<AnyEvent::TLS> context creation, and either of these environment
2026	variables exist, they will be used to specify CA certificate locations	2198	variables are nonempty, they will be used to specify CA certificate
2027	instead of a system-dependent default.	2199	locations instead of a system-dependent default.
2028		2200
2029	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2201	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2030		2202
2031	When these are set to C<1>, then the respective modules are not	2203	When these are set to C<1>, then the respective modules are not
2032	loaded. Mostly good for testing AnyEvent itself.	2204	loaded. Mostly good for testing AnyEvent itself.
…		…
2364	(even when used without AnyEvent), but most event loops have acceptable	2536	(even when used without AnyEvent), but most event loops have acceptable
2365	performance with or without AnyEvent.	2537	performance with or without AnyEvent.
2366		2538
2367	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2539	=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	2540	the actual event loop, only with extremely fast event loops such as EV
2369	adds AnyEvent significant overhead.	2541	does AnyEvent add significant overhead.
2370		2542
2371	=item * You should avoid POE like the plague if you want performance or	2543	=item * You should avoid POE like the plague if you want performance or
2372	reasonable memory usage.	2544	reasonable memory usage.
2373		2545
2374	=back	2546	=back
…		…
2749		2921
2750	Tutorial/Introduction: L<AnyEvent::Intro>.	2922	Tutorial/Introduction: L<AnyEvent::Intro>.
2751		2923
2752	FAQ: L<AnyEvent::FAQ>.	2924	FAQ: L<AnyEvent::FAQ>.
2753		2925
2754	Utility functions: L<AnyEvent::Util>.	2926	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2927	(simply logging).
2755		2928
		2929	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2930	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2931
2756	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,	2932	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>.	2933	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2934	L<Qt>, L<POE>, L<FLTK>.
2758		2935
2759	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2936	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2760	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2937	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2761	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2938	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2762	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2939	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2940	L<AnyEvent::Impl::FLTK>.
2763		2941
2764	Non-blocking file handles, sockets, TCP clients and	2942	Non-blocking handles, pipes, stream sockets, TCP clients and
2765	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2943	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2766		2944
2767	Asynchronous DNS: L<AnyEvent::DNS>.	2945	Asynchronous DNS: L<AnyEvent::DNS>.
2768		2946
2769	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	2947	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.382 by root, Thu Sep 1 23:46:26 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.382 by root, Thu Sep 1 23:46:26 2011 UTC