[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.382 by root, Thu Sep 1 23:46:26 2011 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - the DBI of event loop programming	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6	and POE are various supported event loops/environments.	6	FLTK and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
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 : 3;
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) { # also catches non-numeric levels(!)
		1309	require AnyEvent::Log;
		1310	# AnyEvent::Log overwrites this function
		1311	goto &log;
		1312	}
		1313
		1314	0 # not logged
		1315	}
		1316
		1317	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1318	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1319	}
		1320
1199	my @models = (	1321	our @models = (
1200	[EV:: => AnyEvent::Impl::EV:: , 1],	1322	[EV:: => AnyEvent::Impl::EV:: , 1],
1201	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1323	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1202	# everything below here will not (normally) be autoprobed	1324	# everything below here will not (normally) be autoprobed
1203	# as the pureperl backend should work everywhere	1325	# as the pure perl backend should work everywhere
1204	# and is usually faster	1326	# and is usually faster
1205	[Event:: => AnyEvent::Impl::Event::, 1],	1327	[Event:: => AnyEvent::Impl::Event::, 1],
1206	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1328	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1207	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1329	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1208	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1330	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1209	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1331	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1210	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1332	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1211	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1333	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1212	[Wx:: => AnyEvent::Impl::POE::],	1334	[Wx:: => AnyEvent::Impl::POE::],
1213	[Prima:: => AnyEvent::Impl::POE::],	1335	[Prima:: => AnyEvent::Impl::POE::],
1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1336	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1215	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1337	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
		1338	[FLTK:: => AnyEvent::Impl::FLTK::],
1216	);	1339	);
1217		1340
1218	our %method = map +($_ => 1),	1341	our @isa_hook;
		1342
		1343	sub _isa_set {
		1344	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1345
		1346	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1347	for 1 .. $#pkg;
		1348
		1349	grep $_ && $_->[1], @isa_hook
		1350	and AE::_reset ();
		1351	}
		1352
		1353	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1354	sub _isa_hook($$;$) {
		1355	my ($i, $pkg, $reset_ae) = @_;
		1356
		1357	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1358
		1359	_isa_set;
		1360	}
		1361
		1362	# all autoloaded methods reserve the complete glob, not just the method slot.
		1363	# due to bugs in perls method cache implementation.
1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1364	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		1365
1237	sub detect() {	1366	sub detect() {
		1367	return $MODEL if $MODEL; # some programs keep references to detect
		1368
		1369	local $!; # for good measure
		1370	local $SIG{__DIE__}; # we use eval
		1371
1238	# free some memory	1372	# free some memory
1239	*detect = sub () { $MODEL };	1373	*detect = sub () { $MODEL };
		1374	# undef &func doesn't correctly update the method cache. grmbl.
		1375	# so we delete the whole glob. grmbl.
		1376	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1377	# a glob with an active sub. hrm. i hope it works, but perl is
		1378	# usually buggy in this department. sigh.
		1379	delete @{"AnyEvent::"}{@methods};
		1380	undef @methods;
1240		1381
1241	local $!; # for good measure
1242	local $SIG{__DIE__};
1243
1244	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1382	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1245	my $model = "AnyEvent::Impl::$1";	1383	my $model = $1;
		1384	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1246	if (eval "require $model") {	1385	if (eval "require $model") {
		1386	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1247	$MODEL = $model;	1387	$MODEL = $model;
1248	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1249	} else {	1388	} else {
1250	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1389	AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1251	}	1390	}
1252	}	1391	}
1253		1392
1254	# check for already loaded models	1393	# check for already loaded models
1255	unless ($MODEL) {	1394	unless ($MODEL) {
1256	for (@REGISTRY, @models) {	1395	for (@REGISTRY, @models) {
1257	my ($package, $model) = @$_;	1396	my ($package, $model) = @$_;
1258	if (${"$package\::VERSION"} > 0) {	1397	if (${"$package\::VERSION"} > 0) {
1259	if (eval "require $model") {	1398	if (eval "require $model") {
		1399	AnyEvent::log 7 => "autodetected model '$model', using it.";
1260	$MODEL = $model;	1400	$MODEL = $model;
1261	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1262	last;	1401	last;
1263	}	1402	}
1264	}	1403	}
1265	}	1404	}
1266		1405
…		…
1272	$autoload	1411	$autoload
1273	and eval "require $package"	1412	and eval "require $package"
1274	and ${"$package\::VERSION"} > 0	1413	and ${"$package\::VERSION"} > 0
1275	and eval "require $model"	1414	and eval "require $model"
1276	) {	1415	) {
		1416	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1277	$MODEL = $model;	1417	$MODEL = $model;
1278	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1279	last;	1418	last;
1280	}	1419	}
1281	}	1420	}
1282		1421
1283	$MODEL	1422	$MODEL
1284	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1423	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1285	}	1424	}
1286	}	1425	}
1287		1426
1288	@models = (); # free probe data	1427	# free memory only needed for probing
		1428	undef @models;
		1429	undef @REGISTRY;
