ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.334 by root, Tue Oct 12 06:51:15 2010 UTC vs.
Revision 1.421 by root, Fri Sep 5 22:24:12 2014 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, UV, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async,
6	and POE are various supported event loops/environments.	6	Qt, 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
…		…
85	that isn't them. What's worse, all the potential users of your	85	that isn't them. What's worse, all the potential users of your
86	module are I<also> forced to use the same event loop you use.	86	module are I<also> forced to use the same event loop you use.
87		87
88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
89	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	89	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
90	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	90	with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
91	your module uses one of those, every user of your module has to use it,	91	uses one of those, every user of your module has to use it, too. But if
92	too. But if your module uses AnyEvent, it works transparently with all	92	your module uses AnyEvent, it works transparently with all event models it
93	event models it supports (including stuff like IO::Async, as long as those	93	supports (including stuff like IO::Async, as long as those use one of the
94	use one of the supported event loops. It is easy to add new event loops	94	supported event loops. It is easy to add new event loops to AnyEvent, too,
95	to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
96		96
97	In addition to being free of having to use I<the one and only true event	97	In addition to being free of having to use I<the one and only true event
98	model>, AnyEvent also is free of bloat and policy: with POE or similar	98	model>, AnyEvent also is free of bloat and policy: with POE or similar
99	modules, you get an enormous amount of code and strict rules you have to	99	modules, you get an enormous amount of code and strict rules you have to
100	follow. AnyEvent, on the other hand, is lean and to the point, by only	100	follow. AnyEvent, on the other hand, is lean and to the point, by only
…		…
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
…		…
271		271
272	Example 2: fire an event after 0.5 seconds, then roughly every second.	272	Example 2: fire an event after 0.5 seconds, then roughly every second.
273		273
274	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {	274	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
275	warn "timeout\n";	275	warn "timeout\n";
276	};	276	});
277		277
278	=head3 TIMING ISSUES	278	=head3 TIMING ISSUES
279		279
280	There are two ways to handle timers: based on real time (relative, "fire	280	There are two ways to handle timers: based on real time (relative, "fire
281	in 10 seconds") and based on wallclock time (absolute, "fire at 12	281	in 10 seconds") and based on wallclock time (absolute, "fire at 12
…		…
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
		492	# this forks and immediately calls exit in the child. this
		493	# normally has all sorts of bad consequences for your parent,
		494	# so take this as an example only. always fork and exec,
		495	# or call POSIX::_exit, in real code.
494	my $pid = fork or exit 5;	496	my $pid = fork or exit 5;
495		497
496	my $w = AnyEvent->child (	498	my $w = AnyEvent->child (
497	pid => $pid,	499	pid => $pid,
498	cb => sub {	500	cb => sub {
…		…
747	This works because for every event source (EOF on file handle), there is	749	This works because for every event source (EOF on file handle), there is
748	one call to C<begin>, so the condvar waits for all calls to C<end> before	750	one call to C<begin>, so the condvar waits for all calls to C<end> before
749	sending.	751	sending.
750		752
751	The ping example mentioned above is slightly more complicated, as the	753	The ping example mentioned above is slightly more complicated, as the
752	there are results to be passwd back, and the number of tasks that are	754	there are results to be passed back, and the number of tasks that are
753	begun can potentially be zero:	755	begun can potentially be zero:
754		756
755	my $cv = AnyEvent->condvar;	757	my $cv = AnyEvent->condvar;
756		758
757	my %result;	759	my %result;
…		…
765	};	767	};
766	}	768	}
767		769
768	$cv->end;	770	$cv->end;
769		771
		772	...
		773
		774	my $results = $cv->recv;
		775
770	This code fragment supposedly pings a number of hosts and calls	776	This code fragment supposedly pings a number of hosts and calls
771	C<send> after results for all then have have been gathered - in any	777	C<send> after results for all then have have been gathered - in any
772	order. To achieve this, the code issues a call to C<begin> when it starts	778	order. To achieve this, the code issues a call to C<begin> when it starts
773	each ping request and calls C<end> when it has received some result for	779	each ping request and calls C<end> when it has received some result for
774	it. Since C<begin> and C<end> only maintain a counter, the order in which	780	it. Since C<begin> and C<end> only maintain a counter, the order in which
…		…
809		815
810	In list context, all parameters passed to C<send> will be returned,	816	In list context, all parameters passed to C<send> will be returned,
811	in scalar context only the first one will be returned.	817	in scalar context only the first one will be returned.
812		818
813	Note that doing a blocking wait in a callback is not supported by any	819	Note that doing a blocking wait in a callback is not supported by any
814	event loop, that is, recursive invocation of a blocking C<< ->recv	820	event loop, that is, recursive invocation of a blocking C<< ->recv >> is
815	>> is not allowed, and the C<recv> call will C<croak> if such a	821	not allowed and the C<recv> call will C<croak> if such a condition is
816	condition is detected. This condition can be slightly loosened by using	822	detected. This requirement can be dropped by relying on L<Coro::AnyEvent>
817	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from	823	, which allows you to do a blocking C<< ->recv >> from any thread
818	any thread that doesn't run the event loop itself.	824	that doesn't run the event loop itself. L<Coro::AnyEvent> is loaded
		825	automatically when L<Coro> is used with L<AnyEvent>, so code does not need
		826	to do anything special to take advantage of that: any code that would
		827	normally block your program because it calls C<recv>, be executed in an
		828	C<async> thread instead without blocking other threads.
819		829
820	Not all event models support a blocking wait - some die in that case	830	Not all event models support a blocking wait - some die in that case
821	(programs might want to do that to stay interactive), so I<if you are	831	(programs might want to do that to stay interactive), so I<if you are
822	using this from a module, never require a blocking wait>. Instead, let the	832	using this from a module, never require a blocking wait>. Instead, let the
823	caller decide whether the call will block or not (for example, by coupling	833	caller decide whether the call will block or not (for example, by coupling
…		…
860	use. If EV is not installed, then AnyEvent will fall back to its own	870	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	871	pure-perl implementation, which is available everywhere as it comes with
862	AnyEvent itself.	872	AnyEvent itself.
863		873
864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	874	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	875	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866		876
867	=item Backends that are transparently being picked up when they are used.	877	=item Backends that are transparently being picked up when they are used.
868		878
869	These will be used if they are already loaded when the first watcher	879	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	880	is created, in which case it is assumed that the application is using
…		…
873	create watchers. Nothing special needs to be done by the main program.	883	create watchers. Nothing special needs to be done by the main program.
874		884
875	AnyEvent::Impl::Event based on Event, very stable, few glitches.	885	AnyEvent::Impl::Event based on Event, very stable, few glitches.
876	AnyEvent::Impl::Glib based on Glib, slow but very stable.	886	AnyEvent::Impl::Glib based on Glib, slow but very stable.
877	AnyEvent::Impl::Tk based on Tk, very broken.	887	AnyEvent::Impl::Tk based on Tk, very broken.
		888	AnyEvent::Impl::UV based on UV, innovated square wheels.
878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	889	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879	AnyEvent::Impl::POE based on POE, very slow, some limitations.	890	AnyEvent::Impl::POE based on POE, very slow, some limitations.
880	AnyEvent::Impl::Irssi used when running within irssi.	891	AnyEvent::Impl::Irssi used when running within irssi.
		892	AnyEvent::Impl::IOAsync based on IO::Async.
		893	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		894	AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
881		895
882	=item Backends with special needs.	896	=item Backends with special needs.
883		897
884	Qt requires the Qt::Application to be instantiated first, but will	898	Qt requires the Qt::Application to be instantiated first, but will
885	otherwise be picked up automatically. As long as the main program	899	otherwise be picked up automatically. As long as the main program
886	instantiates the application before any AnyEvent watchers are created,	900	instantiates the application before any AnyEvent watchers are created,
887	everything should just work.	901	everything should just work.
888		902
889	AnyEvent::Impl::Qt based on Qt.	903	AnyEvent::Impl::Qt based on Qt.
890
891	Support for IO::Async can only be partial, as it is too broken and
892	architecturally limited to even support the AnyEvent API. It also
893	is the only event loop that needs the loop to be set explicitly, so
894	it can only be used by a main program knowing about AnyEvent. See
895	L<AnyEvent::Impl::IOAsync> for the gory details.
896
897	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
898		904
899	=item Event loops that are indirectly supported via other backends.	905	=item Event loops that are indirectly supported via other backends.
900		906
901	Some event loops can be supported via other modules:	907	Some event loops can be supported via other modules:
902		908
…		…
938		944
939	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	945	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
940	if necessary. You should only call this function right before you would	946	if necessary. You should only call this function right before you would
941	have created an AnyEvent watcher anyway, that is, as late as possible at	947	have created an AnyEvent watcher anyway, that is, as late as possible at
942	runtime, and not e.g. during initialisation of your module.	948	runtime, and not e.g. during initialisation of your module.
		949
		950	The effect of calling this function is as if a watcher had been created
		951	(specifically, actions that happen "when the first watcher is created"
		952	happen when calling detetc as well).
943		953
944	If you need to do some initialisation before AnyEvent watchers are	954	If you need to do some initialisation before AnyEvent watchers are
945	created, use C<post_detect>.	955	created, use C<post_detect>.
946		956
947	=item $guard = AnyEvent::post_detect { BLOCK }	957	=item $guard = AnyEvent::post_detect { BLOCK }
…		…
1010	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent	1020	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1011	# as soon as it is	1021	# as soon as it is
1012	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };	1022	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1013	}	1023	}
1014		1024
		1025	=item AnyEvent::postpone { BLOCK }
		1026
		1027	Arranges for the block to be executed as soon as possible, but not before
		1028	the call itself returns. In practise, the block will be executed just
		1029	before the event loop polls for new events, or shortly afterwards.
		1030
		1031	This function never returns anything (to make the C<return postpone { ...
		1032	}> idiom more useful.
		1033
		1034	To understand the usefulness of this function, consider a function that
		1035	asynchronously does something for you and returns some transaction
		1036	object or guard to let you cancel the operation. For example,
		1037	C<AnyEvent::Socket::tcp_connect>:
		1038
		1039	# start a connection attempt unless one is active
		1040	$self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1041	delete $self->{connect_guard};
		1042	...
		1043	};
		1044
		1045	Imagine that this function could instantly call the callback, for
		1046	example, because it detects an obvious error such as a negative port
		1047	number. Invoking the callback before the function returns causes problems
		1048	however: the callback will be called and will try to delete the guard
		1049	object. But since the function hasn't returned yet, there is nothing to
		1050	delete. When the function eventually returns it will assign the guard
		1051	object to C<< $self->{connect_guard} >>, where it will likely never be
		1052	deleted, so the program thinks it is still trying to connect.
		1053
		1054	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1055	callback directly on error:
		1056
		1057	$cb->(undef), return # signal error to callback, BAD!
		1058	if $some_error_condition;
		1059
		1060	It should use C<postpone>:
		1061
		1062	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1063	if $some_error_condition;
		1064
		1065	=item AnyEvent::log $level, $msg[, @args]
		1066
		1067	Log the given C<$msg> at the given C<$level>.
		1068
		1069	If L<AnyEvent::Log> is not loaded then this function makes a simple test
		1070	to see whether the message will be logged. If the test succeeds it will
		1071	load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
		1072	the L<AnyEvent::Log> documentation for details.
		1073
		1074	If the test fails it will simply return. Right now this happens when a
		1075	numerical loglevel is used and it is larger than the level specified via
		1076	C<$ENV{PERL_ANYEVENT_VERBOSE}>.
		1077
		1078	If you want to sprinkle loads of logging calls around your code, consider
		1079	creating a logger callback with the C<AnyEvent::Log::logger> function,
		1080	which can reduce typing, codesize and can reduce the logging overhead
		1081	enourmously.
		1082
