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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.350 by root, Tue Aug 2 20:02:44 2011 UTC vs.
Revision 1.405 by root, Tue Aug 14 02:28:22 2012 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - the DBI of event loop programming	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6	and POE are various supported event loops/environments.	6	FLTK and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
121	The interface itself is vaguely similar, but not identical to the L<Event>	121	The interface itself is vaguely similar, but not identical to the L<Event>
122	module.	122	module.
123		123
124	During the first call of any watcher-creation method, the module tries	124	During the first call of any watcher-creation method, the module tries
125	to detect the currently loaded event loop by probing whether one of the	125	to detect the currently loaded event loop by probing whether one of the
126	following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one	127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
128	found is used. If none are detected, the module tries to load the first	128	found is used. If none are detected, the module tries to load the first
129	four modules in the order given; but note that if L<EV> is not	129	four modules in the order given; but note that if L<EV> is not
130	available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
131	the other two are not normally tried.	131	the other two are not normally tried.
132		132
133	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
134	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
135	that model the default. For example:	135	that model the default. For example:
…		…
142	The I<likely> means that, if any module loads another event model and	142	The I<likely> means that, if any module loads another event model and
143	starts using it, all bets are off - this case should be very rare though,	143	starts using it, all bets are off - this case should be very rare though,
144	as very few modules hardcode event loops without announcing this very	144	as very few modules hardcode event loops without announcing this very
145	loudly.	145	loudly.
146		146
147	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	other event modules you can load it explicitly and enjoy the high
149	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
150		150
151	=head1 WATCHERS	151	=head1 WATCHERS
152		152
153	AnyEvent has the central concept of a I<watcher>, which is an object that	153	AnyEvent has the central concept of a I<watcher>, which is an object that
154	stores relevant data for each kind of event you are waiting for, such as	154	stores relevant data for each kind of event you are waiting for, such as
…		…
356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
357	account.	357	account.
358		358
359	=item AnyEvent->now_update	359	=item AnyEvent->now_update
360		360
361	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache	361	Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362	the current time for each loop iteration (see the discussion of L<<	362	time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363	AnyEvent->now >>, above).	363	above).
364		364
365	When a callback runs for a long time (or when the process sleeps), then	365	When a callback runs for a long time (or when the process sleeps), then
366	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
367	might affect timers and time-outs.	367	might affect timers and time-outs.
368		368
…		…
415	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's	415	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416	pure perl implementation).	416	pure perl implementation).
417		417
418	=head3 Safe/Unsafe Signals	418	=head3 Safe/Unsafe Signals
419		419
420	Perl signals can be either "safe" (synchronous to opcode handling) or	420	Perl signals can be either "safe" (synchronous to opcode handling)
421	"unsafe" (asynchronous) - the former might get delayed indefinitely, the	421	or "unsafe" (asynchronous) - the former might delay signal delivery
422	latter might corrupt your memory.	422	indefinitely, the latter might corrupt your memory.
423		423
424	AnyEvent signal handlers are, in addition, synchronous to the event loop,	424	AnyEvent signal handlers are, in addition, synchronous to the event loop,
425	i.e. they will not interrupt your running perl program but will only be	425	i.e. they will not interrupt your running perl program but will only be
426	called as part of the normal event handling (just like timer, I/O etc.	426	called as part of the normal event handling (just like timer, I/O etc.
427	callbacks, too).	427	callbacks, too).
428		428
429	=head3 Signal Races, Delays and Workarounds	429	=head3 Signal Races, Delays and Workarounds
430		430
431	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	431	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support
432	callbacks to signals in a generic way, which is a pity, as you cannot	432	attaching callbacks to signals in a generic way, which is a pity,
433	do race-free signal handling in perl, requiring C libraries for	433	as you cannot do race-free signal handling in perl, requiring
434	this. AnyEvent will try to do its best, which means in some cases,	434	C libraries for this. AnyEvent will try to do its best, which
435	signals will be delayed. The maximum time a signal might be delayed is	435	means in some cases, signals will be delayed. The maximum time
436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This	436	a signal might be delayed is 10 seconds by default, but can
437	variable can be changed only before the first signal watcher is created,	437	be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
438	and should be left alone otherwise. This variable determines how often	438	C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
439	AnyEvent polls for signals (in case a wake-up was missed). Higher values	439	section for details.
440	will cause fewer spurious wake-ups, which is better for power and CPU
441	saving.
442		440
443	All these problems can be avoided by installing the optional	441	All these problems can be avoided by installing the optional
444	L<Async::Interrupt> module, which works with most event loops. It will not	442	L<Async::Interrupt> module, which works with most event loops. It will not
445	work with inherently broken event loops such as L<Event> or L<Event::Lib>	443	work with inherently broken event loops such as L<Event> or L<Event::Lib>
446	(and not with L<POE> currently, as POE does its own workaround with	444	(and not with L<POE> currently). For those, you just have to suffer the
447	one-second latency). For those, you just have to suffer the delays.	445	delays.
448		446
449	=head2 CHILD PROCESS WATCHERS	447	=head2 CHILD PROCESS WATCHERS
450		448
451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);	449	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
452		450
…		…
482	thing in an AnyEvent program, you I<have> to create at least one	480	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	481	watcher before you C<fork> the child (alternatively, you can call
484	C<AnyEvent::detect>).	482	C<AnyEvent::detect>).
485		483
486	As most event loops do not support waiting for child events, they will be	484	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	485	emulated by AnyEvent in most cases, in which case the latency and race
488	mentioned in the description of signal watchers apply.	486	problems mentioned in the description of signal watchers apply.
489		487
490	Example: fork a process and wait for it	488	Example: fork a process and wait for it
491		489
492	my $done = AnyEvent->condvar;	490	my $done = AnyEvent->condvar;
493		491
…		…
860	use. If EV is not installed, then AnyEvent will fall back to its own	858	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	859	pure-perl implementation, which is available everywhere as it comes with
862	AnyEvent itself.	860	AnyEvent itself.
863		861
864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	862	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	863	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866		864
867	=item Backends that are transparently being picked up when they are used.	865	=item Backends that are transparently being picked up when they are used.
868		866
869	These will be used if they are already loaded when the first watcher	867	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	868	is created, in which case it is assumed that the application is using
…		…
878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	876	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879	AnyEvent::Impl::POE based on POE, very slow, some limitations.	877	AnyEvent::Impl::POE based on POE, very slow, some limitations.
880	AnyEvent::Impl::Irssi used when running within irssi.	878	AnyEvent::Impl::Irssi used when running within irssi.
881	AnyEvent::Impl::IOAsync based on IO::Async.	879	AnyEvent::Impl::IOAsync based on IO::Async.
882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.	880	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883	AnyEvent::Impl::FLTK based on FLTK.	881	AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
884		882
885	=item Backends with special needs.	883	=item Backends with special needs.
886		884
887	Qt requires the Qt::Application to be instantiated first, but will	885	Qt requires the Qt::Application to be instantiated first, but will
888	otherwise be picked up automatically. As long as the main program	886	otherwise be picked up automatically. As long as the main program
…		…
933		931
934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	932	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
935	if necessary. You should only call this function right before you would	933	if necessary. You should only call this function right before you would
936	have created an AnyEvent watcher anyway, that is, as late as possible at	934	have created an AnyEvent watcher anyway, that is, as late as possible at
937	runtime, and not e.g. during initialisation of your module.	935	runtime, and not e.g. during initialisation of your module.
		936
		937	The effect of calling this function is as if a watcher had been created
		938	(specifically, actions that happen "when the first watcher is created"
		939	happen when calling detetc as well).
