ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.159 by root, Fri Jun 6 16:19:19 2008 UTC vs.
Revision 1.367 by root, Wed Aug 17 02:14:17 2011 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	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 { ... });
		17
		18	# one-shot or repeating timers
		19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
		20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
		21
		22	print AnyEvent->now; # prints current event loop time
		23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
		24
		25	# POSIX signal
		26	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
		27
		28	# child process exit
		29	my $w = AnyEvent->child (pid => $pid, cb => sub {
		30	my ($pid, $status) = @_;
12	...	31	...
13	});	32	});
14		33
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {	34	# called when event loop idle (if applicable)
16	...	35	my $w = AnyEvent->idle (cb => sub { ... });
17	});
18		36
19	my $w = AnyEvent->condvar; # stores whether a condition was flagged	37	my $w = AnyEvent->condvar; # stores whether a condition was flagged
20	$w->send; # wake up current and all future recv's	38	$w->send; # wake up current and all future recv's
21	$w->recv; # enters "main loop" till $condvar gets ->send	39	$w->recv; # enters "main loop" till $condvar gets ->send
		40	# use a condvar in callback mode:
		41	$w->cb (sub { $_[0]->recv });
22		42
23	=head1 INTRODUCTION/TUTORIAL	43	=head1 INTRODUCTION/TUTORIAL
24		44
25	This manpage is mainly a reference manual. If you are interested	45	This manpage is mainly a reference manual. If you are interested
26	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
27	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
28		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.
		58
29	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	59	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
30		60
31	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
32	nowadays. So what is different about AnyEvent?	62	nowadays. So what is different about AnyEvent?
33		63
34	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	64	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
35	policy> and AnyEvent is I<small and efficient>.	65	policy> and AnyEvent is I<small and efficient>.
36		66
37	First and foremost, I<AnyEvent is not an event model> itself, it only	67	First and foremost, I<AnyEvent is not an event model> itself, it only
38	interfaces to whatever event model the main program happens to use in a	68	interfaces to whatever event model the main program happens to use, in a
39	pragmatic way. For event models and certain classes of immortals alike,	69	pragmatic way. For event models and certain classes of immortals alike,
40	the statement "there can only be one" is a bitter reality: In general,	70	the statement "there can only be one" is a bitter reality: In general,
41	only one event loop can be active at the same time in a process. AnyEvent	71	only one event loop can be active at the same time in a process. AnyEvent
42	helps hiding the differences between those event loops.	72	cannot change this, but it can hide the differences between those event
		73	loops.
43		74
44	The goal of AnyEvent is to offer module authors the ability to do event	75	The goal of AnyEvent is to offer module authors the ability to do event
45	programming (waiting for I/O or timer events) without subscribing to a	76	programming (waiting for I/O or timer events) without subscribing to a
46	religion, a way of living, and most importantly: without forcing your	77	religion, a way of living, and most importantly: without forcing your
47	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
48	model you use.	79	model you use.
49		80
50	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
51	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
52	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
53	cannot use anything else, as it is simply incompatible to everything that	84	cannot use anything else, as they are simply incompatible to everything
54	isn't itself. What's worse, all the potential users of your module are	85	that isn't them. What's worse, all the potential users of your
55	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.
56		87
57	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
58	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
59	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
60	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
61	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
62	event models it supports (including stuff like POE and IO::Async, as long	93	supports (including stuff like IO::Async, as long as those use one of the
63	as those use one of the supported event loops. It is trivial to add new	94	supported event loops. It is easy to add new event loops to AnyEvent, too,
64	event loops to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
65		96
66	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
67	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
68	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
69	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
70	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
71	technically possible.	102	technically possible.
72		103
73	Of course, AnyEvent comes with a big (and fully optional!) toolbox	104	Of course, AnyEvent comes with a big (and fully optional!) toolbox
74	of useful functionality, such as an asynchronous DNS resolver, 100%	105	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
80	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
81	model, you should I<not> use this module.	112	model, you should I<not> use this module.
82		113
83	=head1 DESCRIPTION	114	=head1 DESCRIPTION
84		115
85	L<AnyEvent> provides an identical interface to multiple event loops. This	116	L<AnyEvent> provides a uniform interface to various event loops. This
86	allows module authors to utilise an event loop without forcing module	117	allows module authors to use event loop functionality without forcing
87	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
88	peacefully at any one time).	119	than one event loop cannot coexist peacefully).
89		120
90	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>
91	module.	122	module.
92		123
93	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
94	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
95	following modules is already loaded: L<EV>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
96	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
97	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
98	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
99	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
100	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
101	found, AnyEvent will fall back to a pure-perl event loop, which is not
102	very efficient, but should work everywhere.
103		132
104	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
105	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
106	that model the default. For example:	135	that model the default. For example:
107		136
…		…
109	use AnyEvent;	138	use AnyEvent;
110		139
111	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
112		141
113	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
114	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,
115	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
116		146
117	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
118	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
119	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
120		150
121	=head1 WATCHERS	151	=head1 WATCHERS
122		152
123	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
124	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
…		…
127	These watchers are normal Perl objects with normal Perl lifetime. After	157	These watchers are normal Perl objects with normal Perl lifetime. After
128	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
129	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
130	is in control).	160	is in control).
131		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
132	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
133	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
134	to it).	170	to it).
135		171
136	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.
137		173
138	Many watchers either are used with "recursion" (repeating timers for	174	Many watchers either are used with "recursion" (repeating timers for
139	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.
140		176
141	An any way to achieve that is this pattern:	177	One way to achieve that is this pattern:
142		178
143	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
144	# you can use $w here, for example to undef it	180	# you can use $w here, for example to undef it
145	undef $w;	181	undef $w;
146	});	182	});
…		…
149	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
150	declared.	186	declared.
151		187
152	=head2 I/O WATCHERS	188	=head2 I/O WATCHERS
153		189
		190	$w = AnyEvent->io (
		191	fh => <filehandle_or_fileno>,
		192	poll => <"r" or "w">,
		193	cb => <callback>,
		194	);
		195
154	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
155	with the following mandatory key-value pairs as arguments:	197	with the following mandatory key-value pairs as arguments:
156		198
157	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch	199	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
		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
158	for events. C<poll> must be a string that is either C<r> or C<w>,	206	C<poll> must be a string that is either C<r> or C<w>, which creates a
159	which creates a watcher waiting for "r"eadable or "w"ritable events,	207	watcher waiting for "r"eadable or "w"ritable events, respectively.
		208
160	respectively. C<cb> is the callback to invoke each time the file handle	209	C<cb> is the callback to invoke each time the file handle becomes ready.
161	becomes ready.
162		210
163	Although the callback might get passed parameters, their value and	211	Although the callback might get passed parameters, their value and
164	presence is undefined and you cannot rely on them. Portable AnyEvent	212	presence is undefined and you cannot rely on them. Portable AnyEvent
165	callbacks cannot use arguments passed to I/O watcher callbacks.	213	callbacks cannot use arguments passed to I/O watcher callbacks.
166		214
167	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.
168	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
169	underlying file descriptor.	217	underlying file descriptor.
170		218
171	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
172	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
173	handles.	221	handles.
174		222
175	Example:
176
177	# wait for readability of STDIN, then read a line and disable the watcher	223	Example: wait for readability of STDIN, then read a line and disable the
		224	watcher.
		225
178	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	226	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
179	chomp (my $input = <STDIN>);	227	chomp (my $input = <STDIN>);
180	warn "read: $input\n";	228	warn "read: $input\n";
181	undef $w;	229	undef $w;
182	});	230	});
183		231
184	=head2 TIME WATCHERS	232	=head2 TIME WATCHERS
185		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
186	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 >>
187	method with the following mandatory arguments:	243	method with the following mandatory arguments:
188		244
189	C<after> specifies after how many seconds (fractional values are	245	C<after> specifies after how many seconds (fractional values are
190	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
…		…
192		248
193	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
194	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
195	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
196		252
197	The timer callback will be invoked at most once: if you want a repeating	253	The callback will normally be invoked only once. If you specify another
198	timer you have to create a new watcher (this is a limitation by both Tk	254	parameter, C<interval>, as a strictly positive number (> 0), then the
199	and Glib).	255	callback will be invoked regularly at that interval (in fractional
		256	seconds) after the first invocation. If C<interval> is specified with a
		257	false value, then it is treated as if it were not specified at all.
200		258
201	Example:	259	The callback will be rescheduled before invoking the callback, but no
		260	attempt is made to avoid timer drift in most backends, so the interval is
		261	only approximate.
202		262
203	# fire an event after 7.7 seconds	263	Example: fire an event after 7.7 seconds.
		264
204	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
205	warn "timeout\n";	266	warn "timeout\n";
206	});	267	});
207		268
208	# to cancel the timer:	269	# to cancel the timer:
209	undef $w;	270	undef $w;
210		271
211	Example 2:
212
213	# 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.
214	my $w;
215		273
216	my $cb = sub {
217	# cancel the old timer while creating a new one
218	$w = AnyEvent->timer (after => 1, cb => $cb);	274	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
		275	warn "timeout\n";
219	};	276	};
220
221	# start the "loop" by creating the first watcher
222	$w = AnyEvent->timer (after => 0.5, cb => $cb);
223		277
224	=head3 TIMING ISSUES	278	=head3 TIMING ISSUES
225		279
226	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
227	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
…		…
229		283
230	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
231	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
232	"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
233	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
234	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.
235		289
236	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
237	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
238	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)
239	timers.	293	timers.
240		294
241	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
242	AnyEvent API.	296	AnyEvent API.
…		…
264	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
265	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
266		320
267	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
268	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
269	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
270		324
271	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
272	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
273		327
274	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>
275	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
276		330
277	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
278	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
279	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
280	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
281	after three seconds.	335	after three seconds.
282		336
…		…
300	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
301	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
302	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
303	account.	357	account.
304		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
305	=back	381	=back
306		382
307	=head2 SIGNAL WATCHERS	383	=head2 SIGNAL WATCHERS
308		384
		385	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		386
309	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
310	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to	388	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
311	be invoked whenever a signal occurs.	389	callback to be invoked whenever a signal occurs.
312		390
313	Although the callback might get passed parameters, their value and	391	Although the callback might get passed parameters, their value and
314	presence is undefined and you cannot rely on them. Portable AnyEvent	392	presence is undefined and you cannot rely on them. Portable AnyEvent
315	callbacks cannot use arguments passed to signal watcher callbacks.	393	callbacks cannot use arguments passed to signal watcher callbacks.
316		394
…		…
318	invocation, and callback invocation will be synchronous. Synchronous means	396	invocation, and callback invocation will be synchronous. Synchronous means
319	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,
320	but it is guaranteed not to interrupt any other callbacks.	398	but it is guaranteed not to interrupt any other callbacks.
321		399
322	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
323	between multiple watchers.	401	between multiple watchers, and AnyEvent will ensure that signals will not
		402	interrupt your program at bad times.
324		403
325	This watcher might use C<%SIG>, so programs overwriting those signals	404	This watcher might use C<%SIG> (depending on the event loop used),
326	directly will likely not work correctly.	405	so programs overwriting those signals directly will likely not work
		406	correctly.
327		407
328	Example: exit on SIGINT	408	Example: exit on SIGINT
329		409
330	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	410	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
331		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) or
		421	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		422	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 attaching
		432	callbacks to signals in a generic way, which is a pity, as you cannot
		433	do race-free signal handling in perl, requiring C libraries for
		434	this. AnyEvent will try to do its best, which means in some cases,
		435	signals will be delayed. The maximum time a signal might be delayed is
		436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
		437	variable can be changed only before the first signal watcher is created,
		438	and should be left alone otherwise. This variable determines how often
		439	AnyEvent polls for signals (in case a wake-up was missed). Higher values
		440	will cause fewer spurious wake-ups, which is better for power and CPU
		441	saving.
		442
		443	All these problems can be avoided by installing the optional
		444	L<Async::Interrupt> module, which works with most event loops. It will not
		445	work with inherently broken event loops such as L<Event> or L<Event::Lib>
		446	(and not with L<POE> currently, as POE does its own workaround with
		447	one-second latency). For those, you just have to suffer the delays.
		448
332	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
333		450
		451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		452
