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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.344 by root, Wed Dec 29 05:04:52 2010 UTC vs.
Revision 1.379 by root, Fri Aug 26 18:09:04 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.
		1064
		1065	If you want to sprinkle loads of logging calls around your code, consider
		1066	creating a logger callback with the C<AnyEvent::Log::logger> function,
		1067	which can reduce typing, codesize and can reduce the logging overhead
		1068	enourmously.
		1069
1009	=back	1070	=back
1010		1071
1011	=head1 WHAT TO DO IN A MODULE	1072	=head1 WHAT TO DO IN A MODULE
1012		1073
1013	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1074	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	1107	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	1108	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.	1109	might choose the wrong one unless you load the correct one yourself.
1049		1110
1050	You can chose to use a pure-perl implementation by loading the	1111	You can chose to use a pure-perl implementation by loading the
1051	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1112	C<AnyEvent::Loop> module, which gives you similar behaviour
1052	everywhere, but letting AnyEvent chose the model is generally better.	1113	everywhere, but letting AnyEvent chose the model is generally better.
1053		1114
1054	=head2 MAINLOOP EMULATION	1115	=head2 MAINLOOP EMULATION
1055		1116
1056	Sometimes (often for short test scripts, or even standalone programs who	1117	Sometimes (often for short test scripts, or even standalone programs who
…		…
1069		1130
1070		1131
1071	=head1 OTHER MODULES	1132	=head1 OTHER MODULES
1072		1133
1073	The following is a non-exhaustive list of additional modules that use	1134	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	1135	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	1136	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.	1137	modules come as part of AnyEvent, the others are available via CPAN (see
		1138	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1139	a longer non-exhaustive list), and the list is heavily biased towards
		1140	modules of the AnyEvent author himself :)
1077		1141
1078	=over 4	1142	=over 4
1079		1143
1080	=item L<AnyEvent::Util>	1144	=item L<AnyEvent::Util>
1081		1145
…		…
1101	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>	1165	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1102		1166
1103	Implement event-based interfaces to the protocols of the same name (for	1167	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	1168	the curious, IGS is the International Go Server and FCP is the Freenet
1105	Client Protocol).	1169	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		1170
1129	=item L<AnyEvent::AIO>	1171	=item L<AnyEvent::AIO>
1130		1172
1131	Truly asynchronous (as opposed to non-blocking) I/O, should be in the	1173	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1132	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1174	toolbox of every event programmer. AnyEvent::AIO transparently fuses
1133	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based	1175	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1134	file I/O, and much more.	1176	file I/O, and much more.
1135		1177
		1178	=item L<AnyEvent::Filesys::Notify>
		1179
		1180	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1181	path changes (e.g. "watch this directory for new files", "watch this
		1182	file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
		1183	do just that in a portbale fashion, supporting inotify on GNU/Linux and
		1184	some weird, without doubt broken, stuff on OS X to monitor files. It can
		1185	fall back to blocking scans at regular intervals transparently on other
		1186	platforms, so it's about as portable as it gets.
		1187
		1188	(I haven't used it myself, but I haven't heard anybody complaining about
		1189	it yet).
		1190
		1191	=item L<AnyEvent::DBI>
		1192
		1193	Executes L<DBI> requests asynchronously in a proxy process for you,
		1194	notifying you in an event-based way when the operation is finished.
		1195
1136	=item L<AnyEvent::HTTPD>	1196	=item L<AnyEvent::HTTPD>
1137		1197
1138	A simple embedded webserver.	1198	A simple embedded webserver.
1139		1199
1140	=item L<AnyEvent::FastPing>	1200	=item L<AnyEvent::FastPing>
1141		1201
1142	The fastest ping in the west.	1202	The fastest ping in the west.
1143		1203
1144	=item L<Coro>	1204	=item L<Coro>
1145		1205
1146	Has special support for AnyEvent via L<Coro::AnyEvent>.	1206	Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
		1207	to simply invert the flow control - don't call us, we will call you:
		1208
		1209	async {
		1210	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1211	print "5 seconds later!\n";
		1212
		1213	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1214	my $line = <STDIN>; # works for ttys
		1215
		1216	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1217	my ($body, $hdr) = Coro::rouse_wait;
		1218	};
1147		1219
1148	=back	1220	=back
1149		1221
1150	=cut	1222	=cut
1151		1223
1152	package AnyEvent;	1224	package AnyEvent;
1153		1225
1154	# basically a tuned-down version of common::sense	1226	# basically a tuned-down version of common::sense
1155	sub common_sense {	1227	sub common_sense {
1156	# from common:.sense 3.3	1228	# from common:.sense 3.4
1157	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00";	1229	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1158	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)	1230	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1159	$^H \|= 0x00000600;	1231	$^H \|= 0x00000600;
1160	}	1232	}
1161		1233
1162	BEGIN { AnyEvent::common_sense }	1234	BEGIN { AnyEvent::common_sense }
1163		1235
1164	use Carp ();	1236	use Carp ();
1165		1237
1166	our $VERSION = '5.29';	1238	our $VERSION = '6.02';
1167	our $MODEL;	1239	our $MODEL;
1168		1240
1169	our $AUTOLOAD;
1170	our @ISA;	1241	our @ISA;
1171		1242
1172	our @REGISTRY;	1243	our @REGISTRY;
1173		1244
1174	our $VERBOSE;	1245	our $VERBOSE;
…		…
1179	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1250	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1180		1251
1181	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1252	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1182	if ${^TAINT};	1253	if ${^TAINT};
1183		1254
		1255	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1256	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
		1257
		1258	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1259	if ${^TAINT};
		1260
1184	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1261	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1185
1186	}	1262	}
1187		1263
1188	our $MAX_SIGNAL_LATENCY = 10;	1264	our $MAX_SIGNAL_LATENCY = 10;
1189		1265
1190	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1266	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
1194	$PROTOCOL{$_} = ++$idx	1270	$PROTOCOL{$_} = ++$idx
1195	for reverse split /\s,\s/,	1271	for reverse split /\s,\s/,
1196	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1272	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1197	}	1273	}
1198		1274
		1275	our @post_detect;
		1276
		1277	sub post_detect(&) {
		1278	my ($cb) = @_;
		1279
		1280	push @post_detect, $cb;
		1281
		1282	defined wantarray
		1283	? bless \$cb, "AnyEvent::Util::postdetect"
		1284	: ()
		1285	}
		1286
		1287	sub AnyEvent::Util::postdetect::DESTROY {
		1288	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1289	}
		1290
		1291	our $POSTPONE_W;
		1292	our @POSTPONE;
		1293
		1294	sub _postpone_exec {
		1295	undef $POSTPONE_W;
		1296
		1297	&{ shift @POSTPONE }
		1298	while @POSTPONE;
		1299	}
		1300
		1301	sub postpone(&) {
		1302	push @POSTPONE, shift;
		1303
		1304	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1305
		1306	()
		1307	}
		1308
		1309	sub log($$;@) {
		1310	# only load the big bloated module when we actually are about to log something
		1311	if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
		1312	require AnyEvent::Log;
		1313	# AnyEvent::Log overwrites this function
		1314	goto &log;
		1315	}
		1316
		1317	0 # not logged
		1318	}
		1319
		1320	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1321	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1322	}
		1323