1289		1430
1290	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1431	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1291	unshift @ISA, $MODEL;
1292		1432
1293	# now nuke some methods that are overridden by the backend.	1433	# now nuke some methods that are overridden by the backend.
1294	# SUPER is not allowed.	1434	# SUPER usage is not allowed in these.
1295	for (qw(time signal child idle)) {	1435	for (qw(time signal child idle)) {
1296	undef &{"AnyEvent::Base::$_"}	1436	undef &{"AnyEvent::Base::$_"}
1297	if defined &{"$MODEL\::$_"};	1437	if defined &{"$MODEL\::$_"};
1298	}	1438	}
1299		1439
		1440	_isa_set;
		1441
		1442	# we're officially open!
		1443
1300	if ($ENV{PERL_ANYEVENT_STRICT}) {	1444	if ($ENV{PERL_ANYEVENT_STRICT}) {
1301	eval { require AnyEvent::Strict };	1445	require AnyEvent::Strict;
1302	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1303	if $@ && $VERBOSE;
1304	}	1446	}
1305		1447
		1448	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1449	require AnyEvent::Debug;
		1450	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1451	}
		1452
		1453	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1454	require AnyEvent::Socket;
		1455	require AnyEvent::Debug;
		1456
		1457	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1458	$shell =~ s/\$\$/$$/g;
		1459
		1460	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1461	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1462	}
		1463
		1464	# now the anyevent environment is set up as the user told us to, so
		1465	# call the actual user code - post detects
		1466
1306	(shift @post_detect)->() while @post_detect;	1467	(shift @post_detect)->() while @post_detect;
		1468	undef @post_detect;
