[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.373 by root, Thu Aug 25 03:08:48 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	Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> -
		1059	consequently, look at the L<AnyEvent::Log> documentation for details.
		1060
		1061	If you want to sprinkle loads of logging calls around your code, consider
		1062	creating a logger callback with the C<AnyEvent::Log::logger> function.
		1063
1013	=back	1064	=back
1014		1065
1015	=head1 WHAT TO DO IN A MODULE	1066	=head1 WHAT TO DO IN A MODULE
1016		1067
1017	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1068	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	1101	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	1102	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.	1103	might choose the wrong one unless you load the correct one yourself.
1053		1104
1054	You can chose to use a pure-perl implementation by loading the	1105	You can chose to use a pure-perl implementation by loading the
1055	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1106	C<AnyEvent::Loop> module, which gives you similar behaviour
1056	everywhere, but letting AnyEvent chose the model is generally better.	1107	everywhere, but letting AnyEvent chose the model is generally better.
1057		1108
1058	=head2 MAINLOOP EMULATION	1109	=head2 MAINLOOP EMULATION
1059		1110
1060	Sometimes (often for short test scripts, or even standalone programs who	1111	Sometimes (often for short test scripts, or even standalone programs who
…		…
1073		1124
1074		1125
1075	=head1 OTHER MODULES	1126	=head1 OTHER MODULES
1076		1127
1077	The following is a non-exhaustive list of additional modules that use	1128	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	1129	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	1130	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.	1131	modules come as part of AnyEvent, the others are available via CPAN (see
		1132	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1133	a longer non-exhaustive list), and the list is heavily biased towards
		1134	modules of the AnyEvent author himself :)
1081		1135
1082	=over 4	1136	=over 4
1083		1137
1084	=item L<AnyEvent::Util>	1138	=item L<AnyEvent::Util>
1085		1139
…		…
1155		1209
1156	package AnyEvent;	1210	package AnyEvent;
1157		1211
1158	# basically a tuned-down version of common::sense	1212	# basically a tuned-down version of common::sense
1159	sub common_sense {	1213	sub common_sense {
1160	# from common:.sense 3.3	1214	# from common:.sense 3.4
1161	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00";	1215	${^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)	1216	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1163	$^H \|= 0x00000600;	1217	$^H \|= 0x00000600;
1164	}	1218	}
1165		1219
1166	BEGIN { AnyEvent::common_sense }	1220	BEGIN { AnyEvent::common_sense }
1167		1221
1168	use Carp ();	1222	use Carp ();
1169		1223
1170	our $VERSION = '5.271';	1224	our $VERSION = '6.01';
1171	our $MODEL;	1225	our $MODEL;
1172		1226
1173	our $AUTOLOAD;
1174	our @ISA;	1227	our @ISA;
1175		1228
1176	our @REGISTRY;	1229	our @REGISTRY;
1177		1230
1178	our $VERBOSE;	1231	our $VERBOSE;
…		…
1183	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1236	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1184		1237
1185	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1238	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1186	if ${^TAINT};	1239	if ${^TAINT};
1187		1240
		1241	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1242	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
		1243
		1244	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1245	if ${^TAINT};
		1246
1188	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1247	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1189
1190	}	1248	}
1191		1249
1192	our $MAX_SIGNAL_LATENCY = 10;	1250	our $MAX_SIGNAL_LATENCY = 10;
1193		1251
1194	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1252	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
1198	$PROTOCOL{$_} = ++$idx	1256	$PROTOCOL{$_} = ++$idx
1199	for reverse split /\s,\s/,	1257	for reverse split /\s,\s/,
1200	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1258	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1201	}	1259	}
1202		1260
		1261	our @post_detect;
		1262
		1263	sub post_detect(&) {
		1264	my ($cb) = @_;
		1265
		1266	push @post_detect, $cb;
		1267
		1268	defined wantarray
		1269	? bless \$cb, "AnyEvent::Util::postdetect"
		1270	: ()
		1271	}
		1272
		1273	sub AnyEvent::Util::postdetect::DESTROY {
		1274	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1275	}
		1276
		1277	our $POSTPONE_W;
		1278	our @POSTPONE;
		1279
		1280	sub _postpone_exec {
		1281	undef $POSTPONE_W;
		1282
		1283	&{ shift @POSTPONE }
		1284	while @POSTPONE;
		1285	}
		1286
		1287	sub postpone(&) {
		1288	push @POSTPONE, shift;
		1289
		1290	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1291
		1292	()
		1293	}
		1294
		1295	sub log($$;@) {
		1296	# only load the bug bloated module when we actually are about to log something
		1297	if ($_[0] <= $VERBOSE) {
		1298	require AnyEvent::Log;
		1299	# AnyEvent::Log overwrites this function
		1300	goto &log;
		1301	}
		1302	}
		1303
		1304	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1305	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1306	}
		1307