334	You can also watch on a child process exit and catch its exit status.	453	You can also watch for a child process exit and catch its exit status.
335		454
336	The child process is specified by the C<pid> argument (if set to C<0>, it	455	The child process is specified by the C<pid> argument (on some backends,
337	watches for any child process exit). The watcher will trigger as often	456	using C<0> watches for any child process exit, on others this will
338	as status change for the child are received. This works by installing a	457	croak). The watcher will be triggered only when the child process has
339	signal handler for C<SIGCHLD>. The callback will be called with the pid	458	finished and an exit status is available, not on any trace events
340	and exit status (as returned by waitpid), so unlike other watcher types,	459	(stopped/continued).
341	you I<can> rely on child watcher callback arguments.	460
		461	The callback will be called with the pid and exit status (as returned by
		462	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		463	callback arguments.
		464
		465	This watcher type works by installing a signal handler for C<SIGCHLD>,
		466	and since it cannot be shared, nothing else should use SIGCHLD or reap
		467	random child processes (waiting for specific child processes, e.g. inside
		468	C<system>, is just fine).
342		469
343	There is a slight catch to child watchers, however: you usually start them	470	There is a slight catch to child watchers, however: you usually start them
344	I<after> the child process was created, and this means the process could	471	I<after> the child process was created, and this means the process could
345	have exited already (and no SIGCHLD will be sent anymore).	472	have exited already (and no SIGCHLD will be sent anymore).
346		473
347	Not all event models handle this correctly (POE doesn't), but even for	474	Not all event models handle this correctly (neither POE nor IO::Async do,
		475	see their AnyEvent::Impl manpages for details), but even for event models
348	event models that I<do> handle this correctly, they usually need to be	476	that I<do> handle this correctly, they usually need to be loaded before
349	loaded before the process exits (i.e. before you fork in the first place).	477	the process exits (i.e. before you fork in the first place). AnyEvent's
		478	pure perl event loop handles all cases correctly regardless of when you
		479	start the watcher.
350		480
351	This means you cannot create a child watcher as the very first thing in an	481	This means you cannot create a child watcher as the very first
352	AnyEvent program, you I<have> to create at least one watcher before you	482	thing in an AnyEvent program, you I<have> to create at least one
353	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	483	watcher before you C<fork> the child (alternatively, you can call
		484	C<AnyEvent::detect>).
		485
		486	As most event loops do not support waiting for child events, they will be
		487	emulated by AnyEvent in most cases, in which case the latency and race
		488	problems mentioned in the description of signal watchers apply.
354		489
355	Example: fork a process and wait for it	490	Example: fork a process and wait for it
356		491
357	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
358		493
…		…
368	);	503	);
369		504
370	# do something else, then wait for process exit	505	# do something else, then wait for process exit
371	$done->recv;	506	$done->recv;
372		507
		508	=head2 IDLE WATCHERS
		509
		510	$w = AnyEvent->idle (cb => <callback>);
		511
		512	This will repeatedly invoke the callback after the process becomes idle,
		513	until either the watcher is destroyed or new events have been detected.
		514
		515	Idle watchers are useful when there is a need to do something, but it
		516	is not so important (or wise) to do it instantly. The callback will be
		517	invoked only when there is "nothing better to do", which is usually
		518	defined as "all outstanding events have been handled and no new events
		519	have been detected". That means that idle watchers ideally get invoked
		520	when the event loop has just polled for new events but none have been
		521	detected. Instead of blocking to wait for more events, the idle watchers
		522	will be invoked.
		523
		524	Unfortunately, most event loops do not really support idle watchers (only
		525	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		526	will simply call the callback "from time to time".
		527
		528	Example: read lines from STDIN, but only process them when the
		529	program is otherwise idle:
		530
		531	my @lines; # read data
		532	my $idle_w;
		533	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		534	push @lines, scalar <STDIN>;
		535
		536	# start an idle watcher, if not already done
		537	$idle_w ||= AnyEvent->idle (cb => sub {
		538	# handle only one line, when there are lines left
		539	if (my $line = shift @lines) {
		540	print "handled when idle: $line";
		541	} else {
		542	# otherwise disable the idle watcher again
		543	undef $idle_w;
		544	}
		545	});
		546	});
		547
373	=head2 CONDITION VARIABLES	548	=head2 CONDITION VARIABLES
		549
		550	$cv = AnyEvent->condvar;
		551
		552	$cv->send (<list>);
		553	my @res = $cv->recv;
374		554
375	If you are familiar with some event loops you will know that all of them	555	If you are familiar with some event loops you will know that all of them
376	require you to run some blocking "loop", "run" or similar function that	556	require you to run some blocking "loop", "run" or similar function that
377	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
378		558
379	AnyEvent is different, it expects somebody else to run the event loop and	559	AnyEvent is slightly different: it expects somebody else to run the event
380	will only block when necessary (usually when told by the user).	560	loop and will only block when necessary (usually when told by the user).
381		561
382	The instrument to do that is called a "condition variable", so called	562	The tool to do that is called a "condition variable", so called because
383	because they represent a condition that must become true.	563	they represent a condition that must become true.
		564
		565	Now is probably a good time to look at the examples further below.
384		566
385	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
386	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
387	C<cb>, which specifies a callback to be called when the condition variable	569	C<cb>, which specifies a callback to be called when the condition variable
388	becomes true.	570	becomes true, with the condition variable as the first argument (but not
		571	the results).
389		572
390	After creation, the condition variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
391	by calling the C<send> method (or calling the condition variable as if it	574	by calling the C<send> method (or calling the condition variable as if it
392	were a callback, read about the caveats in the description for the C<<	575	were a callback, read about the caveats in the description for the C<<
393	->send >> method).	576	->send >> method).
394		577
395	Condition variables are similar to callbacks, except that you can	578	Since condition variables are the most complex part of the AnyEvent API, here are
396	optionally wait for them. They can also be called merge points - points	579	some different mental models of what they are - pick the ones you can connect to:
397	in time where multiple outstanding events have been processed. And yet	580
398	another way to call them is transactions - each condition variable can be	581	=over 4
399	used to represent a transaction, which finishes at some point and delivers	582
400	a result.	583	=item * Condition variables are like callbacks - you can call them (and pass them instead
		584	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		585
		586	=item * Condition variables are signals - one side can emit or send them,
		587	the other side can wait for them, or install a handler that is called when
		588	the signal fires.
		589
		590	=item * Condition variables are like "Merge Points" - points in your program
		591	where you merge multiple independent results/control flows into one.
		592
		593	=item * Condition variables represent a transaction - functions that start
		594	some kind of transaction can return them, leaving the caller the choice
		595	between waiting in a blocking fashion, or setting a callback.
		596
		597	=item * Condition variables represent future values, or promises to deliver
		598	some result, long before the result is available.
		599
		600	=back
401		601
402	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
403	for example, if you write a module that does asynchronous http requests,	603	for example, if you write a module that does asynchronous http requests,
404	then a condition variable would be the ideal candidate to signal the	604	then a condition variable would be the ideal candidate to signal the
405	availability of results. The user can either act when the callback is	605	availability of results. The user can either act when the callback is
…		…
418		618
419	Condition variables are represented by hash refs in perl, and the keys	619	Condition variables are represented by hash refs in perl, and the keys
420	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing	620	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
421	easy (it is often useful to build your own transaction class on top of	621	easy (it is often useful to build your own transaction class on top of
422	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call	622	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
423	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
424		624
425	There are two "sides" to a condition variable - the "producer side" which	625	There are two "sides" to a condition variable - the "producer side" which
426	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
427	for the send to occur.	627	for the send to occur.
428		628
429	Example: wait for a timer.	629	Example: wait for a timer.
430		630
431	# wait till the result is ready	631	# condition: "wait till the timer is fired"
432	my $result_ready = AnyEvent->condvar;	632	my $timer_fired = AnyEvent->condvar;
433		633
434	# do something such as adding a timer	634	# create the timer - we could wait for, say
435	# or socket watcher the calls $result_ready->send	635	# a handle becomign ready, or even an
436	# when the "result" is ready.	636	# AnyEvent::HTTP request to finish, but
437	# in this case, we simply use a timer:	637	# in this case, we simply use a timer:
438	my $w = AnyEvent->timer (	638	my $w = AnyEvent->timer (
439	after => 1,	639	after => 1,
440	cb => sub { $result_ready->send },	640	cb => sub { $timer_fired->send },
441	);	641	);
442		642
443	# this "blocks" (while handling events) till the callback	643	# this "blocks" (while handling events) till the callback
444	# calls send	644	# calls ->send
445	$result_ready->recv;	645	$timer_fired->recv;
446		646
447	Example: wait for a timer, but take advantage of the fact that	647	Example: wait for a timer, but take advantage of the fact that condition
448	condition variables are also code references.	648	variables are also callable directly.
449		649
450	my $done = AnyEvent->condvar;	650	my $done = AnyEvent->condvar;
451	my $delay = AnyEvent->timer (after => 5, cb => $done);	651	my $delay = AnyEvent->timer (after => 5, cb => $done);
452	$done->recv;	652	$done->recv;
		653
		654	Example: Imagine an API that returns a condvar and doesn't support
		655	callbacks. This is how you make a synchronous call, for example from
		656	the main program:
		657
		658	use AnyEvent::CouchDB;
		659
		660	...
		661
		662	my @info = $couchdb->info->recv;
		663
		664	And this is how you would just set a callback to be called whenever the
		665	results are available:
		666
		667	$couchdb->info->cb (sub {
		668	my @info = $_[0]->recv;
		669	});
453		670
454	=head3 METHODS FOR PRODUCERS	671	=head3 METHODS FOR PRODUCERS
455		672
456	These methods should only be used by the producing side, i.e. the	673	These methods should only be used by the producing side, i.e. the
457	code/module that eventually sends the signal. Note that it is also	674	code/module that eventually sends the signal. Note that it is also
…		…
470	immediately from within send.	687	immediately from within send.
471		688
472	Any arguments passed to the C<send> call will be returned by all	689	Any arguments passed to the C<send> call will be returned by all
473	future C<< ->recv >> calls.	690	future C<< ->recv >> calls.
474		691
475	Condition variables are overloaded so one can call them directly	692	Condition variables are overloaded so one can call them directly (as if
476	(as a code reference). Calling them directly is the same as calling	693	they were a code reference). Calling them directly is the same as calling
477	C<send>. Note, however, that many C-based event loops do not handle	694	C<send>.
478	overloading, so as tempting as it may be, passing a condition variable
479	instead of a callback does not work. Both the pure perl and EV loops
480	support overloading, however, as well as all functions that use perl to
481	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
482	example).
483		695
484	=item $cv->croak ($error)	696	=item $cv->croak ($error)
485		697
486	Similar to send, but causes all call's to C<< ->recv >> to invoke	698	Similar to send, but causes all calls to C<< ->recv >> to invoke
487	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
488		700
489	This can be used to signal any errors to the condition variable	701	This can be used to signal any errors to the condition variable
490	user/consumer.	702	user/consumer. Doing it this way instead of calling C<croak> directly
		703	delays the error detection, but has the overwhelming advantage that it
		704	diagnoses the error at the place where the result is expected, and not
		705	deep in some event callback with no connection to the actual code causing
		706	the problem.
491		707
492	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
493		709
494	=item $cv->end	710	=item $cv->end
495
496	These two methods are EXPERIMENTAL and MIGHT CHANGE.
497		711
498	These two methods can be used to combine many transactions/events into	712	These two methods can be used to combine many transactions/events into
499	one. For example, a function that pings many hosts in parallel might want	713	one. For example, a function that pings many hosts in parallel might want
500	to use a condition variable for the whole process.	714	to use a condition variable for the whole process.
501		715
502	Every call to C<< ->begin >> will increment a counter, and every call to	716	Every call to C<< ->begin >> will increment a counter, and every call to
503	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	717	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
504	>>, the (last) callback passed to C<begin> will be executed. That callback	718	>>, the (last) callback passed to C<begin> will be executed, passing the
505	is I<supposed> to call C<< ->send >>, but that is not required. If no	719	condvar as first argument. That callback is I<supposed> to call C<< ->send
506	callback was set, C<send> will be called without any arguments.	720	>>, but that is not required. If no group callback was set, C<send> will
		721	be called without any arguments.
507		722
508	Let's clarify this with the ping example:	723	You can think of C<< $cv->send >> giving you an OR condition (one call
		724	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
		725	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
		726
		727	Let's start with a simple example: you have two I/O watchers (for example,
		728	STDOUT and STDERR for a program), and you want to wait for both streams to
		729	close before activating a condvar:
509		730
510	my $cv = AnyEvent->condvar;	731	my $cv = AnyEvent->condvar;
511		732
		733	$cv->begin; # first watcher
		734	my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
		735	defined sysread $fh1, my $buf, 4096
		736	or $cv->end;
		737	});
		738
		739	$cv->begin; # second watcher
		740	my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
		741	defined sysread $fh2, my $buf, 4096
		742	or $cv->end;
		743	});
		744
		745	$cv->recv;
		746
		747	This works because for every event source (EOF on file handle), there is
		748	one call to C<begin>, so the condvar waits for all calls to C<end> before
		749	sending.
		750
		751	The ping example mentioned above is slightly more complicated, as the
		752	there are results to be passwd back, and the number of tasks that are
		753	begun can potentially be zero:
		754
		755	my $cv = AnyEvent->condvar;
		756
