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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.330 by root, Tue Aug 31 00:59:55 2010 UTC vs.
Revision 1.375 by root, Thu Aug 25 05:39:47 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>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
125	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,	127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
126	L<POE>. The first one found is used. If none are found, the module tries	128	found is used. If none are detected, the module tries to load the first
127	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl	129	four modules in the order given; but note that if L<EV> is not
128	adaptor should always succeed) in the order given. The first one that can	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
129	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
130	found, AnyEvent will fall back to a pure-perl event loop, which is not
131	very efficient, but should work everywhere.
132		132
133	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
134	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
135	that model the default. For example:	135	that model the default. For example:
136		136
…		…
142	The I<likely> means that, if any module loads another event model and	142	The I<likely> means that, if any module loads another event model and
143	starts using it, all bets are off - this case should be very rare though,	143	starts using it, all bets are off - this case should be very rare though,
144	as very few modules hardcode event loops without announcing this very	144	as very few modules hardcode event loops without announcing this very
145	loudly.	145	loudly.
146		146
147	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	other event modules you can load it explicitly and enjoy the high
149	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
150		150
151	=head1 WATCHERS	151	=head1 WATCHERS
152		152
153	AnyEvent has the central concept of a I<watcher>, which is an object that	153	AnyEvent has the central concept of a I<watcher>, which is an object that
154	stores relevant data for each kind of event you are waiting for, such as	154	stores relevant data for each kind of event you are waiting for, such as
…		…
356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
357	account.	357	account.
358		358
359	=item AnyEvent->now_update	359	=item AnyEvent->now_update
360		360
361	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache	361	Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362	the current time for each loop iteration (see the discussion of L<<	362	time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363	AnyEvent->now >>, above).	363	above).
364		364
365	When a callback runs for a long time (or when the process sleeps), then	365	When a callback runs for a long time (or when the process sleeps), then
366	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
367	might affect timers and time-outs.	367	might affect timers and time-outs.
368		368
…		…
482	thing in an AnyEvent program, you I<have> to create at least one	482	thing in an AnyEvent program, you I<have> to create at least one
483	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
484	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
485		485
486	As most event loops do not support waiting for child events, they will be	486	As most event loops do not support waiting for child events, they will be
487	emulated by AnyEvent in most cases, in which the latency and race problems	487	emulated by AnyEvent in most cases, in which case the latency and race
488	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
489		489
490	Example: fork a process and wait for it	490	Example: fork a process and wait for it
491		491
492	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
493		493
…		…
860	use. If EV is not installed, then AnyEvent will fall back to its own	860	use. If EV is not installed, then AnyEvent will fall back to its own
861	pure-perl implementation, which is available everywhere as it comes with	861	pure-perl implementation, which is available everywhere as it comes with
862	AnyEvent itself.	862	AnyEvent itself.
863		863
864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866		866
867	=item Backends that are transparently being picked up when they are used.	867	=item Backends that are transparently being picked up when they are used.
868		868
869	These will be used if they are already loaded when the first watcher	869	These will be used if they are already loaded when the first watcher
870	is created, in which case it is assumed that the application is using	870	is created, in which case it is assumed that the application is using
…		…
876	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
877	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
880	AnyEvent::Impl::Irssi used when running within irssi.	880	AnyEvent::Impl::Irssi used when running within irssi.
		881	AnyEvent::Impl::IOAsync based on IO::Async.
		882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		883	AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