1203	my @models = (	1308	our @models = (
1204	[EV:: => AnyEvent::Impl::EV:: , 1],	1309	[EV:: => AnyEvent::Impl::EV:: , 1],
1205	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1310	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1206	# everything below here will not (normally) be autoprobed	1311	# everything below here will not (normally) be autoprobed
1207	# as the pureperl backend should work everywhere	1312	# as the pure perl backend should work everywhere
1208	# and is usually faster	1313	# and is usually faster
1209	[Event:: => AnyEvent::Impl::Event::, 1],	1314	[Event:: => AnyEvent::Impl::Event::, 1],
1210	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1315	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1211	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1316	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1212	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1317	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1213	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1318	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1214	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1319	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1215	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1320	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1216	[Wx:: => AnyEvent::Impl::POE::],	1321	[Wx:: => AnyEvent::Impl::POE::],
1217	[Prima:: => AnyEvent::Impl::POE::],	1322	[Prima:: => AnyEvent::Impl::POE::],
1218	# IO::Async is just too broken - we would need workarounds for its	1323	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1219	# byzantine signal and broken child handling, among others.	1324	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1220	# IO::Async is rather hard to detect, as it doesn't have any	1325	[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	);	1326	);
1227		1327
1228	our %method = map +($_ => 1),	1328	our @isa_hook;
		1329
		1330	sub _isa_set {
		1331	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1332
		1333	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1334	for 1 .. $#pkg;
		1335
		1336	grep $_ && $_->[1], @isa_hook
		1337	and AE::_reset ();
		1338	}
		1339
		1340	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1341	sub _isa_hook($$;$) {
		1342	my ($i, $pkg, $reset_ae) = @_;
		1343
		1344	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1345
		1346	_isa_set;
		1347	}
		1348
		1349	# all autoloaded methods reserve the complete glob, not just the method slot.
		1350	# due to bugs in perls method cache implementation.
1229	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1351	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		1352
1247	sub detect() {	1353	sub detect() {
		1354	return $MODEL if $MODEL; # some programs keep references to detect
		1355
		1356	local $!; # for good measure
		1357	local $SIG{__DIE__}; # we use eval
		1358
1248	# free some memory	1359	# free some memory
1249	*detect = sub () { $MODEL };	1360	*detect = sub () { $MODEL };
		1361	# undef &func doesn't correctly update the method cache. grmbl.
		1362	# so we delete the whole glob. grmbl.
		1363	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1364	# a glob with an active sub. hrm. i hope it works, but perl is
		1365	# usually buggy in this department. sigh.
		1366	delete @{"AnyEvent::"}{@methods};
		1367	undef @methods;
1250		1368
1251	local $!; # for good measure
1252	local $SIG{__DIE__};
1253
1254	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1369	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1255	my $model = "AnyEvent::Impl::$1";	1370	my $model = $1;
		1371	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1256	if (eval "require $model") {	1372	if (eval "require $model") {
		1373	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1257	$MODEL = $model;	1374	$MODEL = $model;
1258	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1259	} else {	1375	} else {
1260	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1376	AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1261	}	1377	}
1262	}	1378	}
1263		1379
1264	# check for already loaded models	1380	# check for already loaded models
1265	unless ($MODEL) {	1381	unless ($MODEL) {
1266	for (@REGISTRY, @models) {	1382	for (@REGISTRY, @models) {
1267	my ($package, $model) = @$_;	1383	my ($package, $model) = @$_;
1268	if (${"$package\::VERSION"} > 0) {	1384	if (${"$package\::VERSION"} > 0) {
1269	if (eval "require $model") {	1385	if (eval "require $model") {
		1386	AnyEvent::log 7 => "autodetected model '$model', using it.";
1270	$MODEL = $model;	1387	$MODEL = $model;
1271	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1272	last;	1388	last;
1273	}	1389	}
1274	}	1390	}
1275	}	1391	}
1276		1392
…		…
1282	$autoload	1398	$autoload
1283	and eval "require $package"	1399	and eval "require $package"
1284	and ${"$package\::VERSION"} > 0	1400	and ${"$package\::VERSION"} > 0
1285	and eval "require $model"	1401	and eval "require $model"
1286	) {	1402	) {
		1403	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1287	$MODEL = $model;	1404	$MODEL = $model;
1288	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1289	last;	1405	last;
1290	}	1406	}
1291	}	1407	}
1292		1408
1293	$MODEL	1409	$MODEL
1294	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1410	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1295	}	1411	}
1296	}	1412	}
1297		1413
1298	@models = (); # free probe data	1414	# free memory only needed for probing
		1415	undef @models;
		1416	undef @REGISTRY;