1307		1469
1308	*post_detect = sub(&) {	1470	*post_detect = sub(&) {
1309	shift->();	1471	shift->();
1310		1472
1311	undef	1473	undef
1312	};	1474	};
1313		1475
1314	$MODEL	1476	$MODEL
1315	}	1477	}
1316		1478
1317	sub AUTOLOAD {	1479	for my $name (@methods) {
1318	(my $func = $AUTOLOAD) =~ s/.*://;	1480	*$name = sub {
1319
1320	$method{$func}
1321	or Carp::croak "$func: not a valid AnyEvent class method";
1322
1323	detect;	1481	detect;
1324		1482	# we use goto because
1325	my $class = shift;	1483	# a) it makes the thunk more transparent
1326	$class->$func (@_);	1484	# b) it allows us to delete the thunk later
		1485	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1486	};
1327	}	1487	}
1328		1488
1329	# utility function to dup a filehandle. this is used by many backends	1489	# utility function to dup a filehandle. this is used by many backends
1330	# to support binding more than one watcher per filehandle (they usually	1490	# 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).	1491	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1355		1515
1356	package AE;	1516	package AE;
1357		1517
1358	our $VERSION = $AnyEvent::VERSION;	1518	our $VERSION = $AnyEvent::VERSION;
1359		1519
		1520	sub _reset() {
		1521	eval q{
1360	# fall back to the main API by default - backends and AnyEvent::Base	1522	# fall back to the main API by default - backends and AnyEvent::Base
1361	# implementations can overwrite these.	1523	# implementations can overwrite these.
1362		1524
1363	sub io($$$) {	1525	sub io($$$) {
1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1526	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365	}	1527	}
1366		1528
1367	sub timer($$$) {	1529	sub timer($$$) {
1368	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1530	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369	}	1531	}
1370		1532
1371	sub signal($$) {	1533	sub signal($$) {
1372	AnyEvent->signal (signal => $_[0], cb => $_[1])	1534	AnyEvent->signal (signal => $_[0], cb => $_[1])
1373	}	1535	}
1374		1536
1375	sub child($$) {	1537	sub child($$) {
1376	AnyEvent->child (pid => $_[0], cb => $_[1])	1538	AnyEvent->child (pid => $_[0], cb => $_[1])
1377	}	1539	}
1378		1540
1379	sub idle($) {	1541	sub idle($) {
1380	AnyEvent->idle (cb => $_[0])	1542	AnyEvent->idle (cb => $_[0]);
1381	}	1543	}
1382		1544
1383	sub cv(;&) {	1545	sub cv(;&) {
1384	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1546	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385	}	1547	}
1386		1548
1387	sub now() {	1549	sub now() {
1388	AnyEvent->now	1550	AnyEvent->now
1389	}	1551	}
1390		1552
1391	sub now_update() {	1553	sub now_update() {
1392	AnyEvent->now_update	1554	AnyEvent->now_update
1393	}	1555	}
1394		1556
1395	sub time() {	1557	sub time() {
1396	AnyEvent->time	1558	AnyEvent->time
		1559	}
		1560
		1561	*postpone = \&AnyEvent::postpone;
		1562	*log = \&AnyEvent::log;
		1563	};
		1564	die if $@;
1397	}	1565	}
		1566
		1567	BEGIN { _reset }
1398		1568
1399	package AnyEvent::Base;	1569	package AnyEvent::Base;
1400		1570
1401	# default implementations for many methods	1571	# default implementations for many methods
1402		1572
1403	sub time {	1573	sub time {
1404	eval q{ # poor man's autoloading {}	1574	eval q{ # poor man's autoloading {}
1405	# probe for availability of Time::HiRes	1575	# probe for availability of Time::HiRes
1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1576	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1407	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1577	*time = sub { Time::HiRes::time () };
1408	*AE::time = \&Time::HiRes::time;	1578	*AE::time = \& Time::HiRes::time ;
		1579	*now = \&time;
		1580	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1409	# if (eval "use POSIX (); (POSIX::times())...	1581	# if (eval "use POSIX (); (POSIX::times())...
1410	} else {	1582	} else {
		1583	*time = sub { CORE::time };
		1584	*AE::time = sub (){ CORE::time };
		1585	*now = \&time;
1411	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1586	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1412	*AE::time = sub (){ time }; # epic fail
1413	}	1587	}
1414
1415	*time = sub { AE::time }; # different prototypes
1416	};	1588	};
1417	die if $@;	1589	die if $@;
1418		1590
1419	&time	1591	&time
1420	}	1592	}
1421		1593
1422	*now = \&time;	1594	*now = \&time;
1423
1424	sub now_update { }	1595	sub now_update { }
1425		1596
		1597	sub _poll {
		1598	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1599	}
		1600
1426	# default implementation for ->condvar	1601	# default implementation for ->condvar
		1602	# in fact, the default should not be overwritten
