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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.350 by root, Tue Aug 2 20:02:44 2011 UTC vs.
Revision 1.386 by root, Mon Sep 26 11:32:19 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
121	The interface itself is vaguely similar, but not identical to the L<Event>	121	The interface itself is vaguely similar, but not identical to the L<Event>
122	module.	122	module.
123		123
124	During the first call of any watcher-creation method, the module tries	124	During the first call of any watcher-creation method, the module tries
125	to detect the currently loaded event loop by probing whether one of the	125	to detect the currently loaded event loop by probing whether one of the
126	following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one	127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
128	found is used. If none are detected, the module tries to load the first	128	found is used. If none are detected, the module tries to load the first
129	four modules in the order given; but note that if L<EV> is not	129	four modules in the order given; but note that if L<EV> is not
130	available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
131	the other two are not normally tried.	131	the other two are not normally tried.
132		132
133	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
134	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
135	that model the default. For example:	135	that model the default. For example:
…		…
142	The I<likely> means that, if any module loads another event model and	142	The I<likely> means that, if any module loads another event model and
143	starts using it, all bets are off - this case should be very rare though,	143	starts using it, all bets are off - this case should be very rare though,
144	as very few modules hardcode event loops without announcing this very	144	as very few modules hardcode event loops without announcing this very
145	loudly.	145	loudly.
146		146
147	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	other event modules you can load it explicitly and enjoy the high
149	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
150		150
151	=head1 WATCHERS	151	=head1 WATCHERS
152		152
153	AnyEvent has the central concept of a I<watcher>, which is an object that	153	AnyEvent has the central concept of a I<watcher>, which is an object that
154	stores relevant data for each kind of event you are waiting for, such as	154	stores relevant data for each kind of event you are waiting for, such as
…		…
356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
357	account.	357	account.
358		358
359	=item AnyEvent->now_update	359	=item AnyEvent->now_update
360		360
361	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache	361	Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362	the current time for each loop iteration (see the discussion of L<<	362	time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363	AnyEvent->now >>, above).	363	above).
364		364
365	When a callback runs for a long time (or when the process sleeps), then	365	When a callback runs for a long time (or when the process sleeps), then
366	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
367	might affect timers and time-outs.	367	might affect timers and time-outs.
368		368
…		…
482	thing in an AnyEvent program, you I<have> to create at least one	482	thing in an AnyEvent program, you I<have> to create at least one
483	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
484	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
485		485
486	As most event loops do not support waiting for child events, they will be	486	As most event loops do not support waiting for child events, they will be
487	emulated by AnyEvent in most cases, in which the latency and race problems	487	emulated by AnyEvent in most cases, in which case the latency and race
488	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
489		489
490	Example: fork a process and wait for it	490	Example: fork a process and wait for it
491		491
492	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
493		493
…		…
860	use. If EV is not installed, then AnyEvent will fall back to its own	860	use. If EV is not installed, then AnyEvent will fall back to its own
861	pure-perl implementation, which is available everywhere as it comes with	861	pure-perl implementation, which is available everywhere as it comes with
862	AnyEvent itself.	862	AnyEvent itself.
863		863
864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866		866
867	=item Backends that are transparently being picked up when they are used.	867	=item Backends that are transparently being picked up when they are used.
868		868
869	These will be used if they are already loaded when the first watcher	869	These will be used if they are already loaded when the first watcher
870	is created, in which case it is assumed that the application is using	870	is created, in which case it is assumed that the application is using
…		…
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 }
…		…
1005	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1006	# as soon as it is	1010	# as soon as it is
1007	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1008	}	1012	}
1009		1013
		1014	=item AnyEvent::postpone { BLOCK }
		1015
		1016	Arranges for the block to be executed as soon as possible, but not before
		1017	the call itself returns. In practise, the block will be executed just
		1018	before the event loop polls for new events, or shortly afterwards.
		1019
		1020	This function never returns anything (to make the C<return postpone { ...
		1021	}> idiom more useful.
		1022
		1023	To understand the usefulness of this function, consider a function that
		1024	asynchronously does something for you and returns some transaction
		1025	object or guard to let you cancel the operation. For example,
		1026	C<AnyEvent::Socket::tcp_connect>:
		1027
		1028	# start a conenction attempt unless one is active
		1029	$self->{connect_guard} \|\|= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1030	delete $self->{connect_guard};
		1031	...
		1032	};
		1033
		1034	Imagine that this function could instantly call the callback, for
		1035	example, because it detects an obvious error such as a negative port
		1036	number. Invoking the callback before the function returns causes problems
		1037	however: the callback will be called and will try to delete the guard
		1038	object. But since the function hasn't returned yet, there is nothing to
		1039	delete. When the function eventually returns it will assign the guard
		1040	object to C<< $self->{connect_guard} >>, where it will likely never be
		1041	deleted, so the program thinks it is still trying to connect.
		1042
		1043	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1044	callback directly on error:
		1045
		1046	$cb->(undef), return # signal error to callback, BAD!
		1047	if $some_error_condition;
		1048
		1049	It should use C<postpone>:
		1050
		1051	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1052	if $some_error_condition;
		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