1299		1417
1300	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1418	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1301	unshift @ISA, $MODEL;
1302		1419
1303	# now nuke some methods that are overriden by the backend.	1420	# now nuke some methods that are overridden by the backend.
1304	# SUPER is not allowed.	1421	# SUPER usage is not allowed in these.
1305	for (qw(time signal child idle)) {	1422	for (qw(time signal child idle)) {
1306	undef &{"AnyEvent::Base::$_"}	1423	undef &{"AnyEvent::Base::$_"}
1307	if defined &{"$MODEL\::$_"};	1424	if defined &{"$MODEL\::$_"};
1308	}	1425	}
1309		1426
1310	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1427	_isa_set;
		1428
		1429	# we're officially open!
		1430
		1431	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1432	require AnyEvent::Strict;
		1433	}
		1434
		1435	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1436	require AnyEvent::Debug;
		1437	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1438	}
		1439
		1440	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1441	require AnyEvent::Socket;
		1442	require AnyEvent::Debug;
		1443
		1444	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1445	$shell =~ s/\$\$/$$/g;
		1446
		1447	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1448	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1449	}
		1450
		1451	# now the anyevent environment is set up as the user told us to, so
		1452	# call the actual user code - post detects
1311		1453
1312	(shift @post_detect)->() while @post_detect;	1454	(shift @post_detect)->() while @post_detect;
		1455	undef @post_detect;
1313		1456
1314	*post_detect = sub(&) {	1457	*post_detect = sub(&) {
1315	shift->();	1458	shift->();
1316		1459
1317	undef	1460	undef
1318	};	1461	};
1319		1462
1320	$MODEL	1463	$MODEL
1321	}	1464	}
1322		1465
1323	sub AUTOLOAD {	1466	for my $name (@methods) {
1324	(my $func = $AUTOLOAD) =~ s/.*://;	1467	*$name = sub {
1325
1326	$method{$func}
1327	or Carp::croak "$func: not a valid AnyEvent class method";
1328
1329	detect;	1468	detect;
1330		1469	# we use goto because
1331	my $class = shift;	1470	# a) it makes the thunk more transparent
1332	$class->$func (@_);	1471	# b) it allows us to delete the thunk later
		1472	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1473	};
1333	}	1474	}
1334		1475
1335	# utility function to dup a filehandle. this is used by many backends	1476	# utility function to dup a filehandle. this is used by many backends
1336	# to support binding more than one watcher per filehandle (they usually	1477	# 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).	1478	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1361		1502
1362	package AE;	1503	package AE;
1363		1504
1364	our $VERSION = $AnyEvent::VERSION;	1505	our $VERSION = $AnyEvent::VERSION;
1365		1506
		1507	sub _reset() {
		1508	eval q{
1366	# fall back to the main API by default - backends and AnyEvent::Base	1509	# fall back to the main API by default - backends and AnyEvent::Base
1367	# implementations can overwrite these.	1510	# implementations can overwrite these.
1368		1511
1369	sub io($$$) {	1512	sub io($$$) {
1370	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1513	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1371	}	1514	}
1372		1515
1373	sub timer($$$) {	1516	sub timer($$$) {
1374	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1517	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1375	}	1518	}
1376		1519
1377	sub signal($$) {	1520	sub signal($$) {
1378	AnyEvent->signal (signal => $_[0], cb => $_[1])	1521	AnyEvent->signal (signal => $_[0], cb => $_[1])
1379	}	1522	}
1380		1523
1381	sub child($$) {	1524	sub child($$) {
1382	AnyEvent->child (pid => $_[0], cb => $_[1])	1525	AnyEvent->child (pid => $_[0], cb => $_[1])
1383	}	1526	}
1384		1527
1385	sub idle($) {	1528	sub idle($) {
1386	AnyEvent->idle (cb => $_[0])	1529	AnyEvent->idle (cb => $_[0]);
1387	}	1530	}
1388		1531
1389	sub cv(;&) {	1532	sub cv(;&) {
1390	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1533	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1391	}	1534	}
1392		1535
1393	sub now() {	1536	sub now() {
1394	AnyEvent->now	1537	AnyEvent->now
1395	}	1538	}
1396		1539
1397	sub now_update() {	1540	sub now_update() {
1398	AnyEvent->now_update	1541	AnyEvent->now_update
1399	}	1542	}
1400		1543
1401	sub time() {	1544	sub time() {
1402	AnyEvent->time	1545	AnyEvent->time
		1546	}
		1547
		1548	*postpone = \&AnyEvent::postpone;
		1549	*log = \&AnyEvent::log;
		1550	};
		1551	die if $@;
1403	}	1552	}
		1553
		1554	BEGIN { _reset }