512	my %result;	757	my %result;
513	$cv->begin (sub { $cv->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
514		759
515	for my $host (@list_of_hosts) {	760	for my $host (@list_of_hosts) {
516	$cv->begin;	761	$cv->begin;
517	ping_host_then_call_callback $host, sub {	762	ping_host_then_call_callback $host, sub {
518	$result{$host} = ...;	763	$result{$host} = ...;
…		…
533	loop, which serves two important purposes: first, it sets the callback	778	loop, which serves two important purposes: first, it sets the callback
534	to be called once the counter reaches C<0>, and second, it ensures that	779	to be called once the counter reaches C<0>, and second, it ensures that
535	C<send> is called even when C<no> hosts are being pinged (the loop	780	C<send> is called even when C<no> hosts are being pinged (the loop
536	doesn't execute once).	781	doesn't execute once).
537		782
538	This is the general pattern when you "fan out" into multiple subrequests:	783	This is the general pattern when you "fan out" into multiple (but
539	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	784	potentially zero) subrequests: use an outer C<begin>/C<end> pair to set
540	is called at least once, and then, for each subrequest you start, call	785	the callback and ensure C<end> is called at least once, and then, for each
541	C<begin> and for each subrequest you finish, call C<end>.	786	subrequest you start, call C<begin> and for each subrequest you finish,
		787	call C<end>.
542		788
543	=back	789	=back
544		790
545	=head3 METHODS FOR CONSUMERS	791	=head3 METHODS FOR CONSUMERS
546		792
…		…
550	=over 4	796	=over 4
551		797
552	=item $cv->recv	798	=item $cv->recv
553		799
554	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
555	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
556	normally.	802	normally.
557		803
558	You can only wait once on a condition - additional calls are valid but	804	You can only wait once on a condition - additional calls are valid but
559	will return immediately.	805	will return immediately.
560		806
…		…
562	function will call C<croak>.	808	function will call C<croak>.
563		809
564	In list context, all parameters passed to C<send> will be returned,	810	In list context, all parameters passed to C<send> will be returned,
565	in scalar context only the first one will be returned.	811	in scalar context only the first one will be returned.
566		812
		813	Note that doing a blocking wait in a callback is not supported by any
		814	event loop, that is, recursive invocation of a blocking C<< ->recv
		815	>> is not allowed, and the C<recv> call will C<croak> if such a
		816	condition is detected. This condition can be slightly loosened by using
		817	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		818	any thread that doesn't run the event loop itself.
		819
567	Not all event models support a blocking wait - some die in that case	820	Not all event models support a blocking wait - some die in that case
568	(programs might want to do that to stay interactive), so I<if you are	821	(programs might want to do that to stay interactive), so I<if you are
569	using this from a module, never require a blocking wait>, but let the	822	using this from a module, never require a blocking wait>. Instead, let the
570	caller decide whether the call will block or not (for example, by coupling	823	caller decide whether the call will block or not (for example, by coupling
571	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
572	callbacks so the caller knows that getting the result will not block,	825	callbacks so the caller knows that getting the result will not block,
573	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
574		827
575	Another reason I<never> to C<< ->recv >> in a module is that you cannot
576	sensibly have two C<< ->recv >>'s in parallel, as that would require
577	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
578	can supply.
579
580	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
581	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
582	versions and also integrates coroutines into AnyEvent, making blocking
583	C<< ->recv >> calls perfectly safe as long as they are done from another
584	coroutine (one that doesn't run the event loop).
585
586	You can ensure that C<< -recv >> never blocks by setting a callback and	828	You can ensure that C<< ->recv >> never blocks by setting a callback and
587	only calling C<< ->recv >> from within that callback (or at a later	829	only calling C<< ->recv >> from within that callback (or at a later
588	time). This will work even when the event loop does not support blocking	830	time). This will work even when the event loop does not support blocking
589	waits otherwise.	831	waits otherwise.
590		832
591	=item $bool = $cv->ready	833	=item $bool = $cv->ready
592		834
593	Returns true when the condition is "true", i.e. whether C<send> or	835	Returns true when the condition is "true", i.e. whether C<send> or
594	C<croak> have been called.	836	C<croak> have been called.
595		837
596	=item $cb = $cv->cb ([new callback])	838	=item $cb = $cv->cb ($cb->($cv))
597		839
598	This is a mutator function that returns the callback set and optionally	840	This is a mutator function that returns the callback set and optionally
599	replaces it before doing so.	841	replaces it before doing so.
600		842
601	The callback will be called when the condition becomes "true", i.e. when	843	The callback will be called when the condition becomes "true", i.e. when
602	C<send> or C<croak> are called, with the only argument being the condition	844	C<send> or C<croak> are called, with the only argument being the
603	variable itself. Calling C<recv> inside the callback or at any later time	845	condition variable itself. If the condition is already true, the
604	is guaranteed not to block.	846	callback is called immediately when it is set. Calling C<recv> inside
		847	the callback or at any later time is guaranteed not to block.
605		848
606	=back	849	=back
607		850
		851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		852
		853	The available backend classes are (every class has its own manpage):
		854
		855	=over 4
		856
		857	=item Backends that are autoprobed when no other event loop can be found.
		858
		859	EV is the preferred backend when no other event loop seems to be in
		860	use. If EV is not installed, then AnyEvent will fall back to its own
		861	pure-perl implementation, which is available everywhere as it comes with
		862	AnyEvent itself.
		863
		864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
		866
		867	=item Backends that are transparently being picked up when they are used.
		868
		869	These will be used if they are already loaded when the first watcher
		870	is created, in which case it is assumed that the application is using
		871	them. This means that AnyEvent will automatically pick the right backend
		872	when the main program loads an event module before anything starts to
		873	create watchers. Nothing special needs to be done by the main program.
		874
		875	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		877	AnyEvent::Impl::Tk based on Tk, very broken.
		878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		880	AnyEvent::Impl::Irssi used when running within irssi.
		881	AnyEvent::Impl::IOAsync based on IO::Async.
		882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		883	AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
		884
		885	=item Backends with special needs.
		886
		887	Qt requires the Qt::Application to be instantiated first, but will
		888	otherwise be picked up automatically. As long as the main program
		889	instantiates the application before any AnyEvent watchers are created,
		890	everything should just work.
		891
		892	AnyEvent::Impl::Qt based on Qt.
		893
		894	=item Event loops that are indirectly supported via other backends.
		895
		896	Some event loops can be supported via other modules:
		897
		898	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		899
		900	B<WxWidgets> has no support for watching file handles. However, you can
		901	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		902	polls 20 times per second, which was considered to be too horrible to even
		903	consider for AnyEvent.
		904
		905	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		906	backend, so it can be supported through POE.
		907
		908	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		909	load L<POE> when detecting them, in the hope that POE will pick them up,
		910	in which case everything will be automatic.
		911
		912	=back
		913
608	=head1 GLOBAL VARIABLES AND FUNCTIONS	914	=head1 GLOBAL VARIABLES AND FUNCTIONS
609		915
		916	These are not normally required to use AnyEvent, but can be useful to
		917	write AnyEvent extension modules.
		918
610	=over 4	919	=over 4
611		920
612	=item $AnyEvent::MODEL	921	=item $AnyEvent::MODEL
613		922
614	Contains C<undef> until the first watcher is being created. Then it	923	Contains C<undef> until the first watcher is being created, before the
		924	backend has been autodetected.
		925
615	contains the event model that is being used, which is the name of the	926	Afterwards it contains the event model that is being used, which is the
616	Perl class implementing the model. This class is usually one of the	927	name of the Perl class implementing the model. This class is usually one
617	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	928	of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
618	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	929	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
619		930	will be C<urxvt::anyevent>).
620	The known classes so far are:
621
622	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
623	AnyEvent::Impl::Event based on Event, second best choice.
624	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
625	AnyEvent::Impl::Glib based on Glib, third-best choice.
626	AnyEvent::Impl::Tk based on Tk, very bad choice.
627	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
628	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
629	AnyEvent::Impl::POE based on POE, not generic enough for full support.
630
631	There is no support for WxWidgets, as WxWidgets has no support for
632	watching file handles. However, you can use WxWidgets through the
633	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
634	second, which was considered to be too horrible to even consider for
635	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
636	it's adaptor.
637
638	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
639	autodetecting them.
640		931
641	=item AnyEvent::detect	932	=item AnyEvent::detect
642		933
643	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
644	if necessary. You should only call this function right before you would	935	if necessary. You should only call this function right before you would
645	have created an AnyEvent watcher anyway, that is, as late as possible at	936	have created an AnyEvent watcher anyway, that is, as late as possible at
646	runtime.	937	runtime, and not e.g. during initialisation of your module.
		938
		939	The effect of calling this function is as if a watcher had been created
		940	(specifically, actions that happen "when the first watcher is created"
		941	happen when calling detetc as well).
		942
		943	If you need to do some initialisation before AnyEvent watchers are
		944	created, use C<post_detect>.
647		945
648	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
649		947
650	Arranges for the code block to be executed as soon as the event model is	948	Arranges for the code block to be executed as soon as the event model is
651	autodetected (or immediately if this has already happened).	949	autodetected (or immediately if that has already happened).
		950
		951	The block will be executed I<after> the actual backend has been detected
		952	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		953	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		954	other initialisations - see the sources of L<AnyEvent::Strict> or
		955	L<AnyEvent::AIO> to see how this is used.
		956
		957	The most common usage is to create some global watchers, without forcing
		958	event module detection too early, for example, L<AnyEvent::AIO> creates
		959	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		960	avoid autodetecting the event module at load time.
652		961
653	If called in scalar or list context, then it creates and returns an object	962	If called in scalar or list context, then it creates and returns an object
654	that automatically removes the callback again when it is destroyed. See	963	that automatically removes the callback again when it is destroyed (or
		964	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
655	L<Coro::BDB> for a case where this is useful.	965	a case where this is useful.
		966
		967	Example: Create a watcher for the IO::AIO module and store it in
		968	C<$WATCHER>, but do so only do so after the event loop is initialised.
		969
		970	our WATCHER;
		971
		972	my $guard = AnyEvent::post_detect {
		973	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		974	};
		975
		976	# the ||= is important in case post_detect immediately runs the block,
		977	# as to not clobber the newly-created watcher. assigning both watcher and
		978	# post_detect guard to the same variable has the advantage of users being
		979	# able to just C<undef $WATCHER> if the watcher causes them grief.
		980
		981	$WATCHER ||= $guard;
656		982
657	=item @AnyEvent::post_detect	983	=item @AnyEvent::post_detect
658		984
659	If there are any code references in this array (you can C<push> to it	985	If there are any code references in this array (you can C<push> to it
660	before or after loading AnyEvent), then they will called directly after	986	before or after loading AnyEvent), then they will be called directly
661	the event loop has been chosen.	987	after the event loop has been chosen.
662		988
663	You should check C<$AnyEvent::MODEL> before adding to this array, though:	989	You should check C<$AnyEvent::MODEL> before adding to this array, though:
664	if it contains a true value then the event loop has already been detected,	990	if it is defined then the event loop has already been detected, and the
665	and the array will be ignored.	991	array will be ignored.
666		992
667	Best use C<AnyEvent::post_detect { BLOCK }> instead.	993	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		994	it, as it takes care of these details.
		995
		996	This variable is mainly useful for modules that can do something useful
		997	when AnyEvent is used and thus want to know when it is initialised, but do
		998	not need to even load it by default. This array provides the means to hook
		999	into AnyEvent passively, without loading it.
		1000
		1001	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1002	together, you could put this into Coro (this is the actual code used by
		1003	Coro to accomplish this):
		1004
		1005	if (defined $AnyEvent::MODEL) {
		1006	# AnyEvent already initialised, so load Coro::AnyEvent
		1007	require Coro::AnyEvent;
		1008	} else {
		1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1010	# as soon as it is
		1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1012	}
		1013
		1014	=item AnyEvent::postpone { BLOCK }
		1015
		1016	Arranges for the block to be executed as soon as possible, but not before
		1017	the call itself returns. In practise, the block will be executed just
		1018	before the event loop polls for new events, or shortly afterwards.
		1019
		1020	This function never returns anything (to make the C<return postpone { ...
		1021	}> idiom more useful.
		1022
		1023	To understand the usefulness of this function, consider a function that
		1024	asynchronously does something for you and returns some transaction
		1025	object or guard to let you cancel the operation. For example,
		1026	C<AnyEvent::Socket::tcp_connect>:
		1027
		1028	# start a conenction attempt unless one is active
		1029	$self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1030	delete $self->{connect_guard};
		1031	...
		1032	};
		1033
		1034	Imagine that this function could instantly call the callback, for
		1035	example, because it detects an obvious error such as a negative port
		1036	number. Invoking the callback before the function returns causes problems
		1037	however: the callback will be called and will try to delete the guard
		1038	object. But since the function hasn't returned yet, there is nothing to
		1039	delete. When the function eventually returns it will assign the guard
		1040	object to C<< $self->{connect_guard} >>, where it will likely never be
		1041	deleted, so the program thinks it is still trying to connect.
		1042
		1043	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1044	callback directly on error:
		1045
		1046	$cb->(undef), return # signal error to callback, BAD!
		1047	if $some_error_condition;
		1048
		1049	It should use C<postpone>:
		1050
		1051	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1052	if $some_error_condition;
		1053
		1054	=item AnyEvent::log $level, $msg[, @args]
		1055
		1056	Log the given C<$msg> at the given C<$level>.
		1057
		1058	Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> -
		1059	consequently, look at the L<AnyEvent::Log> documentation for details.
		1060
		1061	If you want to sprinkle loads of logging calls around your code, consider
		1062	creating a logger callback with the C<AnyEvent::Log::logger< function.
668		1063
669	=back	1064	=back
670		1065
671	=head1 WHAT TO DO IN A MODULE	1066	=head1 WHAT TO DO IN A MODULE
672		1067
…		…
683	because it will stall the whole program, and the whole point of using	1078	because it will stall the whole program, and the whole point of using
684	events is to stay interactive.	1079	events is to stay interactive.
685		1080
686	It is fine, however, to call C<< ->recv >> when the user of your module	1081	It is fine, however, to call C<< ->recv >> when the user of your module
687	requests it (i.e. if you create a http request object ad have a method	1082	requests it (i.e. if you create a http request object ad have a method
688	called C<results> that returns the results, it should call C<< ->recv >>	1083	called C<results> that returns the results, it may call C<< ->recv >>
689	freely, as the user of your module knows what she is doing. always).	1084	freely, as the user of your module knows what she is doing. Always).
690		1085
691	=head1 WHAT TO DO IN THE MAIN PROGRAM	1086	=head1 WHAT TO DO IN THE MAIN PROGRAM
692		1087
693	There will always be a single main program - the only place that should	1088	There will always be a single main program - the only place that should
694	dictate which event model to use.	1089	dictate which event model to use.
695		1090
696	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1091	If the program is not event-based, it need not do anything special, even
697	do anything special (it does not need to be event-based) and let AnyEvent	1092	when it depends on a module that uses an AnyEvent. If the program itself
698	decide which implementation to chose if some module relies on it.	1093	uses AnyEvent, but does not care which event loop is used, all it needs
		1094	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1095	available loop implementation.
699		1096
700	If the main program relies on a specific event model - for example, in	1097	If the main program relies on a specific event model - for example, in
701	Gtk2 programs you have to rely on the Glib module - you should load the	1098	Gtk2 programs you have to rely on the Glib module - you should load the
702	event module before loading AnyEvent or any module that uses it: generally	1099	event module before loading AnyEvent or any module that uses it: generally
703	speaking, you should load it as early as possible. The reason is that	1100	speaking, you should load it as early as possible. The reason is that
704	modules might create watchers when they are loaded, and AnyEvent will	1101	modules might create watchers when they are loaded, and AnyEvent will
705	decide on the event model to use as soon as it creates watchers, and it	1102	decide on the event model to use as soon as it creates watchers, and it
706	might chose the wrong one unless you load the correct one yourself.	1103	might choose the wrong one unless you load the correct one yourself.
707		1104
708	You can chose to use a pure-perl implementation by loading the	1105	You can chose to use a pure-perl implementation by loading the
709	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1106	C<AnyEvent::Loop> module, which gives you similar behaviour
710	everywhere, but letting AnyEvent chose the model is generally better.	1107	everywhere, but letting AnyEvent chose the model is generally better.
711		1108
712	=head2 MAINLOOP EMULATION	1109	=head2 MAINLOOP EMULATION
713		1110
714	Sometimes (often for short test scripts, or even standalone programs who	1111	Sometimes (often for short test scripts, or even standalone programs who
…		…
727		1124
728		1125
729	=head1 OTHER MODULES	1126	=head1 OTHER MODULES
730		1127
731	The following is a non-exhaustive list of additional modules that use	1128	The following is a non-exhaustive list of additional modules that use
732	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1129	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
733	in the same program. Some of the modules come with AnyEvent, some are	1130	modules and other event loops in the same program. Some of the modules
734	available via CPAN.	1131	come as part of AnyEvent, the others are available via CPAN.
735		1132
736	=over 4	1133	=over 4
737		1134
738	=item L<AnyEvent::Util>	1135	=item L<AnyEvent::Util>
739		1136
740	Contains various utility functions that replace often-used but blocking	1137	Contains various utility functions that replace often-used blocking
741	functions such as C<inet_aton> by event-/callback-based versions.	1138	functions such as C<inet_aton> with event/callback-based versions.
742
743	=item L<AnyEvent::Handle>
744
745	Provide read and write buffers and manages watchers for reads and writes.
746		1139
747	=item L<AnyEvent::Socket>	1140	=item L<AnyEvent::Socket>
748		1141
749	Provides various utility functions for (internet protocol) sockets,	1142	Provides various utility functions for (internet protocol) sockets,
750	addresses and name resolution. Also functions to create non-blocking tcp	1143	addresses and name resolution. Also functions to create non-blocking tcp
751	connections or tcp servers, with IPv6 and SRV record support and more.	1144	connections or tcp servers, with IPv6 and SRV record support and more.
752		1145
		1146	=item L<AnyEvent::Handle>
		1147
		1148	Provide read and write buffers, manages watchers for reads and writes,
		1149	supports raw and formatted I/O, I/O queued and fully transparent and
		1150	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
		1151
753	=item L<AnyEvent::DNS>	1152	=item L<AnyEvent::DNS>
754		1153
755	Provides rich asynchronous DNS resolver capabilities.	1154	Provides rich asynchronous DNS resolver capabilities.
756		1155
		1156	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1157
		1158	Implement event-based interfaces to the protocols of the same name (for
		1159	the curious, IGS is the International Go Server and FCP is the Freenet
		1160	Client Protocol).
		1161
		1162	=item L<AnyEvent::Handle::UDP>
		1163
		1164	Here be danger!
		1165
		1166	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1167	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1168	its use of a stream-based API with a protocol that isn't streamable, that
		1169	the only way to improve it is to delete it.
		1170
		1171	It features data corruption (but typically only under load) and general
		1172	confusion. On top, the author is not only clueless about UDP but also
		1173	fact-resistant - some gems of his understanding: "connect doesn't work
		1174	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1175	packets", "I don't need to implement proper error checking as UDP doesn't
		1176	support error checking" and so on - he doesn't even understand what's
		1177	wrong with his module when it is explained to him.
		1178
757	=item L<AnyEvent::HTTP>	1179	=item L<AnyEvent::DBI>
758		1180
759	A simple-to-use HTTP library that is capable of making a lot of concurrent	1181	Executes L<DBI> requests asynchronously in a proxy process for you,
760	HTTP requests.	1182	notifying you in an event-based way when the operation is finished.
		1183
		1184	=item L<AnyEvent::AIO>
		1185
		1186	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1187	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1188	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1189	file I/O, and much more.
761		1190
762	=item L<AnyEvent::HTTPD>	1191	=item L<AnyEvent::HTTPD>
763		1192
764	Provides a simple web application server framework.	1193	A simple embedded webserver.
765		1194
766	=item L<AnyEvent::FastPing>	1195	=item L<AnyEvent::FastPing>
767		1196
768	The fastest ping in the west.	1197	The fastest ping in the west.
769		1198
770	=item L<AnyEvent::DBI>
771
772	Executes DBI requests asynchronously in a proxy process.
773
774	=item L<Net::IRC3>
775
776	AnyEvent based IRC client module family.
777
778	=item L<Net::XMPP2>
779
780	AnyEvent based XMPP (Jabber protocol) module family.
781
782	=item L<Net::FCP>
783
784	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
785	of AnyEvent.
786
787	=item L<Event::ExecFlow>
788
789	High level API for event-based execution flow control.
790
791	=item L<Coro>	1199	=item L<Coro>
792		1200
793	Has special support for AnyEvent via L<Coro::AnyEvent>.	1201	Has special support for AnyEvent via L<Coro::AnyEvent>.
794		1202
795	=item L<AnyEvent::AIO>, L<IO::AIO>
796
797	Truly asynchronous I/O, should be in the toolbox of every event
798	programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
799	together.
800
801	=item L<AnyEvent::BDB>, L<BDB>
802
803	Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
804	IO::AIO and AnyEvent together.
805
806	=item L<IO::Lambda>
807
808	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
809
810	=back	1203	=back
811		1204
812	=cut	1205	=cut
813		1206
814	package AnyEvent;	1207	package AnyEvent;
815		1208
816	no warnings;	1209	# basically a tuned-down version of common::sense
817	use strict;	1210	sub common_sense {
		1211	# from common:.sense 3.4
		1212	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
		1213	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
		1214	$^H |= 0x00000600;
		1215	}
818		1216
		1217	BEGIN { AnyEvent::common_sense }
		1218
819	use Carp;	1219	use Carp ();
820		1220
821	our $VERSION = 4.151;	1221	our $VERSION = '6.01';
822	our $MODEL;	1222	our $MODEL;
823		1223
824	our $AUTOLOAD;
825	our @ISA;	1224	our @ISA;
826		1225
827	our @REGISTRY;	1226	our @REGISTRY;
828		1227
829	our $WIN32;	1228	our $VERBOSE;
830		1229
831	BEGIN {	1230	BEGIN {
832	my $win32 = ! ! ($^O =~ /mswin32/i);	1231	require "AnyEvent/constants.pl";
833	eval "sub WIN32(){ $win32 }";
834	}
835		1232
		1233	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
		1234
		1235	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1236	if ${^TAINT};
		1237
836	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1238	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1239	}
		1240
		1241	our $MAX_SIGNAL_LATENCY = 10;
837		1242
838	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1243	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
839		1244
840	{	1245	{
841	my $idx;	1246	my $idx;
842	$PROTOCOL{$_} = ++$idx	1247	$PROTOCOL{$_} = ++$idx
843	for reverse split /\s*,\s*/,	1248	for reverse split /\s*,\s*/,
844	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1249	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
845	}	1250	}
846		1251
		1252	our @post_detect;
		1253
		1254	sub post_detect(&) {
		1255	my ($cb) = @_;
		1256
		1257	push @post_detect, $cb;
		1258
		1259	defined wantarray
		1260	? bless \$cb, "AnyEvent::Util::postdetect"
		1261	: ()
		1262	}
		1263
		1264	sub AnyEvent::Util::postdetect::DESTROY {
		1265	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1266	}
		1267
		1268	our $POSTPONE_W;
		1269	our @POSTPONE;
		1270
		1271	sub _postpone_exec {
		1272	undef $POSTPONE_W;
		1273
		1274	&{ shift @POSTPONE }
		1275	while @POSTPONE;
		1276	}
		1277
		1278	sub postpone(&) {
		1279	push @POSTPONE, shift;
		1280
		1281	$POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
		1282
		1283	()
		1284	}
		1285
		1286	sub log($$;@) {
		1287	require AnyEvent::Log;
		1288	# AnyEvent::Log overwrites this function
		1289	goto &log;
		1290	}
		1291
847	my @models = (	1292	our @models = (
848	[EV:: => AnyEvent::Impl::EV::],	1293	[EV:: => AnyEvent::Impl::EV:: , 1],
849	[Event:: => AnyEvent::Impl::Event::],	1294	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
850	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
851	# everything below here will not be autoprobed	1295	# everything below here will not (normally) be autoprobed
852	# as the pureperl backend should work everywhere	1296	# as the pure perl backend should work everywhere
853	# and is usually faster	1297	# and is usually faster
		1298	[Event:: => AnyEvent::Impl::Event::, 1],
		1299	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1300	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1301	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
854	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1302	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
855	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
856	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
857	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1303	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
858	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1304	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
859	[Wx:: => AnyEvent::Impl::POE::],	1305	[Wx:: => AnyEvent::Impl::POE::],
860	[Prima:: => AnyEvent::Impl::POE::],	1306	[Prima:: => AnyEvent::Impl::POE::],
		1307	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
		1308	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
		1309	[FLTK:: => AnyEvent::Impl::FLTK2::],
861	);	1310	);
862		1311
863	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);	1312	our @isa_hook;
864		1313
865	our @post_detect;	1314	sub _isa_set {
		1315	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
866		1316
		1317	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1318	for 1 .. $#pkg;
		1319
		1320	grep $_ && $_->[1], @isa_hook
		1321	and AE::_reset ();
		1322	}
		1323
		1324	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1325	sub _isa_hook($$;$) {
		1326	my ($i, $pkg, $reset_ae) = @_;
		1327
		1328	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1329
		1330	_isa_set;
		1331	}
		1332
		1333	# all autoloaded methods reserve the complete glob, not just the method slot.
		1334	# due to bugs in perls method cache implementation.
		1335	our @methods = qw(io timer time now now_update signal child idle condvar);
		1336
867	sub post_detect(&) {	1337	sub detect() {
868	my ($cb) = @_;	1338	return $MODEL if $MODEL; # some programs keep references to detect
869		1339
870	if ($MODEL) {	1340	local $!; # for good measure
871	$cb->();	1341	local $SIG{__DIE__}; # we use eval
872		1342
873	1	1343	# free some memory
		1344	*detect = sub () { $MODEL };
		1345	# undef &func doesn't correctly update the method cache. grmbl.
		1346	# so we delete the whole glob. grmbl.
		1347	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1348	# a glob with an active sub. hrm. i hope it works, but perl is
		1349	# usually buggy in this department. sigh.
		1350	delete @{"AnyEvent::"}{@methods};
		1351	undef @methods;
		1352
		1353	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
		1354	my $model = $1;
		1355	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
		1356	if (eval "require $model") {
		1357	$MODEL = $model;
		1358	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
		1359	if $VERBOSE >= 7;
874	} else {	1360	} else {
875	push @post_detect, $cb;	1361	AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
876		1362	}
877	defined wantarray
878	? bless \$cb, "AnyEvent::Util::PostDetect"
879	: ()
880	}	1363	}
881	}
882		1364
883	sub AnyEvent::Util::PostDetect::DESTROY {	1365	# check for already loaded models
884	@post_detect = grep $_ != ${$_[0]}, @post_detect;
885	}
886
887	sub detect() {
888	unless ($MODEL) {	1366	unless ($MODEL) {
889	no strict 'refs';	1367	for (@REGISTRY, @models) {
890	local $SIG{__DIE__};	1368	my ($package, $model) = @$_;
891		1369	if (${"$package\::VERSION"} > 0) {
892	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
893	my $model = "AnyEvent::Impl::$1";
894	if (eval "require $model") {	1370	if (eval "require $model") {
895	$MODEL = $model;	1371	$MODEL = $model;
896	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1372	AnyEvent::log 7 => "autodetected model '$model', using it."
897	} else {	1373	if $VERBOSE >= 7;
898	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1374	last;
		1375	}
899	}	1376	}
900	}	1377	}
901		1378
902	# check for already loaded models
903	unless ($MODEL) {	1379	unless ($MODEL) {
		1380	# try to autoload a model
904	for (@REGISTRY, @models) {	1381	for (@REGISTRY, @models) {
905	my ($package, $model) = @$_;	1382	my ($package, $model, $autoload) = @$_;
		1383	if (
		1384	$autoload
		1385	and eval "require $package"
906	if (${"$package\::VERSION"} > 0) {	1386	and ${"$package\::VERSION"} > 0
907	if (eval "require $model") {	1387	and eval "require $model"
		1388	) {
908	$MODEL = $model;	1389	$MODEL = $model;
909	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1390	AnyEvent::log 7 => "autoloaded model '$model', using it."
		1391	if $VERBOSE >= 7;
910	last;	1392	last;
911	}
912	}	1393	}
913	}	1394	}
914		1395
915	unless ($MODEL) {	1396	$MODEL
916	# try to load a model	1397	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
		1398	}
		1399	}
917		1400
918	for (@REGISTRY, @models) {	1401	# free memory only needed for probing
919	my ($package, $model) = @$_;	1402	undef @models;
920	if (eval "require $package"	1403	undef @REGISTRY;
921	and ${"$package\::VERSION"} > 0	1404
922	and eval "require $model") {	1405	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
923	$MODEL = $model;	1406
924	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1407	# now nuke some methods that are overridden by the backend.
		1408	# SUPER usage is not allowed in these.
		1409	for (qw(time signal child idle)) {
		1410	undef &{"AnyEvent::Base::$_"}
		1411	if defined &{"$MODEL\::$_"};
		1412	}
		1413
		1414	_isa_set;
		1415
		1416	# we're officially open!
		1417
		1418	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1419	require AnyEvent::Strict;
		1420	}
		1421
		1422	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1423	require AnyEvent::Debug;
		1424	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1425	}
		1426
		1427	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1428	require AnyEvent::Socket;
		1429	require AnyEvent::Debug;
		1430
		1431	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1432	$shell =~ s/\$\$/$$/g;
		1433
		1434	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1435	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1436	}
		1437
		1438	# now the anyevent environment is set up as the user told us to, so
		1439	# call the actual user code - post detects
		1440
		1441	(shift @post_detect)->() while @post_detect;
		1442	undef @post_detect;
		1443
		1444	*post_detect = sub(&) {
		1445	shift->();
		1446
		1447	undef
		1448	};
		1449
		1450	$MODEL
		1451	}
		1452
		1453	for my $name (@methods) {
		1454	*$name = sub {
		1455	detect;
		1456	# we use goto because
		1457	# a) it makes the thunk more transparent
		1458	# b) it allows us to delete the thunk later
		1459	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
		1460	};
		1461	}
		1462
		1463	# utility function to dup a filehandle. this is used by many backends
		1464	# to support binding more than one watcher per filehandle (they usually
		1465	# allow only one watcher per fd, so we dup it to get a different one).
		1466	sub _dupfh($$;$$) {
		1467	my ($poll, $fh, $r, $w) = @_;
		1468
		1469	# cygwin requires the fh mode to be matching, unix doesn't
		1470	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
		1471
		1472	open my $fh2, $mode, $fh
		1473	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
		1474
		1475	# we assume CLOEXEC is already set by perl in all important cases
		1476
		1477	($fh2, $rw)
		1478	}
		1479
		1480	=head1 SIMPLIFIED AE API
		1481
		1482	Starting with version 5.0, AnyEvent officially supports a second, much
		1483	simpler, API that is designed to reduce the calling, typing and memory
		1484	overhead by using function call syntax and a fixed number of parameters.
		1485
		1486	See the L<AE> manpage for details.
		1487
		1488	=cut
		1489
		1490	package AE;
		1491
		1492	our $VERSION = $AnyEvent::VERSION;
		1493
		1494	sub _reset() {
		1495	eval q{
		1496	# fall back to the main API by default - backends and AnyEvent::Base
		1497	# implementations can overwrite these.
		1498
		1499	sub io($$$) {
		1500	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1501	}
		1502
		1503	sub timer($$$) {
		1504	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1505	}
		1506
		1507	sub signal($$) {
		1508	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1509	}
		1510
		1511	sub child($$) {
		1512	AnyEvent->child (pid => $_[0], cb => $_[1])
		1513	}
		1514
		1515	sub idle($) {
		1516	AnyEvent->idle (cb => $_[0]);
		1517	}
		1518
		1519	sub cv(;&) {
		1520	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1521	}
		1522
		1523	sub now() {
		1524	AnyEvent->now
		1525	}
		1526
		1527	sub now_update() {
		1528	AnyEvent->now_update
		1529	}
		1530
		1531	sub time() {
		1532	AnyEvent->time
		1533	}
		1534
		1535	*postpone = \&AnyEvent::postpone;
		1536	*log = \&AnyEvent::log;
		1537	};
		1538	die if $@;
		1539	}
		1540
		1541	BEGIN { _reset }
		1542
		1543	package AnyEvent::Base;
		1544
		1545	# default implementations for many methods
		1546
		1547	sub time {
		1548	eval q{ # poor man's autoloading {}
		1549	# probe for availability of Time::HiRes
		1550	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1551	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
		1552	if $AnyEvent::VERBOSE >= 8;
		1553	*time = sub { Time::HiRes::time () };
		1554	*AE::time = \& Time::HiRes::time ;
		1555	# if (eval "use POSIX (); (POSIX::times())...
		1556	} else {
		1557	AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
		1558	*time = sub { CORE::time };
		1559	*AE::time = sub (){ CORE::time };
		1560	}
		1561
		1562	*now = \&time;
		1563	};
		1564	die if $@;
		1565
		1566	&time
		1567	}
		1568
		1569	*now = \&time;
		1570	sub now_update { }
		1571
		1572	sub _poll {
		1573	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1574	}
		1575
		1576	# default implementation for ->condvar
		1577	# in fact, the default should not be overwritten
		1578
		1579	sub condvar {
		1580	eval q{ # poor man's autoloading {}
		1581	*condvar = sub {
		1582	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1583	};
		1584
		1585	*AE::cv = sub (;&) {
		1586	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1587	};
		1588	};
		1589	die if $@;
		1590
		1591	&condvar
		1592	}
		1593
		1594	# default implementation for ->signal
		1595
		1596	our $HAVE_ASYNC_INTERRUPT;
		1597
		1598	sub _have_async_interrupt() {
		1599	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1600	&& eval "use Async::Interrupt 1.02 (); 1")
		1601	unless defined $HAVE_ASYNC_INTERRUPT;
		1602
		1603	$HAVE_ASYNC_INTERRUPT
		1604	}
		1605
		1606	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1607	our (%SIG_ASY, %SIG_ASY_W);
		1608	our ($SIG_COUNT, $SIG_TW);
		1609
		1610	# install a dummy wakeup watcher to reduce signal catching latency
		1611	# used by Impls
		1612	sub _sig_add() {
		1613	unless ($SIG_COUNT++) {
		1614	# try to align timer on a full-second boundary, if possible
		1615	my $NOW = AE::now;
		1616
		1617	$SIG_TW = AE::timer
		1618	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1619	$MAX_SIGNAL_LATENCY,
		1620	sub { } # just for the PERL_ASYNC_CHECK
		1621	;
		1622	}
		1623	}
		1624
		1625	sub _sig_del {
		1626	undef $SIG_TW
		1627	unless --$SIG_COUNT;
		1628	}
		1629
		1630	our $_sig_name_init; $_sig_name_init = sub {
		1631	eval q{ # poor man's autoloading {}
		1632	undef $_sig_name_init;
		1633
		1634	if (_have_async_interrupt) {
		1635	*sig2num = \&Async::Interrupt::sig2num;
		1636	*sig2name = \&Async::Interrupt::sig2name;
		1637	} else {
		1638	require Config;
		1639
		1640	my %signame2num;
		1641	@signame2num{ split ' ', $Config::Config{sig_name} }
		1642	= split ' ', $Config::Config{sig_num};
		1643
		1644	my @signum2name;
		1645	@signum2name[values %signame2num] = keys %signame2num;
		1646
		1647	*sig2num = sub($) {
		1648	$_[0] > 0 ? shift : $signame2num{+shift}
		1649	};
		1650	*sig2name = sub ($) {
		1651	$_[0] > 0 ? $signum2name[+shift] : shift
		1652	};
		1653	}
		1654	};
		1655	die if $@;
		1656	};
		1657
		1658	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1659	sub sig2name($) { &$_sig_name_init; &sig2name }
		1660
		1661	sub signal {
		1662	eval q{ # poor man's autoloading {}
		1663	# probe for availability of Async::Interrupt
		1664	if (_have_async_interrupt) {
		1665	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
		1666	if $AnyEvent::VERBOSE >= 8;
		1667
		1668	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1669	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1670
		1671	} else {
		1672	AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
		1673	if $AnyEvent::VERBOSE >= 8;
		1674
		1675	if (AnyEvent::WIN32) {
		1676	require AnyEvent::Util;
		1677
		1678	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1679	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1680	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1681	} else {
		1682	pipe $SIGPIPE_R, $SIGPIPE_W;
		1683	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
		1684	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
		1685
		1686	# not strictly required, as $^F is normally 2, but let's make sure...
		1687	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1688	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1689	}
		1690
		1691	$SIGPIPE_R
		1692	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1693
		1694	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1695	}
		1696
		1697	*signal = $HAVE_ASYNC_INTERRUPT
		1698	? sub {
		1699	my (undef, %arg) = @_;
		1700
		1701	# async::interrupt
		1702	my $signal = sig2num $arg{signal};
		1703	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1704
		1705	$SIG_ASY{$signal} ||= new Async::Interrupt
		1706	cb => sub { undef $SIG_EV{$signal} },
		1707	signal => $signal,
		1708	pipe => [$SIGPIPE_R->filenos],
		1709	pipe_autodrain => 0,
		1710	;
		1711
		1712	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1713	}
		1714	: sub {
		1715	my (undef, %arg) = @_;
		1716
		1717	# pure perl
		1718	my $signal = sig2name $arg{signal};
		1719	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1720
		1721	$SIG{$signal} ||= sub {
925	last;	1722	local $!;
		1723	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1724	undef $SIG_EV{$signal};
926	}	1725	};
		1726
		1727	# can't do signal processing without introducing races in pure perl,
		1728	# so limit the signal latency.
		1729	_sig_add;
		1730
		1731	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1732	}
		1733	;
		1734
		1735	*AnyEvent::Base::signal::DESTROY = sub {
		1736	my ($signal, $cb) = @{$_[0]};
		1737
		1738	_sig_del;
		1739
		1740	delete $SIG_CB{$signal}{$cb};
		1741
		1742	$HAVE_ASYNC_INTERRUPT
		1743	? delete $SIG_ASY{$signal}
		1744	: # delete doesn't work with older perls - they then
		1745	# print weird messages, or just unconditionally exit
		1746	# instead of getting the default action.
		1747	undef $SIG{$signal}
		1748	unless keys %{ $SIG_CB{$signal} };
		1749	};
		1750
		1751	*_signal_exec = sub {
		1752	$HAVE_ASYNC_INTERRUPT
		1753	? $SIGPIPE_R->drain
		1754	: sysread $SIGPIPE_R, (my $dummy), 9;
		1755
		1756	while (%SIG_EV) {
		1757	for (keys %SIG_EV) {
		1758	delete $SIG_EV{$_};
		1759	&$_ for values %{ $SIG_CB{$_} || {} };
927	}	1760	}
928
929	$MODEL
930	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
931	}	1761	}
932	}	1762	};
933
934	unshift @ISA, $MODEL;
935	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
936
937	(shift @post_detect)->() while @post_detect;
938	}
939
940	$MODEL
941	}
942
943	sub AUTOLOAD {
944	(my $func = $AUTOLOAD) =~ s/.*://;
945
946	$method{$func}
947	or croak "$func: not a valid method for AnyEvent objects";
948
949	detect unless $MODEL;
950
951	my $class = shift;
952	$class->$func (@_);
953	}
954
955	package AnyEvent::Base;
956
957	# default implementation for now and time
958
959	use Time::HiRes ();
960
961	sub time { Time::HiRes::time }
962	sub now { Time::HiRes::time }
963
964	# default implementation for ->condvar
965
966	sub condvar {
967	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
968	}
969
970	# default implementation for ->signal
971
972	our %SIG_CB;
973
974	sub signal {
975	my (undef, %arg) = @_;
976
977	my $signal = uc $arg{signal}
978	or Carp::croak "required option 'signal' is missing";
979
980	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
981	$SIG{$signal} ||= sub {
982	$_->() for values %{ $SIG_CB{$signal} || {} };
983	};	1763	};
		1764	die if $@;
984		1765
985	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1766	&signal
986	}
987
988	sub AnyEvent::Base::Signal::DESTROY {
989	my ($signal, $cb) = @{$_[0]};
990
991	delete $SIG_CB{$signal}{$cb};
992
993	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };
994	}	1767	}
995		1768
996	# default implementation for ->child	1769	# default implementation for ->child
997		1770
998	our %PID_CB;	1771	our %PID_CB;
999	our $CHLD_W;	1772	our $CHLD_W;
1000	our $CHLD_DELAY_W;	1773	our $CHLD_DELAY_W;
1001	our $PID_IDLE;
1002	our $WNOHANG;
1003		1774
1004	sub _child_wait {	1775	# used by many Impl's
1005	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1776	sub _emit_childstatus($$) {
		1777	my (undef, $rpid, $rstatus) = @_;
		1778
		1779	$_->($rpid, $rstatus)
1006	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1780	for values %{ $PID_CB{$rpid} || {} },
1007	(values %{ $PID_CB{0} || {} });	1781	values %{ $PID_CB{0} || {} };
1008	}
1009
1010	undef $PID_IDLE;
1011	}
1012
1013	sub _sigchld {
1014	# make sure we deliver these changes "synchronous" with the event loop.
1015	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1016	undef $CHLD_DELAY_W;
1017	&_child_wait;
1018	});
1019	}	1782	}
1020		1783
1021	sub child {	1784	sub child {
		1785	eval q{ # poor man's autoloading {}
		1786	*_sigchld = sub {
		1787	my $pid;
		1788
		1789	AnyEvent->_emit_childstatus ($pid, $?)
		1790	while ($pid = waitpid -1, WNOHANG) > 0;
		1791	};
		1792
		1793	*child = sub {
1022	my (undef, %arg) = @_;	1794	my (undef, %arg) = @_;
1023		1795
1024	defined (my $pid = $arg{pid} + 0)	1796	my $pid = $arg{pid};
1025	or Carp::croak "required option 'pid' is missing";	1797	my $cb = $arg{cb};
1026		1798
1027	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1799	$PID_CB{$pid}{$cb+0} = $cb;
1028		1800
1029	unless ($WNOHANG) {
1030	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1031	}
1032
1033	unless ($CHLD_W) {	1801	unless ($CHLD_W) {
1034	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1802	$CHLD_W = AE::signal CHLD => \&_sigchld;
1035	# child could be a zombie already, so make at least one round	1803	# child could be a zombie already, so make at least one round
1036	&_sigchld;	1804	&_sigchld;
1037	}	1805	}
1038		1806
1039	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1807	bless [$pid, $cb+0], "AnyEvent::Base::child"
1040	}	1808	};
1041		1809
1042	sub AnyEvent::Base::Child::DESTROY {	1810	*AnyEvent::Base::child::DESTROY = sub {
1043	my ($pid, $cb) = @{$_[0]};	1811	my ($pid, $icb) = @{$_[0]};
1044		1812
1045	delete $PID_CB{$pid}{$cb};	1813	delete $PID_CB{$pid}{$icb};
1046	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1814	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1047		1815
1048	undef $CHLD_W unless keys %PID_CB;	1816	undef $CHLD_W unless keys %PID_CB;
		1817	};
		1818	};
		1819	die if $@;
		1820
		1821	&child
		1822	}
		1823
		1824	# idle emulation is done by simply using a timer, regardless
		1825	# of whether the process is idle or not, and not letting
		1826	# the callback use more than 50% of the time.
		1827	sub idle {
		1828	eval q{ # poor man's autoloading {}
		1829	*idle = sub {
		1830	my (undef, %arg) = @_;
		1831
		1832	my ($cb, $w, $rcb) = $arg{cb};
		1833
		1834	$rcb = sub {
		1835	if ($cb) {
		1836	$w = AE::time;
		1837	&$cb;
		1838	$w = AE::time - $w;
		1839
		1840	# never use more then 50% of the time for the idle watcher,
		1841	# within some limits
		1842	$w = 0.0001 if $w < 0.0001;
		1843	$w = 5 if $w > 5;
		1844
		1845	$w = AE::timer $w, 0, $rcb;
		1846	} else {
		1847	# clean up...
		1848	undef $w;
		1849	undef $rcb;
		1850	}
		1851	};
		1852
		1853	$w = AE::timer 0.05, 0, $rcb;
		1854
		1855	bless \\$cb, "AnyEvent::Base::idle"
		1856	};
		1857
		1858	*AnyEvent::Base::idle::DESTROY = sub {
		1859	undef $${$_[0]};
		1860	};
		1861	};
		1862	die if $@;
		1863
		1864	&idle
1049	}	1865	}
1050		1866
1051	package AnyEvent::CondVar;	1867	package AnyEvent::CondVar;
1052		1868
1053	our @ISA = AnyEvent::CondVar::Base::;	1869	our @ISA = AnyEvent::CondVar::Base::;
1054		1870
		1871	# only to be used for subclassing
		1872	sub new {
		1873	my $class = shift;
		1874	bless AnyEvent->condvar (@_), $class
		1875	}
		1876
