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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.332 by root, Tue Aug 31 23:32:40 2010 UTC vs.
Revision 1.376 by root, Thu Aug 25 06:34:11 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
46	in a tutorial or some gentle introduction, have a look at the	46	in a tutorial or some gentle introduction, have a look at the
47	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
48		48
49	=head1 SUPPORT	49	=head1 SUPPORT
50		50
		51	An FAQ document is available as L<AnyEvent::FAQ>.
		52
51	There is a mailinglist for discussing all things AnyEvent, and an IRC	53	There also is a mailinglist for discussing all things AnyEvent, and an IRC
52	channel, too.	54	channel, too.
53		55
54	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	56	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
55	Repository>, at L<http://anyevent.schmorp.de>, for more info.	57	Repository>, at L<http://anyevent.schmorp.de>, for more info.
56		58
…		…
83	that isn't them. What's worse, all the potential users of your	85	that isn't them. What's worse, all the potential users of your
84	module are I<also> forced to use the same event loop you use.	86	module are I<also> forced to use the same event loop you use.
85		87
86	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
87	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	89	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
88	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	90	with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
89	your module uses one of those, every user of your module has to use it,	91	uses one of those, every user of your module has to use it, too. But if
90	too. But if your module uses AnyEvent, it works transparently with all	92	your module uses AnyEvent, it works transparently with all event models it
91	event models it supports (including stuff like IO::Async, as long as those	93	supports (including stuff like IO::Async, as long as those use one of the
92	use one of the supported event loops. It is easy to add new event loops	94	supported event loops. It is easy to add new event loops to AnyEvent, too,
93	to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
94		96
95	In addition to being free of having to use I<the one and only true event	97	In addition to being free of having to use I<the one and only true event
96	model>, AnyEvent also is free of bloat and policy: with POE or similar	98	model>, AnyEvent also is free of bloat and policy: with POE or similar
97	modules, you get an enormous amount of code and strict rules you have to	99	modules, you get an enormous amount of code and strict rules you have to
98	follow. AnyEvent, on the other hand, is lean and to the point, by only	100	follow. AnyEvent, on the other hand, is lean and to the point, by only
…		…
119	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>
120	module.	122	module.
121		123
122	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
123	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
124	following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
125	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
126	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
127	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
128	available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
129	the other two are not normally tried.	131	the other two are not normally tried.
130		132
131	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
132	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
133	that model the default. For example:	135	that model the default. For example:
…		…
140	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
141	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,
142	as very few modules hardcode event loops without announcing this very	144	as very few modules hardcode event loops without announcing this very
143	loudly.	145	loudly.
144		146
145	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
146	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
147	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
148		150
149	=head1 WATCHERS	151	=head1 WATCHERS
150		152
151	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
152	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
…		…
354	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
355	account.	357	account.
356		358
357	=item AnyEvent->now_update	359	=item AnyEvent->now_update
358		360
359	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
360	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 >>,
361	AnyEvent->now >>, above).	363	above).
362		364
363	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
364	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
365	might affect timers and time-outs.	367	might affect timers and time-outs.
366		368
…		…
480	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
481	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
482	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
483		485
484	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
485	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
486	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
487		489
488	Example: fork a process and wait for it	490	Example: fork a process and wait for it
489		491
490	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
491		493
…		…
858	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
859	pure-perl implementation, which is available everywhere as it comes with	861	pure-perl implementation, which is available everywhere as it comes with
860	AnyEvent itself.	862	AnyEvent itself.
861		863
862	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
863	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
864		866
865	=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.
866		868
867	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
868	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
…		…
874	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
875	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
876	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
877	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
878	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.
		882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		883	AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