1404		1555
1405	package AnyEvent::Base;	1556	package AnyEvent::Base;
1406		1557
1407	# default implementations for many methods	1558	# default implementations for many methods
1408		1559
1409	sub time {	1560	sub time {
1410	eval q{ # poor man's autoloading {}	1561	eval q{ # poor man's autoloading {}
1411	# probe for availability of Time::HiRes	1562	# probe for availability of Time::HiRes
1412	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1563	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1413	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1564	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
		1565	if $AnyEvent::VERBOSE >= 8;
		1566	*time = sub { Time::HiRes::time () };
1414	*AE::time = \&Time::HiRes::time;	1567	*AE::time = \& Time::HiRes::time ;
1415	# if (eval "use POSIX (); (POSIX::times())...	1568	# if (eval "use POSIX (); (POSIX::times())...
1416	} else {	1569	} else {
1417	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1570	AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
		1571	*time = sub { CORE::time };
1418	*AE::time = sub (){ time }; # epic fail	1572	*AE::time = sub (){ CORE::time };
1419	}	1573	}
1420		1574
1421	*time = sub { AE::time }; # different prototypes	1575	*now = \&time;
1422	};	1576	};
1423	die if $@;	1577	die if $@;
1424		1578
1425	&time	1579	&time
1426	}	1580	}
1427		1581
1428	*now = \&time;	1582	*now = \&time;
1429
1430	sub now_update { }	1583	sub now_update { }
1431		1584
		1585	sub _poll {
		1586	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1587	}
		1588
1432	# default implementation for ->condvar	1589	# default implementation for ->condvar
		1590	# in fact, the default should not be overwritten