1055	package AnyEvent::CondVar::Base;	1877	package AnyEvent::CondVar::Base;
1056		1878
1057	use overload	1879	#use overload
1058	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1880	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1059	fallback => 1;	1881	# fallback => 1;
		1882
		1883	# save 300+ kilobytes by dirtily hardcoding overloading
		1884	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1885	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1886	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1887	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1888
		1889	our $WAITING;
1060		1890
1061	sub _send {	1891	sub _send {
1062	# nop	1892	# nop
		1893	}
		1894
		1895	sub _wait {
		1896	AnyEvent->_poll until $_[0]{_ae_sent};
1063	}	1897	}
1064		1898
1065	sub send {	1899	sub send {
1066	my $cv = shift;	1900	my $cv = shift;
1067	$cv->{_ae_sent} = [@_];	1901	$cv->{_ae_sent} = [@_];
…		…
1076		1910
1077	sub ready {	1911	sub ready {
1078	$_[0]{_ae_sent}	1912	$_[0]{_ae_sent}
1079	}	1913	}
1080		1914
1081	sub _wait {
1082	AnyEvent->one_event while !$_[0]{_ae_sent};
1083	}
1084
1085	sub recv {	1915	sub recv {
		1916	unless ($_[0]{_ae_sent}) {
		1917	$WAITING
		1918	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1919
		1920	local $WAITING = 1;
1086	$_[0]->_wait;	1921	$_[0]->_wait;
		1922	}
1087		1923
1088	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1924	$_[0]{_ae_croak}
1089	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1925	and Carp::croak $_[0]{_ae_croak};
		1926
		1927	wantarray
		1928	? @{ $_[0]{_ae_sent} }
		1929	: $_[0]{_ae_sent}[0]
1090	}	1930	}
1091		1931
1092	sub cb {	1932	sub cb {
1093	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1933	my $cv = shift;
		1934
		1935	@_
		1936	and $cv->{_ae_cb} = shift
		1937	and $cv->{_ae_sent}
		1938	and (delete $cv->{_ae_cb})->($cv);
		1939
1094	$_[0]{_ae_cb}	1940	$cv->{_ae_cb}
1095	}	1941	}
1096		1942
1097	sub begin {	1943	sub begin {
1098	++$_[0]{_ae_counter};	1944	++$_[0]{_ae_counter};
1099	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1945	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1104	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	1950	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1105	}	1951	}
1106		1952
1107	# undocumented/compatibility with pre-3.4	1953	# undocumented/compatibility with pre-3.4
1108	*broadcast = \&send;	1954	*broadcast = \&send;
1109	*wait = \&_wait;	1955	*wait = \&recv;
		1956
		1957	=head1 ERROR AND EXCEPTION HANDLING
		1958
		1959	In general, AnyEvent does not do any error handling - it relies on the
		1960	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1961	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1962	checking of all AnyEvent methods, however, which is highly useful during
		1963	development.
		1964
		1965	As for exception handling (i.e. runtime errors and exceptions thrown while
		1966	executing a callback), this is not only highly event-loop specific, but
		1967	also not in any way wrapped by this module, as this is the job of the main
		1968	program.
		1969
		1970	The pure perl event loop simply re-throws the exception (usually
		1971	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1972	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1973	so on.
		1974
		1975	=head1 ENVIRONMENT VARIABLES
		1976
		1977	The following environment variables are used by this module or its
		1978	submodules.
		1979
		1980	Note that AnyEvent will remove I<all> environment variables starting with
		1981	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1982	enabled.
		1983
		1984	=over 4
		1985
		1986	=item C<PERL_ANYEVENT_VERBOSE>
		1987
		1988	By default, AnyEvent will be completely silent except in fatal
		1989	conditions. You can set this environment variable to make AnyEvent more
		1990	talkative.
		1991
		1992	When set to C<5> or higher, causes AnyEvent to warn about unexpected
		1993	conditions, such as not being able to load the event model specified by
		1994	C<PERL_ANYEVENT_MODEL>.
		1995
		1996	When set to C<7> or higher, cause AnyEvent to report to STDERR which event
		1997	model it chooses.
		1998
		1999	When set to C<8> or higher, then AnyEvent will report extra information on
		2000	which optional modules it loads and how it implements certain features.
		2001
		2002	=item C<PERL_ANYEVENT_STRICT>
		2003
		2004	AnyEvent does not do much argument checking by default, as thorough
		2005	argument checking is very costly. Setting this variable to a true value
		2006	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		2007	check the arguments passed to most method calls. If it finds any problems,
		2008	it will croak.
		2009
		2010	In other words, enables "strict" mode.
		2011
		2012	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
		2013	>>, it is definitely recommended to keep it off in production. Keeping
		2014	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		2015	can be very useful, however.
		2016
		2017	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2018
		2019	If this env variable is set, then its contents will be interpreted by
		2020	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2021	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2022	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2023
		2024	This takes place when the first watcher is created.
		2025
		2026	For example, to bind a debug shell on a unix domain socket in
		2027	F<< /tmp/debug<pid>.sock >>, you could use this:
		2028
		2029	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2030
		2031	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2032	systems.
		2033
		2034	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2035
		2036	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2037	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2038
		2039	=item C<PERL_ANYEVENT_MODEL>
		2040
		2041	This can be used to specify the event model to be used by AnyEvent, before
		2042	auto detection and -probing kicks in.
		2043
		2044	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2045	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
		2046	resulting module name is loaded and - if the load was successful - used as
		2047	event model backend. If it fails to load then AnyEvent will proceed with
		2048	auto detection and -probing.
		2049
		2050	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2051	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2052	the end of a string designates a module name and quotes it appropriately).
		2053
		2054	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
		2055	could start your program like this:
		2056
		2057	PERL_ANYEVENT_MODEL=Perl perl ...
		2058
		2059	=item C<PERL_ANYEVENT_PROTOCOLS>
		2060
		2061	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		2062	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		2063	of auto probing).
		2064
		2065	Must be set to a comma-separated list of protocols or address families,
		2066	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		2067	used, and preference will be given to protocols mentioned earlier in the
		2068	list.
		2069
		2070	This variable can effectively be used for denial-of-service attacks
		2071	against local programs (e.g. when setuid), although the impact is likely
		2072	small, as the program has to handle conenction and other failures anyways.
		2073
		2074	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		2075	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		2076	- only support IPv4, never try to resolve or contact IPv6
		2077	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		2078	IPv6, but prefer IPv6 over IPv4.
		2079
		2080	=item C<PERL_ANYEVENT_EDNS0>
		2081
		2082	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		2083	for DNS. This extension is generally useful to reduce DNS traffic, but
		2084	some (broken) firewalls drop such DNS packets, which is why it is off by
		2085	default.
		2086
		2087	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		2088	EDNS0 in its DNS requests.
		2089
		2090	=item C<PERL_ANYEVENT_MAX_FORKS>
		2091
		2092	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		2093	will create in parallel.
		2094
		2095	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		2096
		2097	The default value for the C<max_outstanding> parameter for the default DNS
		2098	resolver - this is the maximum number of parallel DNS requests that are
		2099	sent to the DNS server.
		2100
		2101	=item C<PERL_ANYEVENT_RESOLV_CONF>
		2102
		2103	The file to use instead of F</etc/resolv.conf> (or OS-specific
		2104	configuration) in the default resolver. When set to the empty string, no
		2105	default config will be used.
		2106
		2107	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		2108
		2109	When neither C<ca_file> nor C<ca_path> was specified during
		2110	L<AnyEvent::TLS> context creation, and either of these environment
		2111	variables exist, they will be used to specify CA certificate locations
		2112	instead of a system-dependent default.
		2113
		2114	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		2115
		2116	When these are set to C<1>, then the respective modules are not
		2117	loaded. Mostly good for testing AnyEvent itself.
		2118
		2119	=back
1110		2120
1111	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	2121	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1112		2122
1113	This is an advanced topic that you do not normally need to use AnyEvent in	2123	This is an advanced topic that you do not normally need to use AnyEvent in
1114	a module. This section is only of use to event loop authors who want to	2124	a module. This section is only of use to event loop authors who want to
…		…
1148		2158
1149	I<rxvt-unicode> also cheats a bit by not providing blocking access to	2159	I<rxvt-unicode> also cheats a bit by not providing blocking access to
1150	condition variables: code blocking while waiting for a condition will	2160	condition variables: code blocking while waiting for a condition will
1151	C<die>. This still works with most modules/usages, and blocking calls must	2161	C<die>. This still works with most modules/usages, and blocking calls must
1152	not be done in an interactive application, so it makes sense.	2162	not be done in an interactive application, so it makes sense.
1153
1154	=head1 ENVIRONMENT VARIABLES
1155
1156	The following environment variables are used by this module:
1157
1158	=over 4
1159
1160	=item C<PERL_ANYEVENT_VERBOSE>
1161
1162	By default, AnyEvent will be completely silent except in fatal
1163	conditions. You can set this environment variable to make AnyEvent more
1164	talkative.
1165
1166	When set to C<1> or higher, causes AnyEvent to warn about unexpected
1167	conditions, such as not being able to load the event model specified by
1168	C<PERL_ANYEVENT_MODEL>.
1169
1170	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1171	model it chooses.
1172
1173	=item C<PERL_ANYEVENT_MODEL>
1174
1175	This can be used to specify the event model to be used by AnyEvent, before
1176	auto detection and -probing kicks in. It must be a string consisting
1177	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1178	and the resulting module name is loaded and if the load was successful,
1179	used as event model. If it fails to load AnyEvent will proceed with
1180	auto detection and -probing.
1181
1182	This functionality might change in future versions.
1183
1184	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1185	could start your program like this:
1186
1187	PERL_ANYEVENT_MODEL=Perl perl ...
1188
1189	=item C<PERL_ANYEVENT_PROTOCOLS>
1190
1191	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1192	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1193	of auto probing).
1194
1195	Must be set to a comma-separated list of protocols or address families,
1196	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1197	used, and preference will be given to protocols mentioned earlier in the
1198	list.
1199
1200	This variable can effectively be used for denial-of-service attacks
1201	against local programs (e.g. when setuid), although the impact is likely
1202	small, as the program has to handle connection errors already-
1203
1204	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1205	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1206	- only support IPv4, never try to resolve or contact IPv6
1207	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1208	IPv6, but prefer IPv6 over IPv4.
1209
1210	=item C<PERL_ANYEVENT_EDNS0>
1211
1212	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1213	for DNS. This extension is generally useful to reduce DNS traffic, but
1214	some (broken) firewalls drop such DNS packets, which is why it is off by
1215	default.
1216
1217	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1218	EDNS0 in its DNS requests.
1219
1220	=item C<PERL_ANYEVENT_MAX_FORKS>
1221
1222	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1223	will create in parallel.
1224
1225	=back
1226		2163
1227	=head1 EXAMPLE PROGRAM	2164	=head1 EXAMPLE PROGRAM
1228		2165
1229	The following program uses an I/O watcher to read data from STDIN, a timer	2166	The following program uses an I/O watcher to read data from STDIN, a timer
1230	to display a message once per second, and a condition variable to quit the	2167	to display a message once per second, and a condition variable to quit the
…		…
1243	warn "read: $input\n"; # output what has been read	2180	warn "read: $input\n"; # output what has been read
1244	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2181	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1245	},	2182	},
1246	);	2183	);
1247		2184
1248	my $time_watcher; # can only be used once
1249
1250	sub new_timer {
1251	$timer = AnyEvent->timer (after => 1, cb => sub {	2185	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1252	warn "timeout\n"; # print 'timeout' about every second	2186	warn "timeout\n"; # print 'timeout' at most every second
1253	&new_timer; # and restart the time
1254	});	2187	});
1255	}
1256
1257	new_timer; # create first timer
1258		2188
1259	$cv->recv; # wait until user enters /^q/i	2189	$cv->recv; # wait until user enters /^q/i
1260		2190
1261	=head1 REAL-WORLD EXAMPLE	2191	=head1 REAL-WORLD EXAMPLE
1262		2192
…		…
1335		2265
1336	The actual code goes further and collects all errors (C<die>s, exceptions)	2266	The actual code goes further and collects all errors (C<die>s, exceptions)
1337	that occurred during request processing. The C<result> method detects	2267	that occurred during request processing. The C<result> method detects
1338	whether an exception as thrown (it is stored inside the $txn object)	2268	whether an exception as thrown (it is stored inside the $txn object)
1339	and just throws the exception, which means connection errors and other	2269	and just throws the exception, which means connection errors and other
1340	problems get reported tot he code that tries to use the result, not in a	2270	problems get reported to the code that tries to use the result, not in a
1341	random callback.	2271	random callback.
1342		2272
1343	All of this enables the following usage styles:	2273	All of this enables the following usage styles:
1344		2274
1345	1. Blocking:	2275	1. Blocking:
…		…
1393	through AnyEvent. The benchmark creates a lot of timers (with a zero	2323	through AnyEvent. The benchmark creates a lot of timers (with a zero
1394	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2324	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1395	which it is), lets them fire exactly once and destroys them again.	2325	which it is), lets them fire exactly once and destroys them again.
1396		2326
1397	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2327	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1398	distribution.	2328	distribution. It uses the L<AE> interface, which makes a real difference
		2329	for the EV and Perl backends only.