881		884
882	=item Backends with special needs.	885	=item Backends with special needs.
883		886
884	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
885	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
886	instantiates the application before any AnyEvent watchers are created,	889	instantiates the application before any AnyEvent watchers are created,
887	everything should just work.	890	everything should just work.
888		891
889	AnyEvent::Impl::Qt based on Qt.	892	AnyEvent::Impl::Qt based on Qt.
890
891	Support for IO::Async can only be partial, as it is too broken and
892	architecturally limited to even support the AnyEvent API. It also
893	is the only event loop that needs the loop to be set explicitly, so
894	it can only be used by a main program knowing about AnyEvent. See
895	L<AnyEvent::Impl::IOAsync> for the gory details.
896
897	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
898		893
899	=item Event loops that are indirectly supported via other backends.	894	=item Event loops that are indirectly supported via other backends.
900		895
901	Some event loops can be supported via other modules:	896	Some event loops can be supported via other modules:
902		897
…		…
938		933
939	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
940	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
941	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
942	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).
943		942
944	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
945	created, use C<post_detect>.	944	created, use C<post_detect>.
946		945
947	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1010	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1011	# as soon as it is	1010	# as soon as it is
1012	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1013	}	1012	}
1014		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
1015	=back	1064	=back
1016		1065
1017	=head1 WHAT TO DO IN A MODULE	1066	=head1 WHAT TO DO IN A MODULE
1018		1067
1019	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
…		…
1052	modules might create watchers when they are loaded, and AnyEvent will	1101	modules might create watchers when they are loaded, and AnyEvent will
1053	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
1054	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.
1055		1104
1056	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
1057	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1106	C<AnyEvent::Loop> module, which gives you similar behaviour
1058	everywhere, but letting AnyEvent chose the model is generally better.	1107	everywhere, but letting AnyEvent chose the model is generally better.
1059		1108
1060	=head2 MAINLOOP EMULATION	1109	=head2 MAINLOOP EMULATION
1061		1110
1062	Sometimes (often for short test scripts, or even standalone programs who	1111	Sometimes (often for short test scripts, or even standalone programs who
…		…
1075		1124
1076		1125
1077	=head1 OTHER MODULES	1126	=head1 OTHER MODULES
1078		1127
1079	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
1080	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
1081	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
1082	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 :)
1083		1135
1084	=over 4	1136	=over 4
1085		1137
1086	=item L<AnyEvent::Util>	1138	=item L<AnyEvent::Util>
1087		1139
…		…
1157		1209
1158	package AnyEvent;	1210	package AnyEvent;
1159		1211
1160	# basically a tuned-down version of common::sense	1212	# basically a tuned-down version of common::sense
1161	sub common_sense {	1213	sub common_sense {
1162	# from common:.sense 1.0	1214	# from common:.sense 3.4
1163	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";	1215	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1164	# 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)
1165	$^H \|= 0x00000600;	1217	$^H \|= 0x00000600;
1166	}	1218	}
1167		1219
1168	BEGIN { AnyEvent::common_sense }	1220	BEGIN { AnyEvent::common_sense }
1169		1221
1170	use Carp ();	1222	use Carp ();
1171		1223
1172	our $VERSION = '5.271';	1224	our $VERSION = '6.01';
1173	our $MODEL;	1225	our $MODEL;
1174		1226
1175	our $AUTOLOAD;
1176	our @ISA;	1227	our @ISA;
1177		1228
1178	our @REGISTRY;	1229	our @REGISTRY;
1179		1230
1180	our $VERBOSE;	1231	our $VERBOSE;
…		…
1185	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1236	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1186		1237
1187	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1238	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1188	if ${^TAINT};	1239	if ${^TAINT};
1189		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
1190	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1247	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1191
1192	}	1248	}
1193		1249
1194	our $MAX_SIGNAL_LATENCY = 10;	1250	our $MAX_SIGNAL_LATENCY = 10;
1195		1251
1196	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1252	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
…		…
1200	$PROTOCOL{$_} = ++$idx	1256	$PROTOCOL{$_} = ++$idx
1201	for reverse split /\s,\s/,	1257	for reverse split /\s,\s/,
1202	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1258	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1203	}	1259	}
1204		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
1205	my @models = (	1308	our @models = (
1206	[EV:: => AnyEvent::Impl::EV:: , 1],	1309	[EV:: => AnyEvent::Impl::EV:: , 1],
1207	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1310	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1208	# everything below here will not (normally) be autoprobed	1311	# everything below here will not (normally) be autoprobed
1209	# as the pureperl backend should work everywhere	1312	# as the pure perl backend should work everywhere
1210	# and is usually faster	1313	# and is usually faster
1211	[Event:: => AnyEvent::Impl::Event::, 1],	1314	[Event:: => AnyEvent::Impl::Event::, 1],
1212	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1315	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1213	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1316	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1214	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1317	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1215	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1318	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1216	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1319	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1217	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1320	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1218	[Wx:: => AnyEvent::Impl::POE::],	1321	[Wx:: => AnyEvent::Impl::POE::],
1219	[Prima:: => AnyEvent::Impl::POE::],	1322	[Prima:: => AnyEvent::Impl::POE::],
1220	# IO::Async is just too broken - we would need workarounds for its	1323	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1221	# byzantine signal and broken child handling, among others.	1324	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1222	# IO::Async is rather hard to detect, as it doesn't have any	1325	[FLTK:: => AnyEvent::Impl::FLTK2::],
1223	# obvious default class.
1224	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1225	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1226	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1227	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1228	);	1326	);
1229		1327
1230	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.
1231	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);
1232
1233	our @post_detect;
1234
1235	sub post_detect(&) {
1236	my ($cb) = @_;
1237
1238	push @post_detect, $cb;
1239
1240	defined wantarray
1241	? bless \$cb, "AnyEvent::Util::postdetect"
1242	: ()
1243	}
1244
1245	sub AnyEvent::Util::postdetect::DESTROY {
1246	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1247	}
1248		1352
1249	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
1250	# free some memory	1359	# free some memory
1251	*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;
1252		1368
1253	local $!; # for good measure
1254	local $SIG{__DIE__};
1255
1256	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1369	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1257	my $model = "AnyEvent::Impl::$1";	1370	my $model = $1;
		1371	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1258	if (eval "require $model") {	1372	if (eval "require $model") {
		1373	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1259	$MODEL = $model;	1374	$MODEL = $model;
1260	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1261	} else {	1375	} else {
1262	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$@";
1263	}	1377	}
1264	}	1378	}
1265		1379
1266	# check for already loaded models	1380	# check for already loaded models
1267	unless ($MODEL) {	1381	unless ($MODEL) {
1268	for (@REGISTRY, @models) {	1382	for (@REGISTRY, @models) {
1269	my ($package, $model) = @$_;	1383	my ($package, $model) = @$_;
1270	if (${"$package\::VERSION"} > 0) {	1384	if (${"$package\::VERSION"} > 0) {
1271	if (eval "require $model") {	1385	if (eval "require $model") {
		1386	AnyEvent::log 7 => "autodetected model '$model', using it.";
1272	$MODEL = $model;	1387	$MODEL = $model;
1273	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1274	last;	1388	last;
1275	}	1389	}
1276	}	1390	}
1277	}	1391	}
1278		1392
…		…
1284	$autoload	1398	$autoload
1285	and eval "require $package"	1399	and eval "require $package"
1286	and ${"$package\::VERSION"} > 0	1400	and ${"$package\::VERSION"} > 0
1287	and eval "require $model"	1401	and eval "require $model"
1288	) {	1402	) {
		1403	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1289	$MODEL = $model;	1404	$MODEL = $model;
1290	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1291	last;	1405	last;
1292	}	1406	}
1293	}	1407	}
1294		1408
1295	$MODEL	1409	$MODEL
1296	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?";
1297	}	1411	}
1298	}	1412	}
1299		1413
1300	@models = (); # free probe data	1414	# free memory only needed for probing
		1415	undef @models;
		1416	undef @REGISTRY;