938		940
939	If you need to do some initialisation before AnyEvent watchers are	941	If you need to do some initialisation before AnyEvent watchers are
940	created, use C<post_detect>.	942	created, use C<post_detect>.
941		943
942	=item $guard = AnyEvent::post_detect { BLOCK }	944	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1005	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1007	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1006	# as soon as it is	1008	# as soon as it is
1007	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1009	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1008	}	1010	}
1009		1011
		1012	=item AnyEvent::postpone { BLOCK }
		1013
		1014	Arranges for the block to be executed as soon as possible, but not before
		1015	the call itself returns. In practise, the block will be executed just
		1016	before the event loop polls for new events, or shortly afterwards.
		1017
		1018	This function never returns anything (to make the C<return postpone { ...
		1019	}> idiom more useful.
		1020
		1021	To understand the usefulness of this function, consider a function that
		1022	asynchronously does something for you and returns some transaction
		1023	object or guard to let you cancel the operation. For example,
		1024	C<AnyEvent::Socket::tcp_connect>:
		1025
		1026	# start a conenction attempt unless one is active
		1027	$self->{connect_guard} \|\|= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1028	delete $self->{connect_guard};
		1029	...
		1030	};
		1031
		1032	Imagine that this function could instantly call the callback, for
		1033	example, because it detects an obvious error such as a negative port
		1034	number. Invoking the callback before the function returns causes problems
		1035	however: the callback will be called and will try to delete the guard
		1036	object. But since the function hasn't returned yet, there is nothing to
		1037	delete. When the function eventually returns it will assign the guard
		1038	object to C<< $self->{connect_guard} >>, where it will likely never be
		1039	deleted, so the program thinks it is still trying to connect.
		1040
		1041	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1042	callback directly on error:
		1043
		1044	$cb->(undef), return # signal error to callback, BAD!
		1045	if $some_error_condition;
		1046
		1047	It should use C<postpone>:
		1048
		1049	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1050	if $some_error_condition;
		1051
		1052	=item AnyEvent::log $level, $msg[, @args]
		1053
		1054	Log the given C<$msg> at the given C<$level>.
		1055
		1056	If L<AnyEvent::Log> is not loaded then this function makes a simple test
		1057	to see whether the message will be logged. If the test succeeds it will
		1058	load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
		1059	the L<AnyEvent::Log> documentation for details.
		1060
		1061	If the test fails it will simply return. Right now this happens when a
		1062	numerical loglevel is used and it is larger than the level specified via
		1063	C<$ENV{PERL_ANYEVENT_VERBOSE}>.
		1064
		1065	If you want to sprinkle loads of logging calls around your code, consider
		1066	creating a logger callback with the C<AnyEvent::Log::logger> function,
		1067	which can reduce typing, codesize and can reduce the logging overhead
		1068	enourmously.
		1069
