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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC vs.
Revision 1.385 by root, Mon Sep 5 08:51:14 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 (fltk 2 binding).
883		884
884	=item Backends with special needs.	885	=item Backends with special needs.
885		886
886	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
887	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
…		…
932		933
933	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
934	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
935	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
936	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).
937		942
938	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
939	created, use C<post_detect>.	944	created, use C<post_detect>.
940		945
941	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1004	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1005	# as soon as it is	1010	# as soon as it is
1006	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1007	}	1012	}
1008		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
1009	=back	1072	=back
1010		1073
1011	=head1 WHAT TO DO IN A MODULE	1074	=head1 WHAT TO DO IN A MODULE
1012		1075
1013	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
…		…
1046	modules might create watchers when they are loaded, and AnyEvent will	1109	modules might create watchers when they are loaded, and AnyEvent will
1047	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
1048	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.
1049		1112
1050	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
1051	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1114	C<AnyEvent::Loop> module, which gives you similar behaviour
1052	everywhere, but letting AnyEvent chose the model is generally better.	1115	everywhere, but letting AnyEvent chose the model is generally better.
1053		1116
1054	=head2 MAINLOOP EMULATION	1117	=head2 MAINLOOP EMULATION
1055		1118
1056	Sometimes (often for short test scripts, or even standalone programs who	1119	Sometimes (often for short test scripts, or even standalone programs who
…		…
1069		1132
1070		1133
1071	=head1 OTHER MODULES	1134	=head1 OTHER MODULES
1072		1135
1073	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
1074	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
1075	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
1076	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 :)
1077		1143
1078	=over 4	1144	=over 4
1079		1145
1080	=item L<AnyEvent::Util>	1146	=item L<AnyEvent::Util>
1081		1147
…		…
1101	=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>
1102		1168
1103	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
1104	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
1105	Client Protocol).	1171	Client Protocol).
1106
1107	=item L<AnyEvent::Handle::UDP>
1108
1109	Here be danger!
1110
1111	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1112	there are so many things wrong with AnyEvent::Handle::UDP, most notably
1113	its use of a stream-based API with a protocol that isn't streamable, that
1114	the only way to improve it is to delete it.
1115
1116	It features data corruption (but typically only under load) and general
1117	confusion. On top, the author is not only clueless about UDP but also
1118	fact-resistant - some gems of his understanding: "connect doesn't work
1119	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1120	packets", "I don't need to implement proper error checking as UDP doesn't
1121	support error checking" and so on - he doesn't even understand what's
1122	wrong with his module when it is explained to him.
1123
1124	=item L<AnyEvent::DBI>
1125
1126	Executes L<DBI> requests asynchronously in a proxy process for you,
1127	notifying you in an event-based way when the operation is finished.
1128		1172
1129	=item L<AnyEvent::AIO>	1173	=item L<AnyEvent::AIO>
1130		1174
1131	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
1132	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1176	toolbox of every event programmer. AnyEvent::AIO transparently fuses
1133	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
1134	file I/O, and much more.	1178	file I/O, and much more.
1135		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
1136	=item L<AnyEvent::HTTPD>	1198	=item L<AnyEvent::HTTPD>
1137		1199
1138	A simple embedded webserver.	1200	A simple embedded webserver.
1139		1201
1140	=item L<AnyEvent::FastPing>	1202	=item L<AnyEvent::FastPing>
1141		1203
1142	The fastest ping in the west.	1204	The fastest ping in the west.
1143		1205
1144	=item L<Coro>	1206	=item L<Coro>
1145		1207
1146	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	};
1147		1221
1148	=back	1222	=back
1149		1223
1150	=cut	1224	=cut
1151		1225
…		…
1161		1235
1162	BEGIN { AnyEvent::common_sense }	1236	BEGIN { AnyEvent::common_sense }
1163		1237
1164	use Carp ();	1238	use Carp ();
1165		1239
1166	our $VERSION = '5.31';	1240	our $VERSION = '6.02';
1167	our $MODEL;	1241	our $MODEL;
1168
1169	our $AUTOLOAD;
1170	our @ISA;	1242	our @ISA;
1171
1172	our @REGISTRY;	1243	our @REGISTRY;
1173
1174	our $VERBOSE;	1244	our $VERBOSE;
		1245	our $MAX_SIGNAL_LATENCY = 10;
		1246	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