1399		2330
1400	=head3 Explanation of the columns	2331	=head3 Explanation of the columns
1401		2332
1402	I<watcher> is the number of event watchers created/destroyed. Since	2333	I<watcher> is the number of event watchers created/destroyed. Since
1403	different event models feature vastly different performances, each event	2334	different event models feature vastly different performances, each event
…		…
1424	watcher.	2355	watcher.
1425		2356
1426	=head3 Results	2357	=head3 Results
1427		2358
1428	name watchers bytes create invoke destroy comment	2359	name watchers bytes create invoke destroy comment
1429	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	2360	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1430	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	2361	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1431	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	2362	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1432	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	2363	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1433	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	2364	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1434	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	2365	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
		2366	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
		2367	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1435	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	2368	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1436	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	2369	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1437	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	2370	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1438	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	2371	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1439		2372
1440	=head3 Discussion	2373	=head3 Discussion
1441		2374
1442	The benchmark does I<not> measure scalability of the event loop very	2375	The benchmark does I<not> measure scalability of the event loop very
1443	well. For example, a select-based event loop (such as the pure perl one)	2376	well. For example, a select-based event loop (such as the pure perl one)
…		…
1455	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2388	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1456	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2389	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1457	cycles with POE.	2390	cycles with POE.
1458		2391
1459	C<EV> is the sole leader regarding speed and memory use, which are both	2392	C<EV> is the sole leader regarding speed and memory use, which are both
1460	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2393	maximal/minimal, respectively. When using the L<AE> API there is zero
		2394	overhead (when going through the AnyEvent API create is about 5-6 times
		2395	slower, with other times being equal, so still uses far less memory than
1461	far less memory than any other event loop and is still faster than Event	2396	any other event loop and is still faster than Event natively).
1462	natively.
1463		2397
1464	The pure perl implementation is hit in a few sweet spots (both the	2398	The pure perl implementation is hit in a few sweet spots (both the
1465	constant timeout and the use of a single fd hit optimisations in the perl	2399	constant timeout and the use of a single fd hit optimisations in the perl
1466	interpreter and the backend itself). Nevertheless this shows that it	2400	interpreter and the backend itself). Nevertheless this shows that it
1467	adds very little overhead in itself. Like any select-based backend its	2401	adds very little overhead in itself. Like any select-based backend its
1468	performance becomes really bad with lots of file descriptors (and few of	2402	performance becomes really bad with lots of file descriptors (and few of
1469	them active), of course, but this was not subject of this benchmark.	2403	them active), of course, but this was not subject of this benchmark.
1470		2404
1471	The C<Event> module has a relatively high setup and callback invocation	2405	The C<Event> module has a relatively high setup and callback invocation
1472	cost, but overall scores in on the third place.	2406	cost, but overall scores in on the third place.
		2407
		2408	C<IO::Async> performs admirably well, about on par with C<Event>, even
		2409	when using its pure perl backend.