1010	=back	1070	=back
1011		1071
1012	=head1 WHAT TO DO IN A MODULE	1072	=head1 WHAT TO DO IN A MODULE
1013		1073
1014	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1074	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1047	modules might create watchers when they are loaded, and AnyEvent will	1107	modules might create watchers when they are loaded, and AnyEvent will
1048	decide on the event model to use as soon as it creates watchers, and it	1108	decide on the event model to use as soon as it creates watchers, and it
1049	might choose the wrong one unless you load the correct one yourself.	1109	might choose the wrong one unless you load the correct one yourself.
1050		1110
1051	You can chose to use a pure-perl implementation by loading the	1111	You can chose to use a pure-perl implementation by loading the
1052	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1112	C<AnyEvent::Loop> module, which gives you similar behaviour
1053	everywhere, but letting AnyEvent chose the model is generally better.	1113	everywhere, but letting AnyEvent chose the model is generally better.
1054		1114
1055	=head2 MAINLOOP EMULATION	1115	=head2 MAINLOOP EMULATION
1056		1116
1057	Sometimes (often for short test scripts, or even standalone programs who	1117	Sometimes (often for short test scripts, or even standalone programs who
…		…
1070		1130
1071		1131
1072	=head1 OTHER MODULES	1132	=head1 OTHER MODULES
1073		1133
1074	The following is a non-exhaustive list of additional modules that use	1134	The following is a non-exhaustive list of additional modules that use
1075	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1135	AnyEvent as a client and can therefore be mixed easily with other
1076	modules and other event loops in the same program. Some of the modules	1136	AnyEvent modules and other event loops in the same program. Some of the
1077	come as part of AnyEvent, the others are available via CPAN.	1137	modules come as part of AnyEvent, the others are available via CPAN (see
		1138	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1139	a longer non-exhaustive list), and the list is heavily biased towards
		1140	modules of the AnyEvent author himself :)
1078		1141
1079	=over 4	1142	=over 4
1080		1143
1081	=item L<AnyEvent::Util>	1144	=item L<AnyEvent::Util>
1082		1145
…		…
1102	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>	1165	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1103		1166
1104	Implement event-based interfaces to the protocols of the same name (for	1167	Implement event-based interfaces to the protocols of the same name (for
1105	the curious, IGS is the International Go Server and FCP is the Freenet	1168	the curious, IGS is the International Go Server and FCP is the Freenet
1106	Client Protocol).	1169	Client Protocol).
1107
1108	=item L<AnyEvent::Handle::UDP>
1109
1110	Here be danger!
1111
1112	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1113	there are so many things wrong with AnyEvent::Handle::UDP, most notably
1114	its use of a stream-based API with a protocol that isn't streamable, that
1115	the only way to improve it is to delete it.
1116
1117	It features data corruption (but typically only under load) and general
1118	confusion. On top, the author is not only clueless about UDP but also
1119	fact-resistant - some gems of his understanding: "connect doesn't work
1120	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1121	packets", "I don't need to implement proper error checking as UDP doesn't
1122	support error checking" and so on - he doesn't even understand what's
1123	wrong with his module when it is explained to him.
1124
1125	=item L<AnyEvent::DBI>
1126
1127	Executes L<DBI> requests asynchronously in a proxy process for you,
1128	notifying you in an event-based way when the operation is finished.
1129		1170
1130	=item L<AnyEvent::AIO>	1171	=item L<AnyEvent::AIO>
1131		1172
1132	Truly asynchronous (as opposed to non-blocking) I/O, should be in the	1173	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1133	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1174	toolbox of every event programmer. AnyEvent::AIO transparently fuses
1134	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based	1175	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1135	file I/O, and much more.	1176	file I/O, and much more.
1136		1177
		1178	=item L<AnyEvent::Filesys::Notify>
		1179
		1180	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1181	path changes (e.g. "watch this directory for new files", "watch this
		1182	file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
		1183	do just that in a portbale fashion, supporting inotify on GNU/Linux and
		1184	some weird, without doubt broken, stuff on OS X to monitor files. It can
		1185	fall back to blocking scans at regular intervals transparently on other
		1186	platforms, so it's about as portable as it gets.
		1187
		1188	(I haven't used it myself, but I haven't heard anybody complaining about
		1189	it yet).
		1190
		1191	=item L<AnyEvent::DBI>
		1192
		1193	Executes L<DBI> requests asynchronously in a proxy process for you,
		1194	notifying you in an event-based way when the operation is finished.
		1195
1137	=item L<AnyEvent::HTTPD>	1196	=item L<AnyEvent::HTTPD>
1138		1197
1139	A simple embedded webserver.	1198	A simple embedded webserver.
1140		1199
1141	=item L<AnyEvent::FastPing>	1200	=item L<AnyEvent::FastPing>
1142		1201
1143	The fastest ping in the west.	1202	The fastest ping in the west.
1144		1203
1145	=item L<Coro>	1204	=item L<Coro>
1146		1205
1147	Has special support for AnyEvent via L<Coro::AnyEvent>.	1206	Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
		1207	to simply invert the flow control - don't call us, we will call you:
		1208
		1209	async {
		1210	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1211	print "5 seconds later!\n";
		1212
		1213	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1214	my $line = <STDIN>; # works for ttys
		1215
		1216	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1217	my ($body, $hdr) = Coro::rouse_wait;
		1218	};
1148		1219
1149	=back	1220	=back
1150		1221
1151	=cut	1222	=cut
1152		1223
1153	package AnyEvent;	1224	package AnyEvent;
1154		1225
1155	# basically a tuned-down version of common::sense	1226	# basically a tuned-down version of common::sense
1156	sub common_sense {	1227	sub common_sense {
1157	# from common:.sense 3.4	1228	# from common:.sense 3.5
		1229	local $^W;
1158	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";	1230	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1159	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)	1231	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1160	$^H \|= 0x00000600;	1232	$^H \|= 0x00000600;
1161	}	1233	}
1162		1234
1163	BEGIN { AnyEvent::common_sense }	1235	BEGIN { AnyEvent::common_sense }
1164		1236
1165	use Carp ();	1237	use Carp ();
1166		1238
1167	our $VERSION = '5.34';	1239	our $VERSION = '7.02';
1168	our $MODEL;	1240	our $MODEL;
1169
1170	our $AUTOLOAD;
1171	our @ISA;	1241	our @ISA;
1172
1173	our @REGISTRY;	1242	our @REGISTRY;
1174
1175	our $VERBOSE;	1243	our $VERBOSE;
		1244	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
		1245	our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} \|\| 10; # executes after the BEGIN block below (tainting!)
1176		1246
1177	BEGIN {	1247	BEGIN {
1178	require "AnyEvent/constants.pl";	1248	require "AnyEvent/constants.pl";
1179		1249
1180	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1250	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1181		1251
1182	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1252	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1183	if ${^TAINT};	1253	if ${^TAINT};
1184		1254
1185	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1255	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1256	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1186		1257
1187	}	1258	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1259	if ${^TAINT};
1188		1260
1189	our $MAX_SIGNAL_LATENCY = 10;	1261	# $ENV{PERL_ANYEVENT_xxx} now valid
1190		1262
1191	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1263	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1192		1264
1193	{
1194	my $idx;	1265	my $idx;
1195	$PROTOCOL{$_} = ++$idx	1266	$PROTOCOL{$_} = ++$idx
1196	for reverse split /\s,\s/,	1267	for reverse split /\s,\s/,
1197	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1268	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1198	}	1269	}
1199		1270
		1271	our @post_detect;
		1272
		1273	sub post_detect(&) {
		1274	my ($cb) = @_;
		1275
		1276	push @post_detect, $cb;
		1277
		1278	defined wantarray
		1279	? bless \$cb, "AnyEvent::Util::postdetect"
		1280	: ()
		1281	}
		1282
		1283	sub AnyEvent::Util::postdetect::DESTROY {
		1284	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1285	}
		1286
		1287	our $POSTPONE_W;
		1288	our @POSTPONE;
		1289
		1290	sub _postpone_exec {
		1291	undef $POSTPONE_W;
		1292
		1293	&{ shift @POSTPONE }
		1294	while @POSTPONE;
		1295	}
		1296
		1297	sub postpone(&) {
		1298	push @POSTPONE, shift;
		1299
		1300	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1301
		1302	()
		1303	}
		1304
		1305	sub log($$;@) {
		1306	# only load the big bloated module when we actually are about to log something
		1307	if ($_[0] <= ($VERBOSE \|\| 1)) { # also catches non-numeric levels(!) and fatal
		1308	local ($!, $@);
		1309	require AnyEvent::Log; # among other things, sets $VERBOSE to 9
		1310	# AnyEvent::Log overwrites this function
		1311	goto &log;
		1312	}
		1313
		1314	0 # not logged
		1315	}
		1316
		1317	sub _logger($;$) {
		1318	my ($level, $renabled) = @_;
		1319
		1320	$$renabled = $level <= $VERBOSE;
		1321
		1322	my $logger = [(caller)[0], $level, $renabled];
		1323
		1324	$AnyEvent::Log::LOGGER{$logger+0} = $logger;
		1325
		1326	# return unless defined wantarray;
		1327	#
		1328	# require AnyEvent::Util;
		1329	# my $guard = AnyEvent::Util::guard (sub {
		1330	# # "clean up"
		1331	# delete $LOGGER{$logger+0};
		1332	# });
		1333	#
		1334	# sub {
		1335	# return 0 unless $$renabled;
		1336	#
		1337	# $guard if 0; # keep guard alive, but don't cause runtime overhead
		1338	# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
		1339	# package AnyEvent::Log;
		1340	# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
		1341	# }
		1342	}
		1343
		1344	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1345	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1346	}
		1347