1175		1247
1176	BEGIN {	1248	BEGIN {
1177	require "AnyEvent/constants.pl";	1249	require "AnyEvent/constants.pl";
1178		1250
1179	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1251	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1180		1252
1181	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1253	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1182	if ${^TAINT};	1254	if ${^TAINT};
1183		1255
1184	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1256	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1257	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1185		1258
1186	}	1259	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1260	if ${^TAINT};
1187		1261
1188	our $MAX_SIGNAL_LATENCY = 10;	1262	# $ENV{PERL_ANYEVENT_xxx} now valid
1189		1263
1190	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1264	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1191		1265
1192	{
1193	my $idx;	1266	my $idx;
1194	$PROTOCOL{$_} = ++$idx	1267	$PROTOCOL{$_} = ++$idx
1195	for reverse split /\s,\s/,	1268	for reverse split /\s,\s/,
1196	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1269	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1197	}	1270	}
1198		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
1199	my @models = (	1351	our @models = (
1200	[EV:: => AnyEvent::Impl::EV:: , 1],	1352	[EV:: => AnyEvent::Impl::EV::],
1201	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1353	[AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1202	# everything below here will not (normally) be autoprobed	1354	# everything below here will not (normally) be autoprobed
1203	# as the pureperl backend should work everywhere	1355	# as the pure perl backend should work everywhere
1204	# 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
1205	[Event:: => AnyEvent::Impl::Event::, 1],	1358	[Event:: => AnyEvent::Impl::Event::], # slow, stable
1206	[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
1207	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1361	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1208	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1209	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1362	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1210	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1363	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1211	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1364	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1212	[Wx:: => AnyEvent::Impl::POE::],	1365	[Wx:: => AnyEvent::Impl::POE::],
1213	[Prima:: => AnyEvent::Impl::POE::],	1366	[Prima:: => AnyEvent::Impl::POE::],
1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1367	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1215	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1368	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
		1369	[FLTK:: => AnyEvent::Impl::FLTK::],
1216	);	1370	);
1217		1371
1218	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.
1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1395	our @methods = qw(io timer time now now_update signal child idle condvar);
1220
1221	our @post_detect;
1222
1223	sub post_detect(&) {
1224	my ($cb) = @_;
1225
1226	push @post_detect, $cb;
1227
1228	defined wantarray
1229	? bless \$cb, "AnyEvent::Util::postdetect"
1230	: ()
1231	}
1232
1233	sub AnyEvent::Util::postdetect::DESTROY {
1234	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1235	}
1236		1396
1237	sub detect() {	1397	sub detect() {
		1398	return $MODEL if $MODEL; # some programs keep references to detect
		1399
		1400	local $!; # for good measure
		1401	local $SIG{__DIE__}; # we use eval
		1402
1238	# free some memory	1403	# free some memory
1239	*detect = sub () { $MODEL };	1404	*detect = sub () { $MODEL };
		1405	# undef &func doesn't correctly update the method cache. grmbl.
		1406	# so we delete the whole glob. grmbl.
		1407	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1408	# a glob with an active sub. hrm. i hope it works, but perl is
		1409	# usually buggy in this department. sigh.
		1410	delete @{"AnyEvent::"}{@methods};
		1411	undef @methods;
1240		1412
1241	local $!; # for good measure
1242	local $SIG{__DIE__};
1243
1244	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1413	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1245	my $model = "AnyEvent::Impl::$1";	1414	my $model = $1;
		1415	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1246	if (eval "require $model") {	1416	if (eval "require $model") {
		1417	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1247	$MODEL = $model;	1418	$MODEL = $model;
1248	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1249	} else {	1419	} else {
1250	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1420	AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1251	}	1421	}
1252	}	1422	}
1253		1423
1254	# check for already loaded models	1424	# check for already loaded models
1255	unless ($MODEL) {	1425	unless ($MODEL) {
1256	for (@REGISTRY, @models) {	1426	for (@REGISTRY, @models) {
1257	my ($package, $model) = @$_;	1427	my ($package, $model) = @$_;
1258	if (${"$package\::VERSION"} > 0) {	1428	if (${"$package\::VERSION"} > 0) {
1259	if (eval "require $model") {	1429	if (eval "require $model") {
		1430	AnyEvent::log 7 => "autodetected model '$model', using it.";
1260	$MODEL = $model;	1431	$MODEL = $model;
1261	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1262	last;	1432	last;
1263	}	1433	}
1264	}	1434	}
1265	}	1435	}
1266		1436
1267	unless ($MODEL) {	1437	unless ($MODEL) {
1268	# try to autoload a model	1438	# try to autoload a model
1269	for (@REGISTRY, @models) {	1439	for (@REGISTRY, @models) {
1270	my ($package, $model, $autoload) = @$_;	1440	my ($package, $model) = @$_;
1271	if (	1441	if (
1272	$autoload
1273	and eval "require $package"	1442	eval "require $package"
1274	and ${"$package\::VERSION"} > 0	1443	and ${"$package\::VERSION"} > 0
1275	and eval "require $model"	1444	and eval "require $model"
1276	) {	1445	) {
		1446	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1277	$MODEL = $model;	1447	$MODEL = $model;
1278	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1279	last;	1448	last;
1280	}	1449	}
1281	}	1450	}
1282		1451
1283	$MODEL	1452	$MODEL
1284	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1453	or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1285	}	1454	}
1286	}	1455	}
1287		1456
1288	@models = (); # free probe data	1457	# free memory only needed for probing
		1458	undef @models;
		1459	undef @REGISTRY;
1289		1460
1290	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1461	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1291	unshift @ISA, $MODEL;
1292		1462
1293	# now nuke some methods that are overridden by the backend.	1463	# now nuke some methods that are overridden by the backend.
1294	# SUPER is not allowed.	1464	# SUPER usage is not allowed in these.
1295	for (qw(time signal child idle)) {	1465	for (qw(time signal child idle)) {
1296	undef &{"AnyEvent::Base::$_"}	1466	undef &{"AnyEvent::Base::$_"}
1297	if defined &{"$MODEL\::$_"};	1467	if defined &{"$MODEL\::$_"};
1298	}	1468	}
1299		1469
		1470	_isa_set;
		1471
		1472	# we're officially open!
		1473
1300	if ($ENV{PERL_ANYEVENT_STRICT}) {	1474	if ($ENV{PERL_ANYEVENT_STRICT}) {
1301	eval { require AnyEvent::Strict };	1475	require AnyEvent::Strict;
1302	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1303	if $@ && $VERBOSE;
1304	}	1476	}
1305		1477
		1478	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1479	require AnyEvent::Debug;
		1480	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1481	}
		1482
		1483	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1484	require AnyEvent::Socket;
		1485	require AnyEvent::Debug;
		1486
		1487	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1488	$shell =~ s/\$\$/$$/g;
		1489
		1490	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1491	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1492	}
		1493
		1494	# now the anyevent environment is set up as the user told us to, so
		1495	# call the actual user code - post detects
		1496
