ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.202 by root, Wed Apr 1 15:29:00 2009 UTC vs.
Revision 1.416 by root, Tue Dec 17 16:43:15 2013 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
		6	FLTK and POE are various supported event loops/environments.
6		7
7	=head1 SYNOPSIS	8	=head1 SYNOPSIS
8		9
9	use AnyEvent;	10	use AnyEvent;
10		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
		15	# file handle or descriptor readable
11	my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
12		17
		18	# one-shot or repeating timers
13	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
14	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
15		21
16	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
17	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
18		24
		25	# POSIX signal
19	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });	26	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
20		27
		28	# child process exit
21	my $w = AnyEvent->child (pid => $pid, cb => sub {	29	my $w = AnyEvent->child (pid => $pid, cb => sub {
22	my ($pid, $status) = @_;	30	my ($pid, $status) = @_;
23	...	31	...
24	});	32	});
		33
		34	# called when event loop idle (if applicable)
		35	my $w = AnyEvent->idle (cb => sub { ... });
25		36
26	my $w = AnyEvent->condvar; # stores whether a condition was flagged	37	my $w = AnyEvent->condvar; # stores whether a condition was flagged
27	$w->send; # wake up current and all future recv's	38	$w->send; # wake up current and all future recv's
28	$w->recv; # enters "main loop" till $condvar gets ->send	39	$w->recv; # enters "main loop" till $condvar gets ->send
29	# use a condvar in callback mode:	40	# use a condvar in callback mode:
…		…
32	=head1 INTRODUCTION/TUTORIAL	43	=head1 INTRODUCTION/TUTORIAL
33		44
34	This manpage is mainly a reference manual. If you are interested	45	This manpage is mainly a reference manual. If you are interested
35	in a tutorial or some gentle introduction, have a look at the	46	in a tutorial or some gentle introduction, have a look at the
36	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
		48
		49	=head1 SUPPORT
		50
		51	An FAQ document is available as L<AnyEvent::FAQ>.
		52
		53	There also is a mailinglist for discussing all things AnyEvent, and an IRC
		54	channel, too.
		55
		56	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		57	Repository>, at L<http://anyevent.schmorp.de>, for more info.
37		58
38	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	59	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
39		60
40	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	61	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
41	nowadays. So what is different about AnyEvent?	62	nowadays. So what is different about AnyEvent?
…		…
57	module users into the same thing by forcing them to use the same event	78	module users into the same thing by forcing them to use the same event
58	model you use.	79	model you use.
59		80
60	For modules like POE or IO::Async (which is a total misnomer as it is	81	For modules like POE or IO::Async (which is a total misnomer as it is
61	actually doing all I/O I<synchronously>...), using them in your module is	82	actually doing all I/O I<synchronously>...), using them in your module is
62	like joining a cult: After you joined, you are dependent on them and you	83	like joining a cult: After you join, you are dependent on them and you
63	cannot use anything else, as they are simply incompatible to everything	84	cannot use anything else, as they are simply incompatible to everything
64	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
65	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.
66		87
67	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
68	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
69	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
70	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
71	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
72	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
73	use one of the supported event loops. It is trivial to add new event loops	94	supported event loops. It is easy to add new event loops to AnyEvent, too,
74	to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
75		96
76	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
77	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
78	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
79	follow. AnyEvent, on the other hand, is lean and up to the point, by only	100	follow. AnyEvent, on the other hand, is lean and to the point, by only
80	offering the functionality that is necessary, in as thin as a wrapper as	101	offering the functionality that is necessary, in as thin as a wrapper as
81	technically possible.	102	technically possible.
82		103
83	Of course, AnyEvent comes with a big (and fully optional!) toolbox	104	Of course, AnyEvent comes with a big (and fully optional!) toolbox
84	of useful functionality, such as an asynchronous DNS resolver, 100%	105	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
90	useful) and you want to force your users to use the one and only event	111	useful) and you want to force your users to use the one and only event
91	model, you should I<not> use this module.	112	model, you should I<not> use this module.
92		113
93	=head1 DESCRIPTION	114	=head1 DESCRIPTION
94		115
95	L<AnyEvent> provides an identical interface to multiple event loops. This	116	L<AnyEvent> provides a uniform interface to various event loops. This
96	allows module authors to utilise an event loop without forcing module	117	allows module authors to use event loop functionality without forcing
97	users to use the same event loop (as only a single event loop can coexist	118	module users to use a specific event loop implementation (since more
98	peacefully at any one time).	119	than one event loop cannot coexist peacefully).
99		120
100	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>
101	module.	122	module.
102		123
103	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
104	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
105	following modules is already loaded: L<EV>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
106	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,	127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
107	L<POE>. The first one found is used. If none are found, the module tries	128	found is used. If none are detected, the module tries to load the first
108	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl	129	four modules in the order given; but note that if L<EV> is not
109	adaptor should always succeed) in the order given. The first one that can	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
110	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
111	found, AnyEvent will fall back to a pure-perl event loop, which is not
112	very efficient, but should work everywhere.
113		132
114	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
115	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
116	that model the default. For example:	135	that model the default. For example:
117		136
…		…
119	use AnyEvent;	138	use AnyEvent;
120		139
121	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
122		141
123	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
124	starts using it, all bets are off. Maybe you should tell their authors to	143	starts using it, all bets are off - this case should be very rare though,
125	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
126		146
127	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
128	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
129	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
130		150
131	=head1 WATCHERS	151	=head1 WATCHERS
132		152
133	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
134	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
…		…
139	callback when the event occurs (of course, only when the event model	159	callback when the event occurs (of course, only when the event model
140	is in control).	160	is in control).
141		161
142	Note that B<callbacks must not permanently change global variables>	162	Note that B<callbacks must not permanently change global variables>
143	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<	163	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
144	callbacks must not C<die> >>. The former is good programming practise in	164	callbacks must not C<die> >>. The former is good programming practice in
145	Perl and the latter stems from the fact that exception handling differs	165	Perl and the latter stems from the fact that exception handling differs
146	widely between event loops.	166	widely between event loops.
147		167
148	To disable the watcher you have to destroy it (e.g. by setting the	168	To disable a watcher you have to destroy it (e.g. by setting the
149	variable you store it in to C<undef> or otherwise deleting all references	169	variable you store it in to C<undef> or otherwise deleting all references
150	to it).	170	to it).
151		171
152	All watchers are created by calling a method on the C<AnyEvent> class.	172	All watchers are created by calling a method on the C<AnyEvent> class.
153		173
154	Many watchers either are used with "recursion" (repeating timers for	174	Many watchers either are used with "recursion" (repeating timers for
155	example), or need to refer to their watcher object in other ways.	175	example), or need to refer to their watcher object in other ways.
156		176
157	An any way to achieve that is this pattern:	177	One way to achieve that is this pattern:
158		178
159	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
160	# you can use $w here, for example to undef it	180	# you can use $w here, for example to undef it
161	undef $w;	181	undef $w;
162	});	182	});
…		…
165	my variables are only visible after the statement in which they are	185	my variables are only visible after the statement in which they are
166	declared.	186	declared.
167		187
168	=head2 I/O WATCHERS	188	=head2 I/O WATCHERS
169		189
		190	$w = AnyEvent->io (
		191	fh => <filehandle_or_fileno>,
		192	poll => <"r" or "w">,
		193	cb => <callback>,
		194	);
		195
170	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	196	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
171	with the following mandatory key-value pairs as arguments:	197	with the following mandatory key-value pairs as arguments:
172		198
173	C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch	199	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
174	for events (AnyEvent might or might not keep a reference to this file	200	for events (AnyEvent might or might not keep a reference to this file
175	handle). Note that only file handles pointing to things for which	201	handle). Note that only file handles pointing to things for which
176	non-blocking operation makes sense are allowed. This includes sockets,	202	non-blocking operation makes sense are allowed. This includes sockets,
177	most character devices, pipes, fifos and so on, but not for example files	203	most character devices, pipes, fifos and so on, but not for example files
178	or block devices.	204	or block devices.
…		…
188		214
189	The I/O watcher might use the underlying file descriptor or a copy of it.	215	The I/O watcher might use the underlying file descriptor or a copy of it.
190	You must not close a file handle as long as any watcher is active on the	216	You must not close a file handle as long as any watcher is active on the
191	underlying file descriptor.	217	underlying file descriptor.
192		218
193	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
194	always use non-blocking calls when reading/writing from/to your file	220	always use non-blocking calls when reading/writing from/to your file
195	handles.	221	handles.
196		222
197	Example: wait for readability of STDIN, then read a line and disable the	223	Example: wait for readability of STDIN, then read a line and disable the
198	watcher.	224	watcher.
…		…
203	undef $w;	229	undef $w;
204	});	230	});
205		231
206	=head2 TIME WATCHERS	232	=head2 TIME WATCHERS
207		233
		234	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		235
		236	$w = AnyEvent->timer (
		237	after => <fractional_seconds>,
		238	interval => <fractional_seconds>,
		239	cb => <callback>,
		240	);
		241
208	You can create a time watcher by calling the C<< AnyEvent->timer >>	242	You can create a time watcher by calling the C<< AnyEvent->timer >>
209	method with the following mandatory arguments:	243	method with the following mandatory arguments:
210		244
211	C<after> specifies after how many seconds (fractional values are	245	C<after> specifies after how many seconds (fractional values are
212	supported) the callback should be invoked. C<cb> is the callback to invoke	246	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
214		248
215	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
216	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
217	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
218		252
219	The callback will normally be invoked once only. If you specify another	253	The callback will normally be invoked only once. If you specify another
220	parameter, C<interval>, as a strictly positive number (> 0), then the	254	parameter, C<interval>, as a strictly positive number (> 0), then the
221	callback will be invoked regularly at that interval (in fractional	255	callback will be invoked regularly at that interval (in fractional
222	seconds) after the first invocation. If C<interval> is specified with a	256	seconds) after the first invocation. If C<interval> is specified with a
223	false value, then it is treated as if it were missing.	257	false value, then it is treated as if it were not specified at all.
224		258
225	The callback will be rescheduled before invoking the callback, but no	259	The callback will be rescheduled before invoking the callback, but no
226	attempt is done to avoid timer drift in most backends, so the interval is	260	attempt is made to avoid timer drift in most backends, so the interval is
227	only approximate.	261	only approximate.
228		262
229	Example: fire an event after 7.7 seconds.	263	Example: fire an event after 7.7 seconds.
230		264
231	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
237		271
238	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.
239		273
240	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {	274	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
241	warn "timeout\n";	275	warn "timeout\n";
242	};	276	});
243		277
244	=head3 TIMING ISSUES	278	=head3 TIMING ISSUES
245		279
246	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
247	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
…		…
249		283
250	While most event loops expect timers to specified in a relative way, they	284	While most event loops expect timers to specified in a relative way, they
251	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
252	"jumps", for example, when ntp decides to set your clock backwards from	286	"jumps", for example, when ntp decides to set your clock backwards from
253	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to	287	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
254	fire "after" a second might actually take six years to finally fire.	288	fire "after a second" might actually take six years to finally fire.
255		289
256	AnyEvent cannot compensate for this. The only event loop that is conscious	290	AnyEvent cannot compensate for this. The only event loop that is conscious
257	about these issues is L<EV>, which offers both relative (ev_timer, based	291	of these issues is L<EV>, which offers both relative (ev_timer, based
258	on true relative time) and absolute (ev_periodic, based on wallclock time)	292	on true relative time) and absolute (ev_periodic, based on wallclock time)
259	timers.	293	timers.
260		294
261	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
262	AnyEvent API.	296	AnyEvent API.
…		…
284	I<In almost all cases (in all cases if you don't care), this is the	318	I<In almost all cases (in all cases if you don't care), this is the
285	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
286		320
287	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
288	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
289	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
290		324
291	The rest of this section is only of relevance if you try to be very exact	325	The rest of this section is only of relevance if you try to be very exact
292	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
293		327
294	For a practical example of when these times differ, consider L<Event::Lib>	328	For a practical example of when these times differ, consider L<Event::Lib>
295	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
296		330
297	The event loop is running and has just invoked one of your callback at	331	The event loop is running and has just invoked one of your callbacks at
298	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
299	you wait a second by executing C<sleep 1> (blocking the process for a	333	you wait a second by executing C<sleep 1> (blocking the process for a
300	second) and then (at time=501) you create a relative timer that fires	334	second) and then (at time=501) you create a relative timer that fires
301	after three seconds.	335	after three seconds.
302		336
…		…
320	In either case, if you care (and in most cases, you don't), then you	354	In either case, if you care (and in most cases, you don't), then you
321	can get whatever behaviour you want with any event loop, by taking the	355	can get whatever behaviour you want with any event loop, by taking the
322	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
323	account.	357	account.
324		358
		359	=item AnyEvent->now_update
		360
		361	Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
		362	time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
		363	above).
		364
		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
		367	might affect timers and time-outs.
		368
		369	When this is the case, you can call this method, which will update the
		370	event loop's idea of "current time".
		371
		372	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		373	when mod_perl executes the script, then the event loop will have the wrong
		374	idea about the "current time" (being potentially far in the past, when the
		375	script ran the last time). In that case you should arrange a call to C<<
		376	AnyEvent->now_update >> each time the web server process wakes up again
		377	(e.g. at the start of your script, or in a handler).
		378
		379	Note that updating the time I<might> cause some events to be handled.
		380
325	=back	381	=back
326		382
327	=head2 SIGNAL WATCHERS	383	=head2 SIGNAL WATCHERS
		384
		385	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
328		386
329	You can watch for signals using a signal watcher, C<signal> is the signal	387	You can watch for signals using a signal watcher, C<signal> is the signal
330	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	388	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
331	callback to be invoked whenever a signal occurs.	389	callback to be invoked whenever a signal occurs.
332		390
…		…
338	invocation, and callback invocation will be synchronous. Synchronous means	396	invocation, and callback invocation will be synchronous. Synchronous means
339	that it might take a while until the signal gets handled by the process,	397	that it might take a while until the signal gets handled by the process,
340	but it is guaranteed not to interrupt any other callbacks.	398	but it is guaranteed not to interrupt any other callbacks.
341		399
342	The main advantage of using these watchers is that you can share a signal	400	The main advantage of using these watchers is that you can share a signal
343	between multiple watchers.	401	between multiple watchers, and AnyEvent will ensure that signals will not
		402	interrupt your program at bad times.