1015	=back	1083	=back
1016		1084
1017	=head1 WHAT TO DO IN A MODULE	1085	=head1 WHAT TO DO IN A MODULE
1018		1086
1019	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1087	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
1052	modules might create watchers when they are loaded, and AnyEvent will	1120	modules might create watchers when they are loaded, and AnyEvent will
1053	decide on the event model to use as soon as it creates watchers, and it	1121	decide on the event model to use as soon as it creates watchers, and it
1054	might choose the wrong one unless you load the correct one yourself.	1122	might choose the wrong one unless you load the correct one yourself.
1055		1123
1056	You can chose to use a pure-perl implementation by loading the	1124	You can chose to use a pure-perl implementation by loading the
1057	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1125	C<AnyEvent::Loop> module, which gives you similar behaviour
1058	everywhere, but letting AnyEvent chose the model is generally better.	1126	everywhere, but letting AnyEvent chose the model is generally better.
1059		1127
1060	=head2 MAINLOOP EMULATION	1128	=head2 MAINLOOP EMULATION
1061		1129
1062	Sometimes (often for short test scripts, or even standalone programs who	1130	Sometimes (often for short test scripts, or even standalone programs who
…		…
1075		1143
1076		1144
1077	=head1 OTHER MODULES	1145	=head1 OTHER MODULES
1078		1146
1079	The following is a non-exhaustive list of additional modules that use	1147	The following is a non-exhaustive list of additional modules that use
1080	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1148	AnyEvent as a client and can therefore be mixed easily with other
1081	modules and other event loops in the same program. Some of the modules	1149	AnyEvent modules and other event loops in the same program. Some of the
1082	come as part of AnyEvent, the others are available via CPAN.	1150	modules come as part of AnyEvent, the others are available via CPAN (see
		1151	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1152	a longer non-exhaustive list), and the list is heavily biased towards
		1153	modules of the AnyEvent author himself :)
1083		1154
1084	=over 4	1155	=over 4
1085		1156
1086	=item L<AnyEvent::Util>	1157	=item L<AnyEvent::Util> (part of the AnyEvent distribution)
1087		1158
1088	Contains various utility functions that replace often-used blocking	1159	Contains various utility functions that replace often-used blocking
1089	functions such as C<inet_aton> with event/callback-based versions.	1160	functions such as C<inet_aton> with event/callback-based versions.
1090		1161
1091	=item L<AnyEvent::Socket>	1162	=item L<AnyEvent::Socket> (part of the AnyEvent distribution)
1092		1163
1093	Provides various utility functions for (internet protocol) sockets,	1164	Provides various utility functions for (internet protocol) sockets,
1094	addresses and name resolution. Also functions to create non-blocking tcp	1165	addresses and name resolution. Also functions to create non-blocking tcp
1095	connections or tcp servers, with IPv6 and SRV record support and more.	1166	connections or tcp servers, with IPv6 and SRV record support and more.
1096		1167
1097	=item L<AnyEvent::Handle>	1168	=item L<AnyEvent::Handle> (part of the AnyEvent distribution)
1098		1169
1099	Provide read and write buffers, manages watchers for reads and writes,	1170	Provide read and write buffers, manages watchers for reads and writes,
1100	supports raw and formatted I/O, I/O queued and fully transparent and	1171	supports raw and formatted I/O, I/O queued and fully transparent and
1101	non-blocking SSL/TLS (via L<AnyEvent::TLS>).	1172	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1102		1173
1103	=item L<AnyEvent::DNS>	1174	=item L<AnyEvent::DNS> (part of the AnyEvent distribution)
1104		1175
1105	Provides rich asynchronous DNS resolver capabilities.	1176	Provides rich asynchronous DNS resolver capabilities.
1106		1177
1107	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>	1178	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1108		1179
1109	Implement event-based interfaces to the protocols of the same name (for	1180	Implement event-based interfaces to the protocols of the same name (for
1110	the curious, IGS is the International Go Server and FCP is the Freenet	1181	the curious, IGS is the International Go Server and FCP is the Freenet
1111	Client Protocol).	1182	Client Protocol).
1112		1183
1113	=item L<AnyEvent::Handle::UDP>	1184	=item L<AnyEvent::AIO> (part of the AnyEvent distribution)
1114
1115	Here be danger!
1116
1117	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1118	there are so many things wrong with AnyEvent::Handle::UDP, most notably
1119	its use of a stream-based API with a protocol that isn't streamable, that
1120	the only way to improve it is to delete it.
1121
1122	It features data corruption (but typically only under load) and general
1123	confusion. On top, the author is not only clueless about UDP but also
1124	fact-resistant - some gems of his understanding: "connect doesn't work
1125	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1126	packets", "I don't need to implement proper error checking as UDP doesn't
1127	support error checking" and so on - he doesn't even understand what's
1128	wrong with his module when it is explained to him.
1129
1130	=item L<AnyEvent::DBI>
1131
1132	Executes L<DBI> requests asynchronously in a proxy process for you,
1133	notifying you in an event-based way when the operation is finished.
1134
1135	=item L<AnyEvent::AIO>
1136		1185
1137	Truly asynchronous (as opposed to non-blocking) I/O, should be in the	1186	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1138	toolbox of every event programmer. AnyEvent::AIO transparently fuses	1187	toolbox of every event programmer. AnyEvent::AIO transparently fuses
1139	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based	1188	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1140	file I/O, and much more.	1189	file I/O, and much more.
1141		1190
		1191	=item L<AnyEvent::Fork>, L<AnyEvent::Fork::RPC>, L<AnyEvent::Fork::Pool>, L<AnyEvent::Fork::Remote>
		1192
		1193	These let you safely fork new subprocesses, either locally or
		1194	remotely (e.g.v ia ssh), using some RPC protocol or not, without
		1195	the limitations normally imposed by fork (AnyEvent works fine for
		1196	example). Dynamically-resized worker pools are obviously included as well.
		1197
		1198	And they are quite tiny and fast as well - "abusing" L<AnyEvent::Fork>
		1199	just to exec external programs can easily beat using C<fork> and C<exec>
		1200	(or even C<system>) in most programs.
		1201
		1202	=item L<AnyEvent::Filesys::Notify>
		1203
		1204	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1205	path changes (e.g. "watch this directory for new files", "watch this
		1206	file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
		1207	do just that in a portbale fashion, supporting inotify on GNU/Linux and
		1208	some weird, without doubt broken, stuff on OS X to monitor files. It can
		1209	fall back to blocking scans at regular intervals transparently on other
		1210	platforms, so it's about as portable as it gets.
		1211
		1212	(I haven't used it myself, but it seems the biggest problem with it is
		1213	it quite bad performance).
		1214
1142	=item L<AnyEvent::HTTPD>	1215	=item L<AnyEvent::DBI>
1143		1216
1144	A simple embedded webserver.	1217	Executes L<DBI> requests asynchronously in a proxy process for you,
		1218	notifying you in an event-based way when the operation is finished.
1145		1219
1146	=item L<AnyEvent::FastPing>	1220	=item L<AnyEvent::FastPing>
1147		1221
1148	The fastest ping in the west.	1222	The fastest ping in the west.
1149		1223
1150	=item L<Coro>	1224	=item L<Coro>
1151		1225
1152	Has special support for AnyEvent via L<Coro::AnyEvent>.	1226	Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
		1227	to simply invert the flow control - don't call us, we will call you:
		1228
		1229	async {
		1230	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1231	print "5 seconds later!\n";
		1232
		1233	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1234	my $line = <STDIN>; # works for ttys
		1235
		1236	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1237	my ($body, $hdr) = Coro::rouse_wait;
		1238	};
1153		1239
1154	=back	1240	=back
1155		1241
1156	=cut	1242	=cut
1157		1243
1158	package AnyEvent;	1244	package AnyEvent;
1159
1160	# basically a tuned-down version of common::sense
1161	sub common_sense {
1162	# from common:.sense 3.3
1163	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00";
1164	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1165	$^H |= 0x00000600;
1166	}
1167
1168	BEGIN { AnyEvent::common_sense }
1169
1170	use Carp ();
1171
1172	our $VERSION = '5.271';
1173	our $MODEL;
1174
1175	our $AUTOLOAD;
1176	our @ISA;
1177
1178	our @REGISTRY;
1179
1180	our $VERBOSE;
1181		1245
1182	BEGIN {	1246	BEGIN {
1183	require "AnyEvent/constants.pl";	1247	require "AnyEvent/constants.pl";
		1248	&AnyEvent::common_sense;
		1249	}
1184		1250
		1251	use Carp ();
		1252
		1253	our $VERSION = '7.08';
		1254	our $MODEL;
		1255	our @ISA;
		1256	our @REGISTRY;
		1257	our $VERBOSE;
		1258	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
		1259	our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
		1260
		1261	BEGIN {
1185	eval "sub TAINT (){" . (${^TAINT}*1) . "}";	1262	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1186		1263
1187	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1264	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1188	if ${^TAINT};	1265	if ${^TAINT};
1189		1266
1190	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1267	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1268	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1191		1269
1192	}	1270	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1271	if ${^TAINT};
1193		1272
1194	our $MAX_SIGNAL_LATENCY = 10;	1273	# $ENV{PERL_ANYEVENT_xxx} now valid
1195		1274
1196	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1275	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1197		1276
1198	{
1199	my $idx;	1277	my $idx;
1200	$PROTOCOL{$_} = ++$idx	1278	$PROTOCOL{$_} = ++$idx
1201	for reverse split /\s*,\s*/,	1279	for reverse split /\s*,\s*/,
1202	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1280	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1203	}	1281	}
1204		1282
		1283	our @post_detect;
		1284
		1285	sub post_detect(&) {
		1286	my ($cb) = @_;
		1287
		1288	push @post_detect, $cb;
		1289
		1290	defined wantarray
		1291	? bless \$cb, "AnyEvent::Util::postdetect"
		1292	: ()
		1293	}
		1294
		1295	sub AnyEvent::Util::postdetect::DESTROY {
		1296	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1297	}
		1298
		1299	our $POSTPONE_W;
		1300	our @POSTPONE;
		1301
		1302	sub _postpone_exec {
		1303	undef $POSTPONE_W;
		1304
		1305	&{ shift @POSTPONE }
		1306	while @POSTPONE;
		1307	}
		1308
		1309	sub postpone(&) {
		1310	push @POSTPONE, shift;
		1311
		1312	$POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
		1313
		1314	()
		1315	}
		1316
		1317	sub log($$;@) {
		1318	# only load the big bloated module when we actually are about to log something
		1319	if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
		1320	local ($!, $@);
		1321	require AnyEvent::Log; # among other things, sets $VERBOSE to 9
		1322	# AnyEvent::Log overwrites this function
		1323	goto &log;
		1324	}
		1325
		1326	0 # not logged
		1327	}
		1328
		1329	sub _logger($;$) {
		1330	my ($level, $renabled) = @_;
		1331
		1332	$$renabled = $level <= $VERBOSE;
		1333
		1334	my $logger = [(caller)[0], $level, $renabled];
		1335
		1336	$AnyEvent::Log::LOGGER{$logger+0} = $logger;
		1337
		1338	# return unless defined wantarray;
		1339	#
		1340	# require AnyEvent::Util;
		1341	# my $guard = AnyEvent::Util::guard (sub {
		1342	# # "clean up"
		1343	# delete $LOGGER{$logger+0};
		1344	# });
		1345	#
		1346	# sub {
		1347	# return 0 unless $$renabled;
		1348	#
		1349	# $guard if 0; # keep guard alive, but don't cause runtime overhead
		1350	# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
		1351	# package AnyEvent::Log;
		1352	# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
		1353	# }
		1354	}
		1355
		1356	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1357	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1358	}
		1359