1306	(shift @post_detect)->() while @post_detect;	1497	(shift @post_detect)->() while @post_detect;
		1498	undef @post_detect;
1307		1499
1308	*post_detect = sub(&) {	1500	*post_detect = sub(&) {
1309	shift->();	1501	shift->();
1310		1502
1311	undef	1503	undef
1312	};	1504	};
1313		1505
1314	$MODEL	1506	$MODEL
1315	}	1507	}
1316		1508
1317	sub AUTOLOAD {	1509	for my $name (@methods) {
1318	(my $func = $AUTOLOAD) =~ s/.*://;	1510	*$name = sub {
1319
1320	$method{$func}
1321	or Carp::croak "$func: not a valid AnyEvent class method";
1322
1323	detect;	1511	detect;
1324		1512	# we use goto because
1325	my $class = shift;	1513	# a) it makes the thunk more transparent
1326	$class->$func (@_);	1514	# b) it allows us to delete the thunk later
		1515	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1516	};
1327	}	1517	}
1328		1518
1329	# utility function to dup a filehandle. this is used by many backends	1519	# utility function to dup a filehandle. this is used by many backends
1330	# to support binding more than one watcher per filehandle (they usually	1520	# to support binding more than one watcher per filehandle (they usually
1331	# allow only one watcher per fd, so we dup it to get a different one).	1521	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1355		1545
1356	package AE;	1546	package AE;
1357		1547
1358	our $VERSION = $AnyEvent::VERSION;	1548	our $VERSION = $AnyEvent::VERSION;
1359		1549
		1550	sub _reset() {
		1551	eval q{
1360	# fall back to the main API by default - backends and AnyEvent::Base	1552	# fall back to the main API by default - backends and AnyEvent::Base
1361	# implementations can overwrite these.	1553	# implementations can overwrite these.
1362		1554
1363	sub io($$$) {	1555	sub io($$$) {
1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1556	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365	}	1557	}
1366		1558
1367	sub timer($$$) {	1559	sub timer($$$) {
1368	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1560	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369	}	1561	}
1370		1562
1371	sub signal($$) {	1563	sub signal($$) {
1372	AnyEvent->signal (signal => $_[0], cb => $_[1])	1564	AnyEvent->signal (signal => $_[0], cb => $_[1])
1373	}	1565	}
1374		1566
1375	sub child($$) {	1567	sub child($$) {
1376	AnyEvent->child (pid => $_[0], cb => $_[1])	1568	AnyEvent->child (pid => $_[0], cb => $_[1])
1377	}	1569	}
1378		1570
1379	sub idle($) {	1571	sub idle($) {
1380	AnyEvent->idle (cb => $_[0])	1572	AnyEvent->idle (cb => $_[0]);
1381	}	1573	}
1382		1574
1383	sub cv(;&) {	1575	sub cv(;&) {
1384	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1576	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385	}	1577	}
1386		1578
1387	sub now() {	1579	sub now() {
1388	AnyEvent->now	1580	AnyEvent->now
1389	}	1581	}
1390		1582
1391	sub now_update() {	1583	sub now_update() {
1392	AnyEvent->now_update	1584	AnyEvent->now_update
1393	}	1585	}
1394		1586
1395	sub time() {	1587	sub time() {
1396	AnyEvent->time	1588	AnyEvent->time
		1589	}
		1590
		1591	*postpone = \&AnyEvent::postpone;
		1592	*log = \&AnyEvent::log;
		1593	};
		1594	die if $@;
1397	}	1595	}
		1596
		1597	BEGIN { _reset }