1010	=back	1072	=back
1011		1073
1012	=head1 WHAT TO DO IN A MODULE	1074	=head1 WHAT TO DO IN A MODULE
1013		1075
1014	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
…		…
1047	modules might create watchers when they are loaded, and AnyEvent will	1109	modules might create watchers when they are loaded, and AnyEvent will
1048	decide on the event model to use as soon as it creates watchers, and it	1110	decide on the event model to use as soon as it creates watchers, and it
1049	might choose the wrong one unless you load the correct one yourself.	1111	might choose the wrong one unless you load the correct one yourself.
1050		1112
1051	You can chose to use a pure-perl implementation by loading the	1113	You can chose to use a pure-perl implementation by loading the
1052	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1114	C<AnyEvent::Loop> module, which gives you similar behaviour
1053	everywhere, but letting AnyEvent chose the model is generally better.	1115	everywhere, but letting AnyEvent chose the model is generally better.
1054		1116
1055	=head2 MAINLOOP EMULATION	1117	=head2 MAINLOOP EMULATION
1056		1118
1057	Sometimes (often for short test scripts, or even standalone programs who	1119	Sometimes (often for short test scripts, or even standalone programs who
…		…
1070		1132
1071		1133
1072	=head1 OTHER MODULES	1134	=head1 OTHER MODULES
1073		1135
1074	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
1075	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
1076	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
1077	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 :)
1078		1143
1079	=over 4	1144	=over 4
1080		1145
1081	=item L<AnyEvent::Util>	1146	=item L<AnyEvent::Util>
1082		1147
…		…
1102	=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>
1103		1168
1104	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
1105	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
1106	Client Protocol).	1171	Client Protocol).
1107
1108	=item L<AnyEvent::Handle::UDP>
1109
1110	Here be danger!
1111
1112	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1113	there are so many things wrong with AnyEvent::Handle::UDP, most notably
1114	its use of a stream-based API with a protocol that isn't streamable, that
1115	the only way to improve it is to delete it.
1116
1117	It features data corruption (but typically only under load) and general
1118	confusion. On top, the author is not only clueless about UDP but also
1119	fact-resistant - some gems of his understanding: "connect doesn't work
1120	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1121	packets", "I don't need to implement proper error checking as UDP doesn't
1122	support error checking" and so on - he doesn't even understand what's
1123	wrong with his module when it is explained to him.
1124
1125	=item L<AnyEvent::DBI>
1126
1127	Executes L<DBI> requests asynchronously in a proxy process for you,
1128	notifying you in an event-based way when the operation is finished.
1129		1172
1130	=item L<AnyEvent::AIO>	1173	=item L<AnyEvent::AIO>
1131		1174
1132	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
1133	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1176	toolbox of every event programmer. AnyEvent::AIO transparently fuses
1134	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
1135	file I/O, and much more.	1178	file I/O, and much more.
1136		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
1137	=item L<AnyEvent::HTTPD>	1198	=item L<AnyEvent::HTTPD>
1138		1199
1139	A simple embedded webserver.	1200	A simple embedded webserver.
1140		1201
1141	=item L<AnyEvent::FastPing>	1202	=item L<AnyEvent::FastPing>
1142		1203
1143	The fastest ping in the west.	1204	The fastest ping in the west.
1144		1205
1145	=item L<Coro>	1206	=item L<Coro>
1146		1207
1147	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	};
1148		1221
1149	=back	1222	=back
1150		1223
1151	=cut	1224	=cut
1152		1225
…		…
1162		1235
1163	BEGIN { AnyEvent::common_sense }	1236	BEGIN { AnyEvent::common_sense }
1164		1237
1165	use Carp ();	1238	use Carp ();
1166		1239
1167	our $VERSION = '5.34';	1240	our $VERSION = '6.02';
1168	our $MODEL;	1241	our $MODEL;
1169
1170	our $AUTOLOAD;
1171	our @ISA;	1242	our @ISA;
1172
1173	our @REGISTRY;	1243	our @REGISTRY;
1174
1175	our $VERBOSE;	1244	our $VERBOSE;
		1245	our $MAX_SIGNAL_LATENCY = 10;
		1246	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
