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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.354 by root, Thu Aug 11 21:26:39 2011 UTC vs.
Revision 1.371 by root, Wed Aug 24 23:59:10 2011 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.354 by root, Thu Aug 11 21:26:39 2011 UTC vs. Revision 1.371 by root, Wed Aug 24 23:59:10 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.354 by root, Thu Aug 11 21:26:39 2011 UTC vs.
Revision 1.371 by root, Wed Aug 24 23:59:10 2011 UTC