344		403
345	This watcher might use C<%SIG>, so programs overwriting those signals	404	This watcher might use C<%SIG> (depending on the event loop used),
346	directly will likely not work correctly.	405	so programs overwriting those signals directly will likely not work
		406	correctly.
347		407
348	Example: exit on SIGINT	408	Example: exit on SIGINT
349		409
350	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	410	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
351		411
		412	=head3 Restart Behaviour
		413
		414	While restart behaviour is up to the event loop implementation, most will
		415	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		416	pure perl implementation).
		417
		418	=head3 Safe/Unsafe Signals
		419
		420	Perl signals can be either "safe" (synchronous to opcode handling)
		421	or "unsafe" (asynchronous) - the former might delay signal delivery
		422	indefinitely, the latter might corrupt your memory.
		423
		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
		426	called as part of the normal event handling (just like timer, I/O etc.
		427	callbacks, too).
		428
		429	=head3 Signal Races, Delays and Workarounds
		430
		431	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support
		432	attaching callbacks to signals in a generic way, which is a pity,
		433	as you cannot do race-free signal handling in perl, requiring
		434	C libraries for this. AnyEvent will try to do its best, which
		435	means in some cases, signals will be delayed. The maximum time
		436	a signal might be delayed is 10 seconds by default, but can
		437	be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
		438	C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
		439	section for details.
		440
		441	All these problems can be avoided by installing the optional
		442	L<Async::Interrupt> module, which works with most event loops. It will not
		443	work with inherently broken event loops such as L<Event> or L<Event::Lib>
		444	(and not with L<POE> currently). For those, you just have to suffer the
		445	delays.
		446
352	=head2 CHILD PROCESS WATCHERS	447	=head2 CHILD PROCESS WATCHERS
353		448
		449	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		450
354	You can also watch on a child process exit and catch its exit status.	451	You can also watch for a child process exit and catch its exit status.
355		452
356	The child process is specified by the C<pid> argument (if set to C<0>, it	453	The child process is specified by the C<pid> argument (on some backends,
357	watches for any child process exit). The watcher will triggered only when	454	using C<0> watches for any child process exit, on others this will
358	the child process has finished and an exit status is available, not on	455	croak). The watcher will be triggered only when the child process has
359	any trace events (stopped/continued).	456	finished and an exit status is available, not on any trace events
		457	(stopped/continued).
360		458
361	The callback will be called with the pid and exit status (as returned by	459	The callback will be called with the pid and exit status (as returned by
362	waitpid), so unlike other watcher types, you I<can> rely on child watcher	460	waitpid), so unlike other watcher types, you I<can> rely on child watcher
363	callback arguments.	461	callback arguments.
364		462
…		…
369		467
370	There is a slight catch to child watchers, however: you usually start them	468	There is a slight catch to child watchers, however: you usually start them
371	I<after> the child process was created, and this means the process could	469	I<after> the child process was created, and this means the process could
372	have exited already (and no SIGCHLD will be sent anymore).	470	have exited already (and no SIGCHLD will be sent anymore).
373		471
374	Not all event models handle this correctly (POE doesn't), but even for	472	Not all event models handle this correctly (neither POE nor IO::Async do,
		473	see their AnyEvent::Impl manpages for details), but even for event models
375	event models that I<do> handle this correctly, they usually need to be	474	that I<do> handle this correctly, they usually need to be loaded before
376	loaded before the process exits (i.e. before you fork in the first place).	475	the process exits (i.e. before you fork in the first place). AnyEvent's
		476	pure perl event loop handles all cases correctly regardless of when you
		477	start the watcher.
377		478
378	This means you cannot create a child watcher as the very first thing in an	479	This means you cannot create a child watcher as the very first
379	AnyEvent program, you I<have> to create at least one watcher before you	480	thing in an AnyEvent program, you I<have> to create at least one
380	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	481	watcher before you C<fork> the child (alternatively, you can call
		482	C<AnyEvent::detect>).
		483
		484	As most event loops do not support waiting for child events, they will be
		485	emulated by AnyEvent in most cases, in which case the latency and race
		486	problems mentioned in the description of signal watchers apply.
381		487
382	Example: fork a process and wait for it	488	Example: fork a process and wait for it
383		489
384	my $done = AnyEvent->condvar;	490	my $done = AnyEvent->condvar;
385		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.
386	my $pid = fork or exit 5;	496	my $pid = fork or exit 5;
387		497
388	my $w = AnyEvent->child (	498	my $w = AnyEvent->child (
389	pid => $pid,	499	pid => $pid,
390	cb => sub {	500	cb => sub {
…		…
395	);	505	);
396		506
397	# do something else, then wait for process exit	507	# do something else, then wait for process exit
398	$done->recv;	508	$done->recv;
399		509
		510	=head2 IDLE WATCHERS
		511
		512	$w = AnyEvent->idle (cb => <callback>);
		513
		514	This will repeatedly invoke the callback after the process becomes idle,
		515	until either the watcher is destroyed or new events have been detected.
		516
		517	Idle watchers are useful when there is a need to do something, but it
		518	is not so important (or wise) to do it instantly. The callback will be
		519	invoked only when there is "nothing better to do", which is usually
		520	defined as "all outstanding events have been handled and no new events
		521	have been detected". That means that idle watchers ideally get invoked
		522	when the event loop has just polled for new events but none have been
		523	detected. Instead of blocking to wait for more events, the idle watchers
		524	will be invoked.
		525
		526	Unfortunately, most event loops do not really support idle watchers (only
		527	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		528	will simply call the callback "from time to time".
		529
		530	Example: read lines from STDIN, but only process them when the
		531	program is otherwise idle:
		532
		533	my @lines; # read data
		534	my $idle_w;
		535	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		536	push @lines, scalar <STDIN>;
		537
		538	# start an idle watcher, if not already done
		539	$idle_w ||= AnyEvent->idle (cb => sub {
		540	# handle only one line, when there are lines left
		541	if (my $line = shift @lines) {
		542	print "handled when idle: $line";
		543	} else {
		544	# otherwise disable the idle watcher again
		545	undef $idle_w;
		546	}
		547	});
		548	});
		549
400	=head2 CONDITION VARIABLES	550	=head2 CONDITION VARIABLES
		551
		552	$cv = AnyEvent->condvar;
		553
		554	$cv->send (<list>);
		555	my @res = $cv->recv;
401		556
402	If you are familiar with some event loops you will know that all of them	557	If you are familiar with some event loops you will know that all of them
403	require you to run some blocking "loop", "run" or similar function that	558	require you to run some blocking "loop", "run" or similar function that
404	will actively watch for new events and call your callbacks.	559	will actively watch for new events and call your callbacks.
405		560
406	AnyEvent is different, it expects somebody else to run the event loop and	561	AnyEvent is slightly different: it expects somebody else to run the event
407	will only block when necessary (usually when told by the user).	562	loop and will only block when necessary (usually when told by the user).
408		563
409	The instrument to do that is called a "condition variable", so called	564	The tool to do that is called a "condition variable", so called because
410	because they represent a condition that must become true.	565	they represent a condition that must become true.
		566
		567	Now is probably a good time to look at the examples further below.
411		568
412	Condition variables can be created by calling the C<< AnyEvent->condvar	569	Condition variables can be created by calling the C<< AnyEvent->condvar
413	>> method, usually without arguments. The only argument pair allowed is	570	>> method, usually without arguments. The only argument pair allowed is
414
415	C<cb>, which specifies a callback to be called when the condition variable	571	C<cb>, which specifies a callback to be called when the condition variable
416	becomes true, with the condition variable as the first argument (but not	572	becomes true, with the condition variable as the first argument (but not
417	the results).	573	the results).
418		574
419	After creation, the condition variable is "false" until it becomes "true"	575	After creation, the condition variable is "false" until it becomes "true"
420	by calling the C<send> method (or calling the condition variable as if it	576	by calling the C<send> method (or calling the condition variable as if it
421	were a callback, read about the caveats in the description for the C<<	577	were a callback, read about the caveats in the description for the C<<
422	->send >> method).	578	->send >> method).
423		579
424	Condition variables are similar to callbacks, except that you can	580	Since condition variables are the most complex part of the AnyEvent API, here are
425	optionally wait for them. They can also be called merge points - points	581	some different mental models of what they are - pick the ones you can connect to:
426	in time where multiple outstanding events have been processed. And yet	582
427	another way to call them is transactions - each condition variable can be	583	=over 4
428	used to represent a transaction, which finishes at some point and delivers	584
429	a result.	585	=item * Condition variables are like callbacks - you can call them (and pass them instead
		586	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		587
		588	=item * Condition variables are signals - one side can emit or send them,
		589	the other side can wait for them, or install a handler that is called when
		590	the signal fires.
		591
		592	=item * Condition variables are like "Merge Points" - points in your program
		593	where you merge multiple independent results/control flows into one.
		594
		595	=item * Condition variables represent a transaction - functions that start
		596	some kind of transaction can return them, leaving the caller the choice
		597	between waiting in a blocking fashion, or setting a callback.
		598
		599	=item * Condition variables represent future values, or promises to deliver
		600	some result, long before the result is available.
		601
		602	=back
430		603
431	Condition variables are very useful to signal that something has finished,	604	Condition variables are very useful to signal that something has finished,
432	for example, if you write a module that does asynchronous http requests,	605	for example, if you write a module that does asynchronous http requests,
433	then a condition variable would be the ideal candidate to signal the	606	then a condition variable would be the ideal candidate to signal the
434	availability of results. The user can either act when the callback is	607	availability of results. The user can either act when the callback is
…		…
447		620
448	Condition variables are represented by hash refs in perl, and the keys	621	Condition variables are represented by hash refs in perl, and the keys
449	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing	622	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
450	easy (it is often useful to build your own transaction class on top of	623	easy (it is often useful to build your own transaction class on top of
451	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call	624	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
452	it's C<new> method in your own C<new> method.	625	its C<new> method in your own C<new> method.
453		626
454	There are two "sides" to a condition variable - the "producer side" which	627	There are two "sides" to a condition variable - the "producer side" which
455	eventually calls C<< -> send >>, and the "consumer side", which waits	628	eventually calls C<< -> send >>, and the "consumer side", which waits
456	for the send to occur.	629	for the send to occur.
457		630
458	Example: wait for a timer.	631	Example: wait for a timer.
459		632
460	# wait till the result is ready	633	# condition: "wait till the timer is fired"
461	my $result_ready = AnyEvent->condvar;	634	my $timer_fired = AnyEvent->condvar;
462		635
463	# do something such as adding a timer	636	# create the timer - we could wait for, say
464	# or socket watcher the calls $result_ready->send	637	# a handle becomign ready, or even an
465	# when the "result" is ready.	638	# AnyEvent::HTTP request to finish, but
466	# in this case, we simply use a timer:	639	# in this case, we simply use a timer:
467	my $w = AnyEvent->timer (	640	my $w = AnyEvent->timer (
468	after => 1,	641	after => 1,
469	cb => sub { $result_ready->send },	642	cb => sub { $timer_fired->send },
470	);	643	);
471		644
472	# this "blocks" (while handling events) till the callback	645	# this "blocks" (while handling events) till the callback
473	# calls send	646	# calls ->send
474	$result_ready->recv;	647	$timer_fired->recv;
475		648
476	Example: wait for a timer, but take advantage of the fact that	649	Example: wait for a timer, but take advantage of the fact that condition
477	condition variables are also code references.	650	variables are also callable directly.
478		651
479	my $done = AnyEvent->condvar;	652	my $done = AnyEvent->condvar;
480	my $delay = AnyEvent->timer (after => 5, cb => $done);	653	my $delay = AnyEvent->timer (after => 5, cb => $done);
481	$done->recv;	654	$done->recv;
482		655
…		…
488		661
489	...	662	...
490		663
491	my @info = $couchdb->info->recv;	664	my @info = $couchdb->info->recv;
492		665
493	And this is how you would just ste a callback to be called whenever the	666	And this is how you would just set a callback to be called whenever the
494	results are available:	667	results are available:
495		668
496	$couchdb->info->cb (sub {	669	$couchdb->info->cb (sub {
497	my @info = $_[0]->recv;	670	my @info = $_[0]->recv;
498	});	671	});
…		…
516	immediately from within send.	689	immediately from within send.
517		690
518	Any arguments passed to the C<send> call will be returned by all	691	Any arguments passed to the C<send> call will be returned by all
519	future C<< ->recv >> calls.	692	future C<< ->recv >> calls.
520		693
521	Condition variables are overloaded so one can call them directly	694	Condition variables are overloaded so one can call them directly (as if
522	(as a code reference). Calling them directly is the same as calling	695	they were a code reference). Calling them directly is the same as calling
523	C<send>. Note, however, that many C-based event loops do not handle	696	C<send>.
524	overloading, so as tempting as it may be, passing a condition variable
525	instead of a callback does not work. Both the pure perl and EV loops
526	support overloading, however, as well as all functions that use perl to
527	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
528	example).
529		697
530	=item $cv->croak ($error)	698	=item $cv->croak ($error)
531		699
532	Similar to send, but causes all call's to C<< ->recv >> to invoke	700	Similar to send, but causes all calls to C<< ->recv >> to invoke
533	C<Carp::croak> with the given error message/object/scalar.	701	C<Carp::croak> with the given error message/object/scalar.
534		702
535	This can be used to signal any errors to the condition variable	703	This can be used to signal any errors to the condition variable
536	user/consumer.	704	user/consumer. Doing it this way instead of calling C<croak> directly
		705	delays the error detection, but has the overwhelming advantage that it
		706	diagnoses the error at the place where the result is expected, and not
		707	deep in some event callback with no connection to the actual code causing
		708	the problem.
537		709
538	=item $cv->begin ([group callback])	710	=item $cv->begin ([group callback])
539		711
540	=item $cv->end	712	=item $cv->end
541
542	These two methods are EXPERIMENTAL and MIGHT CHANGE.
543		713
544	These two methods can be used to combine many transactions/events into	714	These two methods can be used to combine many transactions/events into
545	one. For example, a function that pings many hosts in parallel might want	715	one. For example, a function that pings many hosts in parallel might want
546	to use a condition variable for the whole process.	716	to use a condition variable for the whole process.
547		717
548	Every call to C<< ->begin >> will increment a counter, and every call to	718	Every call to C<< ->begin >> will increment a counter, and every call to
549	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	719	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
550	>>, the (last) callback passed to C<begin> will be executed. That callback	720	>>, the (last) callback passed to C<begin> will be executed, passing the
551	is I<supposed> to call C<< ->send >>, but that is not required. If no	721	condvar as first argument. That callback is I<supposed> to call C<< ->send
552	callback was set, C<send> will be called without any arguments.	722	>>, but that is not required. If no group callback was set, C<send> will
		723	be called without any arguments.
553		724
554	Let's clarify this with the ping example:	725	You can think of C<< $cv->send >> giving you an OR condition (one call
		726	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
		727	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
		728
		729	Let's start with a simple example: you have two I/O watchers (for example,
		730	STDOUT and STDERR for a program), and you want to wait for both streams to
		731	close before activating a condvar:
555		732
556	my $cv = AnyEvent->condvar;	733	my $cv = AnyEvent->condvar;
557		734
		735	$cv->begin; # first watcher
		736	my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
		737	defined sysread $fh1, my $buf, 4096
		738	or $cv->end;
		739	});
		740
		741	$cv->begin; # second watcher
		742	my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
		743	defined sysread $fh2, my $buf, 4096
		744	or $cv->end;
		745	});
		746
		747	$cv->recv;
		748
		749	This works because for every event source (EOF on file handle), there is
		750	one call to C<begin>, so the condvar waits for all calls to C<end> before
		751	sending.
		752
		753	The ping example mentioned above is slightly more complicated, as the
		754	there are results to be passed back, and the number of tasks that are
		755	begun can potentially be zero:
		756
		757	my $cv = AnyEvent->condvar;
		758