1176		1247
1177	BEGIN {	1248	BEGIN {
1178	require "AnyEvent/constants.pl";	1249	require "AnyEvent/constants.pl";
1179		1250
1180	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1251	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1181		1252
1182	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1253	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1183	if ${^TAINT};	1254	if ${^TAINT};
1184		1255
1185	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1256	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1257	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1186		1258
1187	}	1259	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1260	if ${^TAINT};
1188		1261
1189	our $MAX_SIGNAL_LATENCY = 10;	1262	# $ENV{PERL_ANYEVENT_xxx} now valid
1190		1263
1191	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1264	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1192		1265
1193	{
1194	my $idx;	1266	my $idx;
1195	$PROTOCOL{$_} = ++$idx	1267	$PROTOCOL{$_} = ++$idx
1196	for reverse split /\s,\s/,	1268	for reverse split /\s,\s/,
1197	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1269	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1198	}	1270	}
1199		1271
		1272	our @post_detect;
		1273
		1274	sub post_detect(&) {
		1275	my ($cb) = @_;
		1276
		1277	push @post_detect, $cb;
		1278
		1279	defined wantarray
		1280	? bless \$cb, "AnyEvent::Util::postdetect"
		1281	: ()
		1282	}
		1283
		1284	sub AnyEvent::Util::postdetect::DESTROY {
		1285	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1286	}
		1287
		1288	our $POSTPONE_W;
		1289	our @POSTPONE;
		1290
		1291	sub _postpone_exec {
		1292	undef $POSTPONE_W;
		1293
		1294	&{ shift @POSTPONE }
		1295	while @POSTPONE;
		1296	}
		1297
		1298	sub postpone(&) {
		1299	push @POSTPONE, shift;
		1300
		1301	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1302
		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 \|\| 1)) { # also catches non-numeric levels(!) and fatal
		1309	require AnyEvent::Log; # among other things, sets $VERBOSE to 9
		1310	# AnyEvent::Log overwrites this function
		1311	goto &log;
		1312	}
		1313
		1314	0 # not logged
		1315	}
		1316
		1317	sub logger($;$) {
		1318	package AnyEvent::Log;
		1319
		1320	my ($level, $renabled) = @_;
		1321
		1322	$$renabled = $level <= $VERBOSE;
		1323
		1324	my $pkg = (caller)[0];
		1325
		1326	my $logger = [$pkg, $level, $renabled];
		1327
		1328	our %LOGGER;
		1329	$LOGGER{$logger+0} = $logger;
		1330
		1331	require AnyEvent::Util;
		1332	my $guard = AnyEvent::Util::guard (sub {
		1333	# "clean up"
		1334	delete $LOGGER{$logger+0};
		1335	});
		1336
		1337	sub {
		1338	return 0 unless $$renabled;
		1339
		1340	$guard if 0; # keep guard alive, but don't cause runtime overhead
		1341	require AnyEvent::Log unless $AnyEvent::Log::VERSION;
		1342	package AnyEvent::Log;
		1343	_log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
		1344	}
		1345	}
		1346
		1347	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1348	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1349	}
		1350