1199	my @models = (	1324	our @models = (
1200	[EV:: => AnyEvent::Impl::EV:: , 1],	1325	[EV:: => AnyEvent::Impl::EV:: , 1],
1201	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1326	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1202	# everything below here will not (normally) be autoprobed	1327	# everything below here will not (normally) be autoprobed
1203	# as the pureperl backend should work everywhere	1328	# as the pure perl backend should work everywhere
1204	# and is usually faster	1329	# and is usually faster
1205	[Event:: => AnyEvent::Impl::Event::, 1],	1330	[Event:: => AnyEvent::Impl::Event::, 1],
1206	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1331	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1207	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1332	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1208	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1333	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1209	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1334	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1210	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1335	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1211	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1336	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1212	[Wx:: => AnyEvent::Impl::POE::],	1337	[Wx:: => AnyEvent::Impl::POE::],
1213	[Prima:: => AnyEvent::Impl::POE::],	1338	[Prima:: => AnyEvent::Impl::POE::],
1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1339	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1215	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1340	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
		1341	[FLTK:: => AnyEvent::Impl::FLTK::],
1216	);	1342	);
1217		1343
1218	our %method = map +($_ => 1),	1344	our @isa_hook;
		1345
		1346	sub _isa_set {
		1347	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1348
		1349	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1350	for 1 .. $#pkg;
		1351
		1352	grep $_ && $_->[1], @isa_hook
		1353	and AE::_reset ();
		1354	}
		1355
		1356	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1357	sub _isa_hook($$;$) {
		1358	my ($i, $pkg, $reset_ae) = @_;
		1359
		1360	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1361
		1362	_isa_set;
		1363	}
		1364
		1365	# all autoloaded methods reserve the complete glob, not just the method slot.
		1366	# due to bugs in perls method cache implementation.