879		884
880	=item Backends with special needs.	885	=item Backends with special needs.
881		886
882	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
883	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
884	instantiates the application before any AnyEvent watchers are created,	889	instantiates the application before any AnyEvent watchers are created,
885	everything should just work.	890	everything should just work.
886		891
887	AnyEvent::Impl::Qt based on Qt.	892	AnyEvent::Impl::Qt based on Qt.
888
889	Support for IO::Async can only be partial, as it is too broken and
890	architecturally limited to even support the AnyEvent API. It also
891	is the only event loop that needs the loop to be set explicitly, so
892	it can only be used by a main program knowing about AnyEvent. See
893	L<AnyEvent::Impl::IOAsync> for the gory details.
894
895	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
896		893
897	=item Event loops that are indirectly supported via other backends.	894	=item Event loops that are indirectly supported via other backends.
898		895
899	Some event loops can be supported via other modules:	896	Some event loops can be supported via other modules:
900		897
…		…
936		933
937	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
938	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
939	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
940	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).
941		942
942	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
943	created, use C<post_detect>.	944	created, use C<post_detect>.
944		945
945	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1008	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1009	# as soon as it is	1010	# as soon as it is
1010	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1011	}	1012	}
1012		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
1013	=back	1070	=back
1014		1071
1015	=head1 WHAT TO DO IN A MODULE	1072	=head1 WHAT TO DO IN A MODULE
1016		1073
1017	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
…		…
1050	modules might create watchers when they are loaded, and AnyEvent will	1107	modules might create watchers when they are loaded, and AnyEvent will
1051	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
1052	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.
1053		1110
1054	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
1055	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1112	C<AnyEvent::Loop> module, which gives you similar behaviour
1056	everywhere, but letting AnyEvent chose the model is generally better.	1113	everywhere, but letting AnyEvent chose the model is generally better.
1057		1114
1058	=head2 MAINLOOP EMULATION	1115	=head2 MAINLOOP EMULATION
1059		1116
1060	Sometimes (often for short test scripts, or even standalone programs who	1117	Sometimes (often for short test scripts, or even standalone programs who
…		…
1073		1130
1074		1131
1075	=head1 OTHER MODULES	1132	=head1 OTHER MODULES
1076		1133
1077	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
1078	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
1079	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
1080	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 :)
1081		1141
1082	=over 4	1142	=over 4
1083		1143
1084	=item L<AnyEvent::Util>	1144	=item L<AnyEvent::Util>
1085		1145
…		…
1155		1215
1156	package AnyEvent;	1216	package AnyEvent;
1157		1217
1158	# basically a tuned-down version of common::sense	1218	# basically a tuned-down version of common::sense
1159	sub common_sense {	1219	sub common_sense {
1160	# from common:.sense 3.3	1220	# from common:.sense 3.4
1161	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00";	1221	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1162	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)	1222	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1163	$^H \|= 0x00000600;	1223	$^H \|= 0x00000600;
1164	}	1224	}
1165		1225
1166	BEGIN { AnyEvent::common_sense }	1226	BEGIN { AnyEvent::common_sense }
1167		1227
1168	use Carp ();	1228	use Carp ();
1169		1229
1170	our $VERSION = '5.271';	1230	our $VERSION = '6.01';
1171	our $MODEL;	1231	our $MODEL;
1172		1232
1173	our $AUTOLOAD;
1174	our @ISA;	1233	our @ISA;
1175		1234
1176	our @REGISTRY;	1235	our @REGISTRY;
1177		1236
1178	our $VERBOSE;	1237	our $VERBOSE;
…		…
1183	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1242	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1184		1243
1185	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1244	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1186	if ${^TAINT};	1245	if ${^TAINT};
1187		1246
		1247	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1248	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
		1249
		1250	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1251	if ${^TAINT};
		1252
1188	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1253	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1189
1190	}	1254	}
1191		1255
1192	our $MAX_SIGNAL_LATENCY = 10;	1256	our $MAX_SIGNAL_LATENCY = 10;
1193		1257
1194	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1258	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
1198	$PROTOCOL{$_} = ++$idx	1262	$PROTOCOL{$_} = ++$idx
1199	for reverse split /\s,\s/,	1263	for reverse split /\s,\s/,
1200	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1264	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1201	}	1265	}
1202		1266
		1267	our @post_detect;
		1268
		1269	sub post_detect(&) {
		1270	my ($cb) = @_;
		1271
		1272	push @post_detect, $cb;
		1273
		1274	defined wantarray
		1275	? bless \$cb, "AnyEvent::Util::postdetect"
		1276	: ()
		1277	}
		1278
		1279	sub AnyEvent::Util::postdetect::DESTROY {
		1280	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1281	}
		1282
		1283	our $POSTPONE_W;
		1284	our @POSTPONE;
		1285
		1286	sub _postpone_exec {
		1287	undef $POSTPONE_W;
		1288
		1289	&{ shift @POSTPONE }
		1290	while @POSTPONE;
		1291	}
		1292
		1293	sub postpone(&) {
		1294	push @POSTPONE, shift;
		1295
		1296	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1297
		1298	()
		1299	}
		1300
		1301	sub log($$;@) {
		1302	# only load the big bloated module when we actually are about to log something
		1303	if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
		1304	require AnyEvent::Log;
		1305	# AnyEvent::Log overwrites this function
		1306	goto &log;
		1307	}
		1308
		1309	0 # not logged
		1310	}
		1311
		1312	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1313	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1314	}
		1315