558	my %result;	759	my %result;
559	$cv->begin (sub { $cv->send (\%result) });	760	$cv->begin (sub { shift->send (\%result) });
560		761
561	for my $host (@list_of_hosts) {	762	for my $host (@list_of_hosts) {
562	$cv->begin;	763	$cv->begin;
563	ping_host_then_call_callback $host, sub {	764	ping_host_then_call_callback $host, sub {
564	$result{$host} = ...;	765	$result{$host} = ...;
…		…
566	};	767	};
567	}	768	}
568		769
569	$cv->end;	770	$cv->end;
570		771
		772	...
		773
		774	my $results = $cv->recv;
		775
571	This code fragment supposedly pings a number of hosts and calls	776	This code fragment supposedly pings a number of hosts and calls
572	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
573	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
574	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
575	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
…		…
579	loop, which serves two important purposes: first, it sets the callback	784	loop, which serves two important purposes: first, it sets the callback
580	to be called once the counter reaches C<0>, and second, it ensures that	785	to be called once the counter reaches C<0>, and second, it ensures that
581	C<send> is called even when C<no> hosts are being pinged (the loop	786	C<send> is called even when C<no> hosts are being pinged (the loop
582	doesn't execute once).	787	doesn't execute once).
583		788
584	This is the general pattern when you "fan out" into multiple subrequests:	789	This is the general pattern when you "fan out" into multiple (but
585	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	790	potentially zero) subrequests: use an outer C<begin>/C<end> pair to set
586	is called at least once, and then, for each subrequest you start, call	791	the callback and ensure C<end> is called at least once, and then, for each
587	C<begin> and for each subrequest you finish, call C<end>.	792	subrequest you start, call C<begin> and for each subrequest you finish,
		793	call C<end>.
588		794
589	=back	795	=back
590		796
591	=head3 METHODS FOR CONSUMERS	797	=head3 METHODS FOR CONSUMERS
592		798
…		…
596	=over 4	802	=over 4
597		803
598	=item $cv->recv	804	=item $cv->recv
599		805
600	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	806	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
601	>> methods have been called on c<$cv>, while servicing other watchers	807	>> methods have been called on C<$cv>, while servicing other watchers
602	normally.	808	normally.
603		809
604	You can only wait once on a condition - additional calls are valid but	810	You can only wait once on a condition - additional calls are valid but
605	will return immediately.	811	will return immediately.
606		812
…		…
608	function will call C<croak>.	814	function will call C<croak>.
609		815
610	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,
611	in scalar context only the first one will be returned.	817	in scalar context only the first one will be returned.
612		818
		819	Note that doing a blocking wait in a callback is not supported by any
		820	event loop, that is, recursive invocation of a blocking C<< ->recv >> is
		821	not allowed and the C<recv> call will C<croak> if such a condition is
		822	detected. This requirement can be dropped by relying on L<Coro::AnyEvent>
		823	, which allows you to do a blocking C<< ->recv >> from any thread
		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.
		829
613	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
614	(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
615	using this from a module, never require a blocking wait>, but let the	832	using this from a module, never require a blocking wait>. Instead, let the
616	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
617	condition variables with some kind of request results and supporting	834	condition variables with some kind of request results and supporting
618	callbacks so the caller knows that getting the result will not block,	835	callbacks so the caller knows that getting the result will not block,
619	while still supporting blocking waits if the caller so desires).	836	while still supporting blocking waits if the caller so desires).
620		837
621	Another reason I<never> to C<< ->recv >> in a module is that you cannot
622	sensibly have two C<< ->recv >>'s in parallel, as that would require
623	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
624	can supply.
625
626	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
627	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
628	versions and also integrates coroutines into AnyEvent, making blocking
629	C<< ->recv >> calls perfectly safe as long as they are done from another
630	coroutine (one that doesn't run the event loop).
631
632	You can ensure that C<< -recv >> never blocks by setting a callback and	838	You can ensure that C<< ->recv >> never blocks by setting a callback and
633	only calling C<< ->recv >> from within that callback (or at a later	839	only calling C<< ->recv >> from within that callback (or at a later
634	time). This will work even when the event loop does not support blocking	840	time). This will work even when the event loop does not support blocking
635	waits otherwise.	841	waits otherwise.
636		842
637	=item $bool = $cv->ready	843	=item $bool = $cv->ready
…		…
643		849
644	This is a mutator function that returns the callback set and optionally	850	This is a mutator function that returns the callback set and optionally
645	replaces it before doing so.	851	replaces it before doing so.
646		852
647	The callback will be called when the condition becomes "true", i.e. when	853	The callback will be called when the condition becomes "true", i.e. when
648	C<send> or C<croak> are called, with the only argument being the condition	854	C<send> or C<croak> are called, with the only argument being the
649	variable itself. Calling C<recv> inside the callback or at any later time	855	condition variable itself. If the condition is already true, the
650	is guaranteed not to block.	856	callback is called immediately when it is set. Calling C<recv> inside
		857	the callback or at any later time is guaranteed not to block.
651		858
652	=back	859	=back
653		860
		861	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		862
		863	The available backend classes are (every class has its own manpage):
		864
		865	=over 4
		866
		867	=item Backends that are autoprobed when no other event loop can be found.
		868
		869	EV is the preferred backend when no other event loop seems to be in
		870	use. If EV is not installed, then AnyEvent will fall back to its own
		871	pure-perl implementation, which is available everywhere as it comes with
		872	AnyEvent itself.
		873
		874	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		875	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
		876
		877	=item Backends that are transparently being picked up when they are used.
		878
		879	These will be used if they are already loaded when the first watcher
		880	is created, in which case it is assumed that the application is using
		881	them. This means that AnyEvent will automatically pick the right backend
		882	when the main program loads an event module before anything starts to
		883	create watchers. Nothing special needs to be done by the main program.
		884
		885	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		886	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		887	AnyEvent::Impl::Tk based on Tk, very broken.
		888	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		889	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		890	AnyEvent::Impl::Irssi used when running within irssi.
		891	AnyEvent::Impl::IOAsync based on IO::Async.
		892	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		893	AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
		894
		895	=item Backends with special needs.
		896
		897	Qt requires the Qt::Application to be instantiated first, but will
		898	otherwise be picked up automatically. As long as the main program
		899	instantiates the application before any AnyEvent watchers are created,
		900	everything should just work.
		901
		902	AnyEvent::Impl::Qt based on Qt.
		903
		904	=item Event loops that are indirectly supported via other backends.
		905
		906	Some event loops can be supported via other modules:
		907
		908	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		909
		910	B<WxWidgets> has no support for watching file handles. However, you can
		911	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		912	polls 20 times per second, which was considered to be too horrible to even
		913	consider for AnyEvent.
		914
		915	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		916	backend, so it can be supported through POE.
		917
		918	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		919	load L<POE> when detecting them, in the hope that POE will pick them up,
		920	in which case everything will be automatic.
		921
		922	=back
		923
654	=head1 GLOBAL VARIABLES AND FUNCTIONS	924	=head1 GLOBAL VARIABLES AND FUNCTIONS
655		925
		926	These are not normally required to use AnyEvent, but can be useful to
		927	write AnyEvent extension modules.
		928
656	=over 4	929	=over 4
657		930
658	=item $AnyEvent::MODEL	931	=item $AnyEvent::MODEL
659		932
660	Contains C<undef> until the first watcher is being created. Then it	933	Contains C<undef> until the first watcher is being created, before the
		934	backend has been autodetected.
		935
661	contains the event model that is being used, which is the name of the	936	Afterwards it contains the event model that is being used, which is the
662	Perl class implementing the model. This class is usually one of the	937	name of the Perl class implementing the model. This class is usually one
663	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	938	of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
664	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	939	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
665		940	will be C<urxvt::anyevent>).
666	The known classes so far are:
667
668	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
669	AnyEvent::Impl::Event based on Event, second best choice.
670	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
671	AnyEvent::Impl::Glib based on Glib, third-best choice.
672	AnyEvent::Impl::Tk based on Tk, very bad choice.
673	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
674	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
675	AnyEvent::Impl::POE based on POE, not generic enough for full support.
676
677	There is no support for WxWidgets, as WxWidgets has no support for
678	watching file handles. However, you can use WxWidgets through the
679	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
680	second, which was considered to be too horrible to even consider for
681	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
682	it's adaptor.
683
684	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
685	autodetecting them.
686		941
687	=item AnyEvent::detect	942	=item AnyEvent::detect
688		943
689	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	944	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
690	if necessary. You should only call this function right before you would	945	if necessary. You should only call this function right before you would
691	have created an AnyEvent watcher anyway, that is, as late as possible at	946	have created an AnyEvent watcher anyway, that is, as late as possible at
692	runtime.	947	runtime, and not e.g. during initialisation of your module.
		948
		949	The effect of calling this function is as if a watcher had been created
		950	(specifically, actions that happen "when the first watcher is created"
		951	happen when calling detetc as well).
		952
		953	If you need to do some initialisation before AnyEvent watchers are
		954	created, use C<post_detect>.
693		955
694	=item $guard = AnyEvent::post_detect { BLOCK }	956	=item $guard = AnyEvent::post_detect { BLOCK }
695		957
696	Arranges for the code block to be executed as soon as the event model is	958	Arranges for the code block to be executed as soon as the event model is
697	autodetected (or immediately if this has already happened).	959	autodetected (or immediately if that has already happened).
		960
		961	The block will be executed I<after> the actual backend has been detected
		962	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		963	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		964	other initialisations - see the sources of L<AnyEvent::Strict> or
		965	L<AnyEvent::AIO> to see how this is used.
		966
		967	The most common usage is to create some global watchers, without forcing
		968	event module detection too early, for example, L<AnyEvent::AIO> creates
		969	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		970	avoid autodetecting the event module at load time.