1205	my @models = (	1360	our @models = (
1206	[EV:: => AnyEvent::Impl::EV:: , 1],	1361	[EV:: => AnyEvent::Impl::EV::],
1207	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1362	[AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1208	# everything below here will not (normally) be autoprobed	1363	# everything below here will not (normally) be autoprobed
1209	# as the pureperl backend should work everywhere	1364	# as the pure perl backend should work everywhere
1210	# and is usually faster	1365	# and is usually faster
		1366	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1211	[Event:: => AnyEvent::Impl::Event::, 1],	1367	[Event:: => AnyEvent::Impl::Event::], # slow, stable
1212	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1368	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
		1369	# everything below here should not be autoloaded
1213	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1370	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1214	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1215	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1371	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		1372	[UV:: => AnyEvent::Impl::UV::], # switched from libev, added back all bugs imaginable
1216	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1373	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1217	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1374	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1218	[Wx:: => AnyEvent::Impl::POE::],	1375	[Wx:: => AnyEvent::Impl::POE::],
1219	[Prima:: => AnyEvent::Impl::POE::],	1376	[Prima:: => AnyEvent::Impl::POE::],
1220	# IO::Async is just too broken - we would need workarounds for its	1377	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1221	# byzantine signal and broken child handling, among others.	1378	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1222	# IO::Async is rather hard to detect, as it doesn't have any	1379	[FLTK:: => AnyEvent::Impl::FLTK::],
1223	# obvious default class.
1224	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1225	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1226	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1227	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1228	);	1380	);
1229		1381
1230	our %method = map +($_ => 1),	1382	our @isa_hook;
		1383
		1384	sub _isa_set {
		1385	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1386
		1387	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1388	for 1 .. $#pkg;
		1389
		1390	grep $_ && $_->[1], @isa_hook
		1391	and AE::_reset ();
		1392	}
		1393
		1394	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1395	sub _isa_hook($$;$) {
		1396	my ($i, $pkg, $reset_ae) = @_;
		1397
		1398	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1399
		1400	_isa_set;
		1401	}
		1402
		1403	# all autoloaded methods reserve the complete glob, not just the method slot.
		1404	# due to bugs in perls method cache implementation.
1231	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1405	our @methods = qw(io timer time now now_update signal child idle condvar);
1232
1233	our @post_detect;
1234
1235	sub post_detect(&) {
1236	my ($cb) = @_;
1237
1238	push @post_detect, $cb;
1239
1240	defined wantarray
1241	? bless \$cb, "AnyEvent::Util::postdetect"
1242	: ()
1243	}
1244
1245	sub AnyEvent::Util::postdetect::DESTROY {
1246	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1247	}
1248		1406
1249	sub detect() {	1407	sub detect() {
		1408	return $MODEL if $MODEL; # some programs keep references to detect
		1409
		1410	# IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
		1411	# the author knows about the problems and what it does to AnyEvent as a whole
		1412	# (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
		1413	# anyway.
		1414	AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n"
		1415	. "design, abuses internals and breaks AnyEvent - will not continue."
		1416	if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
		1417
		1418	local $!; # for good measure
		1419	local $SIG{__DIE__}; # we use eval
		1420
1250	# free some memory	1421	# free some memory
1251	*detect = sub () { $MODEL };	1422	*detect = sub () { $MODEL };
		1423	# undef &func doesn't correctly update the method cache. grmbl.
		1424	# so we delete the whole glob. grmbl.
		1425	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1426	# a glob with an active sub. hrm. i hope it works, but perl is
		1427	# usually buggy in this department. sigh.
		1428	delete @{"AnyEvent::"}{@methods};
		1429	undef @methods;
1252		1430
1253	local $!; # for good measure
1254	local $SIG{__DIE__};
1255
1256	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1431	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1257	my $model = "AnyEvent::Impl::$1";	1432	my $model = $1;
		1433	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1258	if (eval "require $model") {	1434	if (eval "require $model") {
		1435	AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1259	$MODEL = $model;	1436	$MODEL = $model;
1260	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1261	} else {	1437	} else {
1262	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1438	AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1263	}	1439	}
1264	}	1440	}
1265		1441
1266	# check for already loaded models	1442	# check for already loaded models
1267	unless ($MODEL) {	1443	unless ($MODEL) {
1268	for (@REGISTRY, @models) {	1444	for (@REGISTRY, @models) {
1269	my ($package, $model) = @$_;	1445	my ($package, $model) = @$_;
1270	if (${"$package\::VERSION"} > 0) {	1446	if (${"$package\::VERSION"} > 0) {
1271	if (eval "require $model") {	1447	if (eval "require $model") {
		1448	AnyEvent::log 7 => "Autodetected model '$model', using it.";
1272	$MODEL = $model;	1449	$MODEL = $model;
1273	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1450	last;
		1451	} else {
		1452	AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@";
		1453	}
		1454	}
		1455	}
		1456
		1457	unless ($MODEL) {
		1458	# try to autoload a model
		1459	for (@REGISTRY, @models) {
		1460	my ($package, $model) = @$_;
		1461	if (
		1462	eval "require $package"
		1463	and ${"$package\::VERSION"} > 0
		1464	and eval "require $model"
		1465	) {
		1466	AnyEvent::log 7 => "Autoloaded model '$model', using it.";
		1467	$MODEL = $model;
1274	last;	1468	last;
1275	}	1469	}
1276	}	1470	}
1277	}
1278
1279	unless ($MODEL) {
1280	# try to autoload a model
1281	for (@REGISTRY, @models) {
1282	my ($package, $model, $autoload) = @$_;
1283	if (
1284	$autoload
1285	and eval "require $package"
1286	and ${"$package\::VERSION"} > 0
1287	and eval "require $model"
1288	) {
1289	$MODEL = $model;
1290	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1291	last;
1292	}
1293	}
1294		1471
1295	$MODEL	1472	$MODEL
1296	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1473	or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?";
1297	}	1474	}
1298	}	1475	}
1299		1476
1300	@models = (); # free probe data	1477	# free memory only needed for probing
		1478	undef @models;
		1479	undef @REGISTRY;
1301		1480
1302	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1481	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1303	unshift @ISA, $MODEL;
1304		1482
1305	# now nuke some methods that are overriden by the backend.	1483	# now nuke some methods that are overridden by the backend.
1306	# SUPER is not allowed.	1484	# SUPER usage is not allowed in these.
1307	for (qw(time signal child idle)) {	1485	for (qw(time signal child idle)) {
1308	undef &{"AnyEvent::Base::$_"}	1486	undef &{"AnyEvent::Base::$_"}
1309	if defined &{"$MODEL\::$_"};	1487	if defined &{"$MODEL\::$_"};
1310	}	1488	}
1311		1489
1312	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};	1490	_isa_set;
		1491
		1492	# we're officially open!
		1493
		1494	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1495	require AnyEvent::Strict;
		1496	}
		1497
		1498	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1499	require AnyEvent::Debug;
		1500	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1501	}
		1502
		1503	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1504	require AnyEvent::Socket;
		1505	require AnyEvent::Debug;
		1506
		1507	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1508	$shell =~ s/\$\$/$$/g;
		1509
		1510	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1511	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1512	}
		1513
		1514	# now the anyevent environment is set up as the user told us to, so
		1515	# call the actual user code - post detects