1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1367	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		1368
1237	sub detect() {	1369	sub detect() {
		1370	return $MODEL if $MODEL; # some programs keep references to detect
		1371
		1372	local $!; # for good measure
		1373	local $SIG{__DIE__}; # we use eval
		1374
1238	# free some memory	1375	# free some memory
1239	*detect = sub () { $MODEL };	1376	*detect = sub () { $MODEL };
		1377	# undef &func doesn't correctly update the method cache. grmbl.
		1378	# so we delete the whole glob. grmbl.
		1379	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1380	# a glob with an active sub. hrm. i hope it works, but perl is
		1381	# usually buggy in this department. sigh.
		1382	delete @{"AnyEvent::"}{@methods};
		1383	undef @methods;
1240		1384
1241	local $!; # for good measure
1242	local $SIG{__DIE__};
1243
1244	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1385	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1245	my $model = "AnyEvent::Impl::$1";	1386	my $model = $1;
		1387	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1246	if (eval "require $model") {	1388	if (eval "require $model") {
		1389	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1247	$MODEL = $model;	1390	$MODEL = $model;
1248	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1249	} else {	1391	} else {
1250	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1392	AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1251	}	1393	}
1252	}	1394	}
1253		1395
1254	# check for already loaded models	1396	# check for already loaded models
1255	unless ($MODEL) {	1397	unless ($MODEL) {
1256	for (@REGISTRY, @models) {	1398	for (@REGISTRY, @models) {
1257	my ($package, $model) = @$_;	1399	my ($package, $model) = @$_;
1258	if (${"$package\::VERSION"} > 0) {	1400	if (${"$package\::VERSION"} > 0) {
1259	if (eval "require $model") {	1401	if (eval "require $model") {
		1402	AnyEvent::log 7 => "autodetected model '$model', using it.";
1260	$MODEL = $model;	1403	$MODEL = $model;
1261	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1262	last;	1404	last;
1263	}	1405	}
1264	}	1406	}
1265	}	1407	}
1266		1408
…		…
1272	$autoload	1414	$autoload
1273	and eval "require $package"	1415	and eval "require $package"
1274	and ${"$package\::VERSION"} > 0	1416	and ${"$package\::VERSION"} > 0
1275	and eval "require $model"	1417	and eval "require $model"
1276	) {	1418	) {
		1419	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1277	$MODEL = $model;	1420	$MODEL = $model;
1278	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1279	last;	1421	last;
1280	}	1422	}
1281	}	1423	}
1282		1424
1283	$MODEL	1425	$MODEL
1284	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1426	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1285	}	1427	}
1286	}	1428	}
1287		1429
1288	@models = (); # free probe data	1430	# free memory only needed for probing
		1431	undef @models;
		1432	undef @REGISTRY;
1289		1433
1290	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1434	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1291	unshift @ISA, $MODEL;
1292		1435
1293	# now nuke some methods that are overridden by the backend.	1436	# now nuke some methods that are overridden by the backend.
1294	# SUPER is not allowed.	1437	# SUPER usage is not allowed in these.
1295	for (qw(time signal child idle)) {	1438	for (qw(time signal child idle)) {
1296	undef &{"AnyEvent::Base::$_"}	1439	undef &{"AnyEvent::Base::$_"}
1297	if defined &{"$MODEL\::$_"};	1440	if defined &{"$MODEL\::$_"};
1298	}	1441	}
1299		1442
		1443	_isa_set;
		1444
		1445	# we're officially open!
		1446
