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

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

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.345 by root, Fri Dec 31 04:50:44 2010 UTC vs.
Revision 1.380 by root, Thu Sep 1 04:07:18 2011 UTC