ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

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

Diff Legend

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