698		971
699	If called in scalar or list context, then it creates and returns an object	972	If called in scalar or list context, then it creates and returns an object
700	that automatically removes the callback again when it is destroyed. See	973	that automatically removes the callback again when it is destroyed (or
		974	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
701	L<Coro::BDB> for a case where this is useful.	975	a case where this is useful.
		976
		977	Example: Create a watcher for the IO::AIO module and store it in
		978	C<$WATCHER>, but do so only do so after the event loop is initialised.
		979
		980	our WATCHER;
		981
		982	my $guard = AnyEvent::post_detect {
		983	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		984	};
		985
		986	# the ||= is important in case post_detect immediately runs the block,
		987	# as to not clobber the newly-created watcher. assigning both watcher and
		988	# post_detect guard to the same variable has the advantage of users being
		989	# able to just C<undef $WATCHER> if the watcher causes them grief.
		990
		991	$WATCHER ||= $guard;
702		992
703	=item @AnyEvent::post_detect	993	=item @AnyEvent::post_detect
704		994
705	If there are any code references in this array (you can C<push> to it	995	If there are any code references in this array (you can C<push> to it
706	before or after loading AnyEvent), then they will called directly after	996	before or after loading AnyEvent), then they will be called directly
707	the event loop has been chosen.	997	after the event loop has been chosen.
708		998
709	You should check C<$AnyEvent::MODEL> before adding to this array, though:	999	You should check C<$AnyEvent::MODEL> before adding to this array, though:
710	if it contains a true value then the event loop has already been detected,	1000	if it is defined then the event loop has already been detected, and the
711	and the array will be ignored.	1001	array will be ignored.
712		1002
713	Best use C<AnyEvent::post_detect { BLOCK }> instead.	1003	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		1004	it, as it takes care of these details.
		1005
		1006	This variable is mainly useful for modules that can do something useful
		1007	when AnyEvent is used and thus want to know when it is initialised, but do
		1008	not need to even load it by default. This array provides the means to hook
		1009	into AnyEvent passively, without loading it.
		1010
		1011	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1012	together, you could put this into Coro (this is the actual code used by
		1013	Coro to accomplish this):
		1014
		1015	if (defined $AnyEvent::MODEL) {
		1016	# AnyEvent already initialised, so load Coro::AnyEvent
		1017	require Coro::AnyEvent;
		1018	} else {
		1019	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1020	# as soon as it is
		1021	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1022	}
		1023
		1024	=item AnyEvent::postpone { BLOCK }
		1025
		1026	Arranges for the block to be executed as soon as possible, but not before
		1027	the call itself returns. In practise, the block will be executed just
		1028	before the event loop polls for new events, or shortly afterwards.
		1029
		1030	This function never returns anything (to make the C<return postpone { ...
		1031	}> idiom more useful.
		1032
		1033	To understand the usefulness of this function, consider a function that
		1034	asynchronously does something for you and returns some transaction
		1035	object or guard to let you cancel the operation. For example,
		1036	C<AnyEvent::Socket::tcp_connect>:
		1037
		1038	# start a conenction attempt unless one is active
		1039	$self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1040	delete $self->{connect_guard};
		1041	...
		1042	};
		1043
		1044	Imagine that this function could instantly call the callback, for
		1045	example, because it detects an obvious error such as a negative port
		1046	number. Invoking the callback before the function returns causes problems
		1047	however: the callback will be called and will try to delete the guard
		1048	object. But since the function hasn't returned yet, there is nothing to
		1049	delete. When the function eventually returns it will assign the guard
		1050	object to C<< $self->{connect_guard} >>, where it will likely never be
		1051	deleted, so the program thinks it is still trying to connect.
		1052
		1053	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1054	callback directly on error:
		1055
		1056	$cb->(undef), return # signal error to callback, BAD!
		1057	if $some_error_condition;
		1058
		1059	It should use C<postpone>:
		1060
		1061	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1062	if $some_error_condition;
		1063
		1064	=item AnyEvent::log $level, $msg[, @args]
		1065
		1066	Log the given C<$msg> at the given C<$level>.
		1067
		1068	If L<AnyEvent::Log> is not loaded then this function makes a simple test
		1069	to see whether the message will be logged. If the test succeeds it will
		1070	load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
		1071	the L<AnyEvent::Log> documentation for details.
		1072
		1073	If the test fails it will simply return. Right now this happens when a
		1074	numerical loglevel is used and it is larger than the level specified via
		1075	C<$ENV{PERL_ANYEVENT_VERBOSE}>.
		1076
		1077	If you want to sprinkle loads of logging calls around your code, consider
		1078	creating a logger callback with the C<AnyEvent::Log::logger> function,
		1079	which can reduce typing, codesize and can reduce the logging overhead
		1080	enourmously.
714		1081
715	=back	1082	=back
716		1083
717	=head1 WHAT TO DO IN A MODULE	1084	=head1 WHAT TO DO IN A MODULE
718		1085
…		…
729	because it will stall the whole program, and the whole point of using	1096	because it will stall the whole program, and the whole point of using
730	events is to stay interactive.	1097	events is to stay interactive.
731		1098
732	It is fine, however, to call C<< ->recv >> when the user of your module	1099	It is fine, however, to call C<< ->recv >> when the user of your module
733	requests it (i.e. if you create a http request object ad have a method	1100	requests it (i.e. if you create a http request object ad have a method
734	called C<results> that returns the results, it should call C<< ->recv >>	1101	called C<results> that returns the results, it may call C<< ->recv >>
735	freely, as the user of your module knows what she is doing. always).	1102	freely, as the user of your module knows what she is doing. Always).
736		1103
737	=head1 WHAT TO DO IN THE MAIN PROGRAM	1104	=head1 WHAT TO DO IN THE MAIN PROGRAM
738		1105
739	There will always be a single main program - the only place that should	1106	There will always be a single main program - the only place that should
740	dictate which event model to use.	1107	dictate which event model to use.
741		1108
742	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1109	If the program is not event-based, it need not do anything special, even
743	do anything special (it does not need to be event-based) and let AnyEvent	1110	when it depends on a module that uses an AnyEvent. If the program itself
744	decide which implementation to chose if some module relies on it.	1111	uses AnyEvent, but does not care which event loop is used, all it needs
		1112	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1113	available loop implementation.
745		1114
746	If the main program relies on a specific event model - for example, in	1115	If the main program relies on a specific event model - for example, in
747	Gtk2 programs you have to rely on the Glib module - you should load the	1116	Gtk2 programs you have to rely on the Glib module - you should load the
748	event module before loading AnyEvent or any module that uses it: generally	1117	event module before loading AnyEvent or any module that uses it: generally
749	speaking, you should load it as early as possible. The reason is that	1118	speaking, you should load it as early as possible. The reason is that
750	modules might create watchers when they are loaded, and AnyEvent will	1119	modules might create watchers when they are loaded, and AnyEvent will
751	decide on the event model to use as soon as it creates watchers, and it	1120	decide on the event model to use as soon as it creates watchers, and it
752	might chose the wrong one unless you load the correct one yourself.	1121	might choose the wrong one unless you load the correct one yourself.
753		1122
754	You can chose to use a pure-perl implementation by loading the	1123	You can chose to use a pure-perl implementation by loading the
755	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1124	C<AnyEvent::Loop> module, which gives you similar behaviour
756	everywhere, but letting AnyEvent chose the model is generally better.	1125	everywhere, but letting AnyEvent chose the model is generally better.
757		1126
758	=head2 MAINLOOP EMULATION	1127	=head2 MAINLOOP EMULATION
759		1128
760	Sometimes (often for short test scripts, or even standalone programs who	1129	Sometimes (often for short test scripts, or even standalone programs who
…		…
773		1142
774		1143
775	=head1 OTHER MODULES	1144	=head1 OTHER MODULES
776		1145
777	The following is a non-exhaustive list of additional modules that use	1146	The following is a non-exhaustive list of additional modules that use
778	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1147	AnyEvent as a client and can therefore be mixed easily with other
779	in the same program. Some of the modules come with AnyEvent, some are	1148	AnyEvent modules and other event loops in the same program. Some of the
780	available via CPAN.	1149	modules come as part of AnyEvent, the others are available via CPAN (see
		1150	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1151	a longer non-exhaustive list), and the list is heavily biased towards
		1152	modules of the AnyEvent author himself :)
781		1153
782	=over 4	1154	=over 4
783		1155
784	=item L<AnyEvent::Util>	1156	=item L<AnyEvent::Util> (part of the AnyEvent distribution)
785		1157
786	Contains various utility functions that replace often-used but blocking	1158	Contains various utility functions that replace often-used blocking
787	functions such as C<inet_aton> by event-/callback-based versions.	1159	functions such as C<inet_aton> with event/callback-based versions.
788		1160
789	=item L<AnyEvent::Socket>	1161	=item L<AnyEvent::Socket> (part of the AnyEvent distribution)
790		1162
791	Provides various utility functions for (internet protocol) sockets,	1163	Provides various utility functions for (internet protocol) sockets,
792	addresses and name resolution. Also functions to create non-blocking tcp	1164	addresses and name resolution. Also functions to create non-blocking tcp
793	connections or tcp servers, with IPv6 and SRV record support and more.	1165	connections or tcp servers, with IPv6 and SRV record support and more.
794		1166
795	=item L<AnyEvent::Handle>	1167	=item L<AnyEvent::Handle> (part of the AnyEvent distribution)
796		1168
797	Provide read and write buffers, manages watchers for reads and writes,	1169	Provide read and write buffers, manages watchers for reads and writes,
798	supports raw and formatted I/O, I/O queued and fully transparent and	1170	supports raw and formatted I/O, I/O queued and fully transparent and
799	non-blocking SSL/TLS.	1171	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
800		1172
801	=item L<AnyEvent::DNS>	1173	=item L<AnyEvent::DNS> (part of the AnyEvent distribution)
802		1174
803	Provides rich asynchronous DNS resolver capabilities.	1175	Provides rich asynchronous DNS resolver capabilities.
804		1176
805	=item L<AnyEvent::HTTP>	1177	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
806		1178
807	A simple-to-use HTTP library that is capable of making a lot of concurrent	1179	Implement event-based interfaces to the protocols of the same name (for
808	HTTP requests.	1180	the curious, IGS is the International Go Server and FCP is the Freenet
		1181	Client Protocol).
809		1182
		1183	=item L<AnyEvent::AIO> (part of the AnyEvent distribution)
		1184
		1185	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1186	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1187	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1188	file I/O, and much more.
		1189
		1190	=item L<AnyEvent::Fork>, L<AnyEvent::Fork::RPC>, L<AnyEvent::Fork::Pool>, L<AnyEvent::Fork::Remote>
		1191
		1192	These let you safely fork new subprocesses, either locally or
		1193	remotely (e.g.v ia ssh), using some RPC protocol or not, without
		1194	the limitations normally imposed by fork (AnyEvent works fine for
		1195	example). Dynamically-resized worker pools are obviously included as well.
		1196
		1197	And they are quite tiny and fast as well - "abusing" L<AnyEvent::Fork>
		1198	just to exec external programs can easily beat using C<fork> and C<exec>
		1199	(or even C<system>) in most programs.
		1200
		1201	=item L<AnyEvent::Filesys::Notify>
		1202
		1203	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1204	path changes (e.g. "watch this directory for new files", "watch this
		1205	file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
		1206	do just that in a portbale fashion, supporting inotify on GNU/Linux and
		1207	some weird, without doubt broken, stuff on OS X to monitor files. It can
		1208	fall back to blocking scans at regular intervals transparently on other
		1209	platforms, so it's about as portable as it gets.
		1210
		1211	(I haven't used it myself, but it seems the biggest problem with it is
		1212	it quite bad performance).
		1213
810	=item L<AnyEvent::HTTPD>	1214	=item L<AnyEvent::DBI>
811		1215
812	Provides a simple web application server framework.	1216	Executes L<DBI> requests asynchronously in a proxy process for you,
		1217	notifying you in an event-based way when the operation is finished.
813		1218
814	=item L<AnyEvent::FastPing>	1219	=item L<AnyEvent::FastPing>
815		1220
816	The fastest ping in the west.	1221	The fastest ping in the west.
817		1222
818	=item L<AnyEvent::DBI>
819
820	Executes L<DBI> requests asynchronously in a proxy process.
821
822	=item L<AnyEvent::AIO>
823
824	Truly asynchronous I/O, should be in the toolbox of every event
825	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
826	together.
827
828	=item L<AnyEvent::BDB>
829
830	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
831	L<BDB> and AnyEvent together.
832
833	=item L<AnyEvent::GPSD>
834
835	A non-blocking interface to gpsd, a daemon delivering GPS information.
836
837	=item L<AnyEvent::IGS>
838
839	A non-blocking interface to the Internet Go Server protocol (used by
840	L<App::IGS>).
841
842	=item L<AnyEvent::IRC>
843
844	AnyEvent based IRC client module family (replacing the older Net::IRC3).
845
846	=item L<Net::XMPP2>
847
848	AnyEvent based XMPP (Jabber protocol) module family.
849
850	=item L<Net::FCP>
851
852	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
853	of AnyEvent.
854
855	=item L<Event::ExecFlow>
856
857	High level API for event-based execution flow control.
858
859	=item L<Coro>	1223	=item L<Coro>
860		1224
861	Has special support for AnyEvent via L<Coro::AnyEvent>.	1225	Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
		1226	to simply invert the flow control - don't call us, we will call you:
862		1227
863	=item L<IO::Lambda>	1228	async {
		1229	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1230	print "5 seconds later!\n";
864		1231
865	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.	1232	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1233	my $line = <STDIN>; # works for ttys
		1234
		1235	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1236	my ($body, $hdr) = Coro::rouse_wait;
		1237	};
866		1238
867	=back	1239	=back
868		1240
869	=cut	1241	=cut
870		1242
871	package AnyEvent;	1243	package AnyEvent;
872		1244
873	no warnings;	1245	BEGIN {
874	use strict qw(vars subs);	1246	require "AnyEvent/constants.pl";
		1247	&AnyEvent::common_sense;
		1248	}
875		1249
876	use Carp;	1250	use Carp ();
877		1251
878	our $VERSION = 4.35;	1252	our $VERSION = '7.05';
879	our $MODEL;	1253	our $MODEL;
880
881	our $AUTOLOAD;
882	our @ISA;	1254	our @ISA;
883
884	our @REGISTRY;	1255	our @REGISTRY;
885		1256	our $VERBOSE;
886	our $WIN32;	1257	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
		1258	our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
887		1259
888	BEGIN {	1260	BEGIN {
889	my $win32 = ! ! ($^O =~ /mswin32/i);	1261	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
890	eval "sub WIN32(){ $win32 }";
891	}
892		1262
893	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1263	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1264	if ${^TAINT};
894		1265
895	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1266	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1267	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
896		1268
897	{	1269	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1270	if ${^TAINT};
		1271
		1272	# $ENV{PERL_ANYEVENT_xxx} now valid
		1273
		1274	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
		1275
898	my $idx;	1276	my $idx;
899	$PROTOCOL{$_} = ++$idx	1277	$PROTOCOL{$_} = ++$idx
900	for reverse split /\s*,\s*/,	1278	for reverse split /\s*,\s*/,
901	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1279	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
902	}	1280	}
903		1281
		1282	our @post_detect;
		1283
		1284	sub post_detect(&) {
		1285	my ($cb) = @_;
		1286
		1287	push @post_detect, $cb;
		1288
		1289	defined wantarray
		1290	? bless \$cb, "AnyEvent::Util::postdetect"
		1291	: ()
		1292	}
		1293
		1294	sub AnyEvent::Util::postdetect::DESTROY {
		1295	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1296	}
		1297
		1298	our $POSTPONE_W;
		1299	our @POSTPONE;
		1300
		1301	sub _postpone_exec {
		1302	undef $POSTPONE_W;
		1303
		1304	&{ shift @POSTPONE }
		1305	while @POSTPONE;
		1306	}
		1307
		1308	sub postpone(&) {
		1309	push @POSTPONE, shift;
		1310
		1311	$POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
		1312
		1313	()
		1314	}
		1315
		1316	sub log($$;@) {
		1317	# only load the big bloated module when we actually are about to log something
		1318	if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
		1319	local ($!, $@);
		1320	require AnyEvent::Log; # among other things, sets $VERBOSE to 9
		1321	# AnyEvent::Log overwrites this function
		1322	goto &log;
		1323	}
		1324
		1325	0 # not logged
		1326	}
		1327
		1328	sub _logger($;$) {
		1329	my ($level, $renabled) = @_;
		1330
		1331	$$renabled = $level <= $VERBOSE;
		1332
		1333	my $logger = [(caller)[0], $level, $renabled];
		1334
		1335	$AnyEvent::Log::LOGGER{$logger+0} = $logger;
		1336
		1337	# return unless defined wantarray;
		1338	#
		1339	# require AnyEvent::Util;
		1340	# my $guard = AnyEvent::Util::guard (sub {
		1341	# # "clean up"
		1342	# delete $LOGGER{$logger+0};
		1343	# });
		1344	#
		1345	# sub {
		1346	# return 0 unless $$renabled;
		1347	#
		1348	# $guard if 0; # keep guard alive, but don't cause runtime overhead
		1349	# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
		1350	# package AnyEvent::Log;
		1351	# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
		1352	# }
		1353	}
		1354
		1355	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1356	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1357	}
		1358
904	my @models = (	1359	our @models = (
905	[EV:: => AnyEvent::Impl::EV::],	1360	[EV:: => AnyEvent::Impl::EV::],
906	[Event:: => AnyEvent::Impl::Event::],
907	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1361	[AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
908	# everything below here will not be autoprobed	1362	# everything below here will not (normally) be autoprobed
909	# as the pureperl backend should work everywhere	1363	# as the pure perl backend should work everywhere
910	# and is usually faster	1364	# and is usually faster
		1365	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
		1366	[Event:: => AnyEvent::Impl::Event::], # slow, stable
		1367	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
		1368	# everything below here should not be autoloaded
		1369	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
911	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1370	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
912	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
913	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
914	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1371	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
915	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1372	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
916	[Wx:: => AnyEvent::Impl::POE::],	1373	[Wx:: => AnyEvent::Impl::POE::],
917	[Prima:: => AnyEvent::Impl::POE::],	1374	[Prima:: => AnyEvent::Impl::POE::],
		1375	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
		1376	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
		1377	[FLTK:: => AnyEvent::Impl::FLTK::],
918	);	1378	);
919		1379
920	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);	1380	our @isa_hook;
921		1381
922	our @post_detect;	1382	sub _isa_set {
		1383	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
923		1384
		1385	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1386	for 1 .. $#pkg;
		1387
		1388	grep $_ && $_->[1], @isa_hook
		1389	and AE::_reset ();
		1390	}
		1391
		1392	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1393	sub _isa_hook($$;$) {
		1394	my ($i, $pkg, $reset_ae) = @_;
		1395
		1396	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1397
		1398	_isa_set;
		1399	}
		1400
		1401	# all autoloaded methods reserve the complete glob, not just the method slot.
		1402	# due to bugs in perls method cache implementation.
		1403	our @methods = qw(io timer time now now_update signal child idle condvar);
		1404
924	sub post_detect(&) {	1405	sub detect() {
925	my ($cb) = @_;	1406	return $MODEL if $MODEL; # some programs keep references to detect
926		1407
927	if ($MODEL) {	1408	# IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
928	$cb->();	1409	# the author knows about the problems and what it does to AnyEvent as a whole
		1410	# (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
		1411	# anyway.
		1412	AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n"
		1413	. "design, abuses internals and breaks AnyEvent - will not continue."
		1414	if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
929		1415
930	1	1416	local $!; # for good measure
		1417	local $SIG{__DIE__}; # we use eval
		1418
		1419	# free some memory
		1420	*detect = sub () { $MODEL };
		1421	# undef &func doesn't correctly update the method cache. grmbl.
		1422	# so we delete the whole glob. grmbl.
		1423	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1424	# a glob with an active sub. hrm. i hope it works, but perl is
		1425	# usually buggy in this department. sigh.
		1426	delete @{"AnyEvent::"}{@methods};
		1427	undef @methods;
		1428
		1429	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
		1430	my $model = $1;
		1431	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
		1432	if (eval "require $model") {
		1433	AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
		1434	$MODEL = $model;
931	} else {	1435	} else {
932	push @post_detect, $cb;	1436	AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
933		1437	}
934	defined wantarray
935	? bless \$cb, "AnyEvent::Util::PostDetect"
936	: ()
937	}	1438	}
938	}
939		1439
940	sub AnyEvent::Util::PostDetect::DESTROY {	1440	# check for already loaded models
941	@post_detect = grep $_ != ${$_[0]}, @post_detect;
942	}
943
944	sub detect() {
945	unless ($MODEL) {	1441	unless ($MODEL) {
946	no strict 'refs';	1442	for (@REGISTRY, @models) {
947	local $SIG{__DIE__};	1443	my ($package, $model) = @$_;
948		1444	if (${"$package\::VERSION"} > 0) {
949	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
950	my $model = "AnyEvent::Impl::$1";
951	if (eval "require $model") {	1445	if (eval "require $model") {
		1446	AnyEvent::log 7 => "Autodetected model '$model', using it.";
952	$MODEL = $model;	1447	$MODEL = $model;
953	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1448	last;
954	} else {	1449	} else {
955	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1450	AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@";
		1451	}
956	}	1452	}
957	}	1453	}
958		1454
959	# check for already loaded models
960	unless ($MODEL) {	1455	unless ($MODEL) {
		1456	# try to autoload a model
961	for (@REGISTRY, @models) {	1457	for (@REGISTRY, @models) {
962	my ($package, $model) = @$_;	1458	my ($package, $model) = @$_;
		1459	if (
		1460	eval "require $package"
963	if (${"$package\::VERSION"} > 0) {	1461	and ${"$package\::VERSION"} > 0
964	if (eval "require $model") {	1462	and eval "require $model"
		1463	) {
		1464	AnyEvent::log 7 => "Autoloaded model '$model', using it.";
965	$MODEL = $model;	1465	$MODEL = $model;
966	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;
967	last;	1466	last;
968	}
969	}	1467	}
970	}	1468	}
971		1469
972	unless ($MODEL) {
973	# try to load a model
974
975	for (@REGISTRY, @models) {
976	my ($package, $model) = @$_;
977	if (eval "require $package"
978	and ${"$package\::VERSION"} > 0
979	and eval "require $model") {
980	$MODEL = $model;
981	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
982	last;
983	}
984	}
985
986	$MODEL	1470	$MODEL
987	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1471	or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?";
988	}
989	}	1472	}
990
991	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
992
993	unshift @ISA, $MODEL;
994
995	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
996
997	(shift @post_detect)->() while @post_detect;
998	}	1473	}
999		1474
		1475	# free memory only needed for probing
		1476	undef @models;
		1477	undef @REGISTRY;
		1478
		1479	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1480
		1481	# now nuke some methods that are overridden by the backend.
		1482	# SUPER usage is not allowed in these.
		1483	for (qw(time signal child idle)) {
		1484	undef &{"AnyEvent::Base::$_"}
		1485	if defined &{"$MODEL\::$_"};
		1486	}
		1487
		1488	_isa_set;
		1489
		1490	# we're officially open!
		1491
		1492	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1493	require AnyEvent::Strict;
		1494	}
		1495
		1496	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1497	require AnyEvent::Debug;
		1498	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1499	}
		1500
		1501	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1502	require AnyEvent::Socket;
		1503	require AnyEvent::Debug;
		1504
		1505	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1506	$shell =~ s/\$\$/$$/g;
		1507
		1508	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1509	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1510	}
		1511
		1512	# now the anyevent environment is set up as the user told us to, so
		1513	# call the actual user code - post detects
		1514
		1515	(shift @post_detect)->() while @post_detect;
		1516	undef @post_detect;
		1517
		1518	*post_detect = sub(&) {
		1519	shift->();
		1520
		1521	undef
		1522	};
		1523