1200	my @models = (	1351	our @models = (
1201	[EV:: => AnyEvent::Impl::EV:: , 1],	1352	[EV:: => AnyEvent::Impl::EV::],
1202	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1353	[AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1203	# everything below here will not (normally) be autoprobed	1354	# everything below here will not (normally) be autoprobed
1204	# as the pureperl backend should work everywhere	1355	# as the pure perl backend should work everywhere
1205	# and is usually faster	1356	# and is usually faster
		1357	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1206	[Event:: => AnyEvent::Impl::Event::, 1],	1358	[Event:: => AnyEvent::Impl::Event::], # slow, stable
1207	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1359	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
		1360	# everything below here should not be autoloaded
1208	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1361	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1209	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1210	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1362	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1211	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1363	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1212	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1364	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1213	[Wx:: => AnyEvent::Impl::POE::],	1365	[Wx:: => AnyEvent::Impl::POE::],
1214	[Prima:: => AnyEvent::Impl::POE::],	1366	[Prima:: => AnyEvent::Impl::POE::],
1215	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1367	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1216	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1368	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1217	[FLTK:: => AnyEvent::Impl::FLTK::],	1369	[FLTK:: => AnyEvent::Impl::FLTK::],
1218	);	1370	);
1219		1371
1220	our %method = map +($_ => 1),	1372	our @isa_hook;
		1373
		1374	sub _isa_set {
		1375	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1376
		1377	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1378	for 1 .. $#pkg;
		1379
		1380	grep $_ && $_->[1], @isa_hook
		1381	and AE::_reset ();
		1382	}
		1383
		1384	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1385	sub _isa_hook($$;$) {
		1386	my ($i, $pkg, $reset_ae) = @_;
		1387
		1388	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1389
		1390	_isa_set;
		1391	}
		1392
		1393	# all autoloaded methods reserve the complete glob, not just the method slot.
		1394	# due to bugs in perls method cache implementation.
1221	qw(io timer time now now_update signal child idle condvar DESTROY);	1395	our @methods = qw(io timer time now now_update signal child idle condvar);
1222
1223	our @post_detect;
1224
1225	sub post_detect(&) {
1226	my ($cb) = @_;
1227
1228	push @post_detect, $cb;
1229
1230	defined wantarray
1231	? bless \$cb, "AnyEvent::Util::postdetect"
1232	: ()
1233	}
1234
1235	sub AnyEvent::Util::postdetect::DESTROY {
1236	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1237	}
1238		1396
1239	sub detect() {	1397	sub detect() {
		1398	return $MODEL if $MODEL; # some programs keep references to detect
		1399
		1400	# IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
		1401	# the author knows about the problems and what it does to AnyEvent as a whole
		1402	# (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
		1403	# anyway.
		1404	AnyEvent::log fatal => "AnyEvent: IO::Async::Loop::AnyEvent detected - this module is broken by design,\n"
		1405	. "abuses internals and breaks AnyEvent, will not continue."
		1406	if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
		1407
		1408	local $!; # for good measure
		1409	local $SIG{__DIE__}; # we use eval
		1410
1240	# free some memory	1411	# free some memory
1241	*detect = sub () { $MODEL };	1412	*detect = sub () { $MODEL };
		1413	# undef &func doesn't correctly update the method cache. grmbl.
		1414	# so we delete the whole glob. grmbl.
		1415	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1416	# a glob with an active sub. hrm. i hope it works, but perl is
		1417	# usually buggy in this department. sigh.
		1418	delete @{"AnyEvent::"}{@methods};
		1419	undef @methods;
1242		1420
1243	local $!; # for good measure
1244	local $SIG{__DIE__};
1245
1246	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1421	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1247	my $model = "AnyEvent::Impl::$1";	1422	my $model = $1;
		1423	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1248	if (eval "require $model") {	1424	if (eval "require $model") {
		1425	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1249	$MODEL = $model;	1426	$MODEL = $model;
1250	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1251	} else {	1427	} else {
1252	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1428	AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1253	}	1429	}
1254	}	1430	}
1255		1431
1256	# check for already loaded models	1432	# check for already loaded models
1257	unless ($MODEL) {	1433	unless ($MODEL) {
1258	for (@REGISTRY, @models) {	1434	for (@REGISTRY, @models) {
1259	my ($package, $model) = @$_;	1435	my ($package, $model) = @$_;
1260	if (${"$package\::VERSION"} > 0) {	1436	if (${"$package\::VERSION"} > 0) {
1261	if (eval "require $model") {	1437	if (eval "require $model") {
		1438	AnyEvent::log 7 => "autodetected model '$model', using it.";
1262	$MODEL = $model;	1439	$MODEL = $model;
1263	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1264	last;	1440	last;
1265	}	1441	}
1266	}	1442	}
1267	}	1443	}
1268		1444
1269	unless ($MODEL) {	1445	unless ($MODEL) {
1270	# try to autoload a model	1446	# try to autoload a model
1271	for (@REGISTRY, @models) {	1447	for (@REGISTRY, @models) {
1272	my ($package, $model, $autoload) = @$_;	1448	my ($package, $model) = @$_;
1273	if (	1449	if (
1274	$autoload
1275	and eval "require $package"	1450	eval "require $package"
1276	and ${"$package\::VERSION"} > 0	1451	and ${"$package\::VERSION"} > 0
1277	and eval "require $model"	1452	and eval "require $model"
1278	) {	1453	) {
		1454	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1279	$MODEL = $model;	1455	$MODEL = $model;
1280	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1281	last;	1456	last;
1282	}	1457	}
1283	}	1458	}
1284		1459
1285	$MODEL	1460	$MODEL
1286	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1461	or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1287	}	1462	}
1288	}	1463	}
1289		1464
1290	@models = (); # free probe data	1465	# free memory only needed for probing
		1466	undef @models;
		1467	undef @REGISTRY;
1291		1468
1292	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1469	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293	unshift @ISA, $MODEL;
1294		1470
1295	# now nuke some methods that are overridden by the backend.	1471	# now nuke some methods that are overridden by the backend.
1296	# SUPER is not allowed.	1472	# SUPER usage is not allowed in these.
1297	for (qw(time signal child idle)) {	1473	for (qw(time signal child idle)) {
1298	undef &{"AnyEvent::Base::$_"}	1474	undef &{"AnyEvent::Base::$_"}
1299	if defined &{"$MODEL\::$_"};	1475	if defined &{"$MODEL\::$_"};
1300	}	1476	}
1301		1477
		1478	_isa_set;
		1479
		1480	# we're officially open!
		1481
1302	if ($ENV{PERL_ANYEVENT_STRICT}) {	1482	if ($ENV{PERL_ANYEVENT_STRICT}) {
1303	eval { require AnyEvent::Strict };	1483	require AnyEvent::Strict;
1304	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305	if $@ && $VERBOSE;
1306	}	1484	}
1307		1485
		1486	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1487	require AnyEvent::Debug;
		1488	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1489	}
		1490
		1491	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1492	require AnyEvent::Socket;
		1493	require AnyEvent::Debug;
		1494
		1495	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1496	$shell =~ s/\$\$/$$/g;
		1497
		1498	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1499	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1500	}
		1501
		1502	# now the anyevent environment is set up as the user told us to, so
		1503	# call the actual user code - post detects
		1504
1308	(shift @post_detect)->() while @post_detect;	1505	(shift @post_detect)->() while @post_detect;
		1506	undef @post_detect;