1203	my @models = (	1316	our @models = (
1204	[EV:: => AnyEvent::Impl::EV:: , 1],	1317	[EV:: => AnyEvent::Impl::EV:: , 1],
1205	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1318	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1206	# everything below here will not (normally) be autoprobed	1319	# everything below here will not (normally) be autoprobed
1207	# as the pureperl backend should work everywhere	1320	# as the pure perl backend should work everywhere
1208	# and is usually faster	1321	# and is usually faster
1209	[Event:: => AnyEvent::Impl::Event::, 1],	1322	[Event:: => AnyEvent::Impl::Event::, 1],
1210	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1323	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1211	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1324	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1212	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1325	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1213	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1326	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1214	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1327	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1215	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1328	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1216	[Wx:: => AnyEvent::Impl::POE::],	1329	[Wx:: => AnyEvent::Impl::POE::],
1217	[Prima:: => AnyEvent::Impl::POE::],	1330	[Prima:: => AnyEvent::Impl::POE::],
1218	# IO::Async is just too broken - we would need workarounds for its	1331	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1219	# byzantine signal and broken child handling, among others.	1332	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1220	# IO::Async is rather hard to detect, as it doesn't have any	1333	[FLTK:: => AnyEvent::Impl::FLTK2::],
1221	# obvious default class.
1222	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1223	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1224	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1225	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1226	);	1334	);
1227		1335
1228	our %method = map +($_ => 1),	1336	our @isa_hook;
		1337
		1338	sub _isa_set {
		1339	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1340
		1341	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1342	for 1 .. $#pkg;
		1343
		1344	grep $_ && $_->[1], @isa_hook
		1345	and AE::_reset ();
		1346	}
		1347
		1348	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1349	sub _isa_hook($$;$) {
		1350	my ($i, $pkg, $reset_ae) = @_;
		1351
		1352	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1353
		1354	_isa_set;
		1355	}
		1356
		1357	# all autoloaded methods reserve the complete glob, not just the method slot.
		1358	# due to bugs in perls method cache implementation.
1229	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1359	our @methods = qw(io timer time now now_update signal child idle condvar);
1230
1231	our @post_detect;
1232
1233	sub post_detect(&) {
1234	my ($cb) = @_;
1235
1236	push @post_detect, $cb;
1237
1238	defined wantarray
1239	? bless \$cb, "AnyEvent::Util::postdetect"
1240	: ()
1241	}
1242
1243	sub AnyEvent::Util::postdetect::DESTROY {
1244	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1245	}
1246		1360
1247	sub detect() {	1361	sub detect() {
		1362	return $MODEL if $MODEL; # some programs keep references to detect
		1363
		1364	local $!; # for good measure
		1365	local $SIG{__DIE__}; # we use eval
		1366
1248	# free some memory	1367	# free some memory
1249	*detect = sub () { $MODEL };	1368	*detect = sub () { $MODEL };
		1369	# undef &func doesn't correctly update the method cache. grmbl.
		1370	# so we delete the whole glob. grmbl.
		1371	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1372	# a glob with an active sub. hrm. i hope it works, but perl is
		1373	# usually buggy in this department. sigh.
		1374	delete @{"AnyEvent::"}{@methods};
		1375	undef @methods;
1250		1376
1251	local $!; # for good measure
1252	local $SIG{__DIE__};
1253
1254	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1377	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1255	my $model = "AnyEvent::Impl::$1";	1378	my $model = $1;
		1379	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1256	if (eval "require $model") {	1380	if (eval "require $model") {
		1381	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1257	$MODEL = $model;	1382	$MODEL = $model;
1258	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1259	} else {	1383	} else {
1260	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1384	AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1261	}	1385	}
1262	}	1386	}
1263		1387
1264	# check for already loaded models	1388	# check for already loaded models
1265	unless ($MODEL) {	1389	unless ($MODEL) {
1266	for (@REGISTRY, @models) {	1390	for (@REGISTRY, @models) {
1267	my ($package, $model) = @$_;	1391	my ($package, $model) = @$_;
1268	if (${"$package\::VERSION"} > 0) {	1392	if (${"$package\::VERSION"} > 0) {
1269	if (eval "require $model") {	1393	if (eval "require $model") {
		1394	AnyEvent::log 7 => "autodetected model '$model', using it.";
1270	$MODEL = $model;	1395	$MODEL = $model;
1271	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1272	last;	1396	last;
1273	}	1397	}
1274	}	1398	}
1275	}	1399	}
1276		1400
…		…
1282	$autoload	1406	$autoload
1283	and eval "require $package"	1407	and eval "require $package"
1284	and ${"$package\::VERSION"} > 0	1408	and ${"$package\::VERSION"} > 0
1285	and eval "require $model"	1409	and eval "require $model"
1286	) {	1410	) {
		1411	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1287	$MODEL = $model;	1412	$MODEL = $model;
1288	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1289	last;	1413	last;
1290	}	1414	}
1291	}	1415	}
1292		1416
1293	$MODEL	1417	$MODEL
1294	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1418	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1295	}	1419	}
1296	}	1420	}
1297		1421
1298	@models = (); # free probe data	1422	# free memory only needed for probing
		1423	undef @models;
		1424	undef @REGISTRY;
1299		1425
1300	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1426	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1301	unshift @ISA, $MODEL;
1302		1427
1303	# now nuke some methods that are overriden by the backend.	1428	# now nuke some methods that are overridden by the backend.
1304	# SUPER is not allowed.	1429	# SUPER usage is not allowed in these.
1305	for (qw(time signal child idle)) {	1430	for (qw(time signal child idle)) {
1306	undef &{"AnyEvent::Base::$_"}	1431	undef &{"AnyEvent::Base::$_"}
1307	if defined &{"$MODEL\::$_"};	1432	if defined &{"$MODEL\::$_"};
1308	}	1433	}
1309		1434
1310	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1435	_isa_set;
		1436
		1437	# we're officially open!
		1438
		1439	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1440	require AnyEvent::Strict;
		1441	}
		1442
		1443	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1444	require AnyEvent::Debug;
		1445	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1446	}
		1447
		1448	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1449	require AnyEvent::Socket;
		1450	require AnyEvent::Debug;
		1451
		1452	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1453	$shell =~ s/\$\$/$$/g;
		1454
		1455	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1456	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1457	}
		1458
		1459	# now the anyevent environment is set up as the user told us to, so
		1460	# call the actual user code - post detects