1398		1598
1399	package AnyEvent::Base;	1599	package AnyEvent::Base;
1400		1600
1401	# default implementations for many methods	1601	# default implementations for many methods
1402		1602
1403	sub time {	1603	sub time {
1404	eval q{ # poor man's autoloading {}	1604	eval q{ # poor man's autoloading {}
1405	# probe for availability of Time::HiRes	1605	# probe for availability of Time::HiRes
1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1606	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1407	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1607	*time = sub { Time::HiRes::time () };
1408	*AE::time = \&Time::HiRes::time;	1608	*AE::time = \& Time::HiRes::time ;
		1609	*now = \&time;
		1610	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1409	# if (eval "use POSIX (); (POSIX::times())...	1611	# if (eval "use POSIX (); (POSIX::times())...
1410	} else {	1612	} else {
		1613	*time = sub { CORE::time };
		1614	*AE::time = sub (){ CORE::time };
		1615	*now = \&time;
1411	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1616	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1412	*AE::time = sub (){ time }; # epic fail
1413	}	1617	}
1414
1415	*time = sub { AE::time }; # different prototypes
1416	};	1618	};
1417	die if $@;	1619	die if $@;
1418		1620
1419	&time	1621	&time
1420	}	1622	}
1421		1623
1422	*now = \&time;	1624	*now = \&time;
1423
1424	sub now_update { }	1625	sub now_update { }
1425		1626
		1627	sub _poll {
		1628	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1629	}
		1630
1426	# default implementation for ->condvar	1631	# default implementation for ->condvar
		1632	# in fact, the default should not be overwritten