1313		1516
1314	(shift @post_detect)->() while @post_detect;	1517	(shift @post_detect)->() while @post_detect;
		1518	undef @post_detect;
1315		1519
1316	*post_detect = sub(&) {	1520	*post_detect = sub(&) {
1317	shift->();	1521	shift->();
1318		1522
1319	undef	1523	undef
1320	};	1524	};
1321		1525
1322	$MODEL	1526	$MODEL
1323	}	1527	}
1324		1528
1325	sub AUTOLOAD {	1529	for my $name (@methods) {
1326	(my $func = $AUTOLOAD) =~ s/.*://;	1530	*$name = sub {
1327
1328	$method{$func}
1329	or Carp::croak "$func: not a valid AnyEvent class method";
1330
1331	detect;	1531	detect;
1332		1532	# we use goto because
1333	my $class = shift;	1533	# a) it makes the thunk more transparent
1334	$class->$func (@_);	1534	# b) it allows us to delete the thunk later
		1535	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1536	};
1335	}	1537	}
1336		1538
1337	# utility function to dup a filehandle. this is used by many backends	1539	# utility function to dup a filehandle. this is used by many backends
1338	# to support binding more than one watcher per filehandle (they usually	1540	# to support binding more than one watcher per filehandle (they usually
1339	# allow only one watcher per fd, so we dup it to get a different one).	1541	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1363		1565
1364	package AE;	1566	package AE;
1365		1567
1366	our $VERSION = $AnyEvent::VERSION;	1568	our $VERSION = $AnyEvent::VERSION;
1367		1569
		1570	sub _reset() {
		1571	eval q{
1368	# fall back to the main API by default - backends and AnyEvent::Base	1572	# fall back to the main API by default - backends and AnyEvent::Base
1369	# implementations can overwrite these.	1573	# implementations can overwrite these.
1370		1574
1371	sub io($$$) {	1575	sub io($$$) {
1372	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1576	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1373	}	1577	}
1374		1578
1375	sub timer($$$) {	1579	sub timer($$$) {
1376	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])	1580	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1377	}	1581	}
1378		1582
1379	sub signal($$) {	1583	sub signal($$) {
1380	AnyEvent->signal (signal => $_[0], cb => $_[1])	1584	AnyEvent->signal (signal => $_[0], cb => $_[1])
1381	}	1585	}
1382		1586
1383	sub child($$) {	1587	sub child($$) {
1384	AnyEvent->child (pid => $_[0], cb => $_[1])	1588	AnyEvent->child (pid => $_[0], cb => $_[1])
1385	}	1589	}
1386		1590
1387	sub idle($) {	1591	sub idle($) {
1388	AnyEvent->idle (cb => $_[0])	1592	AnyEvent->idle (cb => $_[0]);
1389	}	1593	}
1390		1594
1391	sub cv(;&) {	1595	sub cv(;&) {
1392	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1596	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1393	}	1597	}
1394		1598
1395	sub now() {	1599	sub now() {
1396	AnyEvent->now	1600	AnyEvent->now
1397	}	1601	}
1398		1602
1399	sub now_update() {	1603	sub now_update() {
1400	AnyEvent->now_update	1604	AnyEvent->now_update
1401	}	1605	}
1402		1606
1403	sub time() {	1607	sub time() {
1404	AnyEvent->time	1608	AnyEvent->time
		1609	}
		1610
		1611	*postpone = \&AnyEvent::postpone;
		1612	*log = \&AnyEvent::log;
		1613	};
		1614	die if $@;