1473		2410
1474	C<Glib>'s memory usage is quite a bit higher, but it features a	2411	C<Glib>'s memory usage is quite a bit higher, but it features a
1475	faster callback invocation and overall ends up in the same class as	2412	faster callback invocation and overall ends up in the same class as
1476	C<Event>. However, Glib scales extremely badly, doubling the number of	2413	C<Event>. However, Glib scales extremely badly, doubling the number of
1477	watchers increases the processing time by more than a factor of four,	2414	watchers increases the processing time by more than a factor of four,
…		…
1512	(even when used without AnyEvent), but most event loops have acceptable	2449	(even when used without AnyEvent), but most event loops have acceptable
1513	performance with or without AnyEvent.	2450	performance with or without AnyEvent.
1514		2451
1515	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2452	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
1516	the actual event loop, only with extremely fast event loops such as EV	2453	the actual event loop, only with extremely fast event loops such as EV
1517	adds AnyEvent significant overhead.	2454	does AnyEvent add significant overhead.
1518		2455
1519	=item * You should avoid POE like the plague if you want performance or	2456	=item * You should avoid POE like the plague if you want performance or
1520	reasonable memory usage.	2457	reasonable memory usage.
1521		2458
1522	=back	2459	=back
…		…
1538	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2475	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1539	(1%) are active. This mirrors the activity of large servers with many	2476	(1%) are active. This mirrors the activity of large servers with many
1540	connections, most of which are idle at any one point in time.	2477	connections, most of which are idle at any one point in time.
1541		2478
1542	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2479	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1543	distribution.	2480	distribution. It uses the L<AE> interface, which makes a real difference
		2481	for the EV and Perl backends only.