1300	if ($ENV{PERL_ANYEVENT_STRICT}) {	1447	if ($ENV{PERL_ANYEVENT_STRICT}) {
1301	eval { require AnyEvent::Strict };	1448	require AnyEvent::Strict;
1302	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1303	if $@ && $VERBOSE;
1304	}	1449	}
1305		1450
		1451	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1452	require AnyEvent::Debug;
		1453	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1454	}
		1455
		1456	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1457	require AnyEvent::Socket;
		1458	require AnyEvent::Debug;
		1459
		1460	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1461	$shell =~ s/\$\$/$$/g;
		1462
		1463	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1464	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1465	}
		1466
		1467	# now the anyevent environment is set up as the user told us to, so
		1468	# call the actual user code - post detects
		1469
1306	(shift @post_detect)->() while @post_detect;	1470	(shift @post_detect)->() while @post_detect;
		1471	undef @post_detect;
1307		1472
1308	*post_detect = sub(&) {	1473	*post_detect = sub(&) {
1309	shift->();	1474	shift->();
1310		1475
1311	undef	1476	undef
1312	};	1477	};
1313		1478
1314	$MODEL	1479	$MODEL
1315	}	1480	}
1316		1481
1317	sub AUTOLOAD {	1482	for my $name (@methods) {
1318	(my $func = $AUTOLOAD) =~ s/.*://;	1483	*$name = sub {
1319
1320	$method{$func}
1321	or Carp::croak "$func: not a valid AnyEvent class method";
1322
1323	detect;	1484	detect;
1324		1485	# we use goto because
1325	my $class = shift;	1486	# a) it makes the thunk more transparent
1326	$class->$func (@_);	1487	# b) it allows us to delete the thunk later
		1488	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1489	};
1327	}	1490	}
1328		1491
1329	# utility function to dup a filehandle. this is used by many backends	1492	# utility function to dup a filehandle. this is used by many backends
1330	# to support binding more than one watcher per filehandle (they usually	1493	# 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).	1494	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1355		1518
1356	package AE;	1519	package AE;
1357		1520
1358	our $VERSION = $AnyEvent::VERSION;	1521	our $VERSION = $AnyEvent::VERSION;
1359		1522
		1523	sub _reset() {
		1524	eval q{
1360	# fall back to the main API by default - backends and AnyEvent::Base	1525	# fall back to the main API by default - backends and AnyEvent::Base
1361	# implementations can overwrite these.	1526	# implementations can overwrite these.
1362		1527
1363	sub io($$$) {	1528	sub io($$$) {
1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1529	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365	}	1530	}
1366		1531
1367	sub timer($$$) {	1532	sub timer($$$) {
1368	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1533	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369	}	1534	}
1370		1535
1371	sub signal($$) {	1536	sub signal($$) {
1372	AnyEvent->signal (signal => $_[0], cb => $_[1])	1537	AnyEvent->signal (signal => $_[0], cb => $_[1])
1373	}	1538	}
1374		1539
1375	sub child($$) {	1540	sub child($$) {
1376	AnyEvent->child (pid => $_[0], cb => $_[1])	1541	AnyEvent->child (pid => $_[0], cb => $_[1])
1377	}	1542	}
1378		1543
1379	sub idle($) {	1544	sub idle($) {
1380	AnyEvent->idle (cb => $_[0])	1545	AnyEvent->idle (cb => $_[0]);
1381	}	1546	}
1382		1547
1383	sub cv(;&) {	1548	sub cv(;&) {
1384	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1549	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385	}	1550	}
1386		1551
1387	sub now() {	1552	sub now() {
1388	AnyEvent->now	1553	AnyEvent->now
1389	}	1554	}
1390		1555
1391	sub now_update() {	1556	sub now_update() {
1392	AnyEvent->now_update	1557	AnyEvent->now_update
1393	}	1558	}
1394		1559
1395	sub time() {	1560	sub time() {
1396	AnyEvent->time	1561	AnyEvent->time
		1562	}
		1563
		1564	*postpone = \&AnyEvent::postpone;
		1565	*log = \&AnyEvent::log;
		1566	};
		1567	die if $@;
1397	}	1568	}
		1569
		1570	BEGIN { _reset }