1309		1507
1310	*post_detect = sub(&) {	1508	*post_detect = sub(&) {
1311	shift->();	1509	shift->();
1312		1510
1313	undef	1511	undef
1314	};	1512	};
1315		1513
1316	$MODEL	1514	$MODEL
1317	}	1515	}
1318		1516
1319	sub AUTOLOAD {	1517	for my $name (@methods) {
1320	(my $func = $AUTOLOAD) =~ s/.*://;	1518	*$name = sub {
1321
1322	$method{$func}
1323	or Carp::croak "$func: not a valid AnyEvent class method";
1324
1325	detect;	1519	detect;
1326		1520	# we use goto because
1327	my $class = shift;	1521	# a) it makes the thunk more transparent
1328	$class->$func (@_);	1522	# b) it allows us to delete the thunk later
		1523	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1524	};
1329	}	1525	}
1330		1526
1331	# utility function to dup a filehandle. this is used by many backends	1527	# utility function to dup a filehandle. this is used by many backends
1332	# to support binding more than one watcher per filehandle (they usually	1528	# to support binding more than one watcher per filehandle (they usually
1333	# allow only one watcher per fd, so we dup it to get a different one).	1529	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1357		1553
1358	package AE;	1554	package AE;
1359		1555
1360	our $VERSION = $AnyEvent::VERSION;	1556	our $VERSION = $AnyEvent::VERSION;
1361		1557
		1558	sub _reset() {
		1559	eval q{
1362	# fall back to the main API by default - backends and AnyEvent::Base	1560	# fall back to the main API by default - backends and AnyEvent::Base
1363	# implementations can overwrite these.	1561	# implementations can overwrite these.
1364		1562
1365	sub io($$$) {	1563	sub io($$$) {
1366	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1564	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1367	}	1565	}
1368		1566
1369	sub timer($$$) {	1567	sub timer($$$) {
1370	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1568	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1371	}	1569	}
1372		1570
1373	sub signal($$) {	1571	sub signal($$) {
1374	AnyEvent->signal (signal => $_[0], cb => $_[1])	1572	AnyEvent->signal (signal => $_[0], cb => $_[1])
1375	}	1573	}
1376		1574
1377	sub child($$) {	1575	sub child($$) {
1378	AnyEvent->child (pid => $_[0], cb => $_[1])	1576	AnyEvent->child (pid => $_[0], cb => $_[1])
1379	}	1577	}
1380		1578
1381	sub idle($) {	1579	sub idle($) {
1382	AnyEvent->idle (cb => $_[0])	1580	AnyEvent->idle (cb => $_[0]);
1383	}	1581	}
1384		1582
1385	sub cv(;&) {	1583	sub cv(;&) {
1386	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1584	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1387	}	1585	}
1388		1586
1389	sub now() {	1587	sub now() {
1390	AnyEvent->now	1588	AnyEvent->now
1391	}	1589	}
1392		1590
1393	sub now_update() {	1591	sub now_update() {
1394	AnyEvent->now_update	1592	AnyEvent->now_update
1395	}	1593	}
1396		1594
1397	sub time() {	1595	sub time() {
1398	AnyEvent->time	1596	AnyEvent->time
		1597	}
		1598
		1599	*postpone = \&AnyEvent::postpone;
		1600	*log = \&AnyEvent::log;
		1601	};
		1602	die if $@;
1399	}	1603	}
		1604
		1605	BEGIN { _reset }
1400		1606
1401	package AnyEvent::Base;	1607	package AnyEvent::Base;
1402		1608
1403	# default implementations for many methods	1609	# default implementations for many methods
1404		1610
1405	sub time {	1611	sub time {
1406	eval q{ # poor man's autoloading {}	1612	eval q{ # poor man's autoloading {}
1407	# probe for availability of Time::HiRes	1613	# probe for availability of Time::HiRes
1408	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1614	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1409	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1615	*time = sub { Time::HiRes::time () };
1410	*AE::time = \&Time::HiRes::time;	1616	*AE::time = \& Time::HiRes::time ;
		1617	*now = \&time;
		1618	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1411	# if (eval "use POSIX (); (POSIX::times())...	1619	# if (eval "use POSIX (); (POSIX::times())...
1412	} else {	1620	} else {
		1621	*time = sub { CORE::time };
		1622	*AE::time = sub (){ CORE::time };
		1623	*now = \&time;
1413	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1624	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1414	*AE::time = sub (){ time }; # epic fail
1415	}	1625	}
1416
1417	*time = sub { AE::time }; # different prototypes
1418	};	1626	};
1419	die if $@;	1627	die if $@;
1420		1628
1421	&time	1629	&time
1422	}	1630	}
1423		1631
1424	*now = \&time;	1632	*now = \&time;
1425
1426	sub now_update { }	1633	sub now_update { }
1427		1634
		1635	sub _poll {
		1636	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1637	}
		1638
1428	# default implementation for ->condvar	1639	# default implementation for ->condvar
		1640	# in fact, the default should not be overwritten