1311		1461
1312	(shift @post_detect)->() while @post_detect;	1462	(shift @post_detect)->() while @post_detect;
		1463	undef @post_detect;
1313		1464
1314	*post_detect = sub(&) {	1465	*post_detect = sub(&) {
1315	shift->();	1466	shift->();
1316		1467
1317	undef	1468	undef
1318	};	1469	};
1319		1470
1320	$MODEL	1471	$MODEL
1321	}	1472	}
1322		1473
1323	sub AUTOLOAD {	1474	for my $name (@methods) {
1324	(my $func = $AUTOLOAD) =~ s/.*://;	1475	*$name = sub {
1325
1326	$method{$func}
1327	or Carp::croak "$func: not a valid AnyEvent class method";
1328
1329	detect;	1476	detect;
1330		1477	# we use goto because
1331	my $class = shift;	1478	# a) it makes the thunk more transparent
1332	$class->$func (@_);	1479	# b) it allows us to delete the thunk later
		1480	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1481	};
1333	}	1482	}
1334		1483
1335	# utility function to dup a filehandle. this is used by many backends	1484	# utility function to dup a filehandle. this is used by many backends
1336	# to support binding more than one watcher per filehandle (they usually	1485	# to support binding more than one watcher per filehandle (they usually
1337	# allow only one watcher per fd, so we dup it to get a different one).	1486	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1361		1510
1362	package AE;	1511	package AE;
1363		1512
1364	our $VERSION = $AnyEvent::VERSION;	1513	our $VERSION = $AnyEvent::VERSION;
1365		1514
		1515	sub _reset() {
		1516	eval q{
1366	# fall back to the main API by default - backends and AnyEvent::Base	1517	# fall back to the main API by default - backends and AnyEvent::Base
1367	# implementations can overwrite these.	1518	# implementations can overwrite these.
1368		1519
1369	sub io($$$) {	1520	sub io($$$) {
1370	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1521	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1371	}	1522	}
1372		1523
1373	sub timer($$$) {	1524	sub timer($$$) {
1374	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1525	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1375	}	1526	}
1376		1527
1377	sub signal($$) {	1528	sub signal($$) {
1378	AnyEvent->signal (signal => $_[0], cb => $_[1])	1529	AnyEvent->signal (signal => $_[0], cb => $_[1])
1379	}	1530	}
1380		1531
1381	sub child($$) {	1532	sub child($$) {
1382	AnyEvent->child (pid => $_[0], cb => $_[1])	1533	AnyEvent->child (pid => $_[0], cb => $_[1])
1383	}	1534	}
1384		1535
1385	sub idle($) {	1536	sub idle($) {
1386	AnyEvent->idle (cb => $_[0])	1537	AnyEvent->idle (cb => $_[0]);
1387	}	1538	}
1388		1539
1389	sub cv(;&) {	1540	sub cv(;&) {
1390	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1541	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1391	}	1542	}
1392		1543
1393	sub now() {	1544	sub now() {
1394	AnyEvent->now	1545	AnyEvent->now
1395	}	1546	}
1396		1547
1397	sub now_update() {	1548	sub now_update() {
1398	AnyEvent->now_update	1549	AnyEvent->now_update
1399	}	1550	}
1400		1551
1401	sub time() {	1552	sub time() {
1402	AnyEvent->time	1553	AnyEvent->time
		1554	}
		1555
		1556	*postpone = \&AnyEvent::postpone;
		1557	*log = \&AnyEvent::log;
		1558	};
		1559	die if $@;
1403	}	1560	}
		1561
		1562	BEGIN { _reset }
1404		1563
1405	package AnyEvent::Base;	1564	package AnyEvent::Base;
1406		1565
1407	# default implementations for many methods	1566	# default implementations for many methods
1408		1567
1409	sub time {	1568	sub time {
1410	eval q{ # poor man's autoloading {}	1569	eval q{ # poor man's autoloading {}
1411	# probe for availability of Time::HiRes	1570	# probe for availability of Time::HiRes
1412	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1571	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1413	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1572	*time = sub { Time::HiRes::time () };
1414	*AE::time = \&Time::HiRes::time;	1573	*AE::time = \& Time::HiRes::time ;
		1574	*now = \&time;
		1575	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1415	# if (eval "use POSIX (); (POSIX::times())...	1576	# if (eval "use POSIX (); (POSIX::times())...
1416	} else {	1577	} else {
		1578	*time = sub { CORE::time };
		1579	*AE::time = sub (){ CORE::time };
		1580	*now = \&time;
1417	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1581	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1418	*AE::time = sub (){ time }; # epic fail
1419	}	1582	}
1420
1421	*time = sub { AE::time }; # different prototypes
1422	};	1583	};
1423	die if $@;	1584	die if $@;
1424		1585
1425	&time	1586	&time
1426	}	1587	}
1427		1588
1428	*now = \&time;	1589	*now = \&time;
1429
1430	sub now_update { }	1590	sub now_update { }
1431		1591
		1592	sub _poll {
		1593	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1594	}
		1595
