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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC vs.
Revision 1.388 by root, Sun Oct 2 01:22:01 2011 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - the DBI of event loop programming	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6	and POE are various supported event loops/environments.	6	FLTK and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
121	The interface itself is vaguely similar, but not identical to the L<Event>	121	The interface itself is vaguely similar, but not identical to the L<Event>
122	module.	122	module.
123		123
124	During the first call of any watcher-creation method, the module tries	124	During the first call of any watcher-creation method, the module tries
125	to detect the currently loaded event loop by probing whether one of the	125	to detect the currently loaded event loop by probing whether one of the
126	following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one	127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
128	found is used. If none are detected, the module tries to load the first	128	found is used. If none are detected, the module tries to load the first
129	four modules in the order given; but note that if L<EV> is not	129	four modules in the order given; but note that if L<EV> is not
130	available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
131	the other two are not normally tried.	131	the other two are not normally tried.
132		132
133	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
134	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
135	that model the default. For example:	135	that model the default. For example:
…		…
142	The I<likely> means that, if any module loads another event model and	142	The I<likely> means that, if any module loads another event model and
143	starts using it, all bets are off - this case should be very rare though,	143	starts using it, all bets are off - this case should be very rare though,
144	as very few modules hardcode event loops without announcing this very	144	as very few modules hardcode event loops without announcing this very
145	loudly.	145	loudly.
146		146
147	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	other event modules you can load it explicitly and enjoy the high
149	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
150		150
151	=head1 WATCHERS	151	=head1 WATCHERS
152		152
153	AnyEvent has the central concept of a I<watcher>, which is an object that	153	AnyEvent has the central concept of a I<watcher>, which is an object that
154	stores relevant data for each kind of event you are waiting for, such as	154	stores relevant data for each kind of event you are waiting for, such as
…		…
356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
357	account.	357	account.
358		358
359	=item AnyEvent->now_update	359	=item AnyEvent->now_update
360		360
361	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache	361	Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362	the current time for each loop iteration (see the discussion of L<<	362	time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363	AnyEvent->now >>, above).	363	above).
364		364
365	When a callback runs for a long time (or when the process sleeps), then	365	When a callback runs for a long time (or when the process sleeps), then
366	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
367	might affect timers and time-outs.	367	might affect timers and time-outs.
368		368
…		…
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 Ö<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.
		881	AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
883		882
884	=item Backends with special needs.	883	=item Backends with special needs.
885		884
886	Qt requires the Qt::Application to be instantiated first, but will	885	Qt requires the Qt::Application to be instantiated first, but will
887	otherwise be picked up automatically. As long as the main program	886	otherwise be picked up automatically. As long as the main program
…		…
932		931
933	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	932	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
934	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
935	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
936	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).
937		940
938	If you need to do some initialisation before AnyEvent watchers are	941	If you need to do some initialisation before AnyEvent watchers are
939	created, use C<post_detect>.	942	created, use C<post_detect>.
940		943
941	=item $guard = AnyEvent::post_detect { BLOCK }	944	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1004	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1007	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1005	# as soon as it is	1008	# as soon as it is
1006	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1009	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1007	}	1010	}
1008		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
1009	=back	1070	=back
1010		1071
1011	=head1 WHAT TO DO IN A MODULE	1072	=head1 WHAT TO DO IN A MODULE
1012		1073
1013	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
…		…
1046	modules might create watchers when they are loaded, and AnyEvent will	1107	modules might create watchers when they are loaded, and AnyEvent will
1047	decide on the event model to use as soon as it creates watchers, and it	1108	decide on the event model to use as soon as it creates watchers, and it
1048	might choose the wrong one unless you load the correct one yourself.	1109	might choose the wrong one unless you load the correct one yourself.
1049		1110
1050	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
1051	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1112	C<AnyEvent::Loop> module, which gives you similar behaviour
1052	everywhere, but letting AnyEvent chose the model is generally better.	1113	everywhere, but letting AnyEvent chose the model is generally better.
1053		1114
1054	=head2 MAINLOOP EMULATION	1115	=head2 MAINLOOP EMULATION
1055		1116
1056	Sometimes (often for short test scripts, or even standalone programs who	1117	Sometimes (often for short test scripts, or even standalone programs who
…		…
1069		1130
1070		1131
1071	=head1 OTHER MODULES	1132	=head1 OTHER MODULES
1072		1133
1073	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
1074	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
1075	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
1076	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 :)
1077		1141
1078	=over 4	1142	=over 4
1079		1143
1080	=item L<AnyEvent::Util>	1144	=item L<AnyEvent::Util>
1081		1145
…		…
1101	=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>
1102		1166
1103	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
1104	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
1105	Client Protocol).	1169	Client Protocol).
1106
1107	=item L<AnyEvent::Handle::UDP>
1108
1109	Here be danger!
1110
1111	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1112	there are so many things wrong with AnyEvent::Handle::UDP, most notably
1113	its use of a stream-based API with a protocol that isn't streamable, that
1114	the only way to improve it is to delete it.
1115
1116	It features data corruption (but typically only under load) and general
1117	confusion. On top, the author is not only clueless about UDP but also
1118	fact-resistant - some gems of his understanding: "connect doesn't work
1119	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1120	packets", "I don't need to implement proper error checking as UDP doesn't
1121	support error checking" and so on - he doesn't even understand what's
1122	wrong with his module when it is explained to him.
1123
1124	=item L<AnyEvent::DBI>
1125
1126	Executes L<DBI> requests asynchronously in a proxy process for you,
1127	notifying you in an event-based way when the operation is finished.
1128		1170
1129	=item L<AnyEvent::AIO>	1171	=item L<AnyEvent::AIO>
1130		1172
1131	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
1132	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1174	toolbox of every event programmer. AnyEvent::AIO transparently fuses
1133	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
1134	file I/O, and much more.	1176	file I/O, and much more.
1135		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
1136	=item L<AnyEvent::HTTPD>	1196	=item L<AnyEvent::HTTPD>
1137		1197
1138	A simple embedded webserver.	1198	A simple embedded webserver.
1139		1199
1140	=item L<AnyEvent::FastPing>	1200	=item L<AnyEvent::FastPing>
1141		1201
1142	The fastest ping in the west.	1202	The fastest ping in the west.
1143		1203
1144	=item L<Coro>	1204	=item L<Coro>
1145		1205
1146	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	};
1147		1219
1148	=back	1220	=back
1149		1221
1150	=cut	1222	=cut
1151		1223
…		…
1161		1233
1162	BEGIN { AnyEvent::common_sense }	1234	BEGIN { AnyEvent::common_sense }
1163		1235
1164	use Carp ();	1236	use Carp ();
1165		1237
1166	our $VERSION = '5.31';	1238	our $VERSION = '6.02';
1167	our $MODEL;	1239	our $MODEL;
1168
1169	our $AUTOLOAD;
1170	our @ISA;	1240	our @ISA;
1171
1172	our @REGISTRY;	1241	our @REGISTRY;
1173
1174	our $VERBOSE;	1242	our $VERBOSE;
		1243	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
		1244	our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} \|\| 10; # executes after the BEGIN block below (tainting!)