1000	$MODEL	1524	$MODEL
1001	}	1525	}
1002		1526
1003	sub AUTOLOAD {	1527	for my $name (@methods) {
1004	(my $func = $AUTOLOAD) =~ s/.*://;	1528	*$name = sub {
1005		1529	detect;
1006	$method{$func}	1530	# we use goto because
1007	or croak "$func: not a valid method for AnyEvent objects";	1531	# a) it makes the thunk more transparent
1008		1532	# b) it allows us to delete the thunk later
1009	detect unless $MODEL;	1533	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1010		1534	};
1011	my $class = shift;
1012	$class->$func (@_);
1013	}	1535	}
1014		1536
1015	# utility function to dup a filehandle. this is used by many backends	1537	# utility function to dup a filehandle. this is used by many backends
1016	# to support binding more than one watcher per filehandle (they usually	1538	# to support binding more than one watcher per filehandle (they usually
1017	# allow only one watcher per fd, so we dup it to get a different one).	1539	# allow only one watcher per fd, so we dup it to get a different one).
1018	sub _dupfh($$$$) {	1540	sub _dupfh($$;$$) {
1019	my ($poll, $fh, $r, $w) = @_;	1541	my ($poll, $fh, $r, $w) = @_;
1020		1542
1021	# cygwin requires the fh mode to be matching, unix doesn't	1543	# cygwin requires the fh mode to be matching, unix doesn't
1022	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1544	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1023	: $poll eq "w" ? ($w, ">")
1024	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1025		1545
1026	open my $fh2, "$mode&" . fileno $fh	1546	open my $fh2, $mode, $fh
1027	or die "cannot dup() filehandle: $!";	1547	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1028		1548
1029	# we assume CLOEXEC is already set by perl in all important cases	1549	# we assume CLOEXEC is already set by perl in all important cases
1030		1550
1031	($fh2, $rw)	1551	($fh2, $rw)
1032	}	1552	}
1033		1553
		1554	=head1 SIMPLIFIED AE API
		1555
		1556	Starting with version 5.0, AnyEvent officially supports a second, much
		1557	simpler, API that is designed to reduce the calling, typing and memory
		1558	overhead by using function call syntax and a fixed number of parameters.
		1559
		1560	See the L<AE> manpage for details.
		1561
		1562	=cut
		1563
		1564	package AE;
		1565
		1566	our $VERSION = $AnyEvent::VERSION;
		1567
		1568	sub _reset() {
		1569	eval q{
		1570	# fall back to the main API by default - backends and AnyEvent::Base
		1571	# implementations can overwrite these.
		1572
		1573	sub io($$$) {
		1574	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1575	}
		1576
		1577	sub timer($$$) {
		1578	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1579	}
		1580
		1581	sub signal($$) {
		1582	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1583	}
		1584
		1585	sub child($$) {
		1586	AnyEvent->child (pid => $_[0], cb => $_[1])
		1587	}
		1588
		1589	sub idle($) {
		1590	AnyEvent->idle (cb => $_[0]);
		1591	}
		1592
		1593	sub cv(;&) {
		1594	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1595	}
		1596
		1597	sub now() {
		1598	AnyEvent->now
		1599	}
		1600
		1601	sub now_update() {
		1602	AnyEvent->now_update
		1603	}
		1604
		1605	sub time() {
		1606	AnyEvent->time
		1607	}
		1608
		1609	*postpone = \&AnyEvent::postpone;
		1610	*log = \&AnyEvent::log;
		1611	};
		1612	die if $@;
		1613	}
		1614
		1615	BEGIN { _reset }
		1616
1034	package AnyEvent::Base;	1617	package AnyEvent::Base;
1035		1618
1036	# default implementation for now and time	1619	# default implementations for many methods
1037		1620
1038	BEGIN {	1621	sub time {
		1622	eval q{ # poor man's autoloading {}
		1623	# probe for availability of Time::HiRes
1039	if (eval "use Time::HiRes (); time (); 1") {	1624	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1625	*time = sub { Time::HiRes::time () };
1040	*_time = \&Time::HiRes::time;	1626	*AE::time = \& Time::HiRes::time ;
		1627	*now = \&time;
		1628	AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy.";
1041	# if (eval "use POSIX (); (POSIX::times())...	1629	# if (eval "use POSIX (); (POSIX::times())...
1042	} else {	1630	} else {
1043	*_time = sub { time }; # epic fail	1631	*time = sub { CORE::time };
		1632	*AE::time = sub (){ CORE::time };
		1633	*now = \&time;
		1634	AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!";
		1635	}
		1636	};
		1637	die if $@;
		1638
		1639	&time
		1640	}
		1641
		1642	*now = \&time;
		1643	sub now_update { }
		1644
		1645	sub _poll {
		1646	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1647	}
		1648
		1649	# default implementation for ->condvar
		1650	# in fact, the default should not be overwritten
		1651
		1652	sub condvar {
		1653	eval q{ # poor man's autoloading {}
		1654	*condvar = sub {
		1655	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1656	};
		1657
		1658	*AE::cv = sub (;&) {
		1659	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1660	};
		1661	};
		1662	die if $@;
		1663
		1664	&condvar
		1665	}
		1666
		1667	# default implementation for ->signal
		1668
		1669	our $HAVE_ASYNC_INTERRUPT;
		1670
		1671	sub _have_async_interrupt() {
		1672	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1673	&& eval "use Async::Interrupt 1.02 (); 1")
		1674	unless defined $HAVE_ASYNC_INTERRUPT;
		1675
		1676	$HAVE_ASYNC_INTERRUPT
		1677	}
		1678
		1679	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1680	our (%SIG_ASY, %SIG_ASY_W);
		1681	our ($SIG_COUNT, $SIG_TW);
		1682
		1683	# install a dummy wakeup watcher to reduce signal catching latency
		1684	# used by Impls
		1685	sub _sig_add() {
		1686	unless ($SIG_COUNT++) {
		1687	# try to align timer on a full-second boundary, if possible
		1688	my $NOW = AE::now;
		1689
		1690	$SIG_TW = AE::timer
		1691	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1692	$MAX_SIGNAL_LATENCY,
		1693	sub { } # just for the PERL_ASYNC_CHECK
		1694	;
1044	}	1695	}
1045	}	1696	}
1046		1697
1047	sub time { _time }	1698	sub _sig_del {
1048	sub now { _time }	1699	undef $SIG_TW
1049		1700	unless --$SIG_COUNT;
1050	# default implementation for ->condvar
1051
1052	sub condvar {
1053	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
1054	}	1701	}
1055		1702
1056	# default implementation for ->signal	1703	our $_sig_name_init; $_sig_name_init = sub {
		1704	eval q{ # poor man's autoloading {}
		1705	undef $_sig_name_init;
1057		1706
1058	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1707	if (_have_async_interrupt) {
		1708	*sig2num = \&Async::Interrupt::sig2num;
		1709	*sig2name = \&Async::Interrupt::sig2name;
		1710	} else {
		1711	require Config;
1059		1712
1060	sub _signal_exec {	1713	my %signame2num;
1061	sysread $SIGPIPE_R, my $dummy, 4;	1714	@signame2num{ split ' ', $Config::Config{sig_name} }
		1715	= split ' ', $Config::Config{sig_num};
1062		1716
1063	while (%SIG_EV) {	1717	my @signum2name;
1064	for (keys %SIG_EV) {	1718	@signum2name[values %signame2num] = keys %signame2num;
1065	delete $SIG_EV{$_};	1719
1066	$_->() for values %{ $SIG_CB{$_} || {} };	1720	*sig2num = sub($) {
		1721	$_[0] > 0 ? shift : $signame2num{+shift}
		1722	};
		1723	*sig2name = sub ($) {
		1724	$_[0] > 0 ? $signum2name[+shift] : shift
		1725	};
1067	}	1726	}
1068	}	1727	};
1069	}	1728	die if $@;
		1729	};
		1730
		1731	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1732	sub sig2name($) { &$_sig_name_init; &sig2name }