1398		1571
1399	package AnyEvent::Base;	1572	package AnyEvent::Base;
1400		1573
1401	# default implementations for many methods	1574	# default implementations for many methods
1402		1575
1403	sub time {	1576	sub time {
1404	eval q{ # poor man's autoloading {}	1577	eval q{ # poor man's autoloading {}
1405	# probe for availability of Time::HiRes	1578	# probe for availability of Time::HiRes
1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1579	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1407	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1580	*time = sub { Time::HiRes::time () };
1408	*AE::time = \&Time::HiRes::time;	1581	*AE::time = \& Time::HiRes::time ;
		1582	*now = \&time;
		1583	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1409	# if (eval "use POSIX (); (POSIX::times())...	1584	# if (eval "use POSIX (); (POSIX::times())...
1410	} else {	1585	} else {
		1586	*time = sub { CORE::time };
		1587	*AE::time = sub (){ CORE::time };
		1588	*now = \&time;
1411	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1589	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1412	*AE::time = sub (){ time }; # epic fail
1413	}	1590	}
1414
1415	*time = sub { AE::time }; # different prototypes
1416	};	1591	};
1417	die if $@;	1592	die if $@;
1418		1593
1419	&time	1594	&time
1420	}	1595	}
1421		1596
1422	*now = \&time;	1597	*now = \&time;
1423
1424	sub now_update { }	1598	sub now_update { }
1425		1599
		1600	sub _poll {
		1601	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1602	}
		1603
1426	# default implementation for ->condvar	1604	# default implementation for ->condvar
		1605	# in fact, the default should not be overwritten