1175		1245
1176	BEGIN {	1246	BEGIN {
1177	require "AnyEvent/constants.pl";	1247	require "AnyEvent/constants.pl";
1178		1248
1179	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1249	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1180		1250
1181	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1251	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1182	if ${^TAINT};	1252	if ${^TAINT};
1183		1253
1184	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1254	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1255	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1185		1256
1186	}	1257	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1258	if ${^TAINT};
1187		1259
1188	our $MAX_SIGNAL_LATENCY = 10;	1260	# $ENV{PERL_ANYEVENT_xxx} now valid
1189		1261
1190	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1262	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1191		1263
1192	{
1193	my $idx;	1264	my $idx;
1194	$PROTOCOL{$_} = ++$idx	1265	$PROTOCOL{$_} = ++$idx
1195	for reverse split /\s,\s/,	1266	for reverse split /\s,\s/,
1196	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1267	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1197	}	1268	}
1198		1269
		1270	our @post_detect;
		1271
		1272	sub post_detect(&) {
		1273	my ($cb) = @_;
		1274
		1275	push @post_detect, $cb;
		1276
		1277	defined wantarray
		1278	? bless \$cb, "AnyEvent::Util::postdetect"
		1279	: ()
		1280	}
		1281
		1282	sub AnyEvent::Util::postdetect::DESTROY {
		1283	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1284	}
		1285
		1286	our $POSTPONE_W;
		1287	our @POSTPONE;
		1288
		1289	sub _postpone_exec {
		1290	undef $POSTPONE_W;
		1291
		1292	&{ shift @POSTPONE }
		1293	while @POSTPONE;
		1294	}
		1295
		1296	sub postpone(&) {
		1297	push @POSTPONE, shift;
		1298
		1299	$POSTPONE_W \|\|= AE::timer (0, 0, \&_postpone_exec);
		1300
		1301	()
		1302	}
		1303
		1304	sub log($$;@) {
		1305	# only load the big bloated module when we actually are about to log something
		1306	if ($_[0] <= ($VERBOSE \|\| 1)) { # also catches non-numeric levels(!) and fatal
		1307	local ($!, $@);
		1308	require AnyEvent::Log; # among other things, sets $VERBOSE to 9
		1309	# AnyEvent::Log overwrites this function
		1310	goto &log;
		1311	}
		1312
		1313	0 # not logged
		1314	}
		1315
		1316	sub logger($;$) {
		1317	package AnyEvent::Log;
		1318
		1319	my ($level, $renabled) = @_;
		1320
		1321	$$renabled = $level <= $VERBOSE;
		1322
		1323	my $pkg = (caller)[0];
		1324
		1325	my $logger = [$pkg, $level, $renabled];
		1326
		1327	our %LOGGER;
		1328	$LOGGER{$logger+0} = $logger;
		1329
		1330	return unless defined wantarray;
		1331
		1332	require AnyEvent::Util;
		1333	my $guard = AnyEvent::Util::guard (sub {
		1334	# "clean up"
		1335	delete $LOGGER{$logger+0};
		1336	});
		1337
		1338	sub {
		1339	return 0 unless $$renabled;
		1340
		1341	$guard if 0; # keep guard alive, but don't cause runtime overhead
		1342	require AnyEvent::Log unless $AnyEvent::Log::VERSION;
		1343	package AnyEvent::Log;
		1344	_log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
		1345	}
		1346	}
		1347
		1348	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1349	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1350	}
		1351