1070		1733
1071	sub signal {	1734	sub signal {
1072	my (undef, %arg) = @_;	1735	eval q{ # poor man's autoloading {}
		1736	# probe for availability of Async::Interrupt
		1737	if (_have_async_interrupt) {
		1738	AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling.";
1073		1739
1074	unless ($SIGPIPE_R) {	1740	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1075	require Fcntl;	1741	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1076		1742
1077	if (AnyEvent::WIN32) {
1078	require AnyEvent::Util;
1079
1080	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1081	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1082	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1083	} else {	1743	} else {
		1744	AnyEvent::log 8 => "Using emulated perl signal handling with latency timer.";
		1745
		1746	if (AnyEvent::WIN32) {
		1747	require AnyEvent::Util;
		1748
		1749	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1750	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1751	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1752	} else {
1084	pipe $SIGPIPE_R, $SIGPIPE_W;	1753	pipe $SIGPIPE_R, $SIGPIPE_W;
1085	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1754	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1086	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1755	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
		1756
		1757	# not strictly required, as $^F is normally 2, but let's make sure...
		1758	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1759	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1760	}
		1761
		1762	$SIGPIPE_R
		1763	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1764
		1765	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1087	}	1766	}
1088		1767
1089	$SIGPIPE_R	1768	*signal = $HAVE_ASYNC_INTERRUPT
1090	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1769	? sub {
		1770	my (undef, %arg) = @_;
1091		1771
1092	# not strictly required, as $^F is normally 2, but let's make sure...	1772	# async::interrupt
1093	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1094	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1095
1096	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1097	}
1098
1099	my $signal = uc $arg{signal}	1773	my $signal = sig2num $arg{signal};
1100	or Carp::croak "required option 'signal' is missing";
1101
1102	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1774	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1775
		1776	$SIG_ASY{$signal} ||= new Async::Interrupt
		1777	cb => sub { undef $SIG_EV{$signal} },
		1778	signal => $signal,
		1779	pipe => [$SIGPIPE_R->filenos],
		1780	pipe_autodrain => 0,
		1781	;
		1782
		1783	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1784	}
		1785	: sub {
		1786	my (undef, %arg) = @_;
		1787
		1788	# pure perl
		1789	my $signal = sig2name $arg{signal};
		1790	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1791
1103	$SIG{$signal} ||= sub {	1792	$SIG{$signal} ||= sub {
1104	local $!;	1793	local $!;
1105	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1794	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1106	undef $SIG_EV{$signal};	1795	undef $SIG_EV{$signal};
		1796	};
		1797
		1798	# can't do signal processing without introducing races in pure perl,
		1799	# so limit the signal latency.
		1800	_sig_add;
		1801
		1802	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1803	}
		1804	;
		1805
		1806	*AnyEvent::Base::signal::DESTROY = sub {
		1807	my ($signal, $cb) = @{$_[0]};
		1808
		1809	_sig_del;
		1810
		1811	delete $SIG_CB{$signal}{$cb};
		1812
		1813	$HAVE_ASYNC_INTERRUPT
		1814	? delete $SIG_ASY{$signal}
		1815	: # delete doesn't work with older perls - they then
		1816	# print weird messages, or just unconditionally exit
		1817	# instead of getting the default action.
		1818	undef $SIG{$signal}
		1819	unless keys %{ $SIG_CB{$signal} };
		1820	};
		1821
		1822	*_signal_exec = sub {
		1823	$HAVE_ASYNC_INTERRUPT
		1824	? $SIGPIPE_R->drain
		1825	: sysread $SIGPIPE_R, (my $dummy), 9;
		1826
		1827	while (%SIG_EV) {
		1828	for (keys %SIG_EV) {
		1829	delete $SIG_EV{$_};
		1830	&$_ for values %{ $SIG_CB{$_} || {} };
		1831	}
		1832	}
		1833	};
1107	};	1834	};
		1835	die if $@;
1108		1836
1109	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1837	&signal
1110	}
1111
1112	sub AnyEvent::Base::Signal::DESTROY {
1113	my ($signal, $cb) = @{$_[0]};
1114
1115	delete $SIG_CB{$signal}{$cb};
1116
1117	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1118	}	1838	}
1119		1839
1120	# default implementation for ->child	1840	# default implementation for ->child
1121		1841
1122	our %PID_CB;	1842	our %PID_CB;
1123	our $CHLD_W;	1843	our $CHLD_W;
1124	our $CHLD_DELAY_W;	1844	our $CHLD_DELAY_W;
1125	our $PID_IDLE;
1126	our $WNOHANG;
1127		1845
1128	sub _child_wait {	1846	# used by many Impl's
1129	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1847	sub _emit_childstatus($$) {
		1848	my (undef, $rpid, $rstatus) = @_;
		1849
		1850	$_->($rpid, $rstatus)
1130	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1851	for values %{ $PID_CB{$rpid} || {} },
1131	(values %{ $PID_CB{0} || {} });	1852	values %{ $PID_CB{0} || {} };
1132	}
1133
1134	undef $PID_IDLE;
1135	}
1136
1137	sub _sigchld {
1138	# make sure we deliver these changes "synchronous" with the event loop.
1139	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1140	undef $CHLD_DELAY_W;
1141	&_child_wait;
1142	});
1143	}	1853	}
1144		1854
1145	sub child {	1855	sub child {
		1856	eval q{ # poor man's autoloading {}
		1857	*_sigchld = sub {
		1858	my $pid;
		1859
		1860	AnyEvent->_emit_childstatus ($pid, $?)
		1861	while ($pid = waitpid -1, WNOHANG) > 0;
		1862	};
		1863
		1864	*child = sub {
1146	my (undef, %arg) = @_;	1865	my (undef, %arg) = @_;
1147		1866
1148	defined (my $pid = $arg{pid} + 0)	1867	my $pid = $arg{pid};
1149	or Carp::croak "required option 'pid' is missing";	1868	my $cb = $arg{cb};
1150		1869
1151	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1870	$PID_CB{$pid}{$cb+0} = $cb;
1152		1871
1153	unless ($WNOHANG) {
1154	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1155	}
1156
1157	unless ($CHLD_W) {	1872	unless ($CHLD_W) {
1158	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1873	$CHLD_W = AE::signal CHLD => \&_sigchld;
1159	# child could be a zombie already, so make at least one round	1874	# child could be a zombie already, so make at least one round
1160	&_sigchld;	1875	&_sigchld;
1161	}	1876	}
1162		1877
1163	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1878	bless [$pid, $cb+0], "AnyEvent::Base::child"
1164	}	1879	};
1165		1880
1166	sub AnyEvent::Base::Child::DESTROY {	1881	*AnyEvent::Base::child::DESTROY = sub {
1167	my ($pid, $cb) = @{$_[0]};	1882	my ($pid, $icb) = @{$_[0]};
1168		1883
1169	delete $PID_CB{$pid}{$cb};	1884	delete $PID_CB{$pid}{$icb};
1170	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1885	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1171		1886
1172	undef $CHLD_W unless keys %PID_CB;	1887	undef $CHLD_W unless keys %PID_CB;
		1888	};
		1889	};
		1890	die if $@;
		1891
		1892	&child
		1893	}
		1894
		1895	# idle emulation is done by simply using a timer, regardless
		1896	# of whether the process is idle or not, and not letting
		1897	# the callback use more than 50% of the time.
		1898	sub idle {
		1899	eval q{ # poor man's autoloading {}
		1900	*idle = sub {
		1901	my (undef, %arg) = @_;
		1902
		1903	my ($cb, $w, $rcb) = $arg{cb};
		1904
		1905	$rcb = sub {
		1906	if ($cb) {
		1907	$w = AE::time;
		1908	&$cb;
		1909	$w = AE::time - $w;
		1910
		1911	# never use more then 50% of the time for the idle watcher,
		1912	# within some limits
		1913	$w = 0.0001 if $w < 0.0001;
		1914	$w = 5 if $w > 5;
		1915
		1916	$w = AE::timer $w, 0, $rcb;
		1917	} else {
		1918	# clean up...
		1919	undef $w;
		1920	undef $rcb;
		1921	}
		1922	};
		1923
		1924	$w = AE::timer 0.05, 0, $rcb;
		1925
		1926	bless \\$cb, "AnyEvent::Base::idle"
		1927	};
		1928
		1929	*AnyEvent::Base::idle::DESTROY = sub {
		1930	undef $${$_[0]};
		1931	};
		1932	};
		1933	die if $@;
		1934
		1935	&idle
1173	}	1936	}
1174		1937
1175	package AnyEvent::CondVar;	1938	package AnyEvent::CondVar;
1176		1939
1177	our @ISA = AnyEvent::CondVar::Base::;	1940	our @ISA = AnyEvent::CondVar::Base::;
1178		1941
		1942	# only to be used for subclassing
		1943	sub new {
		1944	my $class = shift;
		1945	bless AnyEvent->condvar (@_), $class
		1946	}
		1947
1179	package AnyEvent::CondVar::Base;	1948	package AnyEvent::CondVar::Base;
1180		1949
1181	use overload	1950	#use overload
1182	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1951	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1183	fallback => 1;	1952	# fallback => 1;
		1953
		1954	# save 300+ kilobytes by dirtily hardcoding overloading
		1955	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1956	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1957	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1958	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1959
		1960	our $WAITING;
1184		1961
1185	sub _send {	1962	sub _send {
1186	# nop	1963	# nop
		1964	}
		1965
		1966	sub _wait {
		1967	AnyEvent->_poll until $_[0]{_ae_sent};
1187	}	1968	}
1188		1969
1189	sub send {	1970	sub send {
1190	my $cv = shift;	1971	my $cv = shift;
1191	$cv->{_ae_sent} = [@_];	1972	$cv->{_ae_sent} = [@_];
…		…
1200		1981
1201	sub ready {	1982	sub ready {
1202	$_[0]{_ae_sent}	1983	$_[0]{_ae_sent}
1203	}	1984	}
1204		1985
1205	sub _wait {
1206	AnyEvent->one_event while !$_[0]{_ae_sent};
1207	}
1208
1209	sub recv {	1986	sub recv {
		1987	unless ($_[0]{_ae_sent}) {
		1988	$WAITING
		1989	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1990
		1991	local $WAITING = 1;
1210	$_[0]->_wait;	1992	$_[0]->_wait;
		1993	}
1211		1994
1212	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1995	$_[0]{_ae_croak}
1213	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1996	and Carp::croak $_[0]{_ae_croak};
		1997
		1998	wantarray
		1999	? @{ $_[0]{_ae_sent} }
		2000	: $_[0]{_ae_sent}[0]
1214	}	2001	}
1215		2002
1216	sub cb {	2003	sub cb {
1217	$_[0]{_ae_cb} = $_[1] if @_ > 1;	2004	my $cv = shift;
		2005
		2006	@_
		2007	and $cv->{_ae_cb} = shift
		2008	and $cv->{_ae_sent}
		2009	and (delete $cv->{_ae_cb})->($cv);
		2010
1218	$_[0]{_ae_cb}	2011	$cv->{_ae_cb}
1219	}	2012	}
1220		2013
1221	sub begin {	2014	sub begin {
1222	++$_[0]{_ae_counter};	2015	++$_[0]{_ae_counter};
1223	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	2016	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1228	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	2021	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1229	}	2022	}
1230		2023
1231	# undocumented/compatibility with pre-3.4	2024	# undocumented/compatibility with pre-3.4
1232	*broadcast = \&send;	2025	*broadcast = \&send;
1233	*wait = \&_wait;	2026	*wait = \&recv;
1234		2027
1235	=head1 ERROR AND EXCEPTION HANDLING	2028	=head1 ERROR AND EXCEPTION HANDLING
1236		2029
1237	In general, AnyEvent does not do any error handling - it relies on the	2030	In general, AnyEvent does not do any error handling - it relies on the
1238	caller to do that if required. The L<AnyEvent::Strict> module (see also	2031	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1250	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2043	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1251	so on.	2044	so on.
1252		2045
1253	=head1 ENVIRONMENT VARIABLES	2046	=head1 ENVIRONMENT VARIABLES
1254		2047
1255	The following environment variables are used by this module or its	2048	AnyEvent supports a number of environment variables that tune the
1256	submodules:	2049	runtime behaviour. They are usually evaluated when AnyEvent is
		2050	loaded, initialised, or a submodule that uses them is loaded. Many of
		2051	them also cause AnyEvent to load additional modules - for example,
		2052	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2053	loaded.
		2054
		2055	All the environment variables documented here start with
		2056	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
		2057	namespace. Other modules are encouraged (but by no means required) to use
		2058	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2059	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2060	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2061	variables starting with C<AE_>, see below).
		2062
		2063	All variables can also be set via the C<AE_> prefix, that is, instead
		2064	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2065	case there is a clash btween anyevent and another program that uses
		2066	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2067	variable to the empty string, as those variables take precedence.
		2068
		2069	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2070	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2071	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2072	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2073	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2074	is set).
		2075
		2076	The exact algorithm is currently:
		2077
		2078	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2079	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2080	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2081
		2082	This ensures that child processes will not see the C<AE_> variables.
		2083
		2084	The following environment variables are currently known to AnyEvent:
1257		2085
1258	=over 4	2086	=over 4
1259		2087
1260	=item C<PERL_ANYEVENT_VERBOSE>	2088	=item C<PERL_ANYEVENT_VERBOSE>
1261		2089
1262	By default, AnyEvent will be completely silent except in fatal	2090	By default, AnyEvent will log messages with loglevel C<4> (C<error>) or
1263	conditions. You can set this environment variable to make AnyEvent more	2091	higher (see L<AnyEvent::Log>). You can set this environment variable to a
1264	talkative.	2092	numerical loglevel to make AnyEvent more (or less) talkative.
1265		2093
		2094	If you want to do more than just set the global logging level
		2095	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2096	complex specifications.
		2097
		2098	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2099	everything else at defaults.
		2100
1266	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2101	When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected
1267	conditions, such as not being able to load the event model specified by	2102	conditions, such as not being able to load the event model specified by
1268	C<PERL_ANYEVENT_MODEL>.	2103	C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
		2104	is the minimum recommended level for use during development.
1269		2105
1270	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2106	When set to C<7> or higher (info), AnyEvent reports which event model it
1271	model it chooses.	2107	chooses.
		2108
		2109	When set to C<8> or higher (debug), then AnyEvent will report extra
		2110	information on which optional modules it loads and how it implements
		2111	certain features.
		2112
		2113	=item C<PERL_ANYEVENT_LOG>
		2114
		2115	Accepts rather complex logging specifications. For example, you could log
		2116	all C<debug> messages of some module to stderr, warnings and above to
		2117	stderr, and errors and above to syslog, with:
		2118
		2119	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2120
		2121	For the rather extensive details, see L<AnyEvent::Log>.
		2122
		2123	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2124	so will take effect even before AnyEvent has initialised itself.
		2125
		2126	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2127	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2128	using the latter saves a few hundred kB of memory unless a module
		2129	explicitly needs the extra features of AnyEvent::Log.
1272		2130
1273	=item C<PERL_ANYEVENT_STRICT>	2131	=item C<PERL_ANYEVENT_STRICT>
1274		2132
1275	AnyEvent does not do much argument checking by default, as thorough	2133	AnyEvent does not do much argument checking by default, as thorough
1276	argument checking is very costly. Setting this variable to a true value	2134	argument checking is very costly. Setting this variable to a true value
1277	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	2135	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1278	check the arguments passed to most method calls. If it finds any problems	2136	check the arguments passed to most method calls. If it finds any problems,
1279	it will croak.	2137	it will croak.
1280		2138
1281	In other words, enables "strict" mode.	2139	In other words, enables "strict" mode.
1282		2140
1283	Unlike C<use strict>, it is definitely recommended ot keep it off in	2141	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1284	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	2142	>>, it is definitely recommended to keep it off in production. Keeping
1285	developing programs can be very useful, however.	2143	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		2144	can be very useful, however.
		2145
		2146	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2147
		2148	If this env variable is nonempty, then its contents will be interpreted by
		2149	C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
		2150	replacing every occurance of C<$$> by the process pid). The shell object
		2151	is saved in C<$AnyEvent::Debug::SHELL>.
		2152
		2153	This happens when the first watcher is created.
		2154
		2155	For example, to bind a debug shell on a unix domain socket in
		2156	F<< /tmp/debug<pid>.sock >>, you could use this:
		2157
		2158	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2159	# connect with e.g.: socat readline /tmp/debug123.sock
		2160
		2161	Or to bind to tcp port 4545 on localhost:
		2162
		2163	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		2164	# connect with e.g.: telnet localhost 4545
		2165
		2166	Note that creating sockets in F</tmp> or on localhost is very unsafe on
		2167	multiuser systems.
		2168
		2169	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2170
		2171	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2172	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