1427		1606
1428	sub condvar {	1607	sub condvar {
1429	eval q{ # poor man's autoloading {}	1608	eval q{ # poor man's autoloading {}
1430	*condvar = sub {	1609	*condvar = sub {
1431	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1610	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1509		1688
1510	sub signal {	1689	sub signal {
1511	eval q{ # poor man's autoloading {}	1690	eval q{ # poor man's autoloading {}
1512	# probe for availability of Async::Interrupt	1691	# probe for availability of Async::Interrupt
1513	if (_have_async_interrupt) {	1692	if (_have_async_interrupt) {
1514	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1693	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1515		1694
1516	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1695	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1517	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1696	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1518		1697
1519	} else {	1698	} else {
1520	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1699	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1521		1700
1522	if (AnyEvent::WIN32) {	1701	if (AnyEvent::WIN32) {
1523	require AnyEvent::Util;	1702	require AnyEvent::Util;
1524		1703
1525	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1704	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1601	: sysread $SIGPIPE_R, (my $dummy), 9;	1780	: sysread $SIGPIPE_R, (my $dummy), 9;
1602		1781
1603	while (%SIG_EV) {	1782	while (%SIG_EV) {
1604	for (keys %SIG_EV) {	1783	for (keys %SIG_EV) {
1605	delete $SIG_EV{$_};	1784	delete $SIG_EV{$_};
1606	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1785	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1607	}	1786	}
1608	}	1787	}
1609	};	1788	};
1610	};	1789	};
1611	die if $@;	1790	die if $@;
…		…
1638	};	1817	};
1639		1818
1640	*child = sub {	1819	*child = sub {
1641	my (undef, %arg) = @_;	1820	my (undef, %arg) = @_;
1642		1821
1643	defined (my $pid = $arg{pid} + 0)	1822	my $pid = $arg{pid};
1644	or Carp::croak "required option 'pid' is missing";	1823	my $cb = $arg{cb};
1645		1824
1646	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1825	$PID_CB{$pid}{$cb+0} = $cb;
1647		1826
1648	unless ($CHLD_W) {	1827	unless ($CHLD_W) {
1649	$CHLD_W = AE::signal CHLD => \&_sigchld;	1828	$CHLD_W = AE::signal CHLD => \&_sigchld;
1650	# child could be a zombie already, so make at least one round	1829	# child could be a zombie already, so make at least one round
1651	&_sigchld;	1830	&_sigchld;
1652	}	1831	}
1653		1832
1654	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1833	bless [$pid, $cb+0], "AnyEvent::Base::child"
1655	};	1834	};
1656		1835
1657	*AnyEvent::Base::child::DESTROY = sub {	1836	*AnyEvent::Base::child::DESTROY = sub {
1658	my ($pid, $cb) = @{$_[0]};	1837	my ($pid, $icb) = @{$_[0]};
1659		1838
1660	delete $PID_CB{$pid}{$cb};	1839	delete $PID_CB{$pid}{$icb};
1661	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1840	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1662		1841
1663	undef $CHLD_W unless keys %PID_CB;	1842	undef $CHLD_W unless keys %PID_CB;
1664	};	1843	};
1665	};	1844	};
…		…
1678		1857
1679	my ($cb, $w, $rcb) = $arg{cb};	1858	my ($cb, $w, $rcb) = $arg{cb};
1680		1859
1681	$rcb = sub {	1860	$rcb = sub {
1682	if ($cb) {	1861	if ($cb) {
1683	$w = _time;	1862	$w = AE::time;
1684	&$cb;	1863	&$cb;
1685	$w = _time - $w;	1864	$w = AE::time - $w;
1686		1865
1687	# never use more then 50% of the time for the idle watcher,	1866	# never use more then 50% of the time for the idle watcher,
1688	# within some limits	1867	# within some limits
1689	$w = 0.0001 if $w < 0.0001;	1868	$w = 0.0001 if $w < 0.0001;
1690	$w = 5 if $w > 5;	1869	$w = 5 if $w > 5;
…		…
1737		1916
1738	sub _send {	1917	sub _send {
1739	# nop	1918	# nop
1740	}	1919	}
1741		1920
		1921	sub _wait {
		1922	AnyEvent->_poll until $_[0]{_ae_sent};
		1923	}
		1924
1742	sub send {	1925	sub send {
1743	my $cv = shift;	1926	my $cv = shift;
1744	$cv->{_ae_sent} = [@_];	1927	$cv->{_ae_sent} = [@_];
1745	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1928	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1746	$cv->_send;	1929	$cv->_send;
…		…
1753		1936
1754	sub ready {	1937	sub ready {
1755	$_[0]{_ae_sent}	1938	$_[0]{_ae_sent}
1756	}	1939	}
1757		1940
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 {	1941	sub recv {
		1942	unless ($_[0]{_ae_sent}) {
		1943	$WAITING
		1944	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1945
		1946	local $WAITING = 1;
1768	$_[0]->_wait;	1947	$_[0]->_wait;
		1948	}
1769		1949
1770	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1950	$_[0]{_ae_croak}
1771	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1951	and Carp::croak $_[0]{_ae_croak};
		1952
		1953	wantarray
		1954	? @{ $_[0]{_ae_sent} }
		1955	: $_[0]{_ae_sent}[0]
1772	}	1956	}
1773		1957
1774	sub cb {	1958	sub cb {
1775	my $cv = shift;	1959	my $cv = shift;
1776		1960
…		…
1792	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1976	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1793	}	1977	}
1794		1978
1795	# undocumented/compatibility with pre-3.4	1979	# undocumented/compatibility with pre-3.4
1796	*broadcast = \&send;	1980	*broadcast = \&send;
1797	*wait = \&_wait;	1981	*wait = \&recv;
1798		1982
1799	=head1 ERROR AND EXCEPTION HANDLING	1983	=head1 ERROR AND EXCEPTION HANDLING
1800		1984
1801	In general, AnyEvent does not do any error handling - it relies on the	1985	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	1986	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	1998	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1815	so on.	1999	so on.
1816		2000
1817	=head1 ENVIRONMENT VARIABLES	2001	=head1 ENVIRONMENT VARIABLES
1818		2002
1819	The following environment variables are used by this module or its	2003	AnyEvent supports a number of environment variables that tune the
1820	submodules.	2004	runtime behaviour. They are usually evaluated when AnyEvent is
		2005	loaded, initialised, or a submodule that uses them is loaded. Many of
		2006	them also cause AnyEvent to load additional modules - for example,
		2007	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2008	loaded.
1821		2009
1822	Note that AnyEvent will remove I<all> environment variables starting with	2010	All the environment variables documented here start with
1823	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2011	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1824	enabled.	2012	namespace. Other modules are encouraged (but by no means required) to use
		2013	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2014	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2015	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2016	variables starting with C<AE_>, see below).
		2017
		2018	All variables can also be set via the C<AE_> prefix, that is, instead
		2019	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2020	case there is a clash btween anyevent and another program that uses
		2021	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2022	variable to the empty string, as those variables take precedence.
		2023
		2024	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2025	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2026	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2027	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2028	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2029	is set).
		2030
		2031	The exact algorithm is currently:
		2032
		2033	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2034	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2035	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2036
		2037	This ensures that child processes will not see the C<AE_> variables.
		2038
		2039	The following environment variables are currently known to AnyEvent:
1825		2040
1826	=over 4	2041	=over 4
1827		2042
1828	=item C<PERL_ANYEVENT_VERBOSE>	2043	=item C<PERL_ANYEVENT_VERBOSE>
1829		2044
1830	By default, AnyEvent will be completely silent except in fatal	2045	By default, AnyEvent will be completely silent except in fatal
1831	conditions. You can set this environment variable to make AnyEvent more	2046	conditions. You can set this environment variable to make AnyEvent more
1832	talkative.	2047	talkative. 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.
1833		2050
1834	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2051	When set to C<5> or higher (warn), causes AnyEvent to warn about unexpected
1835	conditions, such as not being able to load the event model specified by	2052	conditions, such as not being able to load the event model specified by
1836	C<PERL_ANYEVENT_MODEL>.	2053	C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
		2054	is the minimum recommended level.
1837		2055
1838	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2056	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1839	model it chooses.	2057	chooses.
1840		2058
1841	When set to C<8> or higher, then AnyEvent will report extra information on	2059	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.	2060	which optional modules it loads and how it implements certain features.
		2061
		2062	=item C<PERL_ANYEVENT_LOG>
		2063
		2064	Accepts rather complex logging specifications. For example, you could log
		2065	all C<debug> messages of some module to stderr, warnings and above to
		2066	stderr, and errors and above to syslog, with:
		2067
		2068	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2069
		2070	For the rather extensive details, see L<AnyEvent::Log>.
		2071
		2072	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2073	so will take effect even before AnyEvent has initialised itself.
		2074
		2075	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2076	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2077	using the latter saves a few hundred kB of memory until the first message
		2078	is being logged.
1843		2079
1844	=item C<PERL_ANYEVENT_STRICT>	2080	=item C<PERL_ANYEVENT_STRICT>
1845		2081
1846	AnyEvent does not do much argument checking by default, as thorough	2082	AnyEvent does not do much argument checking by default, as thorough
1847	argument checking is very costly. Setting this variable to a true value	2083	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>	2090	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	2091	>>, it is definitely recommended to keep it off in production. Keeping
1856	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2092	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1857	can be very useful, however.	2093	can be very useful, however.
1858		2094
		2095	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2096
		2097	If this env variable is set, then its contents will be interpreted by
		2098	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2099	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2100	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2101
		2102	This happens when the first watcher is created.
		2103
		2104	For example, to bind a debug shell on a unix domain socket in
		2105	F<< /tmp/debug<pid>.sock >>, you could use this:
		2106
		2107	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2108
		2109	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2110	systems.
		2111
		2112	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2113
		2114	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2115	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2116
1859	=item C<PERL_ANYEVENT_MODEL>	2117	=item C<PERL_ANYEVENT_MODEL>
1860		2118
1861	This can be used to specify the event model to be used by AnyEvent, before	2119	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	2120	auto detection and -probing kicks in.
1863	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2121
		2122	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2123	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,	2124	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	2125	event model backend. If it fails to load then AnyEvent will proceed with
1866	auto detection and -probing.	2126	auto detection and -probing.
1867		2127
1868	This functionality might change in future versions.	2128	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2129	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2130	the end of a string designates a module name and quotes it appropriately).
1869		2131
1870	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2132	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1871	could start your program like this:	2133	could start your program like this:
1872		2134
1873	PERL_ANYEVENT_MODEL=Perl perl ...	2135	PERL_ANYEVENT_MODEL=Perl perl ...
1874		2136
1875	=item C<PERL_ANYEVENT_PROTOCOLS>	2137	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1891	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2153	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1892	- only support IPv4, never try to resolve or contact IPv6	2154	- only support IPv4, never try to resolve or contact IPv6
1893	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2155	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1894	IPv6, but prefer IPv6 over IPv4.	2156	IPv6, but prefer IPv6 over IPv4.
1895		2157
		2158	=item C<PERL_ANYEVENT_HOSTS>
		2159
		2160	This variable, if specified, overrides the F</etc/hosts> file used by
		2161	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2162	from that file instead.
		2163
1896	=item C<PERL_ANYEVENT_EDNS0>	2164	=item C<PERL_ANYEVENT_EDNS0>
1897		2165
1898	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2166	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	2167	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	2168	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1901	default.	2169	packets, which is why it is off by default.
1902		2170
1903	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2171	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1904	EDNS0 in its DNS requests.	2172	EDNS0 in its DNS requests.
1905		2173
1906	=item C<PERL_ANYEVENT_MAX_FORKS>	2174	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1914	resolver - this is the maximum number of parallel DNS requests that are	2182	resolver - this is the maximum number of parallel DNS requests that are
1915	sent to the DNS server.	2183	sent to the DNS server.
1916		2184
1917	=item C<PERL_ANYEVENT_RESOLV_CONF>	2185	=item C<PERL_ANYEVENT_RESOLV_CONF>
1918		2186
1919	The file to use instead of F</etc/resolv.conf> (or OS-specific	2187	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	2188	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1921	default config will be used.	2189	resolver, or the empty string to select the default configuration.
1922		2190
1923	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2191	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1924		2192
1925	When neither C<ca_file> nor C<ca_path> was specified during	2193	When neither C<ca_file> nor C<ca_path> was specified during
1926	L<AnyEvent::TLS> context creation, and either of these environment	2194	L<AnyEvent::TLS> context creation, and either of these environment
1927	variables exist, they will be used to specify CA certificate locations	2195	variables are nonempty, they will be used to specify CA certificate
1928	instead of a system-dependent default.	2196	locations instead of a system-dependent default.
1929		2197
1930	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2198	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1931		2199
1932	When these are set to C<1>, then the respective modules are not	2200	When these are set to C<1>, then the respective modules are not
1933	loaded. Mostly good for testing AnyEvent itself.	2201	loaded. Mostly good for testing AnyEvent itself.
…		…
2265	(even when used without AnyEvent), but most event loops have acceptable	2533	(even when used without AnyEvent), but most event loops have acceptable
2266	performance with or without AnyEvent.	2534	performance with or without AnyEvent.
2267		2535
2268	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2536	=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	2537	the actual event loop, only with extremely fast event loops such as EV
2270	adds AnyEvent significant overhead.	2538	does AnyEvent add significant overhead.
2271		2539
2272	=item * You should avoid POE like the plague if you want performance or	2540	=item * You should avoid POE like the plague if you want performance or
2273	reasonable memory usage.	2541	reasonable memory usage.
2274		2542
2275	=back	2543	=back
…		…
2574		2842
2575	=item L<Time::HiRes>	2843	=item L<Time::HiRes>
2576		2844
2577	This module is part of perl since release 5.008. It will be used when the	2845	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	2846	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	2847	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2580	try to use a monotonic clock for timing stability.	2848	try to use a monotonic clock for timing stability.
2581		2849
2582	=back	2850	=back
2583		2851
2584		2852
…		…
2650		2918
2651	Tutorial/Introduction: L<AnyEvent::Intro>.	2919	Tutorial/Introduction: L<AnyEvent::Intro>.
2652		2920
2653	FAQ: L<AnyEvent::FAQ>.	2921	FAQ: L<AnyEvent::FAQ>.
2654		2922
2655	Utility functions: L<AnyEvent::Util>.	2923	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2924	(simply logging).
2656		2925
2657	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2926	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2658	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2927	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2928
		2929	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2930	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2931	L<Qt>, L<POE>, L<FLTK>.
2659		2932
2660	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2933	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2934	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2935	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2936	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2937	L<AnyEvent::Impl::FLTK>.
2664		2938
2665	Non-blocking file handles, sockets, TCP clients and	2939	Non-blocking handles, pipes, stream sockets, TCP clients and
2666	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2940	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2667		2941
2668	Asynchronous DNS: L<AnyEvent::DNS>.	2942	Asynchronous DNS: L<AnyEvent::DNS>.
2669		2943
2670	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	2944	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.344 by root, Wed Dec 29 05:04:52 2010 UTC vs. Revision 1.379 by root, Fri Aug 26 18:09:04 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.344 by root, Wed Dec 29 05:04:52 2010 UTC vs.
Revision 1.379 by root, Fri Aug 26 18:09:04 2011 UTC