1433		1591
1434	sub condvar {	1592	sub condvar {
1435	eval q{ # poor man's autoloading {}	1593	eval q{ # poor man's autoloading {}
1436	*condvar = sub {	1594	*condvar = sub {
1437	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1595	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1515		1673
1516	sub signal {	1674	sub signal {
1517	eval q{ # poor man's autoloading {}	1675	eval q{ # poor man's autoloading {}
1518	# probe for availability of Async::Interrupt	1676	# probe for availability of Async::Interrupt
1519	if (_have_async_interrupt) {	1677	if (_have_async_interrupt) {
1520	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1678	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
		1679	if $AnyEvent::VERBOSE >= 8;
1521		1680
1522	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1681	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1523	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1682	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1524		1683
1525	} else {	1684	} else {
1526	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1685	AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
		1686	if $AnyEvent::VERBOSE >= 8;
1527		1687
1528	if (AnyEvent::WIN32) {	1688	if (AnyEvent::WIN32) {
1529	require AnyEvent::Util;	1689	require AnyEvent::Util;
1530		1690
1531	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1691	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1607	: sysread $SIGPIPE_R, (my $dummy), 9;	1767	: sysread $SIGPIPE_R, (my $dummy), 9;
1608		1768
1609	while (%SIG_EV) {	1769	while (%SIG_EV) {
1610	for (keys %SIG_EV) {	1770	for (keys %SIG_EV) {
1611	delete $SIG_EV{$_};	1771	delete $SIG_EV{$_};
1612	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1772	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1613	}	1773	}
1614	}	1774	}
1615	};	1775	};
1616	};	1776	};
1617	die if $@;	1777	die if $@;
…		…
1622	# default implementation for ->child	1782	# default implementation for ->child
1623		1783
1624	our %PID_CB;	1784	our %PID_CB;
1625	our $CHLD_W;	1785	our $CHLD_W;
1626	our $CHLD_DELAY_W;	1786	our $CHLD_DELAY_W;
1627	our $WNOHANG;
1628		1787
1629	# used by many Impl's	1788	# used by many Impl's
1630	sub _emit_childstatus($$) {	1789	sub _emit_childstatus($$) {
1631	my (undef, $rpid, $rstatus) = @_;	1790	my (undef, $rpid, $rstatus) = @_;
1632		1791
…		…
1639	eval q{ # poor man's autoloading {}	1798	eval q{ # poor man's autoloading {}
1640	*_sigchld = sub {	1799	*_sigchld = sub {
1641	my $pid;	1800	my $pid;
1642		1801
1643	AnyEvent->_emit_childstatus ($pid, $?)	1802	AnyEvent->_emit_childstatus ($pid, $?)
1644	while ($pid = waitpid -1, $WNOHANG) > 0;	1803	while ($pid = waitpid -1, WNOHANG) > 0;
1645	};	1804	};
1646		1805
1647	*child = sub {	1806	*child = sub {
1648	my (undef, %arg) = @_;	1807	my (undef, %arg) = @_;
1649		1808
1650	defined (my $pid = $arg{pid} + 0)	1809	my $pid = $arg{pid};
1651	or Carp::croak "required option 'pid' is missing";	1810	my $cb = $arg{cb};
1652		1811
1653	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1812	$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		1813
1660	unless ($CHLD_W) {	1814	unless ($CHLD_W) {
1661	$CHLD_W = AE::signal CHLD => \&_sigchld;	1815	$CHLD_W = AE::signal CHLD => \&_sigchld;
1662	# child could be a zombie already, so make at least one round	1816	# child could be a zombie already, so make at least one round
1663	&_sigchld;	1817	&_sigchld;
1664	}	1818	}
1665		1819
1666	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1820	bless [$pid, $cb+0], "AnyEvent::Base::child"
1667	};	1821	};
1668		1822
1669	*AnyEvent::Base::child::DESTROY = sub {	1823	*AnyEvent::Base::child::DESTROY = sub {
1670	my ($pid, $cb) = @{$_[0]};	1824	my ($pid, $icb) = @{$_[0]};
1671		1825
1672	delete $PID_CB{$pid}{$cb};	1826	delete $PID_CB{$pid}{$icb};
1673	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1827	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1674		1828
1675	undef $CHLD_W unless keys %PID_CB;	1829	undef $CHLD_W unless keys %PID_CB;
1676	};	1830	};
1677	};	1831	};
…		…
1690		1844
1691	my ($cb, $w, $rcb) = $arg{cb};	1845	my ($cb, $w, $rcb) = $arg{cb};
1692		1846
1693	$rcb = sub {	1847	$rcb = sub {
1694	if ($cb) {	1848	if ($cb) {
1695	$w = _time;	1849	$w = AE::time;
1696	&$cb;	1850	&$cb;
1697	$w = _time - $w;	1851	$w = AE::time - $w;
1698		1852
1699	# never use more then 50% of the time for the idle watcher,	1853	# never use more then 50% of the time for the idle watcher,
1700	# within some limits	1854	# within some limits
1701	$w = 0.0001 if $w < 0.0001;	1855	$w = 0.0001 if $w < 0.0001;
1702	$w = 5 if $w > 5;	1856	$w = 5 if $w > 5;
…		…
1725		1879
1726	package AnyEvent::CondVar;	1880	package AnyEvent::CondVar;
1727		1881
1728	our @ISA = AnyEvent::CondVar::Base::;	1882	our @ISA = AnyEvent::CondVar::Base::;
1729		1883
		1884	# only to be used for subclassing
		1885	sub new {
		1886	my $class = shift;
		1887	bless AnyEvent->condvar (@_), $class
		1888	}
		1889
1730	package AnyEvent::CondVar::Base;	1890	package AnyEvent::CondVar::Base;
1731		1891
1732	#use overload	1892	#use overload
1733	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1893	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1734	# fallback => 1;	1894	# fallback => 1;
…		…
1743		1903
1744	sub _send {	1904	sub _send {
1745	# nop	1905	# nop
1746	}	1906	}
1747		1907
		1908	sub _wait {
		1909	AnyEvent->_poll until $_[0]{_ae_sent};
		1910	}
		1911
1748	sub send {	1912	sub send {
1749	my $cv = shift;	1913	my $cv = shift;
1750	$cv->{_ae_sent} = [@_];	1914	$cv->{_ae_sent} = [@_];
1751	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1915	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1752	$cv->_send;	1916	$cv->_send;
…		…
1759		1923
1760	sub ready {	1924	sub ready {
1761	$_[0]{_ae_sent}	1925	$_[0]{_ae_sent}
1762	}	1926	}
1763		1927
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 {	1928	sub recv {
		1929	unless ($_[0]{_ae_sent}) {
		1930	$WAITING
		1931	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1932
		1933	local $WAITING = 1;
1774	$_[0]->_wait;	1934	$_[0]->_wait;
		1935	}
1775		1936
1776	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1937	$_[0]{_ae_croak}
1777	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1938	and Carp::croak $_[0]{_ae_croak};
		1939
		1940	wantarray
		1941	? @{ $_[0]{_ae_sent} }
		1942	: $_[0]{_ae_sent}[0]
1778	}	1943	}
1779		1944
1780	sub cb {	1945	sub cb {
1781	my $cv = shift;	1946	my $cv = shift;
1782		1947
…		…
1798	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1963	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1799	}	1964	}
1800		1965
1801	# undocumented/compatibility with pre-3.4	1966	# undocumented/compatibility with pre-3.4
1802	*broadcast = \&send;	1967	*broadcast = \&send;
1803	*wait = \&_wait;	1968	*wait = \&recv;
1804		1969
1805	=head1 ERROR AND EXCEPTION HANDLING	1970	=head1 ERROR AND EXCEPTION HANDLING
1806		1971
1807	In general, AnyEvent does not do any error handling - it relies on the	1972	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	1973	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	1985	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1821	so on.	1986	so on.
1822		1987
1823	=head1 ENVIRONMENT VARIABLES	1988	=head1 ENVIRONMENT VARIABLES
1824		1989
1825	The following environment variables are used by this module or its	1990	AnyEvent supports a number of environment variables that tune the
1826	submodules.	1991	runtime behaviour. They are usually evaluated when AnyEvent is
		1992	loaded, initialised, or a submodule that uses them is loaded. Many of
		1993	them also cause AnyEvent to load additional modules - for example,
		1994	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		1995	loaded.
1827		1996
1828	Note that AnyEvent will remove I<all> environment variables starting with	1997	All the environment variables documented here start with
1829	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	1998	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1830	enabled.	1999	namespace. Other modules are encouraged (but by no means required) to use
		2000	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2001	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2002	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2003	variables starting with C<AE_>, see below).
		2004
		2005	All variables can also be set via the C<AE_> prefix, that is, instead
		2006	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2007	case there is a clash btween anyevent and another program that uses
		2008	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2009	variable to the empty string, as those variables take precedence.
		2010
		2011	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2012	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2013	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2014	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2015	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2016	is set).
		2017
		2018	The exact algorithm is currently:
		2019
		2020	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2021	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2022	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2023
		2024	This ensures that child processes will not see the C<AE_> variables.
		2025
		2026	The following environment variables are currently known to AnyEvent:
1831		2027
1832	=over 4	2028	=over 4
1833		2029
1834	=item C<PERL_ANYEVENT_VERBOSE>	2030	=item C<PERL_ANYEVENT_VERBOSE>
1835		2031
1836	By default, AnyEvent will be completely silent except in fatal	2032	By default, AnyEvent will be completely silent except in fatal
1837	conditions. You can set this environment variable to make AnyEvent more	2033	conditions. You can set this environment variable to make AnyEvent more
1838	talkative.	2034	talkative. If you want to do more than just set the global logging level
		2035	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2036	complex specifications.
1839		2037
1840	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2038	When set to C<5> or higher, causes AnyEvent to warn about unexpected
1841	conditions, such as not being able to load the event model specified by	2039	conditions, such as not being able to load the event model specified by
1842	C<PERL_ANYEVENT_MODEL>.	2040	C<PERL_ANYEVENT_MODEL>.
1843		2041
1844	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2042	When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1845	model it chooses.	2043	model it chooses.
1846		2044
1847	When set to C<8> or higher, then AnyEvent will report extra information on	2045	When set to C<8> or higher, then AnyEvent will report extra information on
1848	which optional modules it loads and how it implements certain features.	2046	which optional modules it loads and how it implements certain features.
		2047
		2048	=item C<PERL_ANYEVENT_LOG>
		2049
		2050	Accepts rather complex logging specifications. For example, you could log
		2051	all C<debug> messages of some module to stderr, warnings and above to
		2052	stderr, and errors and above to syslog, with:
		2053
		2054	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2055
		2056	For the rather extensive details, see L<AnyEvent::Log>.
		2057
		2058	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2059	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2060	using the latter saves a few hundred kB of memory until the first message
		2061	is being logged.
1849		2062
1850	=item C<PERL_ANYEVENT_STRICT>	2063	=item C<PERL_ANYEVENT_STRICT>
1851		2064
1852	AnyEvent does not do much argument checking by default, as thorough	2065	AnyEvent does not do much argument checking by default, as thorough
1853	argument checking is very costly. Setting this variable to a true value	2066	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>	2073	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	2074	>>, it is definitely recommended to keep it off in production. Keeping
1862	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2075	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1863	can be very useful, however.	2076	can be very useful, however.
1864		2077
		2078	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2079
		2080	If this env variable is set, then its contents will be interpreted by
		2081	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2082	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2083	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2084
		2085	This takes place when the first watcher is created.
		2086
		2087	For example, to bind a debug shell on a unix domain socket in
		2088	F<< /tmp/debug<pid>.sock >>, you could use this:
		2089
		2090	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2091
		2092	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2093	systems.
		2094
		2095	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2096
		2097	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2098	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2099
1865	=item C<PERL_ANYEVENT_MODEL>	2100	=item C<PERL_ANYEVENT_MODEL>
1866		2101
1867	This can be used to specify the event model to be used by AnyEvent, before	2102	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	2103	auto detection and -probing kicks in.
1869	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2104
		2105	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2106	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,	2107	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	2108	event model backend. If it fails to load then AnyEvent will proceed with
1872	auto detection and -probing.	2109	auto detection and -probing.
1873		2110
1874	This functionality might change in future versions.	2111	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2112	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2113	the end of a string designates a module name and quotes it appropriately).
1875		2114
1876	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2115	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1877	could start your program like this:	2116	could start your program like this:
1878		2117
1879	PERL_ANYEVENT_MODEL=Perl perl ...	2118	PERL_ANYEVENT_MODEL=Perl perl ...
1880		2119
1881	=item C<PERL_ANYEVENT_PROTOCOLS>	2120	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1897	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2136	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1898	- only support IPv4, never try to resolve or contact IPv6	2137	- only support IPv4, never try to resolve or contact IPv6
1899	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2138	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1900	IPv6, but prefer IPv6 over IPv4.	2139	IPv6, but prefer IPv6 over IPv4.
1901		2140
		2141	=item C<PERL_ANYEVENT_HOSTS>
		2142
		2143	This variable, if specified, overrides the F</etc/hosts> file used by
		2144	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2145	from that file instead.
		2146
1902	=item C<PERL_ANYEVENT_EDNS0>	2147	=item C<PERL_ANYEVENT_EDNS0>
1903		2148
1904	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2149	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	2150	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	2151	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1907	default.	2152	packets, which is why it is off by default.
1908		2153
1909	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2154	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1910	EDNS0 in its DNS requests.	2155	EDNS0 in its DNS requests.
1911		2156
1912	=item C<PERL_ANYEVENT_MAX_FORKS>	2157	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1920	resolver - this is the maximum number of parallel DNS requests that are	2165	resolver - this is the maximum number of parallel DNS requests that are
1921	sent to the DNS server.	2166	sent to the DNS server.
1922		2167
1923	=item C<PERL_ANYEVENT_RESOLV_CONF>	2168	=item C<PERL_ANYEVENT_RESOLV_CONF>
1924		2169
1925	The file to use instead of F</etc/resolv.conf> (or OS-specific	2170	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	2171	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1927	default config will be used.	2172	resolver, or the empty string to select the default configuration.
1928		2173
1929	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2174	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1930		2175
1931	When neither C<ca_file> nor C<ca_path> was specified during	2176	When neither C<ca_file> nor C<ca_path> was specified during
1932	L<AnyEvent::TLS> context creation, and either of these environment	2177	L<AnyEvent::TLS> context creation, and either of these environment
1933	variables exist, they will be used to specify CA certificate locations	2178	variables are nonempty, they will be used to specify CA certificate
1934	instead of a system-dependent default.	2179	locations instead of a system-dependent default.
1935		2180
1936	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2181	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1937		2182
1938	When these are set to C<1>, then the respective modules are not	2183	When these are set to C<1>, then the respective modules are not
1939	loaded. Mostly good for testing AnyEvent itself.	2184	loaded. Mostly good for testing AnyEvent itself.
…		…
2271	(even when used without AnyEvent), but most event loops have acceptable	2516	(even when used without AnyEvent), but most event loops have acceptable
2272	performance with or without AnyEvent.	2517	performance with or without AnyEvent.
2273		2518
2274	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2519	=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	2520	the actual event loop, only with extremely fast event loops such as EV
2276	adds AnyEvent significant overhead.	2521	does AnyEvent add significant overhead.
2277		2522
2278	=item * You should avoid POE like the plague if you want performance or	2523	=item * You should avoid POE like the plague if you want performance or
2279	reasonable memory usage.	2524	reasonable memory usage.
2280		2525
2281	=back	2526	=back
…		…
2580		2825
2581	=item L<Time::HiRes>	2826	=item L<Time::HiRes>
2582		2827
2583	This module is part of perl since release 5.008. It will be used when the	2828	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	2829	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	2830	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2586	try to use a monotonic clock for timing stability.	2831	try to use a monotonic clock for timing stability.
2587		2832
2588	=back	2833	=back
2589		2834
2590		2835
…		…
2652	pronounced).	2897	pronounced).
2653		2898
2654		2899
2655	=head1 SEE ALSO	2900	=head1 SEE ALSO
2656		2901
2657	Utility functions: L<AnyEvent::Util>.	2902	Tutorial/Introduction: L<AnyEvent::Intro>.
2658		2903
2659	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2904	FAQ: L<AnyEvent::FAQ>.
2660	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2905
		2906	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2907	(simply logging).
		2908
		2909	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2910	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2911
		2912	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2913	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2914	L<Qt>, L<POE>, L<FLTK>.
2661		2915
2662	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2916	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2663	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2917	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2664	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2918	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2665	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2919	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2920	L<AnyEvent::Impl::FLTK>.
2666		2921
2667	Non-blocking file handles, sockets, TCP clients and	2922	Non-blocking handles, pipes, stream sockets, TCP clients and
2668	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2923	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2669		2924
2670	Asynchronous DNS: L<AnyEvent::DNS>.	2925	Asynchronous DNS: L<AnyEvent::DNS>.
2671		2926
2672	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2927	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2673	L<Coro::Event>,
2674		2928
2675	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2929	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2676	L<AnyEvent::HTTP>.	2930	L<AnyEvent::HTTP>.
2677		2931
2678		2932
2679	=head1 AUTHOR	2933	=head1 AUTHOR
2680		2934

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.373 by root, Thu Aug 25 03:08:48 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.373 by root, Thu Aug 25 03:08:48 2011 UTC