1286		2173
1287	=item C<PERL_ANYEVENT_MODEL>	2174	=item C<PERL_ANYEVENT_MODEL>
1288		2175
1289	This can be used to specify the event model to be used by AnyEvent, before	2176	This can be used to specify the event model to be used by AnyEvent, before
1290	auto detection and -probing kicks in. It must be a string consisting	2177	auto detection and -probing kicks in.
1291	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2178
		2179	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2180	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1292	and the resulting module name is loaded and if the load was successful,	2181	resulting module name is loaded and - if the load was successful - used as
1293	used as event model. If it fails to load AnyEvent will proceed with	2182	event model backend. If it fails to load then AnyEvent will proceed with
1294	auto detection and -probing.	2183	auto detection and -probing.
1295		2184
1296	This functionality might change in future versions.	2185	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2186	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2187	the end of a string designates a module name and quotes it appropriately).
1297		2188
1298	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2189	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1299	could start your program like this:	2190	could start your program like this:
1300		2191
1301	PERL_ANYEVENT_MODEL=Perl perl ...	2192	PERL_ANYEVENT_MODEL=Perl perl ...
		2193
		2194	=item C<PERL_ANYEVENT_IO_MODEL>
		2195
		2196	The current file I/O model - see L<AnyEvent::IO> for more info.
		2197
		2198	At the moment, only C<Perl> (small, pure-perl, synchronous) and
		2199	C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if
		2200	L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>.
1302		2201
1303	=item C<PERL_ANYEVENT_PROTOCOLS>	2202	=item C<PERL_ANYEVENT_PROTOCOLS>
1304		2203
1305	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences	2204	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1306	for IPv4 or IPv6. The default is unspecified (and might change, or be the result	2205	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
…		…
1319	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2218	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1320	- only support IPv4, never try to resolve or contact IPv6	2219	- only support IPv4, never try to resolve or contact IPv6
1321	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2220	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1322	IPv6, but prefer IPv6 over IPv4.	2221	IPv6, but prefer IPv6 over IPv4.
1323		2222
		2223	=item C<PERL_ANYEVENT_HOSTS>
		2224
		2225	This variable, if specified, overrides the F</etc/hosts> file used by
		2226	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2227	from that file instead.
		2228
1324	=item C<PERL_ANYEVENT_EDNS0>	2229	=item C<PERL_ANYEVENT_EDNS0>
1325		2230
1326	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2231	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1327	for DNS. This extension is generally useful to reduce DNS traffic, but	2232	DNS. This extension is generally useful to reduce DNS traffic, especially
1328	some (broken) firewalls drop such DNS packets, which is why it is off by	2233	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1329	default.	2234	packets, which is why it is off by default.
1330		2235
1331	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2236	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1332	EDNS0 in its DNS requests.	2237	EDNS0 in its DNS requests.
1333		2238
1334	=item C<PERL_ANYEVENT_MAX_FORKS>	2239	=item C<PERL_ANYEVENT_MAX_FORKS>
1335		2240
1336	The maximum number of child processes that C<AnyEvent::Util::fork_call>	2241	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1337	will create in parallel.	2242	will create in parallel.
		2243
		2244	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		2245
		2246	The default value for the C<max_outstanding> parameter for the default DNS
		2247	resolver - this is the maximum number of parallel DNS requests that are
		2248	sent to the DNS server.
		2249
		2250	=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
		2251
		2252	Perl has inherently racy signal handling (you can basically choose between
		2253	losing signals and memory corruption) - pure perl event loops (including
		2254	C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
		2255	have to poll regularly to avoid losing signals.
		2256
		2257	Some event loops are racy, but don't poll regularly, and some event loops
		2258	are written in C but are still racy. For those event loops, AnyEvent
		2259	installs a timer that regularly wakes up the event loop.
		2260
		2261	By default, the interval for this timer is C<10> seconds, but you can
		2262	override this delay with this environment variable (or by setting
		2263	the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
		2264	watchers).
		2265
		2266	Lower values increase CPU (and energy) usage, higher values can introduce
		2267	long delays when reaping children or waiting for signals.
		2268
		2269	The L<AnyEvent::Async> module, if available, will be used to avoid this
		2270	polling (with most event loops).
		2271
		2272	=item C<PERL_ANYEVENT_RESOLV_CONF>
		2273
		2274	The absolute path to a F<resolv.conf>-style file to use instead of
		2275	F</etc/resolv.conf> (or the OS-specific configuration) in the default
		2276	resolver, or the empty string to select the default configuration.
		2277
		2278	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		2279
		2280	When neither C<ca_file> nor C<ca_path> was specified during
		2281	L<AnyEvent::TLS> context creation, and either of these environment
		2282	variables are nonempty, they will be used to specify CA certificate
		2283	locations instead of a system-dependent default.
		2284
		2285	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		2286
		2287	When these are set to C<1>, then the respective modules are not
		2288	loaded. Mostly good for testing AnyEvent itself.
1338		2289
1339	=back	2290	=back
1340		2291
1341	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	2292	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1342		2293
…		…
1400	warn "read: $input\n"; # output what has been read	2351	warn "read: $input\n"; # output what has been read
1401	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2352	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1402	},	2353	},
1403	);	2354	);
1404		2355
1405	my $time_watcher; # can only be used once
1406
1407	sub new_timer {
1408	$timer = AnyEvent->timer (after => 1, cb => sub {	2356	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1409	warn "timeout\n"; # print 'timeout' about every second	2357	warn "timeout\n"; # print 'timeout' at most every second
1410	&new_timer; # and restart the time
1411	});	2358	});
1412	}
1413
1414	new_timer; # create first timer
1415		2359
1416	$cv->recv; # wait until user enters /^q/i	2360	$cv->recv; # wait until user enters /^q/i
1417		2361
1418	=head1 REAL-WORLD EXAMPLE	2362	=head1 REAL-WORLD EXAMPLE
1419		2363
…		…
1492		2436
1493	The actual code goes further and collects all errors (C<die>s, exceptions)	2437	The actual code goes further and collects all errors (C<die>s, exceptions)
1494	that occurred during request processing. The C<result> method detects	2438	that occurred during request processing. The C<result> method detects
1495	whether an exception as thrown (it is stored inside the $txn object)	2439	whether an exception as thrown (it is stored inside the $txn object)
1496	and just throws the exception, which means connection errors and other	2440	and just throws the exception, which means connection errors and other
1497	problems get reported tot he code that tries to use the result, not in a	2441	problems get reported to the code that tries to use the result, not in a
1498	random callback.	2442	random callback.
1499		2443
1500	All of this enables the following usage styles:	2444	All of this enables the following usage styles:
1501		2445
1502	1. Blocking:	2446	1. Blocking:
…		…
1550	through AnyEvent. The benchmark creates a lot of timers (with a zero	2494	through AnyEvent. The benchmark creates a lot of timers (with a zero
1551	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2495	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1552	which it is), lets them fire exactly once and destroys them again.	2496	which it is), lets them fire exactly once and destroys them again.
1553		2497
1554	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2498	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1555	distribution.	2499	distribution. It uses the L<AE> interface, which makes a real difference
		2500	for the EV and Perl backends only.
1556		2501
1557	=head3 Explanation of the columns	2502	=head3 Explanation of the columns
1558		2503
1559	I<watcher> is the number of event watchers created/destroyed. Since	2504	I<watcher> is the number of event watchers created/destroyed. Since
1560	different event models feature vastly different performances, each event	2505	different event models feature vastly different performances, each event
…		…
1581	watcher.	2526	watcher.
1582		2527
1583	=head3 Results	2528	=head3 Results
1584		2529
1585	name watchers bytes create invoke destroy comment	2530	name watchers bytes create invoke destroy comment
1586	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2531	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1587	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2532	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1588	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2533	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1589	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2534	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1590	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2535	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1591	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2536	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
		2537	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
		2538	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1592	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2539	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1593	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2540	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1594	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2541	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1595	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2542	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1596		2543
1597	=head3 Discussion	2544	=head3 Discussion
1598		2545
1599	The benchmark does I<not> measure scalability of the event loop very	2546	The benchmark does I<not> measure scalability of the event loop very
1600	well. For example, a select-based event loop (such as the pure perl one)	2547	well. For example, a select-based event loop (such as the pure perl one)
…		…
1612	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2559	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1613	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2560	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1614	cycles with POE.	2561	cycles with POE.
1615		2562
1616	C<EV> is the sole leader regarding speed and memory use, which are both	2563	C<EV> is the sole leader regarding speed and memory use, which are both
1617	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2564	maximal/minimal, respectively. When using the L<AE> API there is zero
		2565	overhead (when going through the AnyEvent API create is about 5-6 times
		2566	slower, with other times being equal, so still uses far less memory than
1618	far less memory than any other event loop and is still faster than Event	2567	any other event loop and is still faster than Event natively).
1619	natively.
1620		2568
1621	The pure perl implementation is hit in a few sweet spots (both the	2569	The pure perl implementation is hit in a few sweet spots (both the
1622	constant timeout and the use of a single fd hit optimisations in the perl	2570	constant timeout and the use of a single fd hit optimisations in the perl
1623	interpreter and the backend itself). Nevertheless this shows that it	2571	interpreter and the backend itself). Nevertheless this shows that it
1624	adds very little overhead in itself. Like any select-based backend its	2572	adds very little overhead in itself. Like any select-based backend its
1625	performance becomes really bad with lots of file descriptors (and few of	2573	performance becomes really bad with lots of file descriptors (and few of
1626	them active), of course, but this was not subject of this benchmark.	2574	them active), of course, but this was not subject of this benchmark.
1627		2575
1628	The C<Event> module has a relatively high setup and callback invocation	2576	The C<Event> module has a relatively high setup and callback invocation
1629	cost, but overall scores in on the third place.	2577	cost, but overall scores in on the third place.
		2578
		2579	C<IO::Async> performs admirably well, about on par with C<Event>, even
		2580	when using its pure perl backend.
1630		2581
1631	C<Glib>'s memory usage is quite a bit higher, but it features a	2582	C<Glib>'s memory usage is quite a bit higher, but it features a
1632	faster callback invocation and overall ends up in the same class as	2583	faster callback invocation and overall ends up in the same class as
1633	C<Event>. However, Glib scales extremely badly, doubling the number of	2584	C<Event>. However, Glib scales extremely badly, doubling the number of
1634	watchers increases the processing time by more than a factor of four,	2585	watchers increases the processing time by more than a factor of four,
…		…
1669	(even when used without AnyEvent), but most event loops have acceptable	2620	(even when used without AnyEvent), but most event loops have acceptable
1670	performance with or without AnyEvent.	2621	performance with or without AnyEvent.
1671		2622
1672	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2623	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
1673	the actual event loop, only with extremely fast event loops such as EV	2624	the actual event loop, only with extremely fast event loops such as EV
1674	adds AnyEvent significant overhead.	2625	does AnyEvent add significant overhead.
1675		2626
1676	=item * You should avoid POE like the plague if you want performance or	2627	=item * You should avoid POE like the plague if you want performance or
1677	reasonable memory usage.	2628	reasonable memory usage.
1678		2629
1679	=back	2630	=back
…		…
1695	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2646	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1696	(1%) are active. This mirrors the activity of large servers with many	2647	(1%) are active. This mirrors the activity of large servers with many
1697	connections, most of which are idle at any one point in time.	2648	connections, most of which are idle at any one point in time.
1698		2649
1699	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2650	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1700	distribution.	2651	distribution. It uses the L<AE> interface, which makes a real difference
		2652	for the EV and Perl backends only.