1405	}	1615	}
		1616
		1617	BEGIN { _reset }
1406		1618
1407	package AnyEvent::Base;	1619	package AnyEvent::Base;
1408		1620
1409	# default implementations for many methods	1621	# default implementations for many methods
1410		1622
1411	sub time {	1623	sub time {
1412	eval q{ # poor man's autoloading {}	1624	eval q{ # poor man's autoloading {}
1413	# probe for availability of Time::HiRes	1625	# probe for availability of Time::HiRes
1414	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1626	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1415	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1627	*time = sub { Time::HiRes::time () };
1416	*AE::time = \&Time::HiRes::time;	1628	*AE::time = \& Time::HiRes::time ;
		1629	*now = \&time;
		1630	AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy.";
1417	# if (eval "use POSIX (); (POSIX::times())...	1631	# if (eval "use POSIX (); (POSIX::times())...
1418	} else {	1632	} else {
1419	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1633	*time = sub { CORE::time };
1420	*AE::time = sub (){ time }; # epic fail	1634	*AE::time = sub (){ CORE::time };
		1635	*now = \&time;
		1636	AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!";
1421	}	1637	}
1422
1423	*time = sub { AE::time }; # different prototypes
1424	};	1638	};
1425	die if $@;	1639	die if $@;
1426		1640
1427	&time	1641	&time
1428	}	1642	}
1429		1643
1430	*now = \&time;	1644	*now = \&time;
1431
1432	sub now_update { }	1645	sub now_update { }
1433		1646
		1647	sub _poll {
		1648	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1649	}
		1650
1434	# default implementation for ->condvar	1651	# default implementation for ->condvar
		1652	# in fact, the default should not be overwritten