1200	my @models = (	1348	our @models = (
1201	[EV:: => AnyEvent::Impl::EV:: , 1],	1349	[EV:: => AnyEvent::Impl::EV::],
1202	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1350	[AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1203	# everything below here will not (normally) be autoprobed	1351	# everything below here will not (normally) be autoprobed
1204	# as the pureperl backend should work everywhere	1352	# as the pure perl backend should work everywhere
1205	# and is usually faster	1353	# and is usually faster
		1354	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1206	[Event:: => AnyEvent::Impl::Event::, 1],	1355	[Event:: => AnyEvent::Impl::Event::], # slow, stable
1207	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1356	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
		1357	# everything below here should not be autoloaded
1208	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1358	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1209	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1210	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1359	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1211	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1360	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1212	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1361	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1213	[Wx:: => AnyEvent::Impl::POE::],	1362	[Wx:: => AnyEvent::Impl::POE::],
1214	[Prima:: => AnyEvent::Impl::POE::],	1363	[Prima:: => AnyEvent::Impl::POE::],
1215	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1364	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1216	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1365	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1217	[FLTK:: => AnyEvent::Impl::FLTK::],	1366	[FLTK:: => AnyEvent::Impl::FLTK::],
1218	);	1367	);
1219		1368
1220	our %method = map +($_ => 1),	1369	our @isa_hook;
		1370
		1371	sub _isa_set {
		1372	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1373
		1374	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1375	for 1 .. $#pkg;
		1376
		1377	grep $_ && $_->[1], @isa_hook
		1378	and AE::_reset ();
		1379	}
		1380
		1381	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1382	sub _isa_hook($$;$) {
		1383	my ($i, $pkg, $reset_ae) = @_;
		1384
		1385	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1386
		1387	_isa_set;
		1388	}
		1389
		1390	# all autoloaded methods reserve the complete glob, not just the method slot.
		1391	# due to bugs in perls method cache implementation.
1221	qw(io timer time now now_update signal child idle condvar DESTROY);	1392	our @methods = qw(io timer time now now_update signal child idle condvar);
1222
1223	our @post_detect;
1224
1225	sub post_detect(&) {
1226	my ($cb) = @_;
1227
1228	push @post_detect, $cb;
1229
1230	defined wantarray
1231	? bless \$cb, "AnyEvent::Util::postdetect"
1232	: ()
1233	}
1234
1235	sub AnyEvent::Util::postdetect::DESTROY {
1236	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1237	}
1238		1393
1239	sub detect() {	1394	sub detect() {
		1395	return $MODEL if $MODEL; # some programs keep references to detect
		1396
		1397	# IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
		1398	# the author knows about the problems and what it does to AnyEvent as a whole
		1399	# (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
		1400	# anyway.
		1401	AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n"
		1402	. "design, abuses internals and breaks AnyEvent - will not continue."
		1403	if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
		1404
		1405	local $!; # for good measure
		1406	local $SIG{__DIE__}; # we use eval
		1407
1240	# free some memory	1408	# free some memory
1241	*detect = sub () { $MODEL };	1409	*detect = sub () { $MODEL };
		1410	# undef &func doesn't correctly update the method cache. grmbl.
		1411	# so we delete the whole glob. grmbl.
		1412	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1413	# a glob with an active sub. hrm. i hope it works, but perl is
		1414	# usually buggy in this department. sigh.
		1415	delete @{"AnyEvent::"}{@methods};
		1416	undef @methods;
1242		1417
1243	local $!; # for good measure
1244	local $SIG{__DIE__};
1245
1246	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1418	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1247	my $model = "AnyEvent::Impl::$1";	1419	my $model = $1;
		1420	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1248	if (eval "require $model") {	1421	if (eval "require $model") {
		1422	AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1249	$MODEL = $model;	1423	$MODEL = $model;
1250	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1251	} else {	1424	} else {
1252	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1425	AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1253	}	1426	}
1254	}	1427	}
1255		1428
1256	# check for already loaded models	1429	# check for already loaded models
1257	unless ($MODEL) {	1430	unless ($MODEL) {
1258	for (@REGISTRY, @models) {	1431	for (@REGISTRY, @models) {
1259	my ($package, $model) = @$_;	1432	my ($package, $model) = @$_;
1260	if (${"$package\::VERSION"} > 0) {	1433	if (${"$package\::VERSION"} > 0) {
1261	if (eval "require $model") {	1434	if (eval "require $model") {
		1435	AnyEvent::log 7 => "Autodetected model '$model', using it.";
1262	$MODEL = $model;	1436	$MODEL = $model;
1263	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1437	last;
		1438	} else {
		1439	AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@";
		1440	}
		1441	}
		1442	}
		1443
		1444	unless ($MODEL) {
		1445	# try to autoload a model
		1446	for (@REGISTRY, @models) {
		1447	my ($package, $model) = @$_;
		1448	if (
		1449	eval "require $package"
		1450	and ${"$package\::VERSION"} > 0
		1451	and eval "require $model"
		1452	) {
		1453	AnyEvent::log 7 => "Autoloaded model '$model', using it.";
		1454	$MODEL = $model;
1264	last;	1455	last;
1265	}	1456	}
1266	}	1457	}
1267	}
1268
1269	unless ($MODEL) {
1270	# try to autoload a model
1271	for (@REGISTRY, @models) {
1272	my ($package, $model, $autoload) = @$_;
1273	if (
1274	$autoload
1275	and eval "require $package"
1276	and ${"$package\::VERSION"} > 0
1277	and eval "require $model"
1278	) {
1279	$MODEL = $model;
1280	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1281	last;
1282	}
1283	}
1284		1458
1285	$MODEL	1459	$MODEL
1286	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1460	or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?";
1287	}	1461	}
1288	}	1462	}
1289		1463
1290	@models = (); # free probe data	1464	# free memory only needed for probing
		1465	undef @models;
		1466	undef @REGISTRY;
1291		1467
1292	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1468	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293	unshift @ISA, $MODEL;
1294		1469
1295	# now nuke some methods that are overridden by the backend.	1470	# now nuke some methods that are overridden by the backend.
1296	# SUPER is not allowed.	1471	# SUPER usage is not allowed in these.
1297	for (qw(time signal child idle)) {	1472	for (qw(time signal child idle)) {
1298	undef &{"AnyEvent::Base::$_"}	1473	undef &{"AnyEvent::Base::$_"}
1299	if defined &{"$MODEL\::$_"};	1474	if defined &{"$MODEL\::$_"};
1300	}	1475	}
1301		1476
		1477	_isa_set;
		1478
		1479	# we're officially open!
		1480
1302	if ($ENV{PERL_ANYEVENT_STRICT}) {	1481	if ($ENV{PERL_ANYEVENT_STRICT}) {
1303	eval { require AnyEvent::Strict };	1482	require AnyEvent::Strict;
1304	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305	if $@ && $VERBOSE;
1306	}	1483	}
1307		1484
		1485	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1486	require AnyEvent::Debug;
		1487	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1488	}
		1489
		1490	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1491	require AnyEvent::Socket;
		1492	require AnyEvent::Debug;
		1493
		1494	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1495	$shell =~ s/\$\$/$$/g;
		1496
		1497	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1498	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1499	}
		1500
		1501	# now the anyevent environment is set up as the user told us to, so
		1502	# call the actual user code - post detects
		1503