1701		2653
1702	=head3 Explanation of the columns	2654	=head3 Explanation of the columns
1703		2655
1704	I<sockets> is the number of sockets, and twice the number of "servers" (as	2656	I<sockets> is the number of sockets, and twice the number of "servers" (as
1705	each server has a read and write socket end).	2657	each server has a read and write socket end).
…		…
1712	it to another server. This includes deleting the old timeout and creating	2664	it to another server. This includes deleting the old timeout and creating
1713	a new one that moves the timeout into the future.	2665	a new one that moves the timeout into the future.
1714		2666
1715	=head3 Results	2667	=head3 Results
1716		2668
1717	name sockets create request	2669	name sockets create request
1718	EV 20000 69.01 11.16	2670	EV 20000 62.66 7.99
1719	Perl 20000 73.32 35.87	2671	Perl 20000 68.32 32.64
1720	Event 20000 212.62 257.32	2672	IOAsync 20000 174.06 101.15 epoll
1721	Glib 20000 651.16 1896.30	2673	IOAsync 20000 174.67 610.84 poll
		2674	Event 20000 202.69 242.91
		2675	Glib 20000 557.01 1689.52
1722	POE 20000 349.67 12317.24 uses POE::Loop::Event	2676	POE 20000 341.54 12086.32 uses POE::Loop::Event
1723		2677
1724	=head3 Discussion	2678	=head3 Discussion
1725		2679
1726	This benchmark I<does> measure scalability and overall performance of the	2680	This benchmark I<does> measure scalability and overall performance of the
1727	particular event loop.	2681	particular event loop.
…		…
1729	EV is again fastest. Since it is using epoll on my system, the setup time	2683	EV is again fastest. Since it is using epoll on my system, the setup time
1730	is relatively high, though.	2684	is relatively high, though.
1731		2685
1732	Perl surprisingly comes second. It is much faster than the C-based event	2686	Perl surprisingly comes second. It is much faster than the C-based event
1733	loops Event and Glib.	2687	loops Event and Glib.
		2688
		2689	IO::Async performs very well when using its epoll backend, and still quite
		2690	good compared to Glib when using its pure perl backend.
1734		2691
1735	Event suffers from high setup time as well (look at its code and you will	2692	Event suffers from high setup time as well (look at its code and you will
1736	understand why). Callback invocation also has a high overhead compared to	2693	understand why). Callback invocation also has a high overhead compared to
1737	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2694	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1738	uses select or poll in basically all documented configurations.	2695	uses select or poll in basically all documented configurations.
…		…
1801	=item * C-based event loops perform very well with small number of	2758	=item * C-based event loops perform very well with small number of
1802	watchers, as the management overhead dominates.	2759	watchers, as the management overhead dominates.
1803		2760
1804	=back	2761	=back
1805		2762
		2763	=head2 THE IO::Lambda BENCHMARK
		2764
		2765	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2766	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2767	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2768	shouldn't come as a surprise to anybody). As such, the benchmark is
		2769	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2770	very optimal. But how would AnyEvent compare when used without the extra
		2771	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2772
		2773	The benchmark itself creates an echo-server, and then, for 500 times,
		2774	connects to the echo server, sends a line, waits for the reply, and then
		2775	creates the next connection. This is a rather bad benchmark, as it doesn't
		2776	test the efficiency of the framework or much non-blocking I/O, but it is a
		2777	benchmark nevertheless.
		2778
		2779	name runtime
		2780	Lambda/select 0.330 sec
		2781	+ optimized 0.122 sec
		2782	Lambda/AnyEvent 0.327 sec
		2783	+ optimized 0.138 sec
		2784	Raw sockets/select 0.077 sec
		2785	POE/select, components 0.662 sec
		2786	POE/select, raw sockets 0.226 sec
		2787	POE/select, optimized 0.404 sec
		2788
		2789	AnyEvent/select/nb 0.085 sec
		2790	AnyEvent/EV/nb 0.068 sec
		2791	+state machine 0.134 sec
		2792
		2793	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2794	benchmarks actually make blocking connects and use 100% blocking I/O,
		2795	defeating the purpose of an event-based solution. All of the newly
		2796	written AnyEvent benchmarks use 100% non-blocking connects (using
		2797	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2798	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2799	generally require a lot more bookkeeping and event handling than blocking
		2800	connects (which involve a single syscall only).
		2801
		2802	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2803	offers similar expressive power as POE and IO::Lambda, using conventional
		2804	Perl syntax. This means that both the echo server and the client are 100%
		2805	non-blocking, further placing it at a disadvantage.
		2806
		2807	As you can see, the AnyEvent + EV combination even beats the
		2808	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2809	backend easily beats IO::Lambda and POE.
		2810
		2811	And even the 100% non-blocking version written using the high-level (and
		2812	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
		2813	higher level ("unoptimised") abstractions by a large margin, even though
		2814	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
		2815
		2816	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2817	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2818	part of the IO::Lambda distribution and were used without any changes.
		2819
1806		2820
1807	=head1 SIGNALS	2821	=head1 SIGNALS
1808		2822
1809	AnyEvent currently installs handlers for these signals:	2823	AnyEvent currently installs handlers for these signals:
1810		2824
…		…
1813	=item SIGCHLD	2827	=item SIGCHLD
1814		2828
1815	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2829	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1816	emulation for event loops that do not support them natively. Also, some	2830	emulation for event loops that do not support them natively. Also, some
1817	event loops install a similar handler.	2831	event loops install a similar handler.
		2832
		2833	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2834	AnyEvent will reset it to default, to avoid losing child exit statuses.
1818		2835
1819	=item SIGPIPE	2836	=item SIGPIPE
1820		2837
1821	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2838	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1822	when AnyEvent gets loaded.	2839	when AnyEvent gets loaded.
…		…
1834		2851
1835	=back	2852	=back
1836		2853
1837	=cut	2854	=cut
1838		2855
		2856	undef $SIG{CHLD}
		2857	if $SIG{CHLD} eq 'IGNORE';
		2858
1839	$SIG{PIPE} = sub { }	2859	$SIG{PIPE} = sub { }
1840	unless defined $SIG{PIPE};	2860	unless defined $SIG{PIPE};
1841		2861
		2862	=head1 RECOMMENDED/OPTIONAL MODULES
		2863
		2864	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2865	its built-in modules) are required to use it.
		2866
		2867	That does not mean that AnyEvent won't take advantage of some additional
		2868	modules if they are installed.
		2869
		2870	This section explains which additional modules will be used, and how they
		2871	affect AnyEvent's operation.
		2872
		2873	=over 4
		2874
		2875	=item L<Async::Interrupt>
		2876
		2877	This slightly arcane module is used to implement fast signal handling: To
		2878	my knowledge, there is no way to do completely race-free and quick
		2879	signal handling in pure perl. To ensure that signals still get
		2880	delivered, AnyEvent will start an interval timer to wake up perl (and
		2881	catch the signals) with some delay (default is 10 seconds, look for
		2882	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2883
		2884	If this module is available, then it will be used to implement signal
		2885	catching, which means that signals will not be delayed, and the event loop
		2886	will not be interrupted regularly, which is more efficient (and good for
		2887	battery life on laptops).
		2888
		2889	This affects not just the pure-perl event loop, but also other event loops
		2890	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2891
		2892	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2893	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2894	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2895	does nothing for those backends.
		2896
		2897	=item L<EV>
		2898
		2899	This module isn't really "optional", as it is simply one of the backend
		2900	event loops that AnyEvent can use. However, it is simply the best event
		2901	loop available in terms of features, speed and stability: It supports
		2902	the AnyEvent API optimally, implements all the watcher types in XS, does
		2903	automatic timer adjustments even when no monotonic clock is available,
		2904	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2905	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2906	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2907
		2908	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2909	then this module will do nothing for you.
		2910
		2911	=item L<Guard>
		2912
		2913	The guard module, when used, will be used to implement
		2914	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2915	lot less memory), but otherwise doesn't affect guard operation much. It is
		2916	purely used for performance.
		2917
		2918	=item L<JSON> and L<JSON::XS>
		2919
		2920	One of these modules is required when you want to read or write JSON data
		2921	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
		2922	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2923
		2924	=item L<Net::SSLeay>
		2925
		2926	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2927	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2928	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2929
		2930	=item L<Time::HiRes>
		2931
		2932	This module is part of perl since release 5.008. It will be used when the
		2933	chosen event library does not come with a timing source of its own. The
		2934	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
		2935	try to use a monotonic clock for timing stability.
		2936
		2937	=item L<AnyEvent::AIO> (and L<IO::AIO>)
		2938
		2939	The default implementation of L<AnyEvent::IO> is to do I/O synchronously,
		2940	stopping programs while they access the disk, which is fine for a lot of
		2941	programs.
		2942
		2943	Installing AnyEvent::AIO (and its IO::AIO dependency) makes it switch to
		2944	a true asynchronous implementation, so event processing can continue even
		2945	while waiting for disk I/O.
		2946
		2947	=back
		2948
1842		2949
1843	=head1 FORK	2950	=head1 FORK
1844		2951
1845	Most event libraries are not fork-safe. The ones who are usually are	2952	Most event libraries are not fork-safe. The ones who are usually are
1846	because they rely on inefficient but fork-safe C<select> or C<poll>	2953	because they rely on inefficient but fork-safe C<select> or C<poll> calls
1847	calls. Only L<EV> is fully fork-aware.	2954	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2955	are usually badly thought-out hacks that are incompatible with fork in
		2956	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2957	continue event-processing in both parent and child (or both, if you know
		2958	what you are doing).
		2959
		2960	This means that, in general, you cannot fork and do event processing in
		2961	the child if the event library was initialised before the fork (which
		2962	usually happens when the first AnyEvent watcher is created, or the library
		2963	is loaded).
1848		2964
1849	If you have to fork, you must either do so I<before> creating your first	2965	If you have to fork, you must either do so I<before> creating your first
1850	watcher OR you must not use AnyEvent at all in the child.	2966	watcher OR you must not use AnyEvent at all in the child OR you must do
		2967	something completely out of the scope of AnyEvent (see below).
		2968
		2969	The problem of doing event processing in the parent I<and> the child
		2970	is much more complicated: even for backends that I<are> fork-aware or
		2971	fork-safe, their behaviour is not usually what you want: fork clones all
		2972	watchers, that means all timers, I/O watchers etc. are active in both
		2973	parent and child, which is almost never what you want. Using C<exec>
		2974	to start worker children from some kind of manage prrocess is usually
		2975	preferred, because it is much easier and cleaner, at the expense of having
		2976	to have another binary.
		2977
		2978	In addition to logical problems with fork, there are also implementation
		2979	problems. For example, on POSIX systems, you cannot fork at all in Perl
		2980	code if a thread (I am talking of pthreads here) was ever created in the
		2981	process, and this is just the tip of the iceberg. In general, using fork
		2982	from Perl is difficult, and attempting to use fork without an exec to
		2983	implement some kind of parallel processing is almost certainly doomed.
		2984
		2985	To safely fork and exec, you should use a module such as
		2986	L<Proc::FastSpawn> that let's you safely fork and exec new processes.
		2987
		2988	If you want to do multiprocessing using processes, you can
		2989	look at the L<AnyEvent::Fork> module (and some related modules
		2990	such as L<AnyEvent::Fork::RPC>, L<AnyEvent::Fork::Pool> and
		2991	L<AnyEvent::Fork::Remote>). This module allows you to safely create
		2992	subprocesses without any limitations - you can use X11 toolkits or
		2993	AnyEvent in the children created by L<AnyEvent::Fork> safely and without
		2994	any special precautions.
1851		2995
1852		2996
1853	=head1 SECURITY CONSIDERATIONS	2997	=head1 SECURITY CONSIDERATIONS
1854		2998
1855	AnyEvent can be forced to load any event model via	2999	AnyEvent can be forced to load any event model via
…		…
1867	use AnyEvent;	3011	use AnyEvent;
1868		3012
1869	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	3013	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1870	be used to probe what backend is used and gain other information (which is	3014	be used to probe what backend is used and gain other information (which is
1871	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and	3015	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1872	$ENV{PERL_ANYEGENT_STRICT}.	3016	$ENV{PERL_ANYEVENT_STRICT}.
		3017
		3018	Note that AnyEvent will remove I<all> environment variables starting with
		3019	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		3020	enabled.
1873		3021
1874		3022
1875	=head1 BUGS	3023	=head1 BUGS
1876		3024
1877	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	3025	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
…		…
1881	pronounced).	3029	pronounced).
1882		3030
1883		3031
1884	=head1 SEE ALSO	3032	=head1 SEE ALSO
1885		3033
1886	Utility functions: L<AnyEvent::Util>.	3034	Tutorial/Introduction: L<AnyEvent::Intro>.
1887		3035
1888	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	3036	FAQ: L<AnyEvent::FAQ>.
1889	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	3037
		3038	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		3039	(simply logging).
		3040
		3041	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		3042	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		3043
		3044	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		3045	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		3046	L<Qt>, L<POE>, L<FLTK>.
1890		3047
1891	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	3048	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1892	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	3049	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1893	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	3050	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
		3051	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
1894	L<AnyEvent::Impl::POE>.	3052	L<AnyEvent::Impl::FLTK>.
1895		3053
1896	Non-blocking file handles, sockets, TCP clients and	3054	Non-blocking handles, pipes, stream sockets, TCP clients and
1897	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	3055	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
		3056
		3057	Asynchronous File I/O: L<AnyEvent::IO>.
1898		3058
1899	Asynchronous DNS: L<AnyEvent::DNS>.	3059	Asynchronous DNS: L<AnyEvent::DNS>.
1900		3060
1901	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	3061	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
1902		3062
1903	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	3063	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
		3064	L<AnyEvent::HTTP>.
1904		3065
1905		3066
1906	=head1 AUTHOR	3067	=head1 AUTHOR
1907		3068
1908	Marc Lehmann <schmorp@schmorp.de>	3069	Marc Lehmann <schmorp@schmorp.de>
1909	http://home.schmorp.de/	3070	http://anyevent.schmorp.de
1910		3071
1911	=cut	3072	=cut
1912		3073
1913	1	3074	1
1914		3075

Diff Legend

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