1199	my @models = (	1352	our @models = (
1200	[EV:: => AnyEvent::Impl::EV:: , 1],	1353	[EV:: => AnyEvent::Impl::EV::],
1201	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1354	[AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1202	# everything below here will not (normally) be autoprobed	1355	# everything below here will not (normally) be autoprobed
1203	# as the pureperl backend should work everywhere	1356	# as the pure perl backend should work everywhere
1204	# and is usually faster	1357	# and is usually faster
		1358	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1205	[Event:: => AnyEvent::Impl::Event::, 1],	1359	[Event:: => AnyEvent::Impl::Event::], # slow, stable
1206	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1360	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
		1361	# everything below here should not be autoloaded
1207	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1362	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1208	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1209	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1363	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1210	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1364	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1211	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1365	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1212	[Wx:: => AnyEvent::Impl::POE::],	1366	[Wx:: => AnyEvent::Impl::POE::],
1213	[Prima:: => AnyEvent::Impl::POE::],	1367	[Prima:: => AnyEvent::Impl::POE::],
1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],	1368	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1215	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],	1369	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
		1370	[FLTK:: => AnyEvent::Impl::FLTK::],
1216	);	1371	);
1217		1372
1218	our %method = map +($_ => 1),	1373	our @isa_hook;
		1374
		1375	sub _isa_set {
		1376	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1377
		1378	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1379	for 1 .. $#pkg;
		1380
		1381	grep $_ && $_->[1], @isa_hook
		1382	and AE::_reset ();
		1383	}
		1384
		1385	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1386	sub _isa_hook($$;$) {
		1387	my ($i, $pkg, $reset_ae) = @_;
		1388
		1389	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1390
		1391	_isa_set;
		1392	}
		1393
		1394	# all autoloaded methods reserve the complete glob, not just the method slot.
		1395	# due to bugs in perls method cache implementation.
1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1396	our @methods = qw(io timer time now now_update signal child idle condvar);
1220
1221	our @post_detect;
1222
1223	sub post_detect(&) {
1224	my ($cb) = @_;
1225
1226	push @post_detect, $cb;
1227
1228	defined wantarray
1229	? bless \$cb, "AnyEvent::Util::postdetect"
1230	: ()
1231	}
1232
1233	sub AnyEvent::Util::postdetect::DESTROY {
1234	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1235	}
1236		1397
1237	sub detect() {	1398	sub detect() {
		1399	return $MODEL if $MODEL; # some programs keep references to detect
		1400
		1401	# IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
		1402	# the author knows about the problems and what it does to AnyEvent as a whole
		1403	# (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
		1404	# anyway.
		1405	AnyEvent::log fatal => "AnyEvent: IO::Async::Loop::AnyEvent detected - this module is broken by design,\n"
		1406	. "abuses internals and breaks AnyEvent, will not continue."
		1407	if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
		1408
		1409	local $!; # for good measure
		1410	local $SIG{__DIE__}; # we use eval
		1411
1238	# free some memory	1412	# free some memory
1239	*detect = sub () { $MODEL };	1413	*detect = sub () { $MODEL };
		1414	# undef &func doesn't correctly update the method cache. grmbl.
		1415	# so we delete the whole glob. grmbl.
		1416	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1417	# a glob with an active sub. hrm. i hope it works, but perl is
		1418	# usually buggy in this department. sigh.
		1419	delete @{"AnyEvent::"}{@methods};
		1420	undef @methods;
1240		1421
1241	local $!; # for good measure
1242	local $SIG{__DIE__};
1243
1244	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1422	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1245	my $model = "AnyEvent::Impl::$1";	1423	my $model = $1;
		1424	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1246	if (eval "require $model") {	1425	if (eval "require $model") {
		1426	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1247	$MODEL = $model;	1427	$MODEL = $model;
1248	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1249	} else {	1428	} else {
1250	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1429	AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1251	}	1430	}
1252	}	1431	}
1253		1432
1254	# check for already loaded models	1433	# check for already loaded models
1255	unless ($MODEL) {	1434	unless ($MODEL) {
1256	for (@REGISTRY, @models) {	1435	for (@REGISTRY, @models) {
1257	my ($package, $model) = @$_;	1436	my ($package, $model) = @$_;
1258	if (${"$package\::VERSION"} > 0) {	1437	if (${"$package\::VERSION"} > 0) {
1259	if (eval "require $model") {	1438	if (eval "require $model") {
		1439	AnyEvent::log 7 => "autodetected model '$model', using it.";
1260	$MODEL = $model;	1440	$MODEL = $model;
1261	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1262	last;	1441	last;
1263	}	1442	}
1264	}	1443	}
1265	}	1444	}
1266		1445
1267	unless ($MODEL) {	1446	unless ($MODEL) {
1268	# try to autoload a model	1447	# try to autoload a model
1269	for (@REGISTRY, @models) {	1448	for (@REGISTRY, @models) {
1270	my ($package, $model, $autoload) = @$_;	1449	my ($package, $model) = @$_;
1271	if (	1450	if (
1272	$autoload
1273	and eval "require $package"	1451	eval "require $package"
1274	and ${"$package\::VERSION"} > 0	1452	and ${"$package\::VERSION"} > 0
1275	and eval "require $model"	1453	and eval "require $model"
1276	) {	1454	) {
		1455	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1277	$MODEL = $model;	1456	$MODEL = $model;
1278	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1279	last;	1457	last;
1280	}	1458	}
1281	}	1459	}
1282		1460
1283	$MODEL	1461	$MODEL
1284	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";	1462	or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1285	}	1463	}
1286	}	1464	}
1287		1465
1288	@models = (); # free probe data	1466	# free memory only needed for probing
		1467	undef @models;
		1468	undef @REGISTRY;
1289		1469
1290	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1470	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1291	unshift @ISA, $MODEL;
1292		1471
1293	# now nuke some methods that are overridden by the backend.	1472	# now nuke some methods that are overridden by the backend.
1294	# SUPER is not allowed.	1473	# SUPER usage is not allowed in these.
1295	for (qw(time signal child idle)) {	1474	for (qw(time signal child idle)) {
1296	undef &{"AnyEvent::Base::$_"}	1475	undef &{"AnyEvent::Base::$_"}
1297	if defined &{"$MODEL\::$_"};	1476	if defined &{"$MODEL\::$_"};
1298	}	1477	}
1299		1478
		1479	_isa_set;
		1480
		1481	# we're officially open!
		1482
1300	if ($ENV{PERL_ANYEVENT_STRICT}) {	1483	if ($ENV{PERL_ANYEVENT_STRICT}) {
1301	eval { require AnyEvent::Strict };	1484	require AnyEvent::Strict;
1302	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1303	if $@ && $VERBOSE;
1304	}	1485	}
1305		1486
		1487	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1488	require AnyEvent::Debug;
		1489	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1490	}
		1491
		1492	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1493	require AnyEvent::Socket;
		1494	require AnyEvent::Debug;
		1495
		1496	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1497	$shell =~ s/\$\$/$$/g;
		1498
		1499	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1500	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1501	}
		1502
		1503	# now the anyevent environment is set up as the user told us to, so
		1504	# call the actual user code - post detects
		1505