1427		1633
1428	sub condvar {	1634	sub condvar {
1429	eval q{ # poor man's autoloading {}	1635	eval q{ # poor man's autoloading {}
1430	*condvar = sub {	1636	*condvar = sub {
1431	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1637	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1509		1715
1510	sub signal {	1716	sub signal {
1511	eval q{ # poor man's autoloading {}	1717	eval q{ # poor man's autoloading {}
1512	# probe for availability of Async::Interrupt	1718	# probe for availability of Async::Interrupt
1513	if (_have_async_interrupt) {	1719	if (_have_async_interrupt) {
1514	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1720	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1515		1721
1516	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1722	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1517	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1723	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1518		1724
1519	} else {	1725	} else {
1520	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1726	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1521		1727
1522	if (AnyEvent::WIN32) {	1728	if (AnyEvent::WIN32) {
1523	require AnyEvent::Util;	1729	require AnyEvent::Util;
1524		1730
1525	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1731	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1601	: sysread $SIGPIPE_R, (my $dummy), 9;	1807	: sysread $SIGPIPE_R, (my $dummy), 9;
1602		1808
1603	while (%SIG_EV) {	1809	while (%SIG_EV) {
1604	for (keys %SIG_EV) {	1810	for (keys %SIG_EV) {
1605	delete $SIG_EV{$_};	1811	delete $SIG_EV{$_};
1606	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1812	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1607	}	1813	}
1608	}	1814	}
1609	};	1815	};
1610	};	1816	};
1611	die if $@;	1817	die if $@;
…		…
1638	};	1844	};
1639		1845
1640	*child = sub {	1846	*child = sub {
1641	my (undef, %arg) = @_;	1847	my (undef, %arg) = @_;
1642		1848
1643	defined (my $pid = $arg{pid} + 0)	1849	my $pid = $arg{pid};
1644	or Carp::croak "required option 'pid' is missing";	1850	my $cb = $arg{cb};
1645		1851
1646	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1852	$PID_CB{$pid}{$cb+0} = $cb;
1647		1853
1648	unless ($CHLD_W) {	1854	unless ($CHLD_W) {
1649	$CHLD_W = AE::signal CHLD => \&_sigchld;	1855	$CHLD_W = AE::signal CHLD => \&_sigchld;
1650	# child could be a zombie already, so make at least one round	1856	# child could be a zombie already, so make at least one round
1651	&_sigchld;	1857	&_sigchld;
1652	}	1858	}
1653		1859
1654	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1860	bless [$pid, $cb+0], "AnyEvent::Base::child"
1655	};	1861	};
1656		1862
1657	*AnyEvent::Base::child::DESTROY = sub {	1863	*AnyEvent::Base::child::DESTROY = sub {
1658	my ($pid, $cb) = @{$_[0]};	1864	my ($pid, $icb) = @{$_[0]};
1659		1865
1660	delete $PID_CB{$pid}{$cb};	1866	delete $PID_CB{$pid}{$icb};
1661	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1867	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1662		1868
1663	undef $CHLD_W unless keys %PID_CB;	1869	undef $CHLD_W unless keys %PID_CB;
1664	};	1870	};
1665	};	1871	};
…		…
1678		1884
1679	my ($cb, $w, $rcb) = $arg{cb};	1885	my ($cb, $w, $rcb) = $arg{cb};
1680		1886
1681	$rcb = sub {	1887	$rcb = sub {
1682	if ($cb) {	1888	if ($cb) {
1683	$w = _time;	1889	$w = AE::time;
1684	&$cb;	1890	&$cb;
1685	$w = _time - $w;	1891	$w = AE::time - $w;
1686		1892
1687	# never use more then 50% of the time for the idle watcher,	1893	# never use more then 50% of the time for the idle watcher,
1688	# within some limits	1894	# within some limits
1689	$w = 0.0001 if $w < 0.0001;	1895	$w = 0.0001 if $w < 0.0001;
1690	$w = 5 if $w > 5;	1896	$w = 5 if $w > 5;
…		…
1737		1943
1738	sub _send {	1944	sub _send {
1739	# nop	1945	# nop
1740	}	1946	}
1741		1947
		1948	sub _wait {
		1949	AnyEvent->_poll until $_[0]{_ae_sent};
		1950	}
		1951
1742	sub send {	1952	sub send {
1743	my $cv = shift;	1953	my $cv = shift;
1744	$cv->{_ae_sent} = [@_];	1954	$cv->{_ae_sent} = [@_];
1745	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1955	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1746	$cv->_send;	1956	$cv->_send;
…		…
1753		1963
1754	sub ready {	1964	sub ready {
1755	$_[0]{_ae_sent}	1965	$_[0]{_ae_sent}
1756	}	1966	}
1757		1967
1758	sub _wait {
1759	$WAITING
1760	and !$_[0]{_ae_sent}
1761	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1762
1763	local $WAITING = 1;
1764	AnyEvent->one_event while !$_[0]{_ae_sent};
1765	}
1766
1767	sub recv {	1968	sub recv {
		1969	unless ($_[0]{_ae_sent}) {
		1970	$WAITING
		1971	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1972
		1973	local $WAITING = 1;
1768	$_[0]->_wait;	1974	$_[0]->_wait;
		1975	}
1769		1976
1770	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1977	$_[0]{_ae_croak}
1771	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1978	and Carp::croak $_[0]{_ae_croak};
		1979
		1980	wantarray
		1981	? @{ $_[0]{_ae_sent} }
		1982	: $_[0]{_ae_sent}[0]
1772	}	1983	}
1773		1984
1774	sub cb {	1985	sub cb {
1775	my $cv = shift;	1986	my $cv = shift;
1776		1987
…		…
1792	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	2003	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1793	}	2004	}
1794		2005
1795	# undocumented/compatibility with pre-3.4	2006	# undocumented/compatibility with pre-3.4
1796	*broadcast = \&send;	2007	*broadcast = \&send;
1797	*wait = \&_wait;	2008	*wait = \&recv;
1798		2009
1799	=head1 ERROR AND EXCEPTION HANDLING	2010	=head1 ERROR AND EXCEPTION HANDLING
1800		2011
1801	In general, AnyEvent does not do any error handling - it relies on the	2012	In general, AnyEvent does not do any error handling - it relies on the
1802	caller to do that if required. The L<AnyEvent::Strict> module (see also	2013	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1814	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2025	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1815	so on.	2026	so on.
1816		2027
1817	=head1 ENVIRONMENT VARIABLES	2028	=head1 ENVIRONMENT VARIABLES
1818		2029
1819	The following environment variables are used by this module or its	2030	AnyEvent supports a number of environment variables that tune the
1820	submodules.	2031	runtime behaviour. They are usually evaluated when AnyEvent is
		2032	loaded, initialised, or a submodule that uses them is loaded. Many of
		2033	them also cause AnyEvent to load additional modules - for example,
		2034	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2035	loaded.
1821		2036
1822	Note that AnyEvent will remove I<all> environment variables starting with	2037	All the environment variables documented here start with
1823	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2038	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1824	enabled.	2039	namespace. Other modules are encouraged (but by no means required) to use
		2040	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2041	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2042	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2043	variables starting with C<AE_>, see below).
		2044
		2045	All variables can also be set via the C<AE_> prefix, that is, instead
		2046	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2047	case there is a clash btween anyevent and another program that uses
		2048	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2049	variable to the empty string, as those variables take precedence.
		2050
		2051	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2052	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2053	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2054	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2055	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2056	is set).
		2057
		2058	The exact algorithm is currently:
		2059
		2060	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2061	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2062	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2063
		2064	This ensures that child processes will not see the C<AE_> variables.
		2065
		2066	The following environment variables are currently known to AnyEvent:
1825		2067
1826	=over 4	2068	=over 4
1827		2069
1828	=item C<PERL_ANYEVENT_VERBOSE>	2070	=item C<PERL_ANYEVENT_VERBOSE>
1829		2071
1830	By default, AnyEvent will be completely silent except in fatal	2072	By default, AnyEvent will only log messages with loglevel C<3>
1831	conditions. You can set this environment variable to make AnyEvent more	2073	(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
		2074	environment variable to a numerical loglevel to make AnyEvent more (or
1832	talkative.	2075	less) talkative.
1833		2076
		2077	If you want to do more than just set the global logging level
		2078	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2079	complex specifications.
		2080
		2081	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2082	the default logging settings.
		2083
1834	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2084	When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1835	conditions, such as not being able to load the event model specified by	2085	unexpected conditions, such as not being able to load the event model
1836	C<PERL_ANYEVENT_MODEL>.	2086	specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
		2087	exception - this is the minimum recommended level.
1837		2088
1838	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2089	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1839	model it chooses.	2090	chooses.
1840		2091
1841	When set to C<8> or higher, then AnyEvent will report extra information on	2092	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1842	which optional modules it loads and how it implements certain features.	2093	which optional modules it loads and how it implements certain features.
		2094
		2095	=item C<PERL_ANYEVENT_LOG>
		2096
		2097	Accepts rather complex logging specifications. For example, you could log
		2098	all C<debug> messages of some module to stderr, warnings and above to
		2099	stderr, and errors and above to syslog, with:
		2100
		2101	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2102
		2103	For the rather extensive details, see L<AnyEvent::Log>.
		2104
		2105	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2106	so will take effect even before AnyEvent has initialised itself.
		2107
		2108	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2109	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2110	using the latter saves a few hundred kB of memory until the first message
		2111	is being logged.
1843		2112
1844	=item C<PERL_ANYEVENT_STRICT>	2113	=item C<PERL_ANYEVENT_STRICT>
1845		2114
1846	AnyEvent does not do much argument checking by default, as thorough	2115	AnyEvent does not do much argument checking by default, as thorough
1847	argument checking is very costly. Setting this variable to a true value	2116	argument checking is very costly. Setting this variable to a true value
…		…
1854	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2123	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1855	>>, it is definitely recommended to keep it off in production. Keeping	2124	>>, it is definitely recommended to keep it off in production. Keeping
1856	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2125	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1857	can be very useful, however.	2126	can be very useful, however.
1858		2127
		2128	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2129
		2130	If this env variable is nonempty, then its contents will be interpreted by
		2131	C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
		2132	replacing every occurance of C<$$> by the process pid). The shell object
		2133	is saved in C<$AnyEvent::Debug::SHELL>.
		2134
		2135	This happens when the first watcher is created.
		2136
		2137	For example, to bind a debug shell on a unix domain socket in
		2138	F<< /tmp/debug<pid>.sock >>, you could use this:
		2139
		2140	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2141	# connect with e.g.: socat readline /tmp/debug123.sock
		2142
		2143	Or to bind to tcp port 4545 on localhost:
		2144
		2145	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		2146	# connect with e.g.: telnet localhost 4545
		2147
		2148	Note that creating sockets in F</tmp> or on localhost is very unsafe on
		2149	multiuser systems.
		2150
		2151	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2152
		2153	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2154	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2155
1859	=item C<PERL_ANYEVENT_MODEL>	2156	=item C<PERL_ANYEVENT_MODEL>
1860		2157
1861	This can be used to specify the event model to be used by AnyEvent, before	2158	This can be used to specify the event model to be used by AnyEvent, before
1862	auto detection and -probing kicks in. It must be a string consisting	2159	auto detection and -probing kicks in.
1863	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2160
		2161	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2162	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1864	and the resulting module name is loaded and if the load was successful,	2163	resulting module name is loaded and - if the load was successful - used as
1865	used as event model. If it fails to load AnyEvent will proceed with	2164	event model backend. If it fails to load then AnyEvent will proceed with
1866	auto detection and -probing.	2165	auto detection and -probing.
1867		2166
1868	This functionality might change in future versions.	2167	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2168	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2169	the end of a string designates a module name and quotes it appropriately).
1869		2170
1870	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2171	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1871	could start your program like this:	2172	could start your program like this:
1872		2173
1873	PERL_ANYEVENT_MODEL=Perl perl ...	2174	PERL_ANYEVENT_MODEL=Perl perl ...
1874		2175
1875	=item C<PERL_ANYEVENT_PROTOCOLS>	2176	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1891	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2192	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1892	- only support IPv4, never try to resolve or contact IPv6	2193	- only support IPv4, never try to resolve or contact IPv6
1893	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2194	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1894	IPv6, but prefer IPv6 over IPv4.	2195	IPv6, but prefer IPv6 over IPv4.
1895		2196
		2197	=item C<PERL_ANYEVENT_HOSTS>
		2198
		2199	This variable, if specified, overrides the F</etc/hosts> file used by
		2200	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2201	from that file instead.
		2202
1896	=item C<PERL_ANYEVENT_EDNS0>	2203	=item C<PERL_ANYEVENT_EDNS0>
1897		2204
1898	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2205	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1899	for DNS. This extension is generally useful to reduce DNS traffic, but	2206	DNS. This extension is generally useful to reduce DNS traffic, especially
1900	some (broken) firewalls drop such DNS packets, which is why it is off by	2207	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1901	default.	2208	packets, which is why it is off by default.
1902		2209
1903	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2210	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1904	EDNS0 in its DNS requests.	2211	EDNS0 in its DNS requests.
1905		2212
1906	=item C<PERL_ANYEVENT_MAX_FORKS>	2213	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1914	resolver - this is the maximum number of parallel DNS requests that are	2221	resolver - this is the maximum number of parallel DNS requests that are
1915	sent to the DNS server.	2222	sent to the DNS server.
1916		2223
1917	=item C<PERL_ANYEVENT_RESOLV_CONF>	2224	=item C<PERL_ANYEVENT_RESOLV_CONF>
1918		2225
1919	The file to use instead of F</etc/resolv.conf> (or OS-specific	2226	The absolute path to a F<resolv.conf>-style file to use instead of
1920	configuration) in the default resolver. When set to the empty string, no	2227	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1921	default config will be used.	2228	resolver, or the empty string to select the default configuration.
1922		2229
1923	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2230	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1924		2231
1925	When neither C<ca_file> nor C<ca_path> was specified during	2232	When neither C<ca_file> nor C<ca_path> was specified during
1926	L<AnyEvent::TLS> context creation, and either of these environment	2233	L<AnyEvent::TLS> context creation, and either of these environment
1927	variables exist, they will be used to specify CA certificate locations	2234	variables are nonempty, they will be used to specify CA certificate
1928	instead of a system-dependent default.	2235	locations instead of a system-dependent default.
1929		2236
1930	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2237	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1931		2238
1932	When these are set to C<1>, then the respective modules are not	2239	When these are set to C<1>, then the respective modules are not
1933	loaded. Mostly good for testing AnyEvent itself.	2240	loaded. Mostly good for testing AnyEvent itself.
…		…
2265	(even when used without AnyEvent), but most event loops have acceptable	2572	(even when used without AnyEvent), but most event loops have acceptable
2266	performance with or without AnyEvent.	2573	performance with or without AnyEvent.
2267		2574
2268	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2575	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2269	the actual event loop, only with extremely fast event loops such as EV	2576	the actual event loop, only with extremely fast event loops such as EV
2270	adds AnyEvent significant overhead.	2577	does AnyEvent add significant overhead.
2271		2578
2272	=item * You should avoid POE like the plague if you want performance or	2579	=item * You should avoid POE like the plague if you want performance or
2273	reasonable memory usage.	2580	reasonable memory usage.
2274		2581
2275	=back	2582	=back
…		…
2574		2881
2575	=item L<Time::HiRes>	2882	=item L<Time::HiRes>
2576		2883
2577	This module is part of perl since release 5.008. It will be used when the	2884	This module is part of perl since release 5.008. It will be used when the
2578	chosen event library does not come with a timing source of its own. The	2885	chosen event library does not come with a timing source of its own. The
2579	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2886	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2580	try to use a monotonic clock for timing stability.	2887	try to use a monotonic clock for timing stability.
2581		2888
2582	=back	2889	=back
2583		2890
2584		2891
…		…
2650		2957
2651	Tutorial/Introduction: L<AnyEvent::Intro>.	2958	Tutorial/Introduction: L<AnyEvent::Intro>.
2652		2959
2653	FAQ: L<AnyEvent::FAQ>.	2960	FAQ: L<AnyEvent::FAQ>.
2654		2961
2655	Utility functions: L<AnyEvent::Util>.	2962	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2963	(simply logging).
2656		2964
2657	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2965	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2658	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2966	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2967
		2968	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2969	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2970	L<Qt>, L<POE>, L<FLTK>.
2659		2971
2660	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2972	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2973	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2974	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2975	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2976	L<AnyEvent::Impl::FLTK>.
2664		2977
2665	Non-blocking file handles, sockets, TCP clients and	2978	Non-blocking handles, pipes, stream sockets, TCP clients and
2666	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2979	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2667		2980
2668	Asynchronous DNS: L<AnyEvent::DNS>.	2981	Asynchronous DNS: L<AnyEvent::DNS>.
2669		2982
2670	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	2983	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.347 by root, Sun Jan 23 11:15:09 2011 UTC vs. Revision 1.385 by root, Mon Sep 5 08:51:14 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC vs.
Revision 1.385 by root, Mon Sep 5 08:51:14 2011 UTC