1544		2482
1545	=head3 Explanation of the columns	2483	=head3 Explanation of the columns
1546		2484
1547	I<sockets> is the number of sockets, and twice the number of "servers" (as	2485	I<sockets> is the number of sockets, and twice the number of "servers" (as
1548	each server has a read and write socket end).	2486	each server has a read and write socket end).
…		…
1555	it to another server. This includes deleting the old timeout and creating	2493	it to another server. This includes deleting the old timeout and creating
1556	a new one that moves the timeout into the future.	2494	a new one that moves the timeout into the future.
1557		2495
1558	=head3 Results	2496	=head3 Results
1559		2497
1560	name sockets create request	2498	name sockets create request
1561	EV 20000 69.01 11.16	2499	EV 20000 62.66 7.99
1562	Perl 20000 73.32 35.87	2500	Perl 20000 68.32 32.64
1563	Event 20000 212.62 257.32	2501	IOAsync 20000 174.06 101.15 epoll
1564	Glib 20000 651.16 1896.30	2502	IOAsync 20000 174.67 610.84 poll
		2503	Event 20000 202.69 242.91
		2504	Glib 20000 557.01 1689.52
1565	POE 20000 349.67 12317.24 uses POE::Loop::Event	2505	POE 20000 341.54 12086.32 uses POE::Loop::Event
1566		2506
1567	=head3 Discussion	2507	=head3 Discussion
1568		2508
1569	This benchmark I<does> measure scalability and overall performance of the	2509	This benchmark I<does> measure scalability and overall performance of the
1570	particular event loop.	2510	particular event loop.
…		…
1572	EV is again fastest. Since it is using epoll on my system, the setup time	2512	EV is again fastest. Since it is using epoll on my system, the setup time
1573	is relatively high, though.	2513	is relatively high, though.
1574		2514
1575	Perl surprisingly comes second. It is much faster than the C-based event	2515	Perl surprisingly comes second. It is much faster than the C-based event
1576	loops Event and Glib.	2516	loops Event and Glib.
		2517
		2518	IO::Async performs very well when using its epoll backend, and still quite
		2519	good compared to Glib when using its pure perl backend.