1306	(shift @post_detect)->() while @post_detect;	1506	(shift @post_detect)->() while @post_detect;
		1507	undef @post_detect;
1307		1508
1308	*post_detect = sub(&) {	1509	*post_detect = sub(&) {
1309	shift->();	1510	shift->();
1310		1511
1311	undef	1512	undef
1312	};	1513	};
1313		1514
1314	$MODEL	1515	$MODEL
1315	}	1516	}
1316		1517
1317	sub AUTOLOAD {	1518	for my $name (@methods) {
1318	(my $func = $AUTOLOAD) =~ s/.*://;	1519	*$name = sub {
1319
1320	$method{$func}
1321	or Carp::croak "$func: not a valid AnyEvent class method";
1322
1323	detect;	1520	detect;
1324		1521	# we use goto because
1325	my $class = shift;	1522	# a) it makes the thunk more transparent
1326	$class->$func (@_);	1523	# b) it allows us to delete the thunk later
		1524	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1525	};
1327	}	1526	}
1328		1527
1329	# utility function to dup a filehandle. this is used by many backends	1528	# utility function to dup a filehandle. this is used by many backends
1330	# to support binding more than one watcher per filehandle (they usually	1529	# to support binding more than one watcher per filehandle (they usually
1331	# allow only one watcher per fd, so we dup it to get a different one).	1530	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1355		1554
1356	package AE;	1555	package AE;
1357		1556
1358	our $VERSION = $AnyEvent::VERSION;	1557	our $VERSION = $AnyEvent::VERSION;
1359		1558
		1559	sub _reset() {
		1560	eval q{
1360	# fall back to the main API by default - backends and AnyEvent::Base	1561	# fall back to the main API by default - backends and AnyEvent::Base
1361	# implementations can overwrite these.	1562	# implementations can overwrite these.
1362		1563
1363	sub io($$$) {	1564	sub io($$$) {
1364	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1565	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1365	}	1566	}
1366		1567
1367	sub timer($$$) {	1568	sub timer($$$) {
1368	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1569	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1369	}	1570	}
1370		1571
1371	sub signal($$) {	1572	sub signal($$) {
1372	AnyEvent->signal (signal => $_[0], cb => $_[1])	1573	AnyEvent->signal (signal => $_[0], cb => $_[1])
1373	}	1574	}
1374		1575
1375	sub child($$) {	1576	sub child($$) {
1376	AnyEvent->child (pid => $_[0], cb => $_[1])	1577	AnyEvent->child (pid => $_[0], cb => $_[1])
1377	}	1578	}
1378		1579
1379	sub idle($) {	1580	sub idle($) {
1380	AnyEvent->idle (cb => $_[0])	1581	AnyEvent->idle (cb => $_[0]);
1381	}	1582	}
1382		1583
1383	sub cv(;&) {	1584	sub cv(;&) {
1384	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1585	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1385	}	1586	}
1386		1587
1387	sub now() {	1588	sub now() {
1388	AnyEvent->now	1589	AnyEvent->now
1389	}	1590	}
1390		1591
1391	sub now_update() {	1592	sub now_update() {
1392	AnyEvent->now_update	1593	AnyEvent->now_update
1393	}	1594	}
1394		1595
1395	sub time() {	1596	sub time() {
1396	AnyEvent->time	1597	AnyEvent->time
		1598	}
		1599
		1600	*postpone = \&AnyEvent::postpone;
		1601	*log = \&AnyEvent::log;
		1602	};
		1603	die if $@;
1397	}	1604	}
		1605
		1606	BEGIN { _reset }