1301		1417
1302	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1418	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1303	unshift @ISA, $MODEL;
1304		1419
1305	# now nuke some methods that are overriden by the backend.	1420	# now nuke some methods that are overridden by the backend.
1306	# SUPER is not allowed.	1421	# SUPER usage is not allowed in these.
1307	for (qw(time signal child idle)) {	1422	for (qw(time signal child idle)) {
1308	undef &{"AnyEvent::Base::$_"}	1423	undef &{"AnyEvent::Base::$_"}
1309	if defined &{"$MODEL\::$_"};	1424	if defined &{"$MODEL\::$_"};
1310	}	1425	}
1311		1426
1312	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
1313		1453
1314	(shift @post_detect)->() while @post_detect;	1454	(shift @post_detect)->() while @post_detect;
		1455	undef @post_detect;
1315		1456
1316	*post_detect = sub(&) {	1457	*post_detect = sub(&) {
1317	shift->();	1458	shift->();
1318		1459
1319	undef	1460	undef
1320	};	1461	};
1321		1462
1322	$MODEL	1463	$MODEL
1323	}	1464	}
1324		1465
1325	sub AUTOLOAD {	1466	for my $name (@methods) {
1326	(my $func = $AUTOLOAD) =~ s/.*://;	1467	*$name = sub {
1327
1328	$method{$func}
1329	or Carp::croak "$func: not a valid AnyEvent class method";
1330
1331	detect;	1468	detect;
1332		1469	# we use goto because
1333	my $class = shift;	1470	# a) it makes the thunk more transparent
1334	$class->$func (@_);	1471	# b) it allows us to delete the thunk later
		1472	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1473	};
1335	}	1474	}
1336		1475
1337	# 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
1338	# to support binding more than one watcher per filehandle (they usually	1477	# to support binding more than one watcher per filehandle (they usually
1339	# 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).
…		…
1363		1502
1364	package AE;	1503	package AE;
1365		1504
1366	our $VERSION = $AnyEvent::VERSION;	1505	our $VERSION = $AnyEvent::VERSION;
1367		1506
		1507	sub _reset() {
		1508	eval q{
1368	# 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
1369	# implementations can overwrite these.	1510	# implementations can overwrite these.
1370		1511
1371	sub io($$$) {	1512	sub io($$$) {
1372	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1513	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1373	}	1514	}
1374		1515
1375	sub timer($$$) {	1516	sub timer($$$) {
1376	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1517	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1377	}	1518	}
1378		1519
1379	sub signal($$) {	1520	sub signal($$) {
1380	AnyEvent->signal (signal => $_[0], cb => $_[1])	1521	AnyEvent->signal (signal => $_[0], cb => $_[1])
1381	}	1522	}
1382		1523
1383	sub child($$) {	1524	sub child($$) {
1384	AnyEvent->child (pid => $_[0], cb => $_[1])	1525	AnyEvent->child (pid => $_[0], cb => $_[1])
1385	}	1526	}
1386		1527
1387	sub idle($) {	1528	sub idle($) {
1388	AnyEvent->idle (cb => $_[0])	1529	AnyEvent->idle (cb => $_[0]);
1389	}	1530	}
1390		1531
1391	sub cv(;&) {	1532	sub cv(;&) {
1392	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1533	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1393	}	1534	}
1394		1535
1395	sub now() {	1536	sub now() {
1396	AnyEvent->now	1537	AnyEvent->now
1397	}	1538	}
1398		1539
1399	sub now_update() {	1540	sub now_update() {
1400	AnyEvent->now_update	1541	AnyEvent->now_update
1401	}	1542	}
1402		1543
1403	sub time() {	1544	sub time() {
1404	AnyEvent->time	1545	AnyEvent->time
		1546	}
		1547
		1548	*postpone = \&AnyEvent::postpone;
		1549	*log = \&AnyEvent::log;
		1550	};
		1551	die if $@;
1405	}	1552	}
		1553
		1554	BEGIN { _reset }