1577		2520
1578	Event suffers from high setup time as well (look at its code and you will	2521	Event suffers from high setup time as well (look at its code and you will
1579	understand why). Callback invocation also has a high overhead compared to	2522	understand why). Callback invocation also has a high overhead compared to
1580	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2523	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1581	uses select or poll in basically all documented configurations.	2524	uses select or poll in basically all documented configurations.
…		…
1644	=item * C-based event loops perform very well with small number of	2587	=item * C-based event loops perform very well with small number of
1645	watchers, as the management overhead dominates.	2588	watchers, as the management overhead dominates.
1646		2589
1647	=back	2590	=back
1648		2591
		2592	=head2 THE IO::Lambda BENCHMARK
		2593
		2594	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2595	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2596	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2597	shouldn't come as a surprise to anybody). As such, the benchmark is
		2598	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2599	very optimal. But how would AnyEvent compare when used without the extra
		2600	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2601
		2602	The benchmark itself creates an echo-server, and then, for 500 times,
		2603	connects to the echo server, sends a line, waits for the reply, and then
		2604	creates the next connection. This is a rather bad benchmark, as it doesn't
		2605	test the efficiency of the framework or much non-blocking I/O, but it is a
		2606	benchmark nevertheless.
		2607
		2608	name runtime
		2609	Lambda/select 0.330 sec
		2610	+ optimized 0.122 sec
		2611	Lambda/AnyEvent 0.327 sec
		2612	+ optimized 0.138 sec
		2613	Raw sockets/select 0.077 sec
		2614	POE/select, components 0.662 sec
		2615	POE/select, raw sockets 0.226 sec
		2616	POE/select, optimized 0.404 sec
		2617
		2618	AnyEvent/select/nb 0.085 sec
		2619	AnyEvent/EV/nb 0.068 sec
		2620	+state machine 0.134 sec
		2621
		2622	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2623	benchmarks actually make blocking connects and use 100% blocking I/O,
		2624	defeating the purpose of an event-based solution. All of the newly
		2625	written AnyEvent benchmarks use 100% non-blocking connects (using
		2626	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2627	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2628	generally require a lot more bookkeeping and event handling than blocking
		2629	connects (which involve a single syscall only).
		2630
		2631	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2632	offers similar expressive power as POE and IO::Lambda, using conventional
		2633	Perl syntax. This means that both the echo server and the client are 100%
		2634	non-blocking, further placing it at a disadvantage.
		2635
		2636	As you can see, the AnyEvent + EV combination even beats the
		2637	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2638	backend easily beats IO::Lambda and POE.
		2639
		2640	And even the 100% non-blocking version written using the high-level (and
		2641	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
		2642	higher level ("unoptimised") abstractions by a large margin, even though
		2643	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
		2644
		2645	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2646	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2647	part of the IO::Lambda distribution and were used without any changes.
		2648
		2649
		2650	=head1 SIGNALS
		2651
		2652	AnyEvent currently installs handlers for these signals:
		2653
		2654	=over 4
		2655
		2656	=item SIGCHLD
		2657
		2658	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		2659	emulation for event loops that do not support them natively. Also, some
		2660	event loops install a similar handler.
		2661
		2662	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2663	AnyEvent will reset it to default, to avoid losing child exit statuses.
		2664
		2665	=item SIGPIPE
		2666
		2667	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		2668	when AnyEvent gets loaded.
		2669
		2670	The rationale for this is that AnyEvent users usually do not really depend
		2671	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		2672	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		2673	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		2674	some random socket.
		2675
		2676	The rationale for installing a no-op handler as opposed to ignoring it is
		2677	that this way, the handler will be restored to defaults on exec.
		2678
		2679	Feel free to install your own handler, or reset it to defaults.
		2680
		2681	=back
		2682
		2683	=cut
		2684
		2685	undef $SIG{CHLD}
		2686	if $SIG{CHLD} eq 'IGNORE';
		2687
		2688	$SIG{PIPE} = sub { }
		2689	unless defined $SIG{PIPE};
		2690
		2691	=head1 RECOMMENDED/OPTIONAL MODULES
		2692
		2693	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2694	its built-in modules) are required to use it.
		2695
		2696	That does not mean that AnyEvent won't take advantage of some additional
		2697	modules if they are installed.
		2698
		2699	This section explains which additional modules will be used, and how they
		2700	affect AnyEvent's operation.
		2701
		2702	=over 4
		2703
		2704	=item L<Async::Interrupt>
		2705
		2706	This slightly arcane module is used to implement fast signal handling: To
		2707	my knowledge, there is no way to do completely race-free and quick
		2708	signal handling in pure perl. To ensure that signals still get
		2709	delivered, AnyEvent will start an interval timer to wake up perl (and
		2710	catch the signals) with some delay (default is 10 seconds, look for
		2711	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2712
		2713	If this module is available, then it will be used to implement signal
		2714	catching, which means that signals will not be delayed, and the event loop
		2715	will not be interrupted regularly, which is more efficient (and good for
		2716	battery life on laptops).
		2717
		2718	This affects not just the pure-perl event loop, but also other event loops
		2719	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2720
		2721	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2722	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2723	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2724	does nothing for those backends.
		2725
		2726	=item L<EV>
		2727
		2728	This module isn't really "optional", as it is simply one of the backend
		2729	event loops that AnyEvent can use. However, it is simply the best event
		2730	loop available in terms of features, speed and stability: It supports
		2731	the AnyEvent API optimally, implements all the watcher types in XS, does
		2732	automatic timer adjustments even when no monotonic clock is available,
		2733	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2734	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2735	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2736
		2737	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2738	then this module will do nothing for you.
		2739
		2740	=item L<Guard>
		2741
		2742	The guard module, when used, will be used to implement
		2743	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2744	lot less memory), but otherwise doesn't affect guard operation much. It is
		2745	purely used for performance.
		2746
		2747	=item L<JSON> and L<JSON::XS>
		2748
		2749	One of these modules is required when you want to read or write JSON data
		2750	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
		2751	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2752
		2753	=item L<Net::SSLeay>
		2754
		2755	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2756	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2757	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2758
		2759	=item L<Time::HiRes>
		2760
		2761	This module is part of perl since release 5.008. It will be used when the
		2762	chosen event library does not come with a timing source of its own. The
		2763	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
		2764	try to use a monotonic clock for timing stability.
		2765
		2766	=back
		2767
1649		2768
1650	=head1 FORK	2769	=head1 FORK
1651		2770
1652	Most event libraries are not fork-safe. The ones who are usually are	2771	Most event libraries are not fork-safe. The ones who are usually are
1653	because they rely on inefficient but fork-safe C<select> or C<poll>	2772	because they rely on inefficient but fork-safe C<select> or C<poll> calls
1654	calls. Only L<EV> is fully fork-aware.	2773	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2774	are usually badly thought-out hacks that are incompatible with fork in
		2775	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2776	continue event-processing in both parent and child (or both, if you know
		2777	what you are doing).
		2778
		2779	This means that, in general, you cannot fork and do event processing in
		2780	the child if the event library was initialised before the fork (which
		2781	usually happens when the first AnyEvent watcher is created, or the library
		2782	is loaded).
1655		2783
1656	If you have to fork, you must either do so I<before> creating your first	2784	If you have to fork, you must either do so I<before> creating your first
1657	watcher OR you must not use AnyEvent at all in the child.	2785	watcher OR you must not use AnyEvent at all in the child OR you must do
		2786	something completely out of the scope of AnyEvent.
		2787
		2788	The problem of doing event processing in the parent I<and> the child
		2789	is much more complicated: even for backends that I<are> fork-aware or
		2790	fork-safe, their behaviour is not usually what you want: fork clones all
		2791	watchers, that means all timers, I/O watchers etc. are active in both
		2792	parent and child, which is almost never what you want. USing C<exec>
		2793	to start worker children from some kind of manage rprocess is usually
		2794	preferred, because it is much easier and cleaner, at the expense of having
		2795	to have another binary.
1658		2796
1659		2797
1660	=head1 SECURITY CONSIDERATIONS	2798	=head1 SECURITY CONSIDERATIONS
1661		2799
1662	AnyEvent can be forced to load any event model via	2800	AnyEvent can be forced to load any event model via
…		…
1673		2811
1674	use AnyEvent;	2812	use AnyEvent;
1675		2813
1676	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2814	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1677	be used to probe what backend is used and gain other information (which is	2815	be used to probe what backend is used and gain other information (which is
1678	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	2816	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		2817	$ENV{PERL_ANYEVENT_STRICT}.
		2818
		2819	Note that AnyEvent will remove I<all> environment variables starting with
		2820	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2821	enabled.
1679		2822
1680		2823
1681	=head1 BUGS	2824	=head1 BUGS
1682		2825
1683	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	2826	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1684	to work around. If you suffer from memleaks, first upgrade to Perl 5.10	2827	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1685	and check wether the leaks still show up. (Perl 5.10.0 has other annoying	2828	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1686	mamleaks, such as leaking on C<map> and C<grep> but it is usually not as	2829	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1687	pronounced).	2830	pronounced).
1688		2831
1689		2832
1690	=head1 SEE ALSO	2833	=head1 SEE ALSO
1691		2834
1692	Utility functions: L<AnyEvent::Util>.	2835	Tutorial/Introduction: L<AnyEvent::Intro>.
1693		2836
1694	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2837	FAQ: L<AnyEvent::FAQ>.
1695	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2838
		2839	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2840	(simply logging).
		2841
		2842	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2843	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2844
		2845	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2846	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2847	L<Qt>, L<POE>, L<FLTK>.
1696		2848
1697	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2849	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1698	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2850	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1699	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2851	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
		2852	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
1700	L<AnyEvent::Impl::POE>.	2853	L<AnyEvent::Impl::FLTK>.
1701		2854
1702	Non-blocking file handles, sockets, TCP clients and	2855	Non-blocking handles, pipes, stream sockets, TCP clients and
1703	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2856	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1704		2857
1705	Asynchronous DNS: L<AnyEvent::DNS>.	2858	Asynchronous DNS: L<AnyEvent::DNS>.
1706		2859
1707	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2860	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
1708		2861
1709	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2862	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
		2863	L<AnyEvent::HTTP>.
1710		2864
1711		2865
1712	=head1 AUTHOR	2866	=head1 AUTHOR
1713		2867
1714	Marc Lehmann <schmorp@schmorp.de>	2868	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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