1398		1607
1399	package AnyEvent::Base;	1608	package AnyEvent::Base;
1400		1609
1401	# default implementations for many methods	1610	# default implementations for many methods
1402		1611
1403	sub time {	1612	sub time {
1404	eval q{ # poor man's autoloading {}	1613	eval q{ # poor man's autoloading {}
1405	# probe for availability of Time::HiRes	1614	# probe for availability of Time::HiRes
1406	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1615	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1407	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1616	*time = sub { Time::HiRes::time () };
1408	*AE::time = \&Time::HiRes::time;	1617	*AE::time = \& Time::HiRes::time ;
		1618	*now = \&time;
		1619	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1409	# if (eval "use POSIX (); (POSIX::times())...	1620	# if (eval "use POSIX (); (POSIX::times())...
1410	} else {	1621	} else {
		1622	*time = sub { CORE::time };
		1623	*AE::time = sub (){ CORE::time };
		1624	*now = \&time;
1411	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1625	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1412	*AE::time = sub (){ time }; # epic fail
1413	}	1626	}
1414
1415	*time = sub { AE::time }; # different prototypes
1416	};	1627	};
1417	die if $@;	1628	die if $@;
1418		1629
1419	&time	1630	&time
1420	}	1631	}
1421		1632
1422	*now = \&time;	1633	*now = \&time;
1423
1424	sub now_update { }	1634	sub now_update { }
1425		1635
		1636	sub _poll {
		1637	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1638	}
		1639
1426	# default implementation for ->condvar	1640	# default implementation for ->condvar
		1641	# in fact, the default should not be overwritten