1435		1653
1436	sub condvar {	1654	sub condvar {
1437	eval q{ # poor man's autoloading {}	1655	eval q{ # poor man's autoloading {}
1438	*condvar = sub {	1656	*condvar = sub {
1439	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1657	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
…		…
1517		1735
1518	sub signal {	1736	sub signal {
1519	eval q{ # poor man's autoloading {}	1737	eval q{ # poor man's autoloading {}
1520	# probe for availability of Async::Interrupt	1738	# probe for availability of Async::Interrupt
1521	if (_have_async_interrupt) {	1739	if (_have_async_interrupt) {
1522	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;	1740	AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling.";
1523		1741
1524	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1742	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1525	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1743	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1526		1744
1527	} else {	1745	} else {
1528	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1746	AnyEvent::log 8 => "Using emulated perl signal handling with latency timer.";
1529		1747
1530	if (AnyEvent::WIN32) {	1748	if (AnyEvent::WIN32) {
1531	require AnyEvent::Util;	1749	require AnyEvent::Util;
1532		1750
1533	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1751	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
…		…
1609	: sysread $SIGPIPE_R, (my $dummy), 9;	1827	: sysread $SIGPIPE_R, (my $dummy), 9;
1610		1828
1611	while (%SIG_EV) {	1829	while (%SIG_EV) {
1612	for (keys %SIG_EV) {	1830	for (keys %SIG_EV) {
1613	delete $SIG_EV{$_};	1831	delete $SIG_EV{$_};
1614	$_->() for values %{ $SIG_CB{$_} || {} };	1832	&$_ for values %{ $SIG_CB{$_} || {} };
1615	}	1833	}
1616	}	1834	}
1617	};	1835	};
1618	};	1836	};
1619	die if $@;	1837	die if $@;
…		…
1624	# default implementation for ->child	1842	# default implementation for ->child
1625		1843
1626	our %PID_CB;	1844	our %PID_CB;
1627	our $CHLD_W;	1845	our $CHLD_W;
1628	our $CHLD_DELAY_W;	1846	our $CHLD_DELAY_W;
1629	our $WNOHANG;
1630		1847
1631	# used by many Impl's	1848	# used by many Impl's
1632	sub _emit_childstatus($$) {	1849	sub _emit_childstatus($$) {
1633	my (undef, $rpid, $rstatus) = @_;	1850	my (undef, $rpid, $rstatus) = @_;
1634		1851
…		…
1641	eval q{ # poor man's autoloading {}	1858	eval q{ # poor man's autoloading {}
1642	*_sigchld = sub {	1859	*_sigchld = sub {
1643	my $pid;	1860	my $pid;
1644		1861
1645	AnyEvent->_emit_childstatus ($pid, $?)	1862	AnyEvent->_emit_childstatus ($pid, $?)
1646	while ($pid = waitpid -1, $WNOHANG) > 0;	1863	while ($pid = waitpid -1, WNOHANG) > 0;
1647	};	1864	};
1648		1865
1649	*child = sub {	1866	*child = sub {
1650	my (undef, %arg) = @_;	1867	my (undef, %arg) = @_;
1651		1868
1652	defined (my $pid = $arg{pid} + 0)	1869	my $pid = $arg{pid};
1653	or Carp::croak "required option 'pid' is missing";	1870	my $cb = $arg{cb};
1654		1871
1655	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1872	$PID_CB{$pid}{$cb+0} = $cb;
1656
1657	# WNOHANG is almost cetrainly 1 everywhere
1658	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1659	? 1
1660	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1661		1873
1662	unless ($CHLD_W) {	1874	unless ($CHLD_W) {
1663	$CHLD_W = AE::signal CHLD => \&_sigchld;	1875	$CHLD_W = AE::signal CHLD => \&_sigchld;
1664	# child could be a zombie already, so make at least one round	1876	# child could be a zombie already, so make at least one round
1665	&_sigchld;	1877	&_sigchld;
1666	}	1878	}
1667		1879
1668	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1880	bless [$pid, $cb+0], "AnyEvent::Base::child"
1669	};	1881	};
1670		1882
1671	*AnyEvent::Base::child::DESTROY = sub {	1883	*AnyEvent::Base::child::DESTROY = sub {
1672	my ($pid, $cb) = @{$_[0]};	1884	my ($pid, $icb) = @{$_[0]};
1673		1885
1674	delete $PID_CB{$pid}{$cb};	1886	delete $PID_CB{$pid}{$icb};
1675	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1887	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1676		1888
1677	undef $CHLD_W unless keys %PID_CB;	1889	undef $CHLD_W unless keys %PID_CB;
1678	};	1890	};
1679	};	1891	};
…		…
1692		1904
1693	my ($cb, $w, $rcb) = $arg{cb};	1905	my ($cb, $w, $rcb) = $arg{cb};
1694		1906
1695	$rcb = sub {	1907	$rcb = sub {
1696	if ($cb) {	1908	if ($cb) {
1697	$w = _time;	1909	$w = AE::time;
1698	&$cb;	1910	&$cb;
1699	$w = _time - $w;	1911	$w = AE::time - $w;
1700		1912
1701	# never use more then 50% of the time for the idle watcher,	1913	# never use more then 50% of the time for the idle watcher,
1702	# within some limits	1914	# within some limits
1703	$w = 0.0001 if $w < 0.0001;	1915	$w = 0.0001 if $w < 0.0001;
1704	$w = 5 if $w > 5;	1916	$w = 5 if $w > 5;
…		…
1751		1963
1752	sub _send {	1964	sub _send {
1753	# nop	1965	# nop
1754	}	1966	}
1755		1967
		1968	sub _wait {
		1969	AnyEvent->_poll until $_[0]{_ae_sent};
		1970	}
		1971
1756	sub send {	1972	sub send {
1757	my $cv = shift;	1973	my $cv = shift;
1758	$cv->{_ae_sent} = [@_];	1974	$cv->{_ae_sent} = [@_];
1759	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1975	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1760	$cv->_send;	1976	$cv->_send;
…		…
1767		1983
1768	sub ready {	1984	sub ready {
1769	$_[0]{_ae_sent}	1985	$_[0]{_ae_sent}
1770	}	1986	}
1771		1987
1772	sub _wait {
1773	$WAITING
1774	and !$_[0]{_ae_sent}
1775	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1776
1777	local $WAITING = 1;
1778	AnyEvent->one_event while !$_[0]{_ae_sent};
1779	}
1780
1781	sub recv {	1988	sub recv {
		1989	unless ($_[0]{_ae_sent}) {
		1990	$WAITING
		1991	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1992
		1993	local $WAITING = 1;
1782	$_[0]->_wait;	1994	$_[0]->_wait;
		1995	}
1783		1996
1784	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1997	$_[0]{_ae_croak}
1785	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1998	and Carp::croak $_[0]{_ae_croak};
		1999
		2000	wantarray
		2001	? @{ $_[0]{_ae_sent} }
		2002	: $_[0]{_ae_sent}[0]
1786	}	2003	}
1787		2004
1788	sub cb {	2005	sub cb {
1789	my $cv = shift;	2006	my $cv = shift;
1790		2007
…		…
1806	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	2023	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1807	}	2024	}
1808		2025
1809	# undocumented/compatibility with pre-3.4	2026	# undocumented/compatibility with pre-3.4
1810	*broadcast = \&send;	2027	*broadcast = \&send;
1811	*wait = \&_wait;	2028	*wait = \&recv;
1812		2029
1813	=head1 ERROR AND EXCEPTION HANDLING	2030	=head1 ERROR AND EXCEPTION HANDLING
1814		2031
1815	In general, AnyEvent does not do any error handling - it relies on the	2032	In general, AnyEvent does not do any error handling - it relies on the
1816	caller to do that if required. The L<AnyEvent::Strict> module (see also	2033	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1828	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2045	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1829	so on.	2046	so on.
1830		2047
1831	=head1 ENVIRONMENT VARIABLES	2048	=head1 ENVIRONMENT VARIABLES
1832		2049
1833	The following environment variables are used by this module or its	2050	AnyEvent supports a number of environment variables that tune the
1834	submodules.	2051	runtime behaviour. They are usually evaluated when AnyEvent is
		2052	loaded, initialised, or a submodule that uses them is loaded. Many of
		2053	them also cause AnyEvent to load additional modules - for example,
		2054	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2055	loaded.
1835		2056
1836	Note that AnyEvent will remove I<all> environment variables starting with	2057	All the environment variables documented here start with
1837	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2058	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1838	enabled.	2059	namespace. Other modules are encouraged (but by no means required) to use
		2060	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2061	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2062	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2063	variables starting with C<AE_>, see below).
		2064
		2065	All variables can also be set via the C<AE_> prefix, that is, instead
		2066	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2067	case there is a clash btween anyevent and another program that uses
		2068	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2069	variable to the empty string, as those variables take precedence.
		2070
		2071	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2072	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2073	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2074	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2075	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2076	is set).
		2077
		2078	The exact algorithm is currently:
		2079
		2080	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2081	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2082	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2083
		2084	This ensures that child processes will not see the C<AE_> variables.
		2085
		2086	The following environment variables are currently known to AnyEvent:
1839		2087
1840	=over 4	2088	=over 4
1841		2089
1842	=item C<PERL_ANYEVENT_VERBOSE>	2090	=item C<PERL_ANYEVENT_VERBOSE>
1843		2091
1844	By default, AnyEvent will be completely silent except in fatal	2092	By default, AnyEvent will log messages with loglevel C<4> (C<error>) or
1845	conditions. You can set this environment variable to make AnyEvent more	2093	higher (see L<AnyEvent::Log>). You can set this environment variable to a
1846	talkative.	2094	numerical loglevel to make AnyEvent more (or less) talkative.
1847		2095
		2096	If you want to do more than just set the global logging level
		2097	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2098	complex specifications.
		2099
		2100	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2101	everything else at defaults.
		2102
1848	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2103	When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected
1849	conditions, such as not being able to load the event model specified by	2104	conditions, such as not being able to load the event model specified by
1850	C<PERL_ANYEVENT_MODEL>.	2105	C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
		2106	is the minimum recommended level for use during development.
1851		2107
1852	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2108	When set to C<7> or higher (info), AnyEvent reports which event model it
1853	model it chooses.	2109	chooses.
1854		2110
1855	When set to C<8> or higher, then AnyEvent will report extra information on	2111	When set to C<8> or higher (debug), then AnyEvent will report extra
1856	which optional modules it loads and how it implements certain features.	2112	information on which optional modules it loads and how it implements
		2113	certain features.
		2114
		2115	=item C<PERL_ANYEVENT_LOG>
		2116
		2117	Accepts rather complex logging specifications. For example, you could log
		2118	all C<debug> messages of some module to stderr, warnings and above to
		2119	stderr, and errors and above to syslog, with:
		2120
		2121	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2122
		2123	For the rather extensive details, see L<AnyEvent::Log>.
		2124
		2125	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2126	so will take effect even before AnyEvent has initialised itself.
		2127
		2128	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2129	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2130	using the latter saves a few hundred kB of memory unless a module
		2131	explicitly needs the extra features of AnyEvent::Log.
1857		2132
1858	=item C<PERL_ANYEVENT_STRICT>	2133	=item C<PERL_ANYEVENT_STRICT>
1859		2134
1860	AnyEvent does not do much argument checking by default, as thorough	2135	AnyEvent does not do much argument checking by default, as thorough
1861	argument checking is very costly. Setting this variable to a true value	2136	argument checking is very costly. Setting this variable to a true value
…		…
1868	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>	2143	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1869	>>, it is definitely recommended to keep it off in production. Keeping	2144	>>, it is definitely recommended to keep it off in production. Keeping
1870	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2145	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1871	can be very useful, however.	2146	can be very useful, however.
1872		2147
		2148	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2149
		2150	If this env variable is nonempty, then its contents will be interpreted by
		2151	C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
		2152	replacing every occurance of C<$$> by the process pid). The shell object
		2153	is saved in C<$AnyEvent::Debug::SHELL>.
		2154
		2155	This happens when the first watcher is created.
		2156
		2157	For example, to bind a debug shell on a unix domain socket in
		2158	F<< /tmp/debug<pid>.sock >>, you could use this:
		2159
		2160	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2161	# connect with e.g.: socat readline /tmp/debug123.sock
		2162
		2163	Or to bind to tcp port 4545 on localhost:
		2164
		2165	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		2166	# connect with e.g.: telnet localhost 4545
		2167
		2168	Note that creating sockets in F</tmp> or on localhost is very unsafe on
		2169	multiuser systems.
		2170
		2171	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2172
		2173	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2174	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2175
1873	=item C<PERL_ANYEVENT_MODEL>	2176	=item C<PERL_ANYEVENT_MODEL>
1874		2177
1875	This can be used to specify the event model to be used by AnyEvent, before	2178	This can be used to specify the event model to be used by AnyEvent, before
1876	auto detection and -probing kicks in. It must be a string consisting	2179	auto detection and -probing kicks in.
1877	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2180
		2181	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2182	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1878	and the resulting module name is loaded and if the load was successful,	2183	resulting module name is loaded and - if the load was successful - used as
1879	used as event model. If it fails to load AnyEvent will proceed with	2184	event model backend. If it fails to load then AnyEvent will proceed with
1880	auto detection and -probing.	2185	auto detection and -probing.
1881		2186
1882	This functionality might change in future versions.	2187	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2188	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2189	the end of a string designates a module name and quotes it appropriately).
1883		2190
1884	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2191	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1885	could start your program like this:	2192	could start your program like this:
1886		2193
1887	PERL_ANYEVENT_MODEL=Perl perl ...	2194	PERL_ANYEVENT_MODEL=Perl perl ...
		2195
		2196	=item C<PERL_ANYEVENT_IO_MODEL>
		2197
		2198	The current file I/O model - see L<AnyEvent::IO> for more info.
		2199
		2200	At the moment, only C<Perl> (small, pure-perl, synchronous) and
		2201	C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if
		2202	L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>.
1888		2203
1889	=item C<PERL_ANYEVENT_PROTOCOLS>	2204	=item C<PERL_ANYEVENT_PROTOCOLS>
1890		2205
1891	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences	2206	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1892	for IPv4 or IPv6. The default is unspecified (and might change, or be the result	2207	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
…		…
1897	used, and preference will be given to protocols mentioned earlier in the	2212	used, and preference will be given to protocols mentioned earlier in the
1898	list.	2213	list.
1899		2214
1900	This variable can effectively be used for denial-of-service attacks	2215	This variable can effectively be used for denial-of-service attacks
1901	against local programs (e.g. when setuid), although the impact is likely	2216	against local programs (e.g. when setuid), although the impact is likely
1902	small, as the program has to handle conenction and other failures anyways.	2217	small, as the program has to handle connection and other failures anyways.
1903		2218
1904	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,	2219	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1905	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2220	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1906	- only support IPv4, never try to resolve or contact IPv6	2221	- only support IPv4, never try to resolve or contact IPv6
1907	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2222	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1908	IPv6, but prefer IPv6 over IPv4.	2223	IPv6, but prefer IPv6 over IPv4.
1909		2224
		2225	=item C<PERL_ANYEVENT_HOSTS>
		2226
		2227	This variable, if specified, overrides the F</etc/hosts> file used by
		2228	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2229	from that file instead.
		2230
1910	=item C<PERL_ANYEVENT_EDNS0>	2231	=item C<PERL_ANYEVENT_EDNS0>
1911		2232
1912	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2233	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1913	for DNS. This extension is generally useful to reduce DNS traffic, but	2234	DNS. This extension is generally useful to reduce DNS traffic, especially
1914	some (broken) firewalls drop such DNS packets, which is why it is off by	2235	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1915	default.	2236	packets, which is why it is off by default.
1916		2237
1917	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2238	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1918	EDNS0 in its DNS requests.	2239	EDNS0 in its DNS requests.
1919		2240
1920	=item C<PERL_ANYEVENT_MAX_FORKS>	2241	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1926		2247
1927	The default value for the C<max_outstanding> parameter for the default DNS	2248	The default value for the C<max_outstanding> parameter for the default DNS
1928	resolver - this is the maximum number of parallel DNS requests that are	2249	resolver - this is the maximum number of parallel DNS requests that are
1929	sent to the DNS server.	2250	sent to the DNS server.
1930		2251
		2252	=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
		2253
		2254	Perl has inherently racy signal handling (you can basically choose between
		2255	losing signals and memory corruption) - pure perl event loops (including
		2256	C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
		2257	have to poll regularly to avoid losing signals.
		2258
		2259	Some event loops are racy, but don't poll regularly, and some event loops
		2260	are written in C but are still racy. For those event loops, AnyEvent
		2261	installs a timer that regularly wakes up the event loop.
		2262
		2263	By default, the interval for this timer is C<10> seconds, but you can
		2264	override this delay with this environment variable (or by setting
		2265	the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
		2266	watchers).
		2267
		2268	Lower values increase CPU (and energy) usage, higher values can introduce
		2269	long delays when reaping children or waiting for signals.
		2270
		2271	The L<AnyEvent::Async> module, if available, will be used to avoid this
		2272	polling (with most event loops).
		2273
1931	=item C<PERL_ANYEVENT_RESOLV_CONF>	2274	=item C<PERL_ANYEVENT_RESOLV_CONF>
1932		2275
1933	The file to use instead of F</etc/resolv.conf> (or OS-specific	2276	The absolute path to a F<resolv.conf>-style file to use instead of
1934	configuration) in the default resolver. When set to the empty string, no	2277	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1935	default config will be used.	2278	resolver, or the empty string to select the default configuration.
1936		2279
1937	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2280	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1938		2281
1939	When neither C<ca_file> nor C<ca_path> was specified during	2282	When neither C<ca_file> nor C<ca_path> was specified during
1940	L<AnyEvent::TLS> context creation, and either of these environment	2283	L<AnyEvent::TLS> context creation, and either of these environment
1941	variables exist, they will be used to specify CA certificate locations	2284	variables are nonempty, they will be used to specify CA certificate
1942	instead of a system-dependent default.	2285	locations instead of a system-dependent default.
1943		2286
1944	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2287	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1945		2288
1946	When these are set to C<1>, then the respective modules are not	2289	When these are set to C<1>, then the respective modules are not
1947	loaded. Mostly good for testing AnyEvent itself.	2290	loaded. Mostly good for testing AnyEvent itself.
…		…
2279	(even when used without AnyEvent), but most event loops have acceptable	2622	(even when used without AnyEvent), but most event loops have acceptable
2280	performance with or without AnyEvent.	2623	performance with or without AnyEvent.
2281		2624
2282	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2625	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2283	the actual event loop, only with extremely fast event loops such as EV	2626	the actual event loop, only with extremely fast event loops such as EV
2284	adds AnyEvent significant overhead.	2627	does AnyEvent add significant overhead.
2285		2628
2286	=item * You should avoid POE like the plague if you want performance or	2629	=item * You should avoid POE like the plague if you want performance or
2287	reasonable memory usage.	2630	reasonable memory usage.
2288		2631
2289	=back	2632	=back
…		…
2588		2931
2589	=item L<Time::HiRes>	2932	=item L<Time::HiRes>
2590		2933
2591	This module is part of perl since release 5.008. It will be used when the	2934	This module is part of perl since release 5.008. It will be used when the
2592	chosen event library does not come with a timing source of its own. The	2935	chosen event library does not come with a timing source of its own. The
2593	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2936	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2594	try to use a monotonic clock for timing stability.	2937	try to use a monotonic clock for timing stability.
		2938
		2939	=item L<AnyEvent::AIO> (and L<IO::AIO>)
		2940
		2941	The default implementation of L<AnyEvent::IO> is to do I/O synchronously,
		2942	stopping programs while they access the disk, which is fine for a lot of
		2943	programs.
		2944
		2945	Installing AnyEvent::AIO (and its IO::AIO dependency) makes it switch to
		2946	a true asynchronous implementation, so event processing can continue even
		2947	while waiting for disk I/O.
2595		2948
2596	=back	2949	=back
2597		2950
2598		2951
2599	=head1 FORK	2952	=head1 FORK
…		…
2611	usually happens when the first AnyEvent watcher is created, or the library	2964	usually happens when the first AnyEvent watcher is created, or the library
2612	is loaded).	2965	is loaded).
2613		2966
2614	If you have to fork, you must either do so I<before> creating your first	2967	If you have to fork, you must either do so I<before> creating your first
2615	watcher OR you must not use AnyEvent at all in the child OR you must do	2968	watcher OR you must not use AnyEvent at all in the child OR you must do
2616	something completely out of the scope of AnyEvent.	2969	something completely out of the scope of AnyEvent (see below).
2617		2970
2618	The problem of doing event processing in the parent I<and> the child	2971	The problem of doing event processing in the parent I<and> the child
2619	is much more complicated: even for backends that I<are> fork-aware or	2972	is much more complicated: even for backends that I<are> fork-aware or
2620	fork-safe, their behaviour is not usually what you want: fork clones all	2973	fork-safe, their behaviour is not usually what you want: fork clones all
2621	watchers, that means all timers, I/O watchers etc. are active in both	2974	watchers, that means all timers, I/O watchers etc. are active in both
2622	parent and child, which is almost never what you want. USing C<exec>	2975	parent and child, which is almost never what you want. Using C<exec>
2623	to start worker children from some kind of manage rprocess is usually	2976	to start worker children from some kind of manage prrocess is usually
2624	preferred, because it is much easier and cleaner, at the expense of having	2977	preferred, because it is much easier and cleaner, at the expense of having
2625	to have another binary.	2978	to have another binary.
		2979
		2980	In addition to logical problems with fork, there are also implementation
		2981	problems. For example, on POSIX systems, you cannot fork at all in Perl
		2982	code if a thread (I am talking of pthreads here) was ever created in the
		2983	process, and this is just the tip of the iceberg. In general, using fork
		2984	from Perl is difficult, and attempting to use fork without an exec to
		2985	implement some kind of parallel processing is almost certainly doomed.
		2986
		2987	To safely fork and exec, you should use a module such as
		2988	L<Proc::FastSpawn> that let's you safely fork and exec new processes.
		2989
		2990	If you want to do multiprocessing using processes, you can
		2991	look at the L<AnyEvent::Fork> module (and some related modules
		2992	such as L<AnyEvent::Fork::RPC>, L<AnyEvent::Fork::Pool> and
		2993	L<AnyEvent::Fork::Remote>). This module allows you to safely create
		2994	subprocesses without any limitations - you can use X11 toolkits or
		2995	AnyEvent in the children created by L<AnyEvent::Fork> safely and without
		2996	any special precautions.
2626		2997
2627		2998
2628	=head1 SECURITY CONSIDERATIONS	2999	=head1 SECURITY CONSIDERATIONS
2629		3000
2630	AnyEvent can be forced to load any event model via	3001	AnyEvent can be forced to load any event model via
…		…
2664		3035
2665	Tutorial/Introduction: L<AnyEvent::Intro>.	3036	Tutorial/Introduction: L<AnyEvent::Intro>.
2666		3037
2667	FAQ: L<AnyEvent::FAQ>.	3038	FAQ: L<AnyEvent::FAQ>.
2668		3039
2669	Utility functions: L<AnyEvent::Util>.	3040	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		3041	(simply logging).
2670		3042
2671	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	3043	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2672	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	3044	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		3045
		3046	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		3047	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		3048	L<Qt>, L<POE>, L<FLTK>.
2673		3049
2674	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	3050	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2675	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	3051	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2676	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	3052	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2677	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.	3053	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		3054	L<AnyEvent::Impl::FLTK>.
2678		3055
2679	Non-blocking file handles, sockets, TCP clients and	3056	Non-blocking handles, pipes, stream sockets, TCP clients and
2680	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	3057	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2681		3058
		3059	Asynchronous File I/O: L<AnyEvent::IO>.
		3060
2682	Asynchronous DNS: L<AnyEvent::DNS>.	3061	Asynchronous DNS: L<AnyEvent::DNS>.
2683		3062
2684	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV L<Coro::Event >,	3063	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2685		3064
2686	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,	3065	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2687	L<AnyEvent::HTTP>.	3066	L<AnyEvent::HTTP>.
2688		3067
2689		3068
2690	=head1 AUTHOR	3069	=head1 AUTHOR
2691		3070
2692	Marc Lehmann <schmorp@schmorp.de>	3071	Marc Lehmann <schmorp@schmorp.de>
2693	http://home.schmorp.de/	3072	http://anyevent.schmorp.de
2694		3073
2695	=cut	3074	=cut
2696		3075
2697	1	3076	1
2698		3077

Diff Legend

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