1406		1555
1407	package AnyEvent::Base;	1556	package AnyEvent::Base;
1408		1557
1409	# default implementations for many methods	1558	# default implementations for many methods
1410		1559
1411	sub time {	1560	sub time {
1412	eval q{ # poor man's autoloading {}	1561	eval q{ # poor man's autoloading {}
1413	# probe for availability of Time::HiRes	1562	# probe for availability of Time::HiRes
1414	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1563	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1415	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 () };
1416	*AE::time = \&Time::HiRes::time;	1567	*AE::time = \& Time::HiRes::time ;
1417	# if (eval "use POSIX (); (POSIX::times())...	1568	# if (eval "use POSIX (); (POSIX::times())...
1418	} else {	1569	} else {
1419	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 };
1420	*AE::time = sub (){ time }; # epic fail	1572	*AE::time = sub (){ CORE::time };
1421	}	1573	}
1422		1574
1423	*time = sub { AE::time }; # different prototypes	1575	*now = \&time;
1424	};	1576	};
1425	die if $@;	1577	die if $@;
1426		1578
1427	&time	1579	&time
1428	}	1580	}
1429		1581
1430	*now = \&time;	1582	*now = \&time;
1431
1432	sub now_update { }	1583	sub now_update { }
1433		1584
		1585	sub _poll {
		1586	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1587	}
		1588
1434	# default implementation for ->condvar	1589	# default implementation for ->condvar
		1590	# in fact, the default should not be overwritten