1427		1642
1428	sub condvar {	1643	sub condvar {
1429	eval q{ # poor man's autoloading {}	1644	eval q{ # poor man's autoloading {}
1430	*condvar = sub {	1645	*condvar = sub {
1431	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1646	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1509		1724
1510	sub signal {	1725	sub signal {
1511	eval q{ # poor man's autoloading {}	1726	eval q{ # poor man's autoloading {}
1512	# probe for availability of Async::Interrupt	1727	# probe for availability of Async::Interrupt
1513	if (_have_async_interrupt) {	1728	if (_have_async_interrupt) {
1514	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1729	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1515		1730
1516	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1731	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1517	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1732	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1518		1733
1519	} else {	1734	} else {
1520	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1735	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1521		1736
1522	if (AnyEvent::WIN32) {	1737	if (AnyEvent::WIN32) {
1523	require AnyEvent::Util;	1738	require AnyEvent::Util;
1524		1739
1525	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1740	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1601	: sysread $SIGPIPE_R, (my $dummy), 9;	1816	: sysread $SIGPIPE_R, (my $dummy), 9;
1602		1817
1603	while (%SIG_EV) {	1818	while (%SIG_EV) {
1604	for (keys %SIG_EV) {	1819	for (keys %SIG_EV) {
1605	delete $SIG_EV{$_};	1820	delete $SIG_EV{$_};
1606	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1821	&$_ for values %{ $SIG_CB{$_} \|\| {} };
1607	}	1822	}
1608	}	1823	}
1609	};	1824	};
1610	};	1825	};
1611	die if $@;	1826	die if $@;
…		…
1638	};	1853	};
1639		1854
1640	*child = sub {	1855	*child = sub {
1641	my (undef, %arg) = @_;	1856	my (undef, %arg) = @_;
1642		1857
1643	defined (my $pid = $arg{pid} + 0)	1858	my $pid = $arg{pid};
1644	or Carp::croak "required option 'pid' is missing";	1859	my $cb = $arg{cb};
1645		1860
1646	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1861	$PID_CB{$pid}{$cb+0} = $cb;
1647		1862
1648	unless ($CHLD_W) {	1863	unless ($CHLD_W) {
1649	$CHLD_W = AE::signal CHLD => \&_sigchld;	1864	$CHLD_W = AE::signal CHLD => \&_sigchld;
1650	# child could be a zombie already, so make at least one round	1865	# child could be a zombie already, so make at least one round
1651	&_sigchld;	1866	&_sigchld;
1652	}	1867	}
1653		1868
1654	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1869	bless [$pid, $cb+0], "AnyEvent::Base::child"
1655	};	1870	};
1656		1871
1657	*AnyEvent::Base::child::DESTROY = sub {	1872	*AnyEvent::Base::child::DESTROY = sub {
1658	my ($pid, $cb) = @{$_[0]};	1873	my ($pid, $icb) = @{$_[0]};
1659		1874
1660	delete $PID_CB{$pid}{$cb};	1875	delete $PID_CB{$pid}{$icb};
1661	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1876	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1662		1877
1663	undef $CHLD_W unless keys %PID_CB;	1878	undef $CHLD_W unless keys %PID_CB;
1664	};	1879	};
1665	};	1880	};
…		…
1678		1893
1679	my ($cb, $w, $rcb) = $arg{cb};	1894	my ($cb, $w, $rcb) = $arg{cb};
1680		1895
1681	$rcb = sub {	1896	$rcb = sub {
1682	if ($cb) {	1897	if ($cb) {
1683	$w = _time;	1898	$w = AE::time;
1684	&$cb;	1899	&$cb;
1685	$w = _time - $w;	1900	$w = AE::time - $w;
1686		1901
1687	# never use more then 50% of the time for the idle watcher,	1902	# never use more then 50% of the time for the idle watcher,
1688	# within some limits	1903	# within some limits
1689	$w = 0.0001 if $w < 0.0001;	1904	$w = 0.0001 if $w < 0.0001;
1690	$w = 5 if $w > 5;	1905	$w = 5 if $w > 5;
…		…
1737		1952
1738	sub _send {	1953	sub _send {
1739	# nop	1954	# nop
1740	}	1955	}
1741		1956
		1957	sub _wait {
		1958	AnyEvent->_poll until $_[0]{_ae_sent};
		1959	}
		1960
1742	sub send {	1961	sub send {
1743	my $cv = shift;	1962	my $cv = shift;
1744	$cv->{_ae_sent} = [@_];	1963	$cv->{_ae_sent} = [@_];
1745	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1964	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1746	$cv->_send;	1965	$cv->_send;
…		…
1753		1972
1754	sub ready {	1973	sub ready {
1755	$_[0]{_ae_sent}	1974	$_[0]{_ae_sent}
1756	}	1975	}
1757		1976
1758	sub _wait {
1759	$WAITING
1760	and !$_[0]{_ae_sent}
1761	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1762
1763	local $WAITING = 1;
1764	AnyEvent->one_event while !$_[0]{_ae_sent};
1765	}
1766
1767	sub recv {	1977	sub recv {
		1978	unless ($_[0]{_ae_sent}) {
		1979	$WAITING
		1980	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1981
		1982	local $WAITING = 1;
1768	$_[0]->_wait;	1983	$_[0]->_wait;
		1984	}
1769		1985
1770	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1986	$_[0]{_ae_croak}
1771	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1987	and Carp::croak $_[0]{_ae_croak};
		1988
		1989	wantarray
		1990	? @{ $_[0]{_ae_sent} }
		1991	: $_[0]{_ae_sent}[0]
1772	}	1992	}
1773		1993
1774	sub cb {	1994	sub cb {
1775	my $cv = shift;	1995	my $cv = shift;
1776		1996
…		…
1792	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };	2012	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
1793	}	2013	}
1794		2014
1795	# undocumented/compatibility with pre-3.4	2015	# undocumented/compatibility with pre-3.4
1796	*broadcast = \&send;	2016	*broadcast = \&send;
1797	*wait = \&_wait;	2017	*wait = \&recv;
1798		2018
1799	=head1 ERROR AND EXCEPTION HANDLING	2019	=head1 ERROR AND EXCEPTION HANDLING
1800		2020
1801	In general, AnyEvent does not do any error handling - it relies on the	2021	In general, AnyEvent does not do any error handling - it relies on the
1802	caller to do that if required. The L<AnyEvent::Strict> module (see also	2022	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1814	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2034	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1815	so on.	2035	so on.
1816		2036
1817	=head1 ENVIRONMENT VARIABLES	2037	=head1 ENVIRONMENT VARIABLES
1818		2038
1819	The following environment variables are used by this module or its	2039	AnyEvent supports a number of environment variables that tune the
1820	submodules.	2040	runtime behaviour. They are usually evaluated when AnyEvent is
		2041	loaded, initialised, or a submodule that uses them is loaded. Many of
		2042	them also cause AnyEvent to load additional modules - for example,
		2043	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2044	loaded.
1821		2045
1822	Note that AnyEvent will remove I<all> environment variables starting with	2046	All the environment variables documented here start with
1823	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2047	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1824	enabled.	2048	namespace. Other modules are encouraged (but by no means required) to use
		2049	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2050	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2051	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2052	variables starting with C<AE_>, see below).
		2053
		2054	All variables can also be set via the C<AE_> prefix, that is, instead
		2055	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2056	case there is a clash btween anyevent and another program that uses
		2057	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2058	variable to the empty string, as those variables take precedence.
		2059
		2060	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2061	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2062	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2063	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2064	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2065	is set).
		2066
		2067	The exact algorithm is currently:
		2068
		2069	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2070	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2071	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2072
		2073	This ensures that child processes will not see the C<AE_> variables.
		2074
		2075	The following environment variables are currently known to AnyEvent:
1825		2076
1826	=over 4	2077	=over 4
1827		2078
1828	=item C<PERL_ANYEVENT_VERBOSE>	2079	=item C<PERL_ANYEVENT_VERBOSE>
1829		2080
1830	By default, AnyEvent will be completely silent except in fatal	2081	By default, AnyEvent will only log messages with loglevel C<3>
1831	conditions. You can set this environment variable to make AnyEvent more	2082	(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
		2083	environment variable to a numerical loglevel to make AnyEvent more (or
1832	talkative.	2084	less) talkative.
1833		2085
		2086	If you want to do more than just set the global logging level
		2087	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2088	complex specifications.
		2089
		2090	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2091	the default logging settings.
		2092
1834	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2093	When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1835	conditions, such as not being able to load the event model specified by	2094	unexpected conditions, such as not being able to load the event model
1836	C<PERL_ANYEVENT_MODEL>.	2095	specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
		2096	exception - this is the minimum recommended level.
1837		2097
1838	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2098	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1839	model it chooses.	2099	chooses.
1840		2100
1841	When set to C<8> or higher, then AnyEvent will report extra information on	2101	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1842	which optional modules it loads and how it implements certain features.	2102	which optional modules it loads and how it implements certain features.
		2103
		2104	=item C<PERL_ANYEVENT_LOG>
		2105
		2106	Accepts rather complex logging specifications. For example, you could log
		2107	all C<debug> messages of some module to stderr, warnings and above to
		2108	stderr, and errors and above to syslog, with:
		2109
		2110	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2111
		2112	For the rather extensive details, see L<AnyEvent::Log>.
		2113
		2114	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2115	so will take effect even before AnyEvent has initialised itself.
		2116
		2117	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2118	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2119	using the latter saves a few hundred kB of memory until the first message
		2120	is being logged.
1843		2121
1844	=item C<PERL_ANYEVENT_STRICT>	2122	=item C<PERL_ANYEVENT_STRICT>
1845		2123
1846	AnyEvent does not do much argument checking by default, as thorough	2124	AnyEvent does not do much argument checking by default, as thorough
1847	argument checking is very costly. Setting this variable to a true value	2125	argument checking is very costly. Setting this variable to a true value
…		…
1854	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2132	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1855	>>, it is definitely recommended to keep it off in production. Keeping	2133	>>, it is definitely recommended to keep it off in production. Keeping
1856	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2134	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1857	can be very useful, however.	2135	can be very useful, however.
1858		2136
		2137	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2138
		2139	If this env variable is nonempty, then its contents will be interpreted by
		2140	C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
		2141	replacing every occurance of C<$$> by the process pid). The shell object
		2142	is saved in C<$AnyEvent::Debug::SHELL>.
		2143
		2144	This happens when the first watcher is created.
		2145
		2146	For example, to bind a debug shell on a unix domain socket in
		2147	F<< /tmp/debug<pid>.sock >>, you could use this:
		2148
		2149	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2150	# connect with e.g.: socat readline /tmp/debug123.sock
		2151
		2152	Or to bind to tcp port 4545 on localhost:
		2153
		2154	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		2155	# connect with e.g.: telnet localhost 4545
		2156
		2157	Note that creating sockets in F</tmp> or on localhost is very unsafe on
		2158	multiuser systems.
		2159
		2160	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2161
		2162	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2163	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2164
1859	=item C<PERL_ANYEVENT_MODEL>	2165	=item C<PERL_ANYEVENT_MODEL>
1860		2166
1861	This can be used to specify the event model to be used by AnyEvent, before	2167	This can be used to specify the event model to be used by AnyEvent, before
1862	auto detection and -probing kicks in. It must be a string consisting	2168	auto detection and -probing kicks in.
1863	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2169
		2170	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2171	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1864	and the resulting module name is loaded and if the load was successful,	2172	resulting module name is loaded and - if the load was successful - used as
1865	used as event model. If it fails to load AnyEvent will proceed with	2173	event model backend. If it fails to load then AnyEvent will proceed with
1866	auto detection and -probing.	2174	auto detection and -probing.
1867		2175
1868	This functionality might change in future versions.	2176	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2177	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2178	the end of a string designates a module name and quotes it appropriately).
1869		2179
1870	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2180	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1871	could start your program like this:	2181	could start your program like this:
1872		2182
1873	PERL_ANYEVENT_MODEL=Perl perl ...	2183	PERL_ANYEVENT_MODEL=Perl perl ...
1874		2184
1875	=item C<PERL_ANYEVENT_PROTOCOLS>	2185	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1891	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2201	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1892	- only support IPv4, never try to resolve or contact IPv6	2202	- only support IPv4, never try to resolve or contact IPv6
1893	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2203	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1894	IPv6, but prefer IPv6 over IPv4.	2204	IPv6, but prefer IPv6 over IPv4.
1895		2205
		2206	=item C<PERL_ANYEVENT_HOSTS>
		2207
		2208	This variable, if specified, overrides the F</etc/hosts> file used by
		2209	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2210	from that file instead.
		2211
1896	=item C<PERL_ANYEVENT_EDNS0>	2212	=item C<PERL_ANYEVENT_EDNS0>
1897		2213
1898	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2214	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1899	for DNS. This extension is generally useful to reduce DNS traffic, but	2215	DNS. This extension is generally useful to reduce DNS traffic, especially
1900	some (broken) firewalls drop such DNS packets, which is why it is off by	2216	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1901	default.	2217	packets, which is why it is off by default.
1902		2218
1903	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2219	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1904	EDNS0 in its DNS requests.	2220	EDNS0 in its DNS requests.
1905		2221
1906	=item C<PERL_ANYEVENT_MAX_FORKS>	2222	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1912		2228
1913	The default value for the C<max_outstanding> parameter for the default DNS	2229	The default value for the C<max_outstanding> parameter for the default DNS
1914	resolver - this is the maximum number of parallel DNS requests that are	2230	resolver - this is the maximum number of parallel DNS requests that are
1915	sent to the DNS server.	2231	sent to the DNS server.
1916		2232
		2233	=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
		2234
		2235	Perl has inherently racy signal handling (you can basically choose between
		2236	losing signals and memory corruption) - pure perl event loops (including
		2237	C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
		2238	have to poll regularly to avoid losing signals.
		2239
		2240	Some event loops are racy, but don't poll regularly, and some event loops
		2241	are written in C but are still racy. For those event loops, AnyEvent
		2242	installs a timer that regularly wakes up the event loop.
		2243
		2244	By default, the interval for this timer is C<10> seconds, but you can
		2245	override this delay with this environment variable (or by setting
		2246	the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
		2247	watchers).
		2248
		2249	Lower values increase CPU (and energy) usage, higher values can introduce
		2250	long delays when reaping children or waiting for signals.
		2251
		2252	The L<AnyEvent::Async> module, if available, will be used to avoid this
		2253	polling (with most event loops).
		2254
1917	=item C<PERL_ANYEVENT_RESOLV_CONF>	2255	=item C<PERL_ANYEVENT_RESOLV_CONF>
1918		2256
1919	The file to use instead of F</etc/resolv.conf> (or OS-specific	2257	The absolute path to a F<resolv.conf>-style file to use instead of
1920	configuration) in the default resolver. When set to the empty string, no	2258	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1921	default config will be used.	2259	resolver, or the empty string to select the default configuration.
1922		2260
1923	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2261	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1924		2262
1925	When neither C<ca_file> nor C<ca_path> was specified during	2263	When neither C<ca_file> nor C<ca_path> was specified during
1926	L<AnyEvent::TLS> context creation, and either of these environment	2264	L<AnyEvent::TLS> context creation, and either of these environment
1927	variables exist, they will be used to specify CA certificate locations	2265	variables are nonempty, they will be used to specify CA certificate
1928	instead of a system-dependent default.	2266	locations instead of a system-dependent default.
1929		2267
1930	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2268	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1931		2269
1932	When these are set to C<1>, then the respective modules are not	2270	When these are set to C<1>, then the respective modules are not
1933	loaded. Mostly good for testing AnyEvent itself.	2271	loaded. Mostly good for testing AnyEvent itself.
…		…
2265	(even when used without AnyEvent), but most event loops have acceptable	2603	(even when used without AnyEvent), but most event loops have acceptable
2266	performance with or without AnyEvent.	2604	performance with or without AnyEvent.
2267		2605
2268	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2606	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2269	the actual event loop, only with extremely fast event loops such as EV	2607	the actual event loop, only with extremely fast event loops such as EV
2270	adds AnyEvent significant overhead.	2608	does AnyEvent add significant overhead.
2271		2609
2272	=item * You should avoid POE like the plague if you want performance or	2610	=item * You should avoid POE like the plague if you want performance or
2273	reasonable memory usage.	2611	reasonable memory usage.
2274		2612
2275	=back	2613	=back
…		…
2574		2912
2575	=item L<Time::HiRes>	2913	=item L<Time::HiRes>
2576		2914
2577	This module is part of perl since release 5.008. It will be used when the	2915	This module is part of perl since release 5.008. It will be used when the
2578	chosen event library does not come with a timing source of its own. The	2916	chosen event library does not come with a timing source of its own. The
2579	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2917	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2580	try to use a monotonic clock for timing stability.	2918	try to use a monotonic clock for timing stability.
2581		2919
2582	=back	2920	=back
2583		2921
2584		2922
…		…
2650		2988
2651	Tutorial/Introduction: L<AnyEvent::Intro>.	2989	Tutorial/Introduction: L<AnyEvent::Intro>.
2652		2990
2653	FAQ: L<AnyEvent::FAQ>.	2991	FAQ: L<AnyEvent::FAQ>.
2654		2992
2655	Utility functions: L<AnyEvent::Util>.	2993	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2994	(simply logging).
2656		2995
2657	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2996	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2658	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2997	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2998
		2999	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		3000	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		3001	L<Qt>, L<POE>, L<FLTK>.
2659		3002
2660	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	3003	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2661	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	3004	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2662	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	3005	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2663	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	3006	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		3007	L<AnyEvent::Impl::FLTK>.
2664		3008
2665	Non-blocking file handles, sockets, TCP clients and	3009	Non-blocking handles, pipes, stream sockets, TCP clients and
2666	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	3010	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2667		3011
2668	Asynchronous DNS: L<AnyEvent::DNS>.	3012	Asynchronous DNS: L<AnyEvent::DNS>.
2669		3013
2670	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	3014	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC vs. Revision 1.388 by root, Sun Oct 2 01:22:01 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.347 by root, Sun Jan 23 11:15:09 2011 UTC vs.
Revision 1.388 by root, Sun Oct 2 01:22:01 2011 UTC