1429		1641
1430	sub condvar {	1642	sub condvar {
1431	eval q{ # poor man's autoloading {}	1643	eval q{ # poor man's autoloading {}
1432	*condvar = sub {	1644	*condvar = sub {
1433	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1645	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1511		1723
1512	sub signal {	1724	sub signal {
1513	eval q{ # poor man's autoloading {}	1725	eval q{ # poor man's autoloading {}
1514	# probe for availability of Async::Interrupt	1726	# probe for availability of Async::Interrupt
1515	if (_have_async_interrupt) {	1727	if (_have_async_interrupt) {
1516	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1728	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1517		1729
1518	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1730	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1519	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1731	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1520		1732
1521	} else {	1733	} else {
1522	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1734	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1523		1735
1524	if (AnyEvent::WIN32) {	1736	if (AnyEvent::WIN32) {
1525	require AnyEvent::Util;	1737	require AnyEvent::Util;
1526		1738
1527	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1739	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1603	: sysread $SIGPIPE_R, (my $dummy), 9;	1815	: sysread $SIGPIPE_R, (my $dummy), 9;
1604		1816
1605	while (%SIG_EV) {	1817	while (%SIG_EV) {
1606	for (keys %SIG_EV) {	1818	for (keys %SIG_EV) {
1607	delete $SIG_EV{$_};	1819	delete $SIG_EV{$_};
1608	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1820	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1609	}	1821	}
1610	}	1822	}
1611	};	1823	};
1612	};	1824	};
1613	die if $@;	1825	die if $@;
…		…
1640	};	1852	};
1641		1853
1642	*child = sub {	1854	*child = sub {
1643	my (undef, %arg) = @_;	1855	my (undef, %arg) = @_;
1644		1856
1645	defined (my $pid = $arg{pid} + 0)	1857	my $pid = $arg{pid};
1646	or Carp::croak "required option 'pid' is missing";	1858	my $cb = $arg{cb};
1647		1859
1648	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1860	$PID_CB{$pid}{$cb+0} = $cb;
1649		1861
1650	unless ($CHLD_W) {	1862	unless ($CHLD_W) {
1651	$CHLD_W = AE::signal CHLD => \&_sigchld;	1863	$CHLD_W = AE::signal CHLD => \&_sigchld;
1652	# child could be a zombie already, so make at least one round	1864	# child could be a zombie already, so make at least one round
1653	&_sigchld;	1865	&_sigchld;
1654	}	1866	}
1655		1867
1656	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1868	bless [$pid, $cb+0], "AnyEvent::Base::child"
1657	};	1869	};
1658		1870
1659	*AnyEvent::Base::child::DESTROY = sub {	1871	*AnyEvent::Base::child::DESTROY = sub {
1660	my ($pid, $cb) = @{$_[0]};	1872	my ($pid, $icb) = @{$_[0]};
1661		1873
1662	delete $PID_CB{$pid}{$cb};	1874	delete $PID_CB{$pid}{$icb};
1663	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1875	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1664		1876
1665	undef $CHLD_W unless keys %PID_CB;	1877	undef $CHLD_W unless keys %PID_CB;
1666	};	1878	};
1667	};	1879	};
…		…
1680		1892
1681	my ($cb, $w, $rcb) = $arg{cb};	1893	my ($cb, $w, $rcb) = $arg{cb};
1682		1894
1683	$rcb = sub {	1895	$rcb = sub {
1684	if ($cb) {	1896	if ($cb) {
1685	$w = _time;	1897	$w = AE::time;
1686	&$cb;	1898	&$cb;
1687	$w = _time - $w;	1899	$w = AE::time - $w;
1688		1900
1689	# never use more then 50% of the time for the idle watcher,	1901	# never use more then 50% of the time for the idle watcher,
1690	# within some limits	1902	# within some limits
1691	$w = 0.0001 if $w < 0.0001;	1903	$w = 0.0001 if $w < 0.0001;
1692	$w = 5 if $w > 5;	1904	$w = 5 if $w > 5;
…		…
1740	sub _send {	1952	sub _send {
1741	# nop	1953	# nop
1742	}	1954	}
1743		1955
1744	sub _wait {	1956	sub _wait {
1745	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";	1957	AnyEvent->_poll until $_[0]{_ae_sent};
1746	}	1958	}
1747		1959
1748	sub send {	1960	sub send {
1749	my $cv = shift;	1961	my $cv = shift;
1750	$cv->{_ae_sent} = [@_];	1962	$cv->{_ae_sent} = [@_];
…		…
1762	}	1974	}
1763		1975
1764	sub recv {	1976	sub recv {
1765	unless ($_[0]{_ae_sent}) {	1977	unless ($_[0]{_ae_sent}) {
1766	$WAITING	1978	$WAITING
1767	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";	1979	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1768		1980
1769	local $WAITING = 1;	1981	local $WAITING = 1;
1770	$_[0]->_wait;	1982	$_[0]->_wait;
1771	}	1983	}
1772		1984
…		…
1821	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2033	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1822	so on.	2034	so on.
1823		2035
1824	=head1 ENVIRONMENT VARIABLES	2036	=head1 ENVIRONMENT VARIABLES
1825		2037
1826	The following environment variables are used by this module or its	2038	AnyEvent supports a number of environment variables that tune the
1827	submodules.	2039	runtime behaviour. They are usually evaluated when AnyEvent is
		2040	loaded, initialised, or a submodule that uses them is loaded. Many of
		2041	them also cause AnyEvent to load additional modules - for example,
		2042	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2043	loaded.
1828		2044
1829	Note that AnyEvent will remove I<all> environment variables starting with	2045	All the environment variables documented here start with
1830	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2046	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1831	enabled.	2047	namespace. Other modules are encouraged (but by no means required) to use
		2048	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2049	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2050	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2051	variables starting with C<AE_>, see below).
		2052
		2053	All variables can also be set via the C<AE_> prefix, that is, instead
		2054	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2055	case there is a clash btween anyevent and another program that uses
		2056	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2057	variable to the empty string, as those variables take precedence.
		2058
		2059	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2060	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2061	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2062	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2063	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2064	is set).
		2065
		2066	The exact algorithm is currently:
		2067
		2068	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2069	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2070	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2071
		2072	This ensures that child processes will not see the C<AE_> variables.
		2073
		2074	The following environment variables are currently known to AnyEvent:
1832		2075
1833	=over 4	2076	=over 4
1834		2077
1835	=item C<PERL_ANYEVENT_VERBOSE>	2078	=item C<PERL_ANYEVENT_VERBOSE>
1836		2079
1837	By default, AnyEvent will be completely silent except in fatal	2080	By default, AnyEvent will only log messages with loglevel C<3>
1838	conditions. You can set this environment variable to make AnyEvent more	2081	(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
		2082	environment variable to a numerical loglevel to make AnyEvent more (or
1839	talkative.	2083	less) talkative.
1840		2084
		2085	If you want to do more than just set the global logging level
		2086	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2087	complex specifications.
		2088
		2089	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2090	the default logging settings.
		2091
1841	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2092	When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1842	conditions, such as not being able to load the event model specified by	2093	unexpected conditions, such as not being able to load the event model
1843	C<PERL_ANYEVENT_MODEL>.	2094	specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
		2095	exception - this is the minimum recommended level.
1844		2096
1845	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2097	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1846	model it chooses.	2098	chooses.
1847		2099
1848	When set to C<8> or higher, then AnyEvent will report extra information on	2100	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1849	which optional modules it loads and how it implements certain features.	2101	which optional modules it loads and how it implements certain features.
		2102
		2103	=item C<PERL_ANYEVENT_LOG>
		2104
		2105	Accepts rather complex logging specifications. For example, you could log
		2106	all C<debug> messages of some module to stderr, warnings and above to
		2107	stderr, and errors and above to syslog, with:
		2108
		2109	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2110
		2111	For the rather extensive details, see L<AnyEvent::Log>.
		2112
		2113	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2114	so will take effect even before AnyEvent has initialised itself.
		2115
		2116	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2117	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2118	using the latter saves a few hundred kB of memory until the first message
		2119	is being logged.
1850		2120
1851	=item C<PERL_ANYEVENT_STRICT>	2121	=item C<PERL_ANYEVENT_STRICT>
1852		2122
1853	AnyEvent does not do much argument checking by default, as thorough	2123	AnyEvent does not do much argument checking by default, as thorough
1854	argument checking is very costly. Setting this variable to a true value	2124	argument checking is very costly. Setting this variable to a true value
…		…
1861	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2131	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1862	>>, it is definitely recommended to keep it off in production. Keeping	2132	>>, it is definitely recommended to keep it off in production. Keeping
1863	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2133	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1864	can be very useful, however.	2134	can be very useful, however.
1865		2135
		2136	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2137
		2138	If this env variable is nonempty, then its contents will be interpreted by
		2139	C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
		2140	replacing every occurance of C<$$> by the process pid). The shell object
		2141	is saved in C<$AnyEvent::Debug::SHELL>.
		2142
		2143	This happens when the first watcher is created.
		2144
		2145	For example, to bind a debug shell on a unix domain socket in
		2146	F<< /tmp/debug<pid>.sock >>, you could use this:
		2147
		2148	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2149	# connect with e.g.: socat readline /tmp/debug123.sock
		2150
		2151	Or to bind to tcp port 4545 on localhost:
		2152
		2153	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		2154	# connect with e.g.: telnet localhost 4545
		2155
		2156	Note that creating sockets in F</tmp> or on localhost is very unsafe on
		2157	multiuser systems.
		2158
		2159	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2160
		2161	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2162	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2163
1866	=item C<PERL_ANYEVENT_MODEL>	2164	=item C<PERL_ANYEVENT_MODEL>
1867		2165
1868	This can be used to specify the event model to be used by AnyEvent, before	2166	This can be used to specify the event model to be used by AnyEvent, before
1869	auto detection and -probing kicks in. It must be a string consisting	2167	auto detection and -probing kicks in.
1870	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2168
		2169	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2170	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1871	and the resulting module name is loaded and if the load was successful,	2171	resulting module name is loaded and - if the load was successful - used as
1872	used as event model. If it fails to load AnyEvent will proceed with	2172	event model backend. If it fails to load then AnyEvent will proceed with
1873	auto detection and -probing.	2173	auto detection and -probing.
1874		2174
1875	This functionality might change in future versions.	2175	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2176	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2177	the end of a string designates a module name and quotes it appropriately).
1876		2178
1877	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2179	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1878	could start your program like this:	2180	could start your program like this:
1879		2181
1880	PERL_ANYEVENT_MODEL=Perl perl ...	2182	PERL_ANYEVENT_MODEL=Perl perl ...
1881		2183
1882	=item C<PERL_ANYEVENT_PROTOCOLS>	2184	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1898	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2200	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1899	- only support IPv4, never try to resolve or contact IPv6	2201	- only support IPv4, never try to resolve or contact IPv6
1900	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2202	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1901	IPv6, but prefer IPv6 over IPv4.	2203	IPv6, but prefer IPv6 over IPv4.
1902		2204
		2205	=item C<PERL_ANYEVENT_HOSTS>
		2206
		2207	This variable, if specified, overrides the F</etc/hosts> file used by
		2208	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2209	from that file instead.
		2210
1903	=item C<PERL_ANYEVENT_EDNS0>	2211	=item C<PERL_ANYEVENT_EDNS0>
1904		2212
1905	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2213	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1906	for DNS. This extension is generally useful to reduce DNS traffic, but	2214	DNS. This extension is generally useful to reduce DNS traffic, especially
1907	some (broken) firewalls drop such DNS packets, which is why it is off by	2215	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1908	default.	2216	packets, which is why it is off by default.
1909		2217
1910	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2218	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1911	EDNS0 in its DNS requests.	2219	EDNS0 in its DNS requests.
1912		2220
1913	=item C<PERL_ANYEVENT_MAX_FORKS>	2221	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1921	resolver - this is the maximum number of parallel DNS requests that are	2229	resolver - this is the maximum number of parallel DNS requests that are
1922	sent to the DNS server.	2230	sent to the DNS server.
1923		2231
1924	=item C<PERL_ANYEVENT_RESOLV_CONF>	2232	=item C<PERL_ANYEVENT_RESOLV_CONF>
1925		2233
1926	The file to use instead of F</etc/resolv.conf> (or OS-specific	2234	The absolute path to a F<resolv.conf>-style file to use instead of
1927	configuration) in the default resolver. When set to the empty string, no	2235	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1928	default config will be used.	2236	resolver, or the empty string to select the default configuration.
1929		2237
1930	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2238	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1931		2239
1932	When neither C<ca_file> nor C<ca_path> was specified during	2240	When neither C<ca_file> nor C<ca_path> was specified during
1933	L<AnyEvent::TLS> context creation, and either of these environment	2241	L<AnyEvent::TLS> context creation, and either of these environment
1934	variables exist, they will be used to specify CA certificate locations	2242	variables are nonempty, they will be used to specify CA certificate
1935	instead of a system-dependent default.	2243	locations instead of a system-dependent default.
1936		2244
1937	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2245	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1938		2246
1939	When these are set to C<1>, then the respective modules are not	2247	When these are set to C<1>, then the respective modules are not
1940	loaded. Mostly good for testing AnyEvent itself.	2248	loaded. Mostly good for testing AnyEvent itself.
…		…
2272	(even when used without AnyEvent), but most event loops have acceptable	2580	(even when used without AnyEvent), but most event loops have acceptable
2273	performance with or without AnyEvent.	2581	performance with or without AnyEvent.
2274		2582
2275	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2583	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2276	the actual event loop, only with extremely fast event loops such as EV	2584	the actual event loop, only with extremely fast event loops such as EV
2277	adds AnyEvent significant overhead.	2585	does AnyEvent add significant overhead.
2278		2586
2279	=item * You should avoid POE like the plague if you want performance or	2587	=item * You should avoid POE like the plague if you want performance or
2280	reasonable memory usage.	2588	reasonable memory usage.
2281		2589
2282	=back	2590	=back
…		…
2581		2889
2582	=item L<Time::HiRes>	2890	=item L<Time::HiRes>
2583		2891
2584	This module is part of perl since release 5.008. It will be used when the	2892	This module is part of perl since release 5.008. It will be used when the
2585	chosen event library does not come with a timing source of its own. The	2893	chosen event library does not come with a timing source of its own. The
2586	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2894	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2587	try to use a monotonic clock for timing stability.	2895	try to use a monotonic clock for timing stability.
2588		2896
2589	=back	2897	=back
2590		2898
2591		2899
…		…
2657		2965
2658	Tutorial/Introduction: L<AnyEvent::Intro>.	2966	Tutorial/Introduction: L<AnyEvent::Intro>.
2659		2967
2660	FAQ: L<AnyEvent::FAQ>.	2968	FAQ: L<AnyEvent::FAQ>.
2661		2969
2662	Utility functions: L<AnyEvent::Util>.	2970	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2971	(simply logging).
2663		2972
2664	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2973	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2665	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2974	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2975
		2976	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2977	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2978	L<Qt>, L<POE>, L<FLTK>.
2666		2979
2667	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2980	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2668	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2981	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2669	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2982	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2670	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2983	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2984	L<AnyEvent::Impl::FLTK>.
2671		2985
2672	Non-blocking file handles, sockets, TCP clients and	2986	Non-blocking handles, pipes, stream sockets, TCP clients and
2673	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2987	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2674		2988
2675	Asynchronous DNS: L<AnyEvent::DNS>.	2989	Asynchronous DNS: L<AnyEvent::DNS>.
2676		2990
2677	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	2991	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.350 by root, Tue Aug 2 20:02:44 2011 UTC vs. Revision 1.386 by root, Mon Sep 26 11:32:19 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.350 by root, Tue Aug 2 20:02:44 2011 UTC vs.
Revision 1.386 by root, Mon Sep 26 11:32:19 2011 UTC