1427		1603
1428	sub condvar {	1604	sub condvar {
1429	eval q{ # poor man's autoloading {}	1605	eval q{ # poor man's autoloading {}
1430	*condvar = sub {	1606	*condvar = sub {
1431	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1607	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1509		1685
1510	sub signal {	1686	sub signal {
1511	eval q{ # poor man's autoloading {}	1687	eval q{ # poor man's autoloading {}
1512	# probe for availability of Async::Interrupt	1688	# probe for availability of Async::Interrupt
1513	if (_have_async_interrupt) {	1689	if (_have_async_interrupt) {
1514	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1690	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1515		1691
1516	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1692	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1517	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1693	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1518		1694
1519	} else {	1695	} else {
1520	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1696	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1521		1697
1522	if (AnyEvent::WIN32) {	1698	if (AnyEvent::WIN32) {
1523	require AnyEvent::Util;	1699	require AnyEvent::Util;
1524		1700
1525	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1701	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1601	: sysread $SIGPIPE_R, (my $dummy), 9;	1777	: sysread $SIGPIPE_R, (my $dummy), 9;
1602		1778
1603	while (%SIG_EV) {	1779	while (%SIG_EV) {
1604	for (keys %SIG_EV) {	1780	for (keys %SIG_EV) {
1605	delete $SIG_EV{$_};	1781	delete $SIG_EV{$_};
1606	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1782	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1607	}	1783	}
1608	}	1784	}
1609	};	1785	};
1610	};	1786	};
1611	die if $@;	1787	die if $@;
…		…
1638	};	1814	};
1639		1815
1640	*child = sub {	1816	*child = sub {
1641	my (undef, %arg) = @_;	1817	my (undef, %arg) = @_;
1642		1818
1643	defined (my $pid = $arg{pid} + 0)	1819	my $pid = $arg{pid};
1644	or Carp::croak "required option 'pid' is missing";	1820	my $cb = $arg{cb};
1645		1821
1646	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1822	$PID_CB{$pid}{$cb+0} = $cb;
1647		1823
1648	unless ($CHLD_W) {	1824	unless ($CHLD_W) {
1649	$CHLD_W = AE::signal CHLD => \&_sigchld;	1825	$CHLD_W = AE::signal CHLD => \&_sigchld;
1650	# child could be a zombie already, so make at least one round	1826	# child could be a zombie already, so make at least one round
1651	&_sigchld;	1827	&_sigchld;
1652	}	1828	}
1653		1829
1654	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1830	bless [$pid, $cb+0], "AnyEvent::Base::child"
1655	};	1831	};
1656		1832
1657	*AnyEvent::Base::child::DESTROY = sub {	1833	*AnyEvent::Base::child::DESTROY = sub {
1658	my ($pid, $cb) = @{$_[0]};	1834	my ($pid, $icb) = @{$_[0]};
1659		1835
1660	delete $PID_CB{$pid}{$cb};	1836	delete $PID_CB{$pid}{$icb};
1661	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1837	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1662		1838
1663	undef $CHLD_W unless keys %PID_CB;	1839	undef $CHLD_W unless keys %PID_CB;
1664	};	1840	};
1665	};	1841	};
…		…
1678		1854
1679	my ($cb, $w, $rcb) = $arg{cb};	1855	my ($cb, $w, $rcb) = $arg{cb};
1680		1856
1681	$rcb = sub {	1857	$rcb = sub {
1682	if ($cb) {	1858	if ($cb) {
1683	$w = _time;	1859	$w = AE::time;
1684	&$cb;	1860	&$cb;
1685	$w = _time - $w;	1861	$w = AE::time - $w;
1686		1862
1687	# never use more then 50% of the time for the idle watcher,	1863	# never use more then 50% of the time for the idle watcher,
1688	# within some limits	1864	# within some limits
1689	$w = 0.0001 if $w < 0.0001;	1865	$w = 0.0001 if $w < 0.0001;
1690	$w = 5 if $w > 5;	1866	$w = 5 if $w > 5;
…		…
1737		1913
1738	sub _send {	1914	sub _send {
1739	# nop	1915	# nop
1740	}	1916	}
1741		1917
		1918	sub _wait {
		1919	AnyEvent->_poll until $_[0]{_ae_sent};
		1920	}
		1921
1742	sub send {	1922	sub send {
1743	my $cv = shift;	1923	my $cv = shift;
1744	$cv->{_ae_sent} = [@_];	1924	$cv->{_ae_sent} = [@_];
1745	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1925	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1746	$cv->_send;	1926	$cv->_send;
…		…
1753		1933
1754	sub ready {	1934	sub ready {
1755	$_[0]{_ae_sent}	1935	$_[0]{_ae_sent}
1756	}	1936	}
1757		1937
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 {	1938	sub recv {
		1939	unless ($_[0]{_ae_sent}) {
		1940	$WAITING
		1941	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1942
		1943	local $WAITING = 1;
1768	$_[0]->_wait;	1944	$_[0]->_wait;
		1945	}
1769		1946
1770	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1947	$_[0]{_ae_croak}
1771	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1948	and Carp::croak $_[0]{_ae_croak};
		1949
		1950	wantarray
		1951	? @{ $_[0]{_ae_sent} }
		1952	: $_[0]{_ae_sent}[0]
1772	}	1953	}
1773		1954
1774	sub cb {	1955	sub cb {
1775	my $cv = shift;	1956	my $cv = shift;
1776		1957
…		…
1792	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1973	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1793	}	1974	}
1794		1975
1795	# undocumented/compatibility with pre-3.4	1976	# undocumented/compatibility with pre-3.4
1796	*broadcast = \&send;	1977	*broadcast = \&send;
1797	*wait = \&_wait;	1978	*wait = \&recv;
1798		1979
1799	=head1 ERROR AND EXCEPTION HANDLING	1980	=head1 ERROR AND EXCEPTION HANDLING
1800		1981
1801	In general, AnyEvent does not do any error handling - it relies on the	1982	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	1983	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	1995	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1815	so on.	1996	so on.
1816		1997
1817	=head1 ENVIRONMENT VARIABLES	1998	=head1 ENVIRONMENT VARIABLES
1818		1999
1819	The following environment variables are used by this module or its	2000	AnyEvent supports a number of environment variables that tune the
1820	submodules.	2001	runtime behaviour. They are usually evaluated when AnyEvent is
		2002	loaded, initialised, or a submodule that uses them is loaded. Many of
		2003	them also cause AnyEvent to load additional modules - for example,
		2004	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2005	loaded.
1821		2006
1822	Note that AnyEvent will remove I<all> environment variables starting with	2007	All the environment variables documented here start with
1823	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2008	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1824	enabled.	2009	namespace. Other modules are encouraged (but by no means required) to use
		2010	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2011	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2012	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2013	variables starting with C<AE_>, see below).
		2014
		2015	All variables can also be set via the C<AE_> prefix, that is, instead
		2016	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2017	case there is a clash btween anyevent and another program that uses
		2018	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2019	variable to the empty string, as those variables take precedence.
		2020
		2021	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2022	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2023	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2024	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2025	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2026	is set).
		2027
		2028	The exact algorithm is currently:
		2029
		2030	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2031	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2032	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2033
		2034	This ensures that child processes will not see the C<AE_> variables.
		2035
		2036	The following environment variables are currently known to AnyEvent:
1825		2037
1826	=over 4	2038	=over 4
1827		2039
1828	=item C<PERL_ANYEVENT_VERBOSE>	2040	=item C<PERL_ANYEVENT_VERBOSE>
1829		2041
1830	By default, AnyEvent will be completely silent except in fatal	2042	By default, AnyEvent will only log messages with loglevel C<3>
1831	conditions. You can set this environment variable to make AnyEvent more	2043	(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
		2044	environment variable to a numerical loglevel to make AnyEvent more (or
1832	talkative.	2045	less) talkative.
1833		2046
		2047	If you want to do more than just set the global logging level
		2048	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2049	complex specifications.
		2050
		2051	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2052	the default logging settings.
		2053
1834	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2054	When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1835	conditions, such as not being able to load the event model specified by	2055	unexpected conditions, such as not being able to load the event model
1836	C<PERL_ANYEVENT_MODEL>.	2056	specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
		2057	exception - this is the minimum recommended level.
1837		2058
1838	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2059	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1839	model it chooses.	2060	chooses.
1840		2061
1841	When set to C<8> or higher, then AnyEvent will report extra information on	2062	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1842	which optional modules it loads and how it implements certain features.	2063	which optional modules it loads and how it implements certain features.
		2064
		2065	=item C<PERL_ANYEVENT_LOG>
		2066
		2067	Accepts rather complex logging specifications. For example, you could log
		2068	all C<debug> messages of some module to stderr, warnings and above to
		2069	stderr, and errors and above to syslog, with:
		2070
		2071	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2072
		2073	For the rather extensive details, see L<AnyEvent::Log>.
		2074
		2075	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2076	so will take effect even before AnyEvent has initialised itself.
		2077
		2078	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2079	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2080	using the latter saves a few hundred kB of memory until the first message
		2081	is being logged.
1843		2082
1844	=item C<PERL_ANYEVENT_STRICT>	2083	=item C<PERL_ANYEVENT_STRICT>
1845		2084
1846	AnyEvent does not do much argument checking by default, as thorough	2085	AnyEvent does not do much argument checking by default, as thorough
1847	argument checking is very costly. Setting this variable to a true value	2086	argument checking is very costly. Setting this variable to a true value
…		…
1854	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2093	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1855	>>, it is definitely recommended to keep it off in production. Keeping	2094	>>, it is definitely recommended to keep it off in production. Keeping
1856	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2095	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1857	can be very useful, however.	2096	can be very useful, however.
1858		2097
		2098	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2099
		2100	If this env variable is set, then its contents will be interpreted by
		2101	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2102	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2103	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2104
		2105	This happens when the first watcher is created.
		2106
		2107	For example, to bind a debug shell on a unix domain socket in
		2108	F<< /tmp/debug<pid>.sock >>, you could use this:
		2109
		2110	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2111
		2112	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2113	systems.
		2114
		2115	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2116
		2117	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2118	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2119
1859	=item C<PERL_ANYEVENT_MODEL>	2120	=item C<PERL_ANYEVENT_MODEL>
1860		2121
1861	This can be used to specify the event model to be used by AnyEvent, before	2122	This can be used to specify the event model to be used by AnyEvent, before
1862	auto detection and -probing kicks in. It must be a string consisting	2123	auto detection and -probing kicks in.
1863	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2124
		2125	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2126	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,	2127	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	2128	event model backend. If it fails to load then AnyEvent will proceed with
1866	auto detection and -probing.	2129	auto detection and -probing.
1867		2130
1868	This functionality might change in future versions.	2131	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2132	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2133	the end of a string designates a module name and quotes it appropriately).
1869		2134
1870	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2135	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1871	could start your program like this:	2136	could start your program like this:
1872		2137
1873	PERL_ANYEVENT_MODEL=Perl perl ...	2138	PERL_ANYEVENT_MODEL=Perl perl ...
1874		2139
1875	=item C<PERL_ANYEVENT_PROTOCOLS>	2140	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1891	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2156	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1892	- only support IPv4, never try to resolve or contact IPv6	2157	- only support IPv4, never try to resolve or contact IPv6
1893	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2158	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1894	IPv6, but prefer IPv6 over IPv4.	2159	IPv6, but prefer IPv6 over IPv4.
1895		2160
		2161	=item C<PERL_ANYEVENT_HOSTS>
		2162
		2163	This variable, if specified, overrides the F</etc/hosts> file used by
		2164	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2165	from that file instead.
		2166
1896	=item C<PERL_ANYEVENT_EDNS0>	2167	=item C<PERL_ANYEVENT_EDNS0>
1897		2168
1898	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2169	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1899	for DNS. This extension is generally useful to reduce DNS traffic, but	2170	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	2171	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1901	default.	2172	packets, which is why it is off by default.
1902		2173
1903	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2174	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1904	EDNS0 in its DNS requests.	2175	EDNS0 in its DNS requests.
1905		2176
1906	=item C<PERL_ANYEVENT_MAX_FORKS>	2177	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1914	resolver - this is the maximum number of parallel DNS requests that are	2185	resolver - this is the maximum number of parallel DNS requests that are
1915	sent to the DNS server.	2186	sent to the DNS server.
1916		2187
1917	=item C<PERL_ANYEVENT_RESOLV_CONF>	2188	=item C<PERL_ANYEVENT_RESOLV_CONF>
1918		2189
1919	The file to use instead of F</etc/resolv.conf> (or OS-specific	2190	The absolute path to a F<resolv.conf>-style file to use instead of
1920	configuration) in the default resolver. When set to the empty string, no	2191	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1921	default config will be used.	2192	resolver, or the empty string to select the default configuration.
1922		2193
1923	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2194	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1924		2195
1925	When neither C<ca_file> nor C<ca_path> was specified during	2196	When neither C<ca_file> nor C<ca_path> was specified during
1926	L<AnyEvent::TLS> context creation, and either of these environment	2197	L<AnyEvent::TLS> context creation, and either of these environment
1927	variables exist, they will be used to specify CA certificate locations	2198	variables are nonempty, they will be used to specify CA certificate
1928	instead of a system-dependent default.	2199	locations instead of a system-dependent default.
1929		2200
1930	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2201	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1931		2202
1932	When these are set to C<1>, then the respective modules are not	2203	When these are set to C<1>, then the respective modules are not
1933	loaded. Mostly good for testing AnyEvent itself.	2204	loaded. Mostly good for testing AnyEvent itself.
…		…
2265	(even when used without AnyEvent), but most event loops have acceptable	2536	(even when used without AnyEvent), but most event loops have acceptable
2266	performance with or without AnyEvent.	2537	performance with or without AnyEvent.
2267		2538
2268	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2539	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2269	the actual event loop, only with extremely fast event loops such as EV	2540	the actual event loop, only with extremely fast event loops such as EV
2270	adds AnyEvent significant overhead.	2541	does AnyEvent add significant overhead.
2271		2542
2272	=item * You should avoid POE like the plague if you want performance or	2543	=item * You should avoid POE like the plague if you want performance or
2273	reasonable memory usage.	2544	reasonable memory usage.
2274		2545
2275	=back	2546	=back
…		…
2574		2845
2575	=item L<Time::HiRes>	2846	=item L<Time::HiRes>
2576		2847
2577	This module is part of perl since release 5.008. It will be used when the	2848	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	2849	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	2850	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2580	try to use a monotonic clock for timing stability.	2851	try to use a monotonic clock for timing stability.
2581		2852
2582	=back	2853	=back
2583		2854
2584		2855
…		…
2650		2921
2651	Tutorial/Introduction: L<AnyEvent::Intro>.	2922	Tutorial/Introduction: L<AnyEvent::Intro>.
2652		2923
2653	FAQ: L<AnyEvent::FAQ>.	2924	FAQ: L<AnyEvent::FAQ>.
2654		2925
2655	Utility functions: L<AnyEvent::Util>.	2926	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2927	(simply logging).
2656		2928
2657	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2929	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2658	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2930	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2931
		2932	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2933	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2934	L<Qt>, L<POE>, L<FLTK>.
2659		2935
2660	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2936	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2937	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2938	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2939	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2940	L<AnyEvent::Impl::FLTK>.
2664		2941
2665	Non-blocking file handles, sockets, TCP clients and	2942	Non-blocking handles, pipes, stream sockets, TCP clients and
2666	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2943	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2667		2944
2668	Asynchronous DNS: L<AnyEvent::DNS>.	2945	Asynchronous DNS: L<AnyEvent::DNS>.
2669		2946
2670	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	2947	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC vs. Revision 1.382 by root, Thu Sep 1 23:46:26 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC vs.
Revision 1.382 by root, Thu Sep 1 23:46:26 2011 UTC