1308	(shift @post_detect)->() while @post_detect;	1504	(shift @post_detect)->() while @post_detect;
		1505	undef @post_detect;
1309		1506
1310	*post_detect = sub(&) {	1507	*post_detect = sub(&) {
1311	shift->();	1508	shift->();
1312		1509
1313	undef	1510	undef
1314	};	1511	};
1315		1512
1316	$MODEL	1513	$MODEL
1317	}	1514	}
1318		1515
1319	sub AUTOLOAD {	1516	for my $name (@methods) {
1320	(my $func = $AUTOLOAD) =~ s/.*://;	1517	*$name = sub {
1321
1322	$method{$func}
1323	or Carp::croak "$func: not a valid AnyEvent class method";
1324
1325	detect;	1518	detect;
1326		1519	# we use goto because
1327	my $class = shift;	1520	# a) it makes the thunk more transparent
1328	$class->$func (@_);	1521	# b) it allows us to delete the thunk later
		1522	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1523	};
1329	}	1524	}
1330		1525
1331	# utility function to dup a filehandle. this is used by many backends	1526	# utility function to dup a filehandle. this is used by many backends
1332	# to support binding more than one watcher per filehandle (they usually	1527	# to support binding more than one watcher per filehandle (they usually
1333	# allow only one watcher per fd, so we dup it to get a different one).	1528	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1357		1552
1358	package AE;	1553	package AE;
1359		1554
1360	our $VERSION = $AnyEvent::VERSION;	1555	our $VERSION = $AnyEvent::VERSION;
1361		1556
		1557	sub _reset() {
		1558	eval q{
1362	# fall back to the main API by default - backends and AnyEvent::Base	1559	# fall back to the main API by default - backends and AnyEvent::Base
1363	# implementations can overwrite these.	1560	# implementations can overwrite these.
1364		1561
1365	sub io($$$) {	1562	sub io($$$) {
1366	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1563	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1367	}	1564	}
1368		1565
1369	sub timer($$$) {	1566	sub timer($$$) {
1370	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1567	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1371	}	1568	}
1372		1569
1373	sub signal($$) {	1570	sub signal($$) {
1374	AnyEvent->signal (signal => $_[0], cb => $_[1])	1571	AnyEvent->signal (signal => $_[0], cb => $_[1])
1375	}	1572	}
1376		1573
1377	sub child($$) {	1574	sub child($$) {
1378	AnyEvent->child (pid => $_[0], cb => $_[1])	1575	AnyEvent->child (pid => $_[0], cb => $_[1])
1379	}	1576	}
1380		1577
1381	sub idle($) {	1578	sub idle($) {
1382	AnyEvent->idle (cb => $_[0])	1579	AnyEvent->idle (cb => $_[0]);
1383	}	1580	}
1384		1581
1385	sub cv(;&) {	1582	sub cv(;&) {
1386	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1583	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1387	}	1584	}
1388		1585
1389	sub now() {	1586	sub now() {
1390	AnyEvent->now	1587	AnyEvent->now
1391	}	1588	}
1392		1589
1393	sub now_update() {	1590	sub now_update() {
1394	AnyEvent->now_update	1591	AnyEvent->now_update
1395	}	1592	}
1396		1593
1397	sub time() {	1594	sub time() {
1398	AnyEvent->time	1595	AnyEvent->time
		1596	}
		1597
		1598	*postpone = \&AnyEvent::postpone;
		1599	*log = \&AnyEvent::log;
		1600	};
		1601	die if $@;
1399	}	1602	}
		1603
		1604	BEGIN { _reset }
1400		1605
1401	package AnyEvent::Base;	1606	package AnyEvent::Base;
1402		1607
1403	# default implementations for many methods	1608	# default implementations for many methods
1404		1609
1405	sub time {	1610	sub time {
1406	eval q{ # poor man's autoloading {}	1611	eval q{ # poor man's autoloading {}
1407	# probe for availability of Time::HiRes	1612	# probe for availability of Time::HiRes
1408	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1613	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1409	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1614	*time = sub { Time::HiRes::time () };
1410	*AE::time = \&Time::HiRes::time;	1615	*AE::time = \& Time::HiRes::time ;
		1616	*now = \&time;
		1617	AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy.";
1411	# if (eval "use POSIX (); (POSIX::times())...	1618	# if (eval "use POSIX (); (POSIX::times())...
1412	} else {	1619	} else {
1413	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1620	*time = sub { CORE::time };
1414	*AE::time = sub (){ time }; # epic fail	1621	*AE::time = sub (){ CORE::time };
		1622	*now = \&time;
		1623	AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!";
1415	}	1624	}
1416
1417	*time = sub { AE::time }; # different prototypes
1418	};	1625	};
1419	die if $@;	1626	die if $@;
1420		1627
1421	&time	1628	&time
1422	}	1629	}
1423		1630
1424	*now = \&time;	1631	*now = \&time;
1425
1426	sub now_update { }	1632	sub now_update { }
1427		1633
		1634	sub _poll {
		1635	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1636	}
		1637