1432	# default implementation for ->condvar	1596	# default implementation for ->condvar
		1597	# in fact, the default should not be overwritten
1433		1598
1434	sub condvar {	1599	sub condvar {
1435	eval q{ # poor man's autoloading {}	1600	eval q{ # poor man's autoloading {}
1436	*condvar = sub {	1601	*condvar = sub {
1437	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1602	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1515		1680
1516	sub signal {	1681	sub signal {
1517	eval q{ # poor man's autoloading {}	1682	eval q{ # poor man's autoloading {}
1518	# probe for availability of Async::Interrupt	1683	# probe for availability of Async::Interrupt
1519	if (_have_async_interrupt) {	1684	if (_have_async_interrupt) {
1520	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1685	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1521		1686
1522	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1687	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1523	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1688	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1524		1689
1525	} else {	1690	} else {
1526	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1691	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1527		1692
1528	if (AnyEvent::WIN32) {	1693	if (AnyEvent::WIN32) {
1529	require AnyEvent::Util;	1694	require AnyEvent::Util;
1530		1695
1531	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1696	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1607	: sysread $SIGPIPE_R, (my $dummy), 9;	1772	: sysread $SIGPIPE_R, (my $dummy), 9;
1608		1773
1609	while (%SIG_EV) {	1774	while (%SIG_EV) {
1610	for (keys %SIG_EV) {	1775	for (keys %SIG_EV) {
1611	delete $SIG_EV{$_};	1776	delete $SIG_EV{$_};
1612	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1777	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1613	}	1778	}
1614	}	1779	}
1615	};	1780	};
1616	};	1781	};
1617	die if $@;	1782	die if $@;
…		…
1622	# default implementation for ->child	1787	# default implementation for ->child
1623		1788
1624	our %PID_CB;	1789	our %PID_CB;
1625	our $CHLD_W;	1790	our $CHLD_W;
1626	our $CHLD_DELAY_W;	1791	our $CHLD_DELAY_W;
1627	our $WNOHANG;
1628		1792
1629	# used by many Impl's	1793	# used by many Impl's
1630	sub _emit_childstatus($$) {	1794	sub _emit_childstatus($$) {
1631	my (undef, $rpid, $rstatus) = @_;	1795	my (undef, $rpid, $rstatus) = @_;
1632		1796
…		…
1639	eval q{ # poor man's autoloading {}	1803	eval q{ # poor man's autoloading {}
1640	*_sigchld = sub {	1804	*_sigchld = sub {
1641	my $pid;	1805	my $pid;
1642		1806
1643	AnyEvent->_emit_childstatus ($pid, $?)	1807	AnyEvent->_emit_childstatus ($pid, $?)
1644	while ($pid = waitpid -1, $WNOHANG) > 0;	1808	while ($pid = waitpid -1, WNOHANG) > 0;
1645	};	1809	};
1646		1810
1647	*child = sub {	1811	*child = sub {
1648	my (undef, %arg) = @_;	1812	my (undef, %arg) = @_;
1649		1813
1650	defined (my $pid = $arg{pid} + 0)	1814	my $pid = $arg{pid};
1651	or Carp::croak "required option 'pid' is missing";	1815	my $cb = $arg{cb};
1652		1816
1653	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1817	$PID_CB{$pid}{$cb+0} = $cb;
1654
1655	# WNOHANG is almost cetrainly 1 everywhere
1656	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1657	? 1
1658	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1659		1818
1660	unless ($CHLD_W) {	1819	unless ($CHLD_W) {
1661	$CHLD_W = AE::signal CHLD => \&_sigchld;	1820	$CHLD_W = AE::signal CHLD => \&_sigchld;
1662	# child could be a zombie already, so make at least one round	1821	# child could be a zombie already, so make at least one round
1663	&_sigchld;	1822	&_sigchld;
1664	}	1823	}
1665		1824
1666	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1825	bless [$pid, $cb+0], "AnyEvent::Base::child"
1667	};	1826	};
1668		1827
1669	*AnyEvent::Base::child::DESTROY = sub {	1828	*AnyEvent::Base::child::DESTROY = sub {
1670	my ($pid, $cb) = @{$_[0]};	1829	my ($pid, $icb) = @{$_[0]};
1671		1830
1672	delete $PID_CB{$pid}{$cb};	1831	delete $PID_CB{$pid}{$icb};
1673	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1832	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1674		1833
1675	undef $CHLD_W unless keys %PID_CB;	1834	undef $CHLD_W unless keys %PID_CB;
1676	};	1835	};
1677	};	1836	};
…		…
1690		1849
1691	my ($cb, $w, $rcb) = $arg{cb};	1850	my ($cb, $w, $rcb) = $arg{cb};
1692		1851
1693	$rcb = sub {	1852	$rcb = sub {
1694	if ($cb) {	1853	if ($cb) {
1695	$w = _time;	1854	$w = AE::time;
1696	&$cb;	1855	&$cb;
1697	$w = _time - $w;	1856	$w = AE::time - $w;
1698		1857
1699	# never use more then 50% of the time for the idle watcher,	1858	# never use more then 50% of the time for the idle watcher,
1700	# within some limits	1859	# within some limits
1701	$w = 0.0001 if $w < 0.0001;	1860	$w = 0.0001 if $w < 0.0001;
1702	$w = 5 if $w > 5;	1861	$w = 5 if $w > 5;
…		…
1725		1884
1726	package AnyEvent::CondVar;	1885	package AnyEvent::CondVar;
1727		1886
1728	our @ISA = AnyEvent::CondVar::Base::;	1887	our @ISA = AnyEvent::CondVar::Base::;
1729		1888
		1889	# only to be used for subclassing
		1890	sub new {
		1891	my $class = shift;
		1892	bless AnyEvent->condvar (@_), $class
		1893	}
		1894
1730	package AnyEvent::CondVar::Base;	1895	package AnyEvent::CondVar::Base;
1731		1896
1732	#use overload	1897	#use overload
1733	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1898	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1734	# fallback => 1;	1899	# fallback => 1;
…		…
1743		1908
1744	sub _send {	1909	sub _send {
1745	# nop	1910	# nop
1746	}	1911	}
1747		1912
		1913	sub _wait {
		1914	AnyEvent->_poll until $_[0]{_ae_sent};
		1915	}
		1916
1748	sub send {	1917	sub send {
1749	my $cv = shift;	1918	my $cv = shift;
1750	$cv->{_ae_sent} = [@_];	1919	$cv->{_ae_sent} = [@_];
1751	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1920	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1752	$cv->_send;	1921	$cv->_send;
…		…
1759		1928
1760	sub ready {	1929	sub ready {
1761	$_[0]{_ae_sent}	1930	$_[0]{_ae_sent}
1762	}	1931	}
1763		1932
1764	sub _wait {
1765	$WAITING
1766	and !$_[0]{_ae_sent}
1767	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1768
1769	local $WAITING = 1;
1770	AnyEvent->one_event while !$_[0]{_ae_sent};
1771	}
1772
1773	sub recv {	1933	sub recv {
		1934	unless ($_[0]{_ae_sent}) {
		1935	$WAITING
		1936	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1937
		1938	local $WAITING = 1;
1774	$_[0]->_wait;	1939	$_[0]->_wait;
		1940	}
1775		1941
1776	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1942	$_[0]{_ae_croak}
1777	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1943	and Carp::croak $_[0]{_ae_croak};
		1944
		1945	wantarray
		1946	? @{ $_[0]{_ae_sent} }
		1947	: $_[0]{_ae_sent}[0]
1778	}	1948	}
1779		1949
1780	sub cb {	1950	sub cb {
1781	my $cv = shift;	1951	my $cv = shift;
1782		1952
…		…
1798	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1968	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1799	}	1969	}
1800		1970
1801	# undocumented/compatibility with pre-3.4	1971	# undocumented/compatibility with pre-3.4
1802	*broadcast = \&send;	1972	*broadcast = \&send;
1803	*wait = \&_wait;	1973	*wait = \&recv;
1804		1974
1805	=head1 ERROR AND EXCEPTION HANDLING	1975	=head1 ERROR AND EXCEPTION HANDLING
1806		1976
1807	In general, AnyEvent does not do any error handling - it relies on the	1977	In general, AnyEvent does not do any error handling - it relies on the
1808	caller to do that if required. The L<AnyEvent::Strict> module (see also	1978	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1820	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	1990	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1821	so on.	1991	so on.
1822		1992
1823	=head1 ENVIRONMENT VARIABLES	1993	=head1 ENVIRONMENT VARIABLES
1824		1994
1825	The following environment variables are used by this module or its	1995	AnyEvent supports a number of environment variables that tune the
1826	submodules.	1996	runtime behaviour. They are usually evaluated when AnyEvent is
		1997	loaded, initialised, or a submodule that uses them is loaded. Many of
		1998	them also cause AnyEvent to load additional modules - for example,
		1999	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2000	loaded.
1827		2001
1828	Note that AnyEvent will remove I<all> environment variables starting with	2002	All the environment variables documented here start with
1829	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2003	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1830	enabled.	2004	namespace. Other modules are encouraged (but by no means required) to use
		2005	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2006	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2007	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2008	variables starting with C<AE_>, see below).
		2009
		2010	All variables can also be set via the C<AE_> prefix, that is, instead
		2011	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2012	case there is a clash btween anyevent and another program that uses
		2013	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2014	variable to the empty string, as those variables take precedence.
		2015
		2016	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2017	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2018	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2019	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2020	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2021	is set).
		2022
		2023	The exact algorithm is currently:
		2024
		2025	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2026	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2027	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2028
		2029	This ensures that child processes will not see the C<AE_> variables.
		2030
		2031	The following environment variables are currently known to AnyEvent:
1831		2032
1832	=over 4	2033	=over 4
1833		2034
1834	=item C<PERL_ANYEVENT_VERBOSE>	2035	=item C<PERL_ANYEVENT_VERBOSE>
1835		2036
1836	By default, AnyEvent will be completely silent except in fatal	2037	By default, AnyEvent will be completely silent except in fatal
1837	conditions. You can set this environment variable to make AnyEvent more	2038	conditions. You can set this environment variable to make AnyEvent more
1838	talkative.	2039	talkative. If you want to do more than just set the global logging level
		2040	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2041	complex specifications.
1839		2042
1840	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2043	When set to C<5> or higher (warn), causes AnyEvent to warn about unexpected
1841	conditions, such as not being able to load the event model specified by	2044	conditions, such as not being able to load the event model specified by
1842	C<PERL_ANYEVENT_MODEL>.	2045	C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
		2046	is the minimum recommended level.
1843		2047
1844	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2048	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1845	model it chooses.	2049	chooses.
1846		2050
1847	When set to C<8> or higher, then AnyEvent will report extra information on	2051	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1848	which optional modules it loads and how it implements certain features.	2052	which optional modules it loads and how it implements certain features.
		2053
		2054	=item C<PERL_ANYEVENT_LOG>
		2055
		2056	Accepts rather complex logging specifications. For example, you could log
		2057	all C<debug> messages of some module to stderr, warnings and above to
		2058	stderr, and errors and above to syslog, with:
		2059
		2060	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2061
		2062	For the rather extensive details, see L<AnyEvent::Log>.
		2063
		2064	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2065	so will take effect even before AnyEvent has initialised itself.
		2066
		2067	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2068	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2069	using the latter saves a few hundred kB of memory until the first message
		2070	is being logged.
1849		2071
1850	=item C<PERL_ANYEVENT_STRICT>	2072	=item C<PERL_ANYEVENT_STRICT>
1851		2073
1852	AnyEvent does not do much argument checking by default, as thorough	2074	AnyEvent does not do much argument checking by default, as thorough
1853	argument checking is very costly. Setting this variable to a true value	2075	argument checking is very costly. Setting this variable to a true value
…		…
1860	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2082	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1861	>>, it is definitely recommended to keep it off in production. Keeping	2083	>>, it is definitely recommended to keep it off in production. Keeping
1862	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2084	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1863	can be very useful, however.	2085	can be very useful, however.
1864		2086
		2087	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2088
		2089	If this env variable is set, then its contents will be interpreted by
		2090	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2091	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2092	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2093
		2094	This happens when the first watcher is created.
		2095
		2096	For example, to bind a debug shell on a unix domain socket in
		2097	F<< /tmp/debug<pid>.sock >>, you could use this:
		2098
		2099	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2100
		2101	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2102	systems.
		2103
		2104	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2105
		2106	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2107	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2108
1865	=item C<PERL_ANYEVENT_MODEL>	2109	=item C<PERL_ANYEVENT_MODEL>
1866		2110
1867	This can be used to specify the event model to be used by AnyEvent, before	2111	This can be used to specify the event model to be used by AnyEvent, before
1868	auto detection and -probing kicks in. It must be a string consisting	2112	auto detection and -probing kicks in.
1869	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2113
		2114	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2115	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1870	and the resulting module name is loaded and if the load was successful,	2116	resulting module name is loaded and - if the load was successful - used as
1871	used as event model. If it fails to load AnyEvent will proceed with	2117	event model backend. If it fails to load then AnyEvent will proceed with
1872	auto detection and -probing.	2118	auto detection and -probing.
1873		2119
1874	This functionality might change in future versions.	2120	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2121	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2122	the end of a string designates a module name and quotes it appropriately).
1875		2123
1876	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2124	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1877	could start your program like this:	2125	could start your program like this:
1878		2126
1879	PERL_ANYEVENT_MODEL=Perl perl ...	2127	PERL_ANYEVENT_MODEL=Perl perl ...
1880		2128
1881	=item C<PERL_ANYEVENT_PROTOCOLS>	2129	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1897	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2145	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1898	- only support IPv4, never try to resolve or contact IPv6	2146	- only support IPv4, never try to resolve or contact IPv6
1899	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2147	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1900	IPv6, but prefer IPv6 over IPv4.	2148	IPv6, but prefer IPv6 over IPv4.
1901		2149
		2150	=item C<PERL_ANYEVENT_HOSTS>
		2151
		2152	This variable, if specified, overrides the F</etc/hosts> file used by
		2153	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2154	from that file instead.
		2155
1902	=item C<PERL_ANYEVENT_EDNS0>	2156	=item C<PERL_ANYEVENT_EDNS0>
1903		2157
1904	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2158	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1905	for DNS. This extension is generally useful to reduce DNS traffic, but	2159	DNS. This extension is generally useful to reduce DNS traffic, especially
1906	some (broken) firewalls drop such DNS packets, which is why it is off by	2160	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1907	default.	2161	packets, which is why it is off by default.
1908		2162
1909	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2163	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1910	EDNS0 in its DNS requests.	2164	EDNS0 in its DNS requests.
1911		2165
1912	=item C<PERL_ANYEVENT_MAX_FORKS>	2166	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1920	resolver - this is the maximum number of parallel DNS requests that are	2174	resolver - this is the maximum number of parallel DNS requests that are
1921	sent to the DNS server.	2175	sent to the DNS server.
1922		2176
1923	=item C<PERL_ANYEVENT_RESOLV_CONF>	2177	=item C<PERL_ANYEVENT_RESOLV_CONF>
1924		2178
1925	The file to use instead of F</etc/resolv.conf> (or OS-specific	2179	The absolute path to a F<resolv.conf>-style file to use instead of
1926	configuration) in the default resolver. When set to the empty string, no	2180	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1927	default config will be used.	2181	resolver, or the empty string to select the default configuration.
1928		2182
1929	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2183	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1930		2184
1931	When neither C<ca_file> nor C<ca_path> was specified during	2185	When neither C<ca_file> nor C<ca_path> was specified during
1932	L<AnyEvent::TLS> context creation, and either of these environment	2186	L<AnyEvent::TLS> context creation, and either of these environment
1933	variables exist, they will be used to specify CA certificate locations	2187	variables are nonempty, they will be used to specify CA certificate
1934	instead of a system-dependent default.	2188	locations instead of a system-dependent default.
1935		2189
1936	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2190	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1937		2191
1938	When these are set to C<1>, then the respective modules are not	2192	When these are set to C<1>, then the respective modules are not
1939	loaded. Mostly good for testing AnyEvent itself.	2193	loaded. Mostly good for testing AnyEvent itself.
…		…
2271	(even when used without AnyEvent), but most event loops have acceptable	2525	(even when used without AnyEvent), but most event loops have acceptable
2272	performance with or without AnyEvent.	2526	performance with or without AnyEvent.
2273		2527
2274	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2528	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2275	the actual event loop, only with extremely fast event loops such as EV	2529	the actual event loop, only with extremely fast event loops such as EV
2276	adds AnyEvent significant overhead.	2530	does AnyEvent add significant overhead.
2277		2531
2278	=item * You should avoid POE like the plague if you want performance or	2532	=item * You should avoid POE like the plague if you want performance or
2279	reasonable memory usage.	2533	reasonable memory usage.
2280		2534
2281	=back	2535	=back
…		…
2580		2834
2581	=item L<Time::HiRes>	2835	=item L<Time::HiRes>
2582		2836
2583	This module is part of perl since release 5.008. It will be used when the	2837	This module is part of perl since release 5.008. It will be used when the
2584	chosen event library does not come with a timing source of its own. The	2838	chosen event library does not come with a timing source of its own. The
2585	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2839	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2586	try to use a monotonic clock for timing stability.	2840	try to use a monotonic clock for timing stability.
2587		2841
2588	=back	2842	=back
2589		2843
2590		2844
…		…
2652	pronounced).	2906	pronounced).
2653		2907
2654		2908
2655	=head1 SEE ALSO	2909	=head1 SEE ALSO
2656		2910
2657	Utility functions: L<AnyEvent::Util>.	2911	Tutorial/Introduction: L<AnyEvent::Intro>.
2658		2912
2659	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2913	FAQ: L<AnyEvent::FAQ>.
2660	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2914
		2915	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2916	(simply logging).
		2917
		2918	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2919	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2920
		2921	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2922	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2923	L<Qt>, L<POE>, L<FLTK>.
2661		2924
2662	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2925	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2663	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2926	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2664	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2927	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2665	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2928	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2929	L<AnyEvent::Impl::FLTK>.
2666		2930
2667	Non-blocking file handles, sockets, TCP clients and	2931	Non-blocking handles, pipes, stream sockets, TCP clients and
2668	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2932	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2669		2933
2670	Asynchronous DNS: L<AnyEvent::DNS>.	2934	Asynchronous DNS: L<AnyEvent::DNS>.
2671		2935
2672	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2936	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2673	L<Coro::Event>,
2674		2937
2675	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2938	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2676	L<AnyEvent::HTTP>.	2939	L<AnyEvent::HTTP>.
2677		2940
2678		2941
2679	=head1 AUTHOR	2942	=head1 AUTHOR
2680		2943

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.332 by root, Tue Aug 31 23:32:40 2010 UTC vs. Revision 1.376 by root, Thu Aug 25 06:34:11 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.332 by root, Tue Aug 31 23:32:40 2010 UTC vs.
Revision 1.376 by root, Thu Aug 25 06:34:11 2011 UTC