1435		1591
1436	sub condvar {	1592	sub condvar {
1437	eval q{ # poor man's autoloading {}	1593	eval q{ # poor man's autoloading {}
1438	*condvar = sub {	1594	*condvar = sub {
1439	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1595	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1517		1673
1518	sub signal {	1674	sub signal {
1519	eval q{ # poor man's autoloading {}	1675	eval q{ # poor man's autoloading {}
1520	# probe for availability of Async::Interrupt	1676	# probe for availability of Async::Interrupt
1521	if (_have_async_interrupt) {	1677	if (_have_async_interrupt) {
1522	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;
1523		1680
1524	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1681	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1525	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1682	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1526		1683
1527	} else {	1684	} else {
1528	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;
1529		1687
1530	if (AnyEvent::WIN32) {	1688	if (AnyEvent::WIN32) {
1531	require AnyEvent::Util;	1689	require AnyEvent::Util;
1532		1690
1533	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1691	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1609	: sysread $SIGPIPE_R, (my $dummy), 9;	1767	: sysread $SIGPIPE_R, (my $dummy), 9;
1610		1768
1611	while (%SIG_EV) {	1769	while (%SIG_EV) {
1612	for (keys %SIG_EV) {	1770	for (keys %SIG_EV) {
1613	delete $SIG_EV{$_};	1771	delete $SIG_EV{$_};
1614	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1772	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1615	}	1773	}
1616	}	1774	}
1617	};	1775	};
1618	};	1776	};
1619	die if $@;	1777	die if $@;
…		…
1624	# default implementation for ->child	1782	# default implementation for ->child
1625		1783
1626	our %PID_CB;	1784	our %PID_CB;
1627	our $CHLD_W;	1785	our $CHLD_W;
1628	our $CHLD_DELAY_W;	1786	our $CHLD_DELAY_W;
1629	our $WNOHANG;
1630		1787
1631	# used by many Impl's	1788	# used by many Impl's
1632	sub _emit_childstatus($$) {	1789	sub _emit_childstatus($$) {
1633	my (undef, $rpid, $rstatus) = @_;	1790	my (undef, $rpid, $rstatus) = @_;
1634		1791
…		…
1641	eval q{ # poor man's autoloading {}	1798	eval q{ # poor man's autoloading {}
1642	*_sigchld = sub {	1799	*_sigchld = sub {
1643	my $pid;	1800	my $pid;
1644		1801
1645	AnyEvent->_emit_childstatus ($pid, $?)	1802	AnyEvent->_emit_childstatus ($pid, $?)
1646	while ($pid = waitpid -1, $WNOHANG) > 0;	1803	while ($pid = waitpid -1, WNOHANG) > 0;
1647	};	1804	};
1648		1805
1649	*child = sub {	1806	*child = sub {
1650	my (undef, %arg) = @_;	1807	my (undef, %arg) = @_;
1651		1808
1652	defined (my $pid = $arg{pid} + 0)	1809	my $pid = $arg{pid};
1653	or Carp::croak "required option 'pid' is missing";	1810	my $cb = $arg{cb};
1654		1811
1655	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1812	$PID_CB{$pid}{$cb+0} = $cb;
1656
1657	# WNOHANG is almost cetrainly 1 everywhere
1658	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1659	? 1
1660	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1661		1813
1662	unless ($CHLD_W) {	1814	unless ($CHLD_W) {
1663	$CHLD_W = AE::signal CHLD => \&_sigchld;	1815	$CHLD_W = AE::signal CHLD => \&_sigchld;
1664	# 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
1665	&_sigchld;	1817	&_sigchld;
1666	}	1818	}
1667		1819
1668	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1820	bless [$pid, $cb+0], "AnyEvent::Base::child"
1669	};	1821	};
1670		1822
1671	*AnyEvent::Base::child::DESTROY = sub {	1823	*AnyEvent::Base::child::DESTROY = sub {
1672	my ($pid, $cb) = @{$_[0]};	1824	my ($pid, $icb) = @{$_[0]};
1673		1825
1674	delete $PID_CB{$pid}{$cb};	1826	delete $PID_CB{$pid}{$icb};
1675	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1827	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1676		1828
1677	undef $CHLD_W unless keys %PID_CB;	1829	undef $CHLD_W unless keys %PID_CB;
1678	};	1830	};
1679	};	1831	};
…		…
1692		1844
1693	my ($cb, $w, $rcb) = $arg{cb};	1845	my ($cb, $w, $rcb) = $arg{cb};
1694		1846
1695	$rcb = sub {	1847	$rcb = sub {
1696	if ($cb) {	1848	if ($cb) {
1697	$w = _time;	1849	$w = AE::time;
1698	&$cb;	1850	&$cb;
1699	$w = _time - $w;	1851	$w = AE::time - $w;
1700		1852
1701	# 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,
1702	# within some limits	1854	# within some limits
1703	$w = 0.0001 if $w < 0.0001;	1855	$w = 0.0001 if $w < 0.0001;
1704	$w = 5 if $w > 5;	1856	$w = 5 if $w > 5;
…		…
1727		1879
1728	package AnyEvent::CondVar;	1880	package AnyEvent::CondVar;
1729		1881
1730	our @ISA = AnyEvent::CondVar::Base::;	1882	our @ISA = AnyEvent::CondVar::Base::;
1731		1883
		1884	# only to be used for subclassing
		1885	sub new {
		1886	my $class = shift;
		1887	bless AnyEvent->condvar (@_), $class
		1888	}
		1889
1732	package AnyEvent::CondVar::Base;	1890	package AnyEvent::CondVar::Base;
1733		1891
1734	#use overload	1892	#use overload
1735	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1893	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1736	# fallback => 1;	1894	# fallback => 1;
…		…
1745		1903
1746	sub _send {	1904	sub _send {
1747	# nop	1905	# nop
1748	}	1906	}
1749		1907
		1908	sub _wait {
		1909	AnyEvent->_poll until $_[0]{_ae_sent};
		1910	}
		1911
1750	sub send {	1912	sub send {
1751	my $cv = shift;	1913	my $cv = shift;
1752	$cv->{_ae_sent} = [@_];	1914	$cv->{_ae_sent} = [@_];
1753	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1915	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1754	$cv->_send;	1916	$cv->_send;
…		…
1761		1923
1762	sub ready {	1924	sub ready {
1763	$_[0]{_ae_sent}	1925	$_[0]{_ae_sent}
1764	}	1926	}
1765		1927
1766	sub _wait {
1767	$WAITING
1768	and !$_[0]{_ae_sent}
1769	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1770
1771	local $WAITING = 1;
1772	AnyEvent->one_event while !$_[0]{_ae_sent};
1773	}
1774
1775	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;
1776	$_[0]->_wait;	1934	$_[0]->_wait;
		1935	}
1777		1936
1778	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1937	$_[0]{_ae_croak}
1779	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]
1780	}	1943	}
1781		1944
1782	sub cb {	1945	sub cb {
1783	my $cv = shift;	1946	my $cv = shift;
1784		1947
…		…
1800	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	1963	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1801	}	1964	}
1802		1965
1803	# undocumented/compatibility with pre-3.4	1966	# undocumented/compatibility with pre-3.4
1804	*broadcast = \&send;	1967	*broadcast = \&send;
1805	*wait = \&_wait;	1968	*wait = \&recv;
1806		1969
1807	=head1 ERROR AND EXCEPTION HANDLING	1970	=head1 ERROR AND EXCEPTION HANDLING
1808		1971
1809	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
1810	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
…		…
1822	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	1985	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1823	so on.	1986	so on.
1824		1987
1825	=head1 ENVIRONMENT VARIABLES	1988	=head1 ENVIRONMENT VARIABLES
1826		1989
1827	The following environment variables are used by this module or its	1990	AnyEvent supports a number of environment variables that tune the
1828	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.
1829		1996
1830	Note that AnyEvent will remove I<all> environment variables starting with	1997	All the environment variables documented here start with
1831	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
1832	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:
1833		2027
1834	=over 4	2028	=over 4
1835		2029
1836	=item C<PERL_ANYEVENT_VERBOSE>	2030	=item C<PERL_ANYEVENT_VERBOSE>
1837		2031
1838	By default, AnyEvent will be completely silent except in fatal	2032	By default, AnyEvent will be completely silent except in fatal
1839	conditions. You can set this environment variable to make AnyEvent more	2033	conditions. You can set this environment variable to make AnyEvent more
1840	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.
1841		2037
1842	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
1843	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
1844	C<PERL_ANYEVENT_MODEL>.	2040	C<PERL_ANYEVENT_MODEL>.
1845		2041
1846	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
1847	model it chooses.	2043	model it chooses.
1848		2044
1849	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
1850	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	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2059	so will take effect even before AnyEvent has initialised itself.
		2060
		2061	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2062	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2063	using the latter saves a few hundred kB of memory until the first message
		2064	is being logged.
1851		2065
1852	=item C<PERL_ANYEVENT_STRICT>	2066	=item C<PERL_ANYEVENT_STRICT>
1853		2067
1854	AnyEvent does not do much argument checking by default, as thorough	2068	AnyEvent does not do much argument checking by default, as thorough
1855	argument checking is very costly. Setting this variable to a true value	2069	argument checking is very costly. Setting this variable to a true value
…		…
1862	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2076	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1863	>>, it is definitely recommended to keep it off in production. Keeping	2077	>>, it is definitely recommended to keep it off in production. Keeping
1864	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2078	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1865	can be very useful, however.	2079	can be very useful, however.
1866		2080
		2081	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2082
		2083	If this env variable is set, then its contents will be interpreted by
		2084	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2085	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2086	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2087
		2088	This happens when the first watcher is created.
		2089
		2090	For example, to bind a debug shell on a unix domain socket in
		2091	F<< /tmp/debug<pid>.sock >>, you could use this:
		2092
		2093	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2094
		2095	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2096	systems.
		2097
		2098	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2099
		2100	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2101	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2102
1867	=item C<PERL_ANYEVENT_MODEL>	2103	=item C<PERL_ANYEVENT_MODEL>
1868		2104
1869	This can be used to specify the event model to be used by AnyEvent, before	2105	This can be used to specify the event model to be used by AnyEvent, before
1870	auto detection and -probing kicks in. It must be a string consisting	2106	auto detection and -probing kicks in.
1871	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2107
		2108	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2109	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1872	and the resulting module name is loaded and if the load was successful,	2110	resulting module name is loaded and - if the load was successful - used as
1873	used as event model. If it fails to load AnyEvent will proceed with	2111	event model backend. If it fails to load then AnyEvent will proceed with
1874	auto detection and -probing.	2112	auto detection and -probing.
1875		2113
1876	This functionality might change in future versions.	2114	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2115	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2116	the end of a string designates a module name and quotes it appropriately).
1877		2117
1878	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2118	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1879	could start your program like this:	2119	could start your program like this:
1880		2120
1881	PERL_ANYEVENT_MODEL=Perl perl ...	2121	PERL_ANYEVENT_MODEL=Perl perl ...
1882		2122
1883	=item C<PERL_ANYEVENT_PROTOCOLS>	2123	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1899	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2139	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1900	- only support IPv4, never try to resolve or contact IPv6	2140	- only support IPv4, never try to resolve or contact IPv6
1901	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2141	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1902	IPv6, but prefer IPv6 over IPv4.	2142	IPv6, but prefer IPv6 over IPv4.
1903		2143
		2144	=item C<PERL_ANYEVENT_HOSTS>
		2145
		2146	This variable, if specified, overrides the F</etc/hosts> file used by
		2147	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2148	from that file instead.
		2149
1904	=item C<PERL_ANYEVENT_EDNS0>	2150	=item C<PERL_ANYEVENT_EDNS0>
1905		2151
1906	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2152	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1907	for DNS. This extension is generally useful to reduce DNS traffic, but	2153	DNS. This extension is generally useful to reduce DNS traffic, especially
1908	some (broken) firewalls drop such DNS packets, which is why it is off by	2154	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1909	default.	2155	packets, which is why it is off by default.
1910		2156
1911	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2157	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1912	EDNS0 in its DNS requests.	2158	EDNS0 in its DNS requests.
1913		2159
1914	=item C<PERL_ANYEVENT_MAX_FORKS>	2160	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1922	resolver - this is the maximum number of parallel DNS requests that are	2168	resolver - this is the maximum number of parallel DNS requests that are
1923	sent to the DNS server.	2169	sent to the DNS server.
1924		2170
1925	=item C<PERL_ANYEVENT_RESOLV_CONF>	2171	=item C<PERL_ANYEVENT_RESOLV_CONF>
1926		2172
1927	The file to use instead of F</etc/resolv.conf> (or OS-specific	2173	The absolute path to a F<resolv.conf>-style file to use instead of
1928	configuration) in the default resolver. When set to the empty string, no	2174	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1929	default config will be used.	2175	resolver, or the empty string to select the default configuration.
1930		2176
1931	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2177	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1932		2178
1933	When neither C<ca_file> nor C<ca_path> was specified during	2179	When neither C<ca_file> nor C<ca_path> was specified during
1934	L<AnyEvent::TLS> context creation, and either of these environment	2180	L<AnyEvent::TLS> context creation, and either of these environment
1935	variables exist, they will be used to specify CA certificate locations	2181	variables are nonempty, they will be used to specify CA certificate
1936	instead of a system-dependent default.	2182	locations instead of a system-dependent default.
1937		2183
1938	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2184	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1939		2185
1940	When these are set to C<1>, then the respective modules are not	2186	When these are set to C<1>, then the respective modules are not
1941	loaded. Mostly good for testing AnyEvent itself.	2187	loaded. Mostly good for testing AnyEvent itself.
…		…
2273	(even when used without AnyEvent), but most event loops have acceptable	2519	(even when used without AnyEvent), but most event loops have acceptable
2274	performance with or without AnyEvent.	2520	performance with or without AnyEvent.
2275		2521
2276	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2522	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2277	the actual event loop, only with extremely fast event loops such as EV	2523	the actual event loop, only with extremely fast event loops such as EV
2278	adds AnyEvent significant overhead.	2524	does AnyEvent add significant overhead.
2279		2525
2280	=item * You should avoid POE like the plague if you want performance or	2526	=item * You should avoid POE like the plague if you want performance or
2281	reasonable memory usage.	2527	reasonable memory usage.
2282		2528
2283	=back	2529	=back
…		…
2582		2828
2583	=item L<Time::HiRes>	2829	=item L<Time::HiRes>
2584		2830
2585	This module is part of perl since release 5.008. It will be used when the	2831	This module is part of perl since release 5.008. It will be used when the
2586	chosen event library does not come with a timing source of its own. The	2832	chosen event library does not come with a timing source of its own. The
2587	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2833	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2588	try to use a monotonic clock for timing stability.	2834	try to use a monotonic clock for timing stability.
2589		2835
2590	=back	2836	=back
2591		2837
2592		2838
…		…
2654	pronounced).	2900	pronounced).
2655		2901
2656		2902
2657	=head1 SEE ALSO	2903	=head1 SEE ALSO
2658		2904
2659	Utility functions: L<AnyEvent::Util>.	2905	Tutorial/Introduction: L<AnyEvent::Intro>.
2660		2906
2661	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2907	FAQ: L<AnyEvent::FAQ>.
2662	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2908
		2909	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2910	(simply logging).
		2911
		2912	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2913	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2914
		2915	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2916	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2917	L<Qt>, L<POE>, L<FLTK>.
2663		2918
2664	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2919	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2665	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2920	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2666	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2921	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2667	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	2922	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2923	L<AnyEvent::Impl::FLTK>.
2668		2924
2669	Non-blocking file handles, sockets, TCP clients and	2925	Non-blocking handles, pipes, stream sockets, TCP clients and
2670	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2926	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2671		2927
2672	Asynchronous DNS: L<AnyEvent::DNS>.	2928	Asynchronous DNS: L<AnyEvent::DNS>.
2673		2929
2674	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2930	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2675	L<Coro::Event>,
2676		2931
2677	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2932	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2678	L<AnyEvent::HTTP>.	2933	L<AnyEvent::HTTP>.
2679		2934
2680		2935
2681	=head1 AUTHOR	2936	=head1 AUTHOR
2682		2937

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.330 by root, Tue Aug 31 00:59:55 2010 UTC vs. Revision 1.375 by root, Thu Aug 25 05:39:47 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.330 by root, Tue Aug 31 00:59:55 2010 UTC vs.
Revision 1.375 by root, Thu Aug 25 05:39:47 2011 UTC