1428	# default implementation for ->condvar	1638	# default implementation for ->condvar
		1639	# in fact, the default should not be overwritten
1429		1640
1430	sub condvar {	1641	sub condvar {
1431	eval q{ # poor man's autoloading {}	1642	eval q{ # poor man's autoloading {}
1432	*condvar = sub {	1643	*condvar = sub {
1433	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1644	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1511		1722
1512	sub signal {	1723	sub signal {
1513	eval q{ # poor man's autoloading {}	1724	eval q{ # poor man's autoloading {}
1514	# probe for availability of Async::Interrupt	1725	# probe for availability of Async::Interrupt
1515	if (_have_async_interrupt) {	1726	if (_have_async_interrupt) {
1516	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1727	AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling.";
1517		1728
1518	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1729	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1519	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1730	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1520		1731
1521	} else {	1732	} else {
1522	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1733	AnyEvent::log 8 => "Using emulated perl signal handling with latency timer.";
1523		1734
1524	if (AnyEvent::WIN32) {	1735	if (AnyEvent::WIN32) {
1525	require AnyEvent::Util;	1736	require AnyEvent::Util;
1526		1737
1527	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1738	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1603	: sysread $SIGPIPE_R, (my $dummy), 9;	1814	: sysread $SIGPIPE_R, (my $dummy), 9;
1604		1815
1605	while (%SIG_EV) {	1816	while (%SIG_EV) {
1606	for (keys %SIG_EV) {	1817	for (keys %SIG_EV) {
1607	delete $SIG_EV{$_};	1818	delete $SIG_EV{$_};
1608	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1819	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1609	}	1820	}
1610	}	1821	}
1611	};	1822	};
1612	};	1823	};
1613	die if $@;	1824	die if $@;
…		…
1640	};	1851	};
1641		1852
1642	*child = sub {	1853	*child = sub {
1643	my (undef, %arg) = @_;	1854	my (undef, %arg) = @_;
1644		1855
1645	defined (my $pid = $arg{pid} + 0)	1856	my $pid = $arg{pid};
1646	or Carp::croak "required option 'pid' is missing";	1857	my $cb = $arg{cb};
1647		1858
1648	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1859	$PID_CB{$pid}{$cb+0} = $cb;
1649		1860
1650	unless ($CHLD_W) {	1861	unless ($CHLD_W) {
1651	$CHLD_W = AE::signal CHLD => \&_sigchld;	1862	$CHLD_W = AE::signal CHLD => \&_sigchld;
1652	# child could be a zombie already, so make at least one round	1863	# child could be a zombie already, so make at least one round
1653	&_sigchld;	1864	&_sigchld;
1654	}	1865	}
1655		1866
1656	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1867	bless [$pid, $cb+0], "AnyEvent::Base::child"
1657	};	1868	};
1658		1869
1659	*AnyEvent::Base::child::DESTROY = sub {	1870	*AnyEvent::Base::child::DESTROY = sub {
1660	my ($pid, $cb) = @{$_[0]};	1871	my ($pid, $icb) = @{$_[0]};
1661		1872
1662	delete $PID_CB{$pid}{$cb};	1873	delete $PID_CB{$pid}{$icb};
1663	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1874	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1664		1875
1665	undef $CHLD_W unless keys %PID_CB;	1876	undef $CHLD_W unless keys %PID_CB;
1666	};	1877	};
1667	};	1878	};
…		…
1680		1891
1681	my ($cb, $w, $rcb) = $arg{cb};	1892	my ($cb, $w, $rcb) = $arg{cb};
1682		1893
1683	$rcb = sub {	1894	$rcb = sub {
1684	if ($cb) {	1895	if ($cb) {
1685	$w = _time;	1896	$w = AE::time;
1686	&$cb;	1897	&$cb;
1687	$w = _time - $w;	1898	$w = AE::time - $w;
1688		1899
1689	# never use more then 50% of the time for the idle watcher,	1900	# never use more then 50% of the time for the idle watcher,
1690	# within some limits	1901	# within some limits
1691	$w = 0.0001 if $w < 0.0001;	1902	$w = 0.0001 if $w < 0.0001;
1692	$w = 5 if $w > 5;	1903	$w = 5 if $w > 5;
…		…
1740	sub _send {	1951	sub _send {
1741	# nop	1952	# nop
1742	}	1953	}
1743		1954
1744	sub _wait {	1955	sub _wait {
1745	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";	1956	AnyEvent->_poll until $_[0]{_ae_sent};
1746	}	1957	}
1747		1958
1748	sub send {	1959	sub send {
1749	my $cv = shift;	1960	my $cv = shift;
1750	$cv->{_ae_sent} = [@_];	1961	$cv->{_ae_sent} = [@_];
…		…
1762	}	1973	}
1763		1974
1764	sub recv {	1975	sub recv {
1765	unless ($_[0]{_ae_sent}) {	1976	unless ($_[0]{_ae_sent}) {
1766	$WAITING	1977	$WAITING
1767	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";	1978	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1768		1979
1769	local $WAITING = 1;	1980	local $WAITING = 1;
1770	$_[0]->_wait;	1981	$_[0]->_wait;
1771	}	1982	}
1772		1983
…		…
1821	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2032	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1822	so on.	2033	so on.
1823		2034
1824	=head1 ENVIRONMENT VARIABLES	2035	=head1 ENVIRONMENT VARIABLES
1825		2036
1826	The following environment variables are used by this module or its	2037	AnyEvent supports a number of environment variables that tune the
1827	submodules.	2038	runtime behaviour. They are usually evaluated when AnyEvent is
		2039	loaded, initialised, or a submodule that uses them is loaded. Many of
		2040	them also cause AnyEvent to load additional modules - for example,
		2041	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2042	loaded.
1828		2043
1829	Note that AnyEvent will remove I<all> environment variables starting with	2044	All the environment variables documented here start with
1830	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2045	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1831	enabled.	2046	namespace. Other modules are encouraged (but by no means required) to use
		2047	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2048	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2049	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2050	variables starting with C<AE_>, see below).
		2051
		2052	All variables can also be set via the C<AE_> prefix, that is, instead
		2053	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2054	case there is a clash btween anyevent and another program that uses
		2055	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2056	variable to the empty string, as those variables take precedence.
		2057
		2058	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2059	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2060	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2061	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2062	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2063	is set).
		2064
		2065	The exact algorithm is currently:
		2066
		2067	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2068	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2069	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2070
		2071	This ensures that child processes will not see the C<AE_> variables.
		2072
		2073	The following environment variables are currently known to AnyEvent:
1832		2074
1833	=over 4	2075	=over 4
1834		2076
1835	=item C<PERL_ANYEVENT_VERBOSE>	2077	=item C<PERL_ANYEVENT_VERBOSE>
1836		2078
1837	By default, AnyEvent will be completely silent except in fatal	2079	By default, AnyEvent will log messages with loglevel C<4> (C<error>) or
1838	conditions. You can set this environment variable to make AnyEvent more	2080	higher (see L<AnyEvent::Log>). You can set this environment variable to a
1839	talkative.	2081	numerical loglevel to make AnyEvent more (or less) talkative.
1840		2082
		2083	If you want to do more than just set the global logging level
		2084	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2085	complex specifications.
		2086
		2087	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2088	everything else at defaults.
		2089
1841	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2090	When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected
1842	conditions, such as not being able to load the event model specified by	2091	conditions, such as not being able to load the event model specified by
1843	C<PERL_ANYEVENT_MODEL>.	2092	C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
		2093	is the minimum recommended level for use during development.
1844		2094
1845	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2095	When set to C<7> or higher (info), AnyEvent reports which event model it
1846	model it chooses.	2096	chooses.
1847		2097
1848	When set to C<8> or higher, then AnyEvent will report extra information on	2098	When set to C<8> or higher (debug), then AnyEvent will report extra
1849	which optional modules it loads and how it implements certain features.	2099	information on which optional modules it loads and how it implements
		2100	certain features.
		2101
		2102	=item C<PERL_ANYEVENT_LOG>
		2103
		2104	Accepts rather complex logging specifications. For example, you could log
		2105	all C<debug> messages of some module to stderr, warnings and above to
		2106	stderr, and errors and above to syslog, with:
		2107
		2108	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2109
		2110	For the rather extensive details, see L<AnyEvent::Log>.
		2111
		2112	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2113	so will take effect even before AnyEvent has initialised itself.
		2114
		2115	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2116	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2117	using the latter saves a few hundred kB of memory unless a module
		2118	explicitly needs the extra features of AnyEvent::Log.
1850		2119
1851	=item C<PERL_ANYEVENT_STRICT>	2120	=item C<PERL_ANYEVENT_STRICT>
1852		2121
1853	AnyEvent does not do much argument checking by default, as thorough	2122	AnyEvent does not do much argument checking by default, as thorough
1854	argument checking is very costly. Setting this variable to a true value	2123	argument checking is very costly. Setting this variable to a true value
…		…
1861	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2130	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1862	>>, it is definitely recommended to keep it off in production. Keeping	2131	>>, it is definitely recommended to keep it off in production. Keeping
1863	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2132	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1864	can be very useful, however.	2133	can be very useful, however.
1865		2134
		2135	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2136
		2137	If this env variable is nonempty, then its contents will be interpreted by
		2138	C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
		2139	replacing every occurance of C<$$> by the process pid). The shell object
		2140	is saved in C<$AnyEvent::Debug::SHELL>.
		2141
		2142	This happens when the first watcher is created.
		2143
		2144	For example, to bind a debug shell on a unix domain socket in
		2145	F<< /tmp/debug<pid>.sock >>, you could use this:
		2146
		2147	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2148	# connect with e.g.: socat readline /tmp/debug123.sock
		2149
		2150	Or to bind to tcp port 4545 on localhost:
		2151
		2152	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		2153	# connect with e.g.: telnet localhost 4545
		2154
		2155	Note that creating sockets in F</tmp> or on localhost is very unsafe on
		2156	multiuser systems.
		2157
		2158	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2159
		2160	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2161	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2162
1866	=item C<PERL_ANYEVENT_MODEL>	2163	=item C<PERL_ANYEVENT_MODEL>
1867		2164
1868	This can be used to specify the event model to be used by AnyEvent, before	2165	This can be used to specify the event model to be used by AnyEvent, before
1869	auto detection and -probing kicks in. It must be a string consisting	2166	auto detection and -probing kicks in.
1870	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2167
		2168	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2169	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1871	and the resulting module name is loaded and if the load was successful,	2170	resulting module name is loaded and - if the load was successful - used as
1872	used as event model. If it fails to load AnyEvent will proceed with	2171	event model backend. If it fails to load then AnyEvent will proceed with
1873	auto detection and -probing.	2172	auto detection and -probing.
1874		2173
1875	This functionality might change in future versions.	2174	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2175	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2176	the end of a string designates a module name and quotes it appropriately).
1876		2177
1877	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2178	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1878	could start your program like this:	2179	could start your program like this:
1879		2180
1880	PERL_ANYEVENT_MODEL=Perl perl ...	2181	PERL_ANYEVENT_MODEL=Perl perl ...
		2182
		2183	=item C<PERL_ANYEVENT_IO_MODEL>
		2184
		2185	The current file I/O model - see L<AnyEvent::IO> for more info.
		2186
		2187	At the moment, only C<Perl> (small, pure-perl, synchronous) and
		2188	C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if
		2189	L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>.
1881		2190
1882	=item C<PERL_ANYEVENT_PROTOCOLS>	2191	=item C<PERL_ANYEVENT_PROTOCOLS>
1883		2192
1884	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences	2193	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1885	for IPv4 or IPv6. The default is unspecified (and might change, or be the result	2194	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
…		…
1898	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2207	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1899	- only support IPv4, never try to resolve or contact IPv6	2208	- only support IPv4, never try to resolve or contact IPv6
1900	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2209	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1901	IPv6, but prefer IPv6 over IPv4.	2210	IPv6, but prefer IPv6 over IPv4.
1902		2211
		2212	=item C<PERL_ANYEVENT_HOSTS>
		2213
		2214	This variable, if specified, overrides the F</etc/hosts> file used by
		2215	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2216	from that file instead.
		2217
1903	=item C<PERL_ANYEVENT_EDNS0>	2218	=item C<PERL_ANYEVENT_EDNS0>
1904		2219
1905	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2220	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1906	for DNS. This extension is generally useful to reduce DNS traffic, but	2221	DNS. This extension is generally useful to reduce DNS traffic, especially
1907	some (broken) firewalls drop such DNS packets, which is why it is off by	2222	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1908	default.	2223	packets, which is why it is off by default.
1909		2224
1910	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2225	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1911	EDNS0 in its DNS requests.	2226	EDNS0 in its DNS requests.
1912		2227
1913	=item C<PERL_ANYEVENT_MAX_FORKS>	2228	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1919		2234
1920	The default value for the C<max_outstanding> parameter for the default DNS	2235	The default value for the C<max_outstanding> parameter for the default DNS
1921	resolver - this is the maximum number of parallel DNS requests that are	2236	resolver - this is the maximum number of parallel DNS requests that are
1922	sent to the DNS server.	2237	sent to the DNS server.
1923		2238
		2239	=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
		2240
		2241	Perl has inherently racy signal handling (you can basically choose between
		2242	losing signals and memory corruption) - pure perl event loops (including
		2243	C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
		2244	have to poll regularly to avoid losing signals.
		2245
		2246	Some event loops are racy, but don't poll regularly, and some event loops
		2247	are written in C but are still racy. For those event loops, AnyEvent
		2248	installs a timer that regularly wakes up the event loop.
		2249
		2250	By default, the interval for this timer is C<10> seconds, but you can
		2251	override this delay with this environment variable (or by setting
		2252	the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
		2253	watchers).
		2254
		2255	Lower values increase CPU (and energy) usage, higher values can introduce
		2256	long delays when reaping children or waiting for signals.
		2257
		2258	The L<AnyEvent::Async> module, if available, will be used to avoid this
		2259	polling (with most event loops).
		2260
1924	=item C<PERL_ANYEVENT_RESOLV_CONF>	2261	=item C<PERL_ANYEVENT_RESOLV_CONF>
1925		2262
1926	The file to use instead of F</etc/resolv.conf> (or OS-specific	2263	The absolute path to a F<resolv.conf>-style file to use instead of
1927	configuration) in the default resolver. When set to the empty string, no	2264	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1928	default config will be used.	2265	resolver, or the empty string to select the default configuration.
1929		2266
1930	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2267	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1931		2268
1932	When neither C<ca_file> nor C<ca_path> was specified during	2269	When neither C<ca_file> nor C<ca_path> was specified during
1933	L<AnyEvent::TLS> context creation, and either of these environment	2270	L<AnyEvent::TLS> context creation, and either of these environment
1934	variables exist, they will be used to specify CA certificate locations	2271	variables are nonempty, they will be used to specify CA certificate
1935	instead of a system-dependent default.	2272	locations instead of a system-dependent default.
1936		2273
1937	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2274	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1938		2275
1939	When these are set to C<1>, then the respective modules are not	2276	When these are set to C<1>, then the respective modules are not
1940	loaded. Mostly good for testing AnyEvent itself.	2277	loaded. Mostly good for testing AnyEvent itself.
…		…
2272	(even when used without AnyEvent), but most event loops have acceptable	2609	(even when used without AnyEvent), but most event loops have acceptable
2273	performance with or without AnyEvent.	2610	performance with or without AnyEvent.
2274		2611
2275	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2612	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2276	the actual event loop, only with extremely fast event loops such as EV	2613	the actual event loop, only with extremely fast event loops such as EV
2277	adds AnyEvent significant overhead.	2614	does AnyEvent add significant overhead.
2278		2615
2279	=item * You should avoid POE like the plague if you want performance or	2616	=item * You should avoid POE like the plague if you want performance or
2280	reasonable memory usage.	2617	reasonable memory usage.
2281		2618
2282	=back	2619	=back
…		…
2581		2918
2582	=item L<Time::HiRes>	2919	=item L<Time::HiRes>
2583		2920
2584	This module is part of perl since release 5.008. It will be used when the	2921	This module is part of perl since release 5.008. It will be used when the
2585	chosen event library does not come with a timing source of its own. The	2922	chosen event library does not come with a timing source of its own. The
2586	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2923	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2587	try to use a monotonic clock for timing stability.	2924	try to use a monotonic clock for timing stability.
2588		2925
2589	=back	2926	=back
2590		2927
2591		2928
…		…
2657		2994
2658	Tutorial/Introduction: L<AnyEvent::Intro>.	2995	Tutorial/Introduction: L<AnyEvent::Intro>.
2659		2996
2660	FAQ: L<AnyEvent::FAQ>.	2997	FAQ: L<AnyEvent::FAQ>.
2661		2998
2662	Utility functions: L<AnyEvent::Util>.	2999	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		3000	(simply logging).
2663		3001
2664	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	3002	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2665	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	3003	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		3004
		3005	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		3006	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		3007	L<Qt>, L<POE>, L<FLTK>.
2666		3008
2667	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	3009	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2668	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	3010	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2669	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	3011	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2670	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	3012	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		3013	L<AnyEvent::Impl::FLTK>.
2671		3014
2672	Non-blocking file handles, sockets, TCP clients and	3015	Non-blocking handles, pipes, stream sockets, TCP clients and
2673	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	3016	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
		3017
		3018	Asynchronous File I/O: L<AnyEvent::IO>.
2674		3019
2675	Asynchronous DNS: L<AnyEvent::DNS>.	3020	Asynchronous DNS: L<AnyEvent::DNS>.
2676		3021
2677	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	3022	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2678		3023
…		…
2681		3026
2682		3027
2683	=head1 AUTHOR	3028	=head1 AUTHOR
2684		3029
2685	Marc Lehmann <schmorp@schmorp.de>	3030	Marc Lehmann <schmorp@schmorp.de>
2686	http://home.schmorp.de/	3031	http://anyevent.schmorp.de
2687		3032
2688	=cut	3033	=cut
2689		3034
2690	1	3035	1
2691		3036

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.350 by root, Tue Aug 2 20:02:44 2011 UTC vs. Revision 1.405 by root, Tue Aug 14 02:28:22 2012 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.350 by root, Tue Aug 2 20:02:44 2011 UTC vs.
Revision 1.405 by root, Tue Aug 14 02:28:22 2012 UTC