ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.143 by root, Wed May 28 23:57:38 2008 UTC vs.
Revision 1.296 by root, Tue Nov 17 01:19:49 2009 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	# file descriptor readable
11	my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub {	13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
		14
		15	# one-shot or repeating timers
		16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
		17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
		18
		19	print AnyEvent->now; # prints current event loop time
		20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
		21
		22	# POSIX signal
		23	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
		24
		25	# child process exit
		26	my $w = AnyEvent->child (pid => $pid, cb => sub {
		27	my ($pid, $status) = @_;
12	...	28	...
13	});	29	});
14		30
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {	31	# called when event loop idle (if applicable)
16	...	32	my $w = AnyEvent->idle (cb => sub { ... });
17	});
18		33
19	my $w = AnyEvent->condvar; # stores whether a condition was flagged	34	my $w = AnyEvent->condvar; # stores whether a condition was flagged
20	$w->send; # wake up current and all future recv's	35	$w->send; # wake up current and all future recv's
21	$w->recv; # enters "main loop" till $condvar gets ->send	36	$w->recv; # enters "main loop" till $condvar gets ->send
		37	# use a condvar in callback mode:
		38	$w->cb (sub { $_[0]->recv });
		39
		40	=head1 INTRODUCTION/TUTORIAL
		41
		42	This manpage is mainly a reference manual. If you are interested
		43	in a tutorial or some gentle introduction, have a look at the
		44	L<AnyEvent::Intro> manpage.
		45
		46	=head1 SUPPORT
		47
		48	There is a mailinglist for discussing all things AnyEvent, and an IRC
		49	channel, too.
		50
		51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		52	Repository>, at L<http://anyevent.schmorp.de>, for more info.
22		53
23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24		55
25	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
27		58
28	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	59	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29	policy> and AnyEvent is I<small and efficient>.	60	policy> and AnyEvent is I<small and efficient>.
30		61
31	First and foremost, I<AnyEvent is not an event model> itself, it only	62	First and foremost, I<AnyEvent is not an event model> itself, it only
32	interfaces to whatever event model the main program happens to use in a	63	interfaces to whatever event model the main program happens to use, in a
33	pragmatic way. For event models and certain classes of immortals alike,	64	pragmatic way. For event models and certain classes of immortals alike,
34	the statement "there can only be one" is a bitter reality: In general,	65	the statement "there can only be one" is a bitter reality: In general,
35	only one event loop can be active at the same time in a process. AnyEvent	66	only one event loop can be active at the same time in a process. AnyEvent
36	helps hiding the differences between those event loops.	67	cannot change this, but it can hide the differences between those event
		68	loops.
37		69
38	The goal of AnyEvent is to offer module authors the ability to do event	70	The goal of AnyEvent is to offer module authors the ability to do event
39	programming (waiting for I/O or timer events) without subscribing to a	71	programming (waiting for I/O or timer events) without subscribing to a
40	religion, a way of living, and most importantly: without forcing your	72	religion, a way of living, and most importantly: without forcing your
41	module users into the same thing by forcing them to use the same event	73	module users into the same thing by forcing them to use the same event
42	model you use.	74	model you use.
43		75
44	For modules like POE or IO::Async (which is a total misnomer as it is	76	For modules like POE or IO::Async (which is a total misnomer as it is
45	actually doing all I/O I<synchronously>...), using them in your module is	77	actually doing all I/O I<synchronously>...), using them in your module is
46	like joining a cult: After you joined, you are dependent on them and you	78	like joining a cult: After you joined, you are dependent on them and you
47	cannot use anything else, as it is simply incompatible to everything that	79	cannot use anything else, as they are simply incompatible to everything
48	isn't itself. What's worse, all the potential users of your module are	80	that isn't them. What's worse, all the potential users of your
49	I<also> forced to use the same event loop you use.	81	module are I<also> forced to use the same event loop you use.
50		82
51	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	83	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	84	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
53	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	85	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
54	your module uses one of those, every user of your module has to use it,	86	your module uses one of those, every user of your module has to use it,
55	too. But if your module uses AnyEvent, it works transparently with all	87	too. But if your module uses AnyEvent, it works transparently with all
56	event models it supports (including stuff like POE and IO::Async, as long	88	event models it supports (including stuff like IO::Async, as long as those
57	as those use one of the supported event loops. It is trivial to add new	89	use one of the supported event loops. It is trivial to add new event loops
58	event loops to AnyEvent, too, so it is future-proof).	90	to AnyEvent, too, so it is future-proof).
59		91
60	In addition to being free of having to use I<the one and only true event	92	In addition to being free of having to use I<the one and only true event
61	model>, AnyEvent also is free of bloat and policy: with POE or similar	93	model>, AnyEvent also is free of bloat and policy: with POE or similar
62	modules, you get an enormous amount of code and strict rules you have to	94	modules, you get an enormous amount of code and strict rules you have to
63	follow. AnyEvent, on the other hand, is lean and up to the point, by only	95	follow. AnyEvent, on the other hand, is lean and up to the point, by only
…		…
121	These watchers are normal Perl objects with normal Perl lifetime. After	153	These watchers are normal Perl objects with normal Perl lifetime. After
122	creating a watcher it will immediately "watch" for events and invoke the	154	creating a watcher it will immediately "watch" for events and invoke the
123	callback when the event occurs (of course, only when the event model	155	callback when the event occurs (of course, only when the event model
124	is in control).	156	is in control).
125		157
		158	Note that B<callbacks must not permanently change global variables>
		159	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
		160	callbacks must not C<die> >>. The former is good programming practise in
		161	Perl and the latter stems from the fact that exception handling differs
		162	widely between event loops.
		163
126	To disable the watcher you have to destroy it (e.g. by setting the	164	To disable the watcher you have to destroy it (e.g. by setting the
127	variable you store it in to C<undef> or otherwise deleting all references	165	variable you store it in to C<undef> or otherwise deleting all references
128	to it).	166	to it).
129		167
130	All watchers are created by calling a method on the C<AnyEvent> class.	168	All watchers are created by calling a method on the C<AnyEvent> class.
…		…
132	Many watchers either are used with "recursion" (repeating timers for	170	Many watchers either are used with "recursion" (repeating timers for
133	example), or need to refer to their watcher object in other ways.	171	example), or need to refer to their watcher object in other ways.
134		172
135	An any way to achieve that is this pattern:	173	An any way to achieve that is this pattern:
136		174
137	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	175	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
138	# you can use $w here, for example to undef it	176	# you can use $w here, for example to undef it
139	undef $w;	177	undef $w;
140	});	178	});
141		179
142	Note that C<my $w; $w => combination. This is necessary because in Perl,	180	Note that C<my $w; $w => combination. This is necessary because in Perl,
143	my variables are only visible after the statement in which they are	181	my variables are only visible after the statement in which they are
144	declared.	182	declared.
145		183
146	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
147		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
148	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	192	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
149	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
150		194
151	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch	195	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
		196	for events (AnyEvent might or might not keep a reference to this file
		197	handle). Note that only file handles pointing to things for which
		198	non-blocking operation makes sense are allowed. This includes sockets,
		199	most character devices, pipes, fifos and so on, but not for example files
		200	or block devices.
		201
152	for events. C<poll> must be a string that is either C<r> or C<w>,	202	C<poll> must be a string that is either C<r> or C<w>, which creates a
153	which creates a watcher waiting for "r"eadable or "w"ritable events,	203	watcher waiting for "r"eadable or "w"ritable events, respectively.
		204
154	respectively. C<cb> is the callback to invoke each time the file handle	205	C<cb> is the callback to invoke each time the file handle becomes ready.
155	becomes ready.
156		206
157	Although the callback might get passed parameters, their value and	207	Although the callback might get passed parameters, their value and
158	presence is undefined and you cannot rely on them. Portable AnyEvent	208	presence is undefined and you cannot rely on them. Portable AnyEvent
159	callbacks cannot use arguments passed to I/O watcher callbacks.	209	callbacks cannot use arguments passed to I/O watcher callbacks.
160		210
…		…
164		214
165	Some event loops issue spurious readyness notifications, so you should	215	Some event loops issue spurious readyness notifications, so you should
166	always use non-blocking calls when reading/writing from/to your file	216	always use non-blocking calls when reading/writing from/to your file
167	handles.	217	handles.
168		218
169	Example:
170
171	# wait for readability of STDIN, then read a line and disable the watcher	219	Example: wait for readability of STDIN, then read a line and disable the
		220	watcher.
		221
172	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	222	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
173	chomp (my $input = <STDIN>);	223	chomp (my $input = <STDIN>);
174	warn "read: $input\n";	224	warn "read: $input\n";
175	undef $w;	225	undef $w;
176	});	226	});
177		227
178	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
179		229
		230	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		231
		232	$w = AnyEvent->timer (
		233	after => <fractional_seconds>,
		234	interval => <fractional_seconds>,
		235	cb => <callback>,
		236	);
		237
180	You can create a time watcher by calling the C<< AnyEvent->timer >>	238	You can create a time watcher by calling the C<< AnyEvent->timer >>
181	method with the following mandatory arguments:	239	method with the following mandatory arguments:
182		240
183	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
184	supported) the callback should be invoked. C<cb> is the callback to invoke	242	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
186		244
187	Although the callback might get passed parameters, their value and	245	Although the callback might get passed parameters, their value and
188	presence is undefined and you cannot rely on them. Portable AnyEvent	246	presence is undefined and you cannot rely on them. Portable AnyEvent
189	callbacks cannot use arguments passed to time watcher callbacks.	247	callbacks cannot use arguments passed to time watcher callbacks.
190		248
191	The timer callback will be invoked at most once: if you want a repeating	249	The callback will normally be invoked once only. If you specify another
192	timer you have to create a new watcher (this is a limitation by both Tk	250	parameter, C<interval>, as a strictly positive number (> 0), then the
193	and Glib).	251	callback will be invoked regularly at that interval (in fractional
		252	seconds) after the first invocation. If C<interval> is specified with a
		253	false value, then it is treated as if it were missing.
194		254
195	Example:	255	The callback will be rescheduled before invoking the callback, but no
		256	attempt is done to avoid timer drift in most backends, so the interval is
		257	only approximate.
196		258
197	# fire an event after 7.7 seconds	259	Example: fire an event after 7.7 seconds.
		260
198	my $w = AnyEvent->timer (after => 7.7, cb => sub {	261	my $w = AnyEvent->timer (after => 7.7, cb => sub {
199	warn "timeout\n";	262	warn "timeout\n";
200	});	263	});
201		264
202	# to cancel the timer:	265	# to cancel the timer:
203	undef $w;	266	undef $w;
204		267
205	Example 2:
206
207	# fire an event after 0.5 seconds, then roughly every second	268	Example 2: fire an event after 0.5 seconds, then roughly every second.
208	my $w;
209		269
210	my $cb = sub {
211	# cancel the old timer while creating a new one
212	$w = AnyEvent->timer (after => 1, cb => $cb);	270	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
		271	warn "timeout\n";
213	};	272	};
214
215	# start the "loop" by creating the first watcher
216	$w = AnyEvent->timer (after => 0.5, cb => $cb);
217		273
218	=head3 TIMING ISSUES	274	=head3 TIMING ISSUES
219		275
220	There are two ways to handle timers: based on real time (relative, "fire	276	There are two ways to handle timers: based on real time (relative, "fire
221	in 10 seconds") and based on wallclock time (absolute, "fire at 12	277	in 10 seconds") and based on wallclock time (absolute, "fire at 12
…		…
243		299
244	This returns the "current wallclock time" as a fractional number of	300	This returns the "current wallclock time" as a fractional number of
245	seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>	301	seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
246	return, and the result is guaranteed to be compatible with those).	302	return, and the result is guaranteed to be compatible with those).
247		303
248	It progresses independently of any event loop processing.	304	It progresses independently of any event loop processing, i.e. each call
249		305	will check the system clock, which usually gets updated frequently.
250	In almost all cases (in all cases if you don't care), this is the function
251	to call when you want to know the current time.
252		306
253	=item AnyEvent->now	307	=item AnyEvent->now
254		308
255	This also returns the "current wallclock time", but unlike C<time>, above,	309	This also returns the "current wallclock time", but unlike C<time>, above,
256	this value might change only once per event loop iteration, depending on	310	this value might change only once per event loop iteration, depending on
257	the event loop (most return the same time as C<time>, above). This is the	311	the event loop (most return the same time as C<time>, above). This is the
258	time that AnyEvent timers get scheduled against.	312	time that AnyEvent's timers get scheduled against.
		313
		314	I<In almost all cases (in all cases if you don't care), this is the
		315	function to call when you want to know the current time.>
		316
		317	This function is also often faster then C<< AnyEvent->time >>, and
		318	thus the preferred method if you want some timestamp (for example,
		319	L<AnyEvent::Handle> uses this to update it's activity timeouts).
		320
		321	The rest of this section is only of relevance if you try to be very exact
		322	with your timing, you can skip it without bad conscience.
259		323
260	For a practical example of when these times differ, consider L<Event::Lib>	324	For a practical example of when these times differ, consider L<Event::Lib>
261	and L<EV> and the following set-up:	325	and L<EV> and the following set-up:
262		326
263	The event loop is running and has just invoked one of your callback at	327	The event loop is running and has just invoked one of your callback at
…		…
268		332
269	With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will	333	With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
270	both return C<501>, because that is the current time, and the timer will	334	both return C<501>, because that is the current time, and the timer will
271	be scheduled to fire at time=504 (C<501> + C<3>).	335	be scheduled to fire at time=504 (C<501> + C<3>).
272		336
273	With L<EV>m C<< AnyEvent->time >> returns C<501> (as that is the current	337	With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
274	time), but C<< AnyEvent->now >> returns C<500>, as that is the time the	338	time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
275	last event processing phase started. With L<EV>, your timer gets scheduled	339	last event processing phase started. With L<EV>, your timer gets scheduled
276	to run at time=503 (C<500> + C<3>).	340	to run at time=503 (C<500> + C<3>).
277		341
278	In one sense, L<Event::Lib> is more exact, as it uses the current time	342	In one sense, L<Event::Lib> is more exact, as it uses the current time
279	regardless of any delays introduced by event processing. However, most	343	regardless of any delays introduced by event processing. However, most
280	callbacks do not expect large delays in processing, so this causes a	344	callbacks do not expect large delays in processing, so this causes a
281	higher drift (and a lot more syscalls to get the current time).	345	higher drift (and a lot more system calls to get the current time).
282		346
283	In another sense, L<EV> is more exact, as your timer will be scheduled at	347	In another sense, L<EV> is more exact, as your timer will be scheduled at
284	the same time, regardless of how long event processing actually took.	348	the same time, regardless of how long event processing actually took.
285		349
286	In either case, if you care (and in most cases, you don't), then you	350	In either case, if you care (and in most cases, you don't), then you
287	can get whatever behaviour you want with any event loop, by taking the	351	can get whatever behaviour you want with any event loop, by taking the
288	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	352	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
289	account.	353	account.
290		354
		355	=item AnyEvent->now_update
		356
		357	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
		358	the current time for each loop iteration (see the discussion of L<<
		359	AnyEvent->now >>, above).
		360
		361	When a callback runs for a long time (or when the process sleeps), then
		362	this "current" time will differ substantially from the real time, which
		363	might affect timers and time-outs.
		364
		365	When this is the case, you can call this method, which will update the
		366	event loop's idea of "current time".
		367
		368	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		369	when mod_perl executes the script, then the event loop will have the wrong
		370	idea about the "current time" (being potentially far in the past, when the
		371	script ran the last time). In that case you should arrange a call to C<<
		372	AnyEvent->now_update >> each time the web server process wakes up again
		373	(e.g. at the start of your script, or in a handler).
		374
		375	Note that updating the time I<might> cause some events to be handled.
		376
291	=back	377	=back
292		378
293	=head2 SIGNAL WATCHERS	379	=head2 SIGNAL WATCHERS
294		380
		381	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		382
295	You can watch for signals using a signal watcher, C<signal> is the signal	383	You can watch for signals using a signal watcher, C<signal> is the signal
296	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to	384	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
297	be invoked whenever a signal occurs.	385	callback to be invoked whenever a signal occurs.
298		386
299	Although the callback might get passed parameters, their value and	387	Although the callback might get passed parameters, their value and
300	presence is undefined and you cannot rely on them. Portable AnyEvent	388	presence is undefined and you cannot rely on them. Portable AnyEvent
301	callbacks cannot use arguments passed to signal watcher callbacks.	389	callbacks cannot use arguments passed to signal watcher callbacks.
302		390
…		…
304	invocation, and callback invocation will be synchronous. Synchronous means	392	invocation, and callback invocation will be synchronous. Synchronous means
305	that it might take a while until the signal gets handled by the process,	393	that it might take a while until the signal gets handled by the process,
306	but it is guaranteed not to interrupt any other callbacks.	394	but it is guaranteed not to interrupt any other callbacks.
307		395
308	The main advantage of using these watchers is that you can share a signal	396	The main advantage of using these watchers is that you can share a signal
309	between multiple watchers.	397	between multiple watchers, and AnyEvent will ensure that signals will not
		398	interrupt your program at bad times.
310		399
311	This watcher might use C<%SIG>, so programs overwriting those signals	400	This watcher might use C<%SIG> (depending on the event loop used),
312	directly will likely not work correctly.	401	so programs overwriting those signals directly will likely not work
		402	correctly.
313		403
314	Example: exit on SIGINT	404	Example: exit on SIGINT
315		405
316	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
317		407
		408	=head3 Signal Races, Delays and Workarounds
		409
		410	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		411	callbacks to signals in a generic way, which is a pity, as you cannot
		412	do race-free signal handling in perl, requiring C libraries for
		413	this. AnyEvent will try to do it's best, which means in some cases,
		414	signals will be delayed. The maximum time a signal might be delayed is
		415	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
		416	variable can be changed only before the first signal watcher is created,
		417	and should be left alone otherwise. This variable determines how often
		418	AnyEvent polls for signals (in case a wake-up was missed). Higher values
		419	will cause fewer spurious wake-ups, which is better for power and CPU
		420	saving.
		421
		422	All these problems can be avoided by installing the optional
		423	L<Async::Interrupt> module, which works with most event loops. It will not
		424	work with inherently broken event loops such as L<Event> or L<Event::Lib>
		425	(and not with L<POE> currently, as POE does it's own workaround with
		426	one-second latency). For those, you just have to suffer the delays.
		427
318	=head2 CHILD PROCESS WATCHERS	428	=head2 CHILD PROCESS WATCHERS
319		429
		430	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		431
320	You can also watch on a child process exit and catch its exit status.	432	You can also watch on a child process exit and catch its exit status.
321		433
322	The child process is specified by the C<pid> argument (if set to C<0>, it	434	The child process is specified by the C<pid> argument (one some backends,
323	watches for any child process exit). The watcher will trigger as often	435	using C<0> watches for any child process exit, on others this will
324	as status change for the child are received. This works by installing a	436	croak). The watcher will be triggered only when the child process has
325	signal handler for C<SIGCHLD>. The callback will be called with the pid	437	finished and an exit status is available, not on any trace events
326	and exit status (as returned by waitpid), so unlike other watcher types,	438	(stopped/continued).
327	you I<can> rely on child watcher callback arguments.	439
		440	The callback will be called with the pid and exit status (as returned by
		441	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		442	callback arguments.
		443
		444	This watcher type works by installing a signal handler for C<SIGCHLD>,
		445	and since it cannot be shared, nothing else should use SIGCHLD or reap
		446	random child processes (waiting for specific child processes, e.g. inside
		447	C<system>, is just fine).
328		448
329	There is a slight catch to child watchers, however: you usually start them	449	There is a slight catch to child watchers, however: you usually start them
330	I<after> the child process was created, and this means the process could	450	I<after> the child process was created, and this means the process could
331	have exited already (and no SIGCHLD will be sent anymore).	451	have exited already (and no SIGCHLD will be sent anymore).
332		452
333	Not all event models handle this correctly (POE doesn't), but even for	453	Not all event models handle this correctly (neither POE nor IO::Async do,
		454	see their AnyEvent::Impl manpages for details), but even for event models
334	event models that I<do> handle this correctly, they usually need to be	455	that I<do> handle this correctly, they usually need to be loaded before
335	loaded before the process exits (i.e. before you fork in the first place).	456	the process exits (i.e. before you fork in the first place). AnyEvent's
		457	pure perl event loop handles all cases correctly regardless of when you
		458	start the watcher.
336		459
337	This means you cannot create a child watcher as the very first thing in an	460	This means you cannot create a child watcher as the very first
338	AnyEvent program, you I<have> to create at least one watcher before you	461	thing in an AnyEvent program, you I<have> to create at least one
339	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	462	watcher before you C<fork> the child (alternatively, you can call
		463	C<AnyEvent::detect>).
		464
		465	As most event loops do not support waiting for child events, they will be
		466	emulated by AnyEvent in most cases, in which the latency and race problems
		467	mentioned in the description of signal watchers apply.
340		468
341	Example: fork a process and wait for it	469	Example: fork a process and wait for it
342		470
343	my $done = AnyEvent->condvar;	471	my $done = AnyEvent->condvar;
344		472
345	my $pid = fork or exit 5;	473	my $pid = fork or exit 5;
346		474
347	my $w = AnyEvent->child (	475	my $w = AnyEvent->child (
348	pid => $pid,	476	pid => $pid,
349	cb => sub {	477	cb => sub {
350	my ($pid, $status) = @_;	478	my ($pid, $status) = @_;
351	warn "pid $pid exited with status $status";	479	warn "pid $pid exited with status $status";
352	$done->send;	480	$done->send;
353	},	481	},
354	);	482	);
355		483
356	# do something else, then wait for process exit	484	# do something else, then wait for process exit
357	$done->recv;	485	$done->recv;
		486
		487	=head2 IDLE WATCHERS
		488
		489	$w = AnyEvent->idle (cb => <callback>);
		490
		491	Sometimes there is a need to do something, but it is not so important
		492	to do it instantly, but only when there is nothing better to do. This
		493	"nothing better to do" is usually defined to be "no other events need
		494	attention by the event loop".
		495
		496	Idle watchers ideally get invoked when the event loop has nothing
		497	better to do, just before it would block the process to wait for new
		498	events. Instead of blocking, the idle watcher is invoked.
		499
		500	Most event loops unfortunately do not really support idle watchers (only
		501	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		502	will simply call the callback "from time to time".
		503
		504	Example: read lines from STDIN, but only process them when the
		505	program is otherwise idle:
		506
		507	my @lines; # read data
		508	my $idle_w;
		509	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		510	push @lines, scalar <STDIN>;
		511
		512	# start an idle watcher, if not already done
		513	$idle_w ||= AnyEvent->idle (cb => sub {
		514	# handle only one line, when there are lines left
		515	if (my $line = shift @lines) {
		516	print "handled when idle: $line";
		517	} else {
		518	# otherwise disable the idle watcher again
		519	undef $idle_w;
		520	}
		521	});
		522	});
358		523
359	=head2 CONDITION VARIABLES	524	=head2 CONDITION VARIABLES
		525
		526	$cv = AnyEvent->condvar;
		527
		528	$cv->send (<list>);
		529	my @res = $cv->recv;
360		530
361	If you are familiar with some event loops you will know that all of them	531	If you are familiar with some event loops you will know that all of them
362	require you to run some blocking "loop", "run" or similar function that	532	require you to run some blocking "loop", "run" or similar function that
363	will actively watch for new events and call your callbacks.	533	will actively watch for new events and call your callbacks.
364		534
365	AnyEvent is different, it expects somebody else to run the event loop and	535	AnyEvent is slightly different: it expects somebody else to run the event
366	will only block when necessary (usually when told by the user).	536	loop and will only block when necessary (usually when told by the user).
367		537
368	The instrument to do that is called a "condition variable", so called	538	The instrument to do that is called a "condition variable", so called
369	because they represent a condition that must become true.	539	because they represent a condition that must become true.
		540
		541	Now is probably a good time to look at the examples further below.
370		542
371	Condition variables can be created by calling the C<< AnyEvent->condvar	543	Condition variables can be created by calling the C<< AnyEvent->condvar
372	>> method, usually without arguments. The only argument pair allowed is	544	>> method, usually without arguments. The only argument pair allowed is
373	C<cb>, which specifies a callback to be called when the condition variable	545	C<cb>, which specifies a callback to be called when the condition variable
374	becomes true.	546	becomes true, with the condition variable as the first argument (but not
		547	the results).
375		548
376	After creation, the condition variable is "false" until it becomes "true"	549	After creation, the condition variable is "false" until it becomes "true"
377	by calling the C<send> method (or calling the condition variable as if it	550	by calling the C<send> method (or calling the condition variable as if it
378	were a callback, read about the caveats in the description for the C<<	551	were a callback, read about the caveats in the description for the C<<
379	->send >> method).	552	->send >> method).
…		…
381	Condition variables are similar to callbacks, except that you can	554	Condition variables are similar to callbacks, except that you can
382	optionally wait for them. They can also be called merge points - points	555	optionally wait for them. They can also be called merge points - points
383	in time where multiple outstanding events have been processed. And yet	556	in time where multiple outstanding events have been processed. And yet
384	another way to call them is transactions - each condition variable can be	557	another way to call them is transactions - each condition variable can be
385	used to represent a transaction, which finishes at some point and delivers	558	used to represent a transaction, which finishes at some point and delivers
386	a result.	559	a result. And yet some people know them as "futures" - a promise to
		560	compute/deliver something that you can wait for.
387		561
388	Condition variables are very useful to signal that something has finished,	562	Condition variables are very useful to signal that something has finished,
389	for example, if you write a module that does asynchronous http requests,	563	for example, if you write a module that does asynchronous http requests,
390	then a condition variable would be the ideal candidate to signal the	564	then a condition variable would be the ideal candidate to signal the
391	availability of results. The user can either act when the callback is	565	availability of results. The user can either act when the callback is
…		…
425	after => 1,	599	after => 1,
426	cb => sub { $result_ready->send },	600	cb => sub { $result_ready->send },
427	);	601	);
428		602
429	# this "blocks" (while handling events) till the callback	603	# this "blocks" (while handling events) till the callback
430	# calls send	604	# calls ->send
431	$result_ready->recv;	605	$result_ready->recv;
432		606
433	Example: wait for a timer, but take advantage of the fact that	607	Example: wait for a timer, but take advantage of the fact that condition
434	condition variables are also code references.	608	variables are also callable directly.
435		609
436	my $done = AnyEvent->condvar;	610	my $done = AnyEvent->condvar;
437	my $delay = AnyEvent->timer (after => 5, cb => $done);	611	my $delay = AnyEvent->timer (after => 5, cb => $done);
438	$done->recv;	612	$done->recv;
		613
		614	Example: Imagine an API that returns a condvar and doesn't support
		615	callbacks. This is how you make a synchronous call, for example from
		616	the main program:
		617
		618	use AnyEvent::CouchDB;
		619
		620	...
		621
		622	my @info = $couchdb->info->recv;
		623
		624	And this is how you would just set a callback to be called whenever the
		625	results are available:
		626
		627	$couchdb->info->cb (sub {
		628	my @info = $_[0]->recv;
		629	});
439		630
440	=head3 METHODS FOR PRODUCERS	631	=head3 METHODS FOR PRODUCERS
441		632
442	These methods should only be used by the producing side, i.e. the	633	These methods should only be used by the producing side, i.e. the
443	code/module that eventually sends the signal. Note that it is also	634	code/module that eventually sends the signal. Note that it is also
…		…
456	immediately from within send.	647	immediately from within send.
457		648
458	Any arguments passed to the C<send> call will be returned by all	649	Any arguments passed to the C<send> call will be returned by all
459	future C<< ->recv >> calls.	650	future C<< ->recv >> calls.
460		651
461	Condition variables are overloaded so one can call them directly	652	Condition variables are overloaded so one can call them directly (as if
462	(as a code reference). Calling them directly is the same as calling	653	they were a code reference). Calling them directly is the same as calling
463	C<send>. Note, however, that many C-based event loops do not handle	654	C<send>.
464	overloading, so as tempting as it may be, passing a condition variable
465	instead of a callback does not work. Both the pure perl and EV loops
466	support overloading, however, as well as all functions that use perl to
467	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
468	example).
469		655
470	=item $cv->croak ($error)	656	=item $cv->croak ($error)
471		657
472	Similar to send, but causes all call's to C<< ->recv >> to invoke	658	Similar to send, but causes all call's to C<< ->recv >> to invoke
473	C<Carp::croak> with the given error message/object/scalar.	659	C<Carp::croak> with the given error message/object/scalar.
474		660
475	This can be used to signal any errors to the condition variable	661	This can be used to signal any errors to the condition variable
476	user/consumer.	662	user/consumer. Doing it this way instead of calling C<croak> directly
		663	delays the error detetcion, but has the overwhelmign advantage that it
		664	diagnoses the error at the place where the result is expected, and not
		665	deep in some event clalback without connection to the actual code causing
		666	the problem.
477		667
478	=item $cv->begin ([group callback])	668	=item $cv->begin ([group callback])
479		669
480	=item $cv->end	670	=item $cv->end
481
482	These two methods are EXPERIMENTAL and MIGHT CHANGE.
483		671
484	These two methods can be used to combine many transactions/events into	672	These two methods can be used to combine many transactions/events into
485	one. For example, a function that pings many hosts in parallel might want	673	one. For example, a function that pings many hosts in parallel might want
486	to use a condition variable for the whole process.	674	to use a condition variable for the whole process.
487		675
488	Every call to C<< ->begin >> will increment a counter, and every call to	676	Every call to C<< ->begin >> will increment a counter, and every call to
489	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	677	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
490	>>, the (last) callback passed to C<begin> will be executed. That callback	678	>>, the (last) callback passed to C<begin> will be executed, passing the
491	is I<supposed> to call C<< ->send >>, but that is not required. If no	679	condvar as first argument. That callback is I<supposed> to call C<< ->send
492	callback was set, C<send> will be called without any arguments.	680	>>, but that is not required. If no group callback was set, C<send> will
		681	be called without any arguments.
493		682
494	Let's clarify this with the ping example:	683	You can think of C<< $cv->send >> giving you an OR condition (one call
		684	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
		685	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
		686
		687	Let's start with a simple example: you have two I/O watchers (for example,
		688	STDOUT and STDERR for a program), and you want to wait for both streams to
		689	close before activating a condvar:
495		690
496	my $cv = AnyEvent->condvar;	691	my $cv = AnyEvent->condvar;
497		692
		693	$cv->begin; # first watcher
		694	my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
		695	defined sysread $fh1, my $buf, 4096
		696	or $cv->end;
		697	});
		698
		699	$cv->begin; # second watcher
		700	my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
		701	defined sysread $fh2, my $buf, 4096
		702	or $cv->end;
		703	});
		704
		705	$cv->recv;
		706
		707	This works because for every event source (EOF on file handle), there is
		708	one call to C<begin>, so the condvar waits for all calls to C<end> before
		709	sending.
		710
		711	The ping example mentioned above is slightly more complicated, as the
		712	there are results to be passwd back, and the number of tasks that are
		713	begung can potentially be zero:
		714
		715	my $cv = AnyEvent->condvar;
		716
498	my %result;	717	my %result;
499	$cv->begin (sub { $cv->send (\%result) });	718	$cv->begin (sub { shift->send (\%result) });
500		719
501	for my $host (@list_of_hosts) {	720	for my $host (@list_of_hosts) {
502	$cv->begin;	721	$cv->begin;
503	ping_host_then_call_callback $host, sub {	722	ping_host_then_call_callback $host, sub {
504	$result{$host} = ...;	723	$result{$host} = ...;
…		…
519	loop, which serves two important purposes: first, it sets the callback	738	loop, which serves two important purposes: first, it sets the callback
520	to be called once the counter reaches C<0>, and second, it ensures that	739	to be called once the counter reaches C<0>, and second, it ensures that
521	C<send> is called even when C<no> hosts are being pinged (the loop	740	C<send> is called even when C<no> hosts are being pinged (the loop
522	doesn't execute once).	741	doesn't execute once).
523		742
524	This is the general pattern when you "fan out" into multiple subrequests:	743	This is the general pattern when you "fan out" into multiple (but
525	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	744	potentially none) subrequests: use an outer C<begin>/C<end> pair to set
526	is called at least once, and then, for each subrequest you start, call	745	the callback and ensure C<end> is called at least once, and then, for each
527	C<begin> and for each subrequest you finish, call C<end>.	746	subrequest you start, call C<begin> and for each subrequest you finish,
		747	call C<end>.
528		748
529	=back	749	=back
530		750
531	=head3 METHODS FOR CONSUMERS	751	=head3 METHODS FOR CONSUMERS
532		752
…		…
548	function will call C<croak>.	768	function will call C<croak>.
549		769
550	In list context, all parameters passed to C<send> will be returned,	770	In list context, all parameters passed to C<send> will be returned,
551	in scalar context only the first one will be returned.	771	in scalar context only the first one will be returned.
552		772
		773	Note that doing a blocking wait in a callback is not supported by any
		774	event loop, that is, recursive invocation of a blocking C<< ->recv
		775	>> is not allowed, and the C<recv> call will C<croak> if such a
		776	condition is detected. This condition can be slightly loosened by using
		777	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		778	any thread that doesn't run the event loop itself.
		779
553	Not all event models support a blocking wait - some die in that case	780	Not all event models support a blocking wait - some die in that case
554	(programs might want to do that to stay interactive), so I<if you are	781	(programs might want to do that to stay interactive), so I<if you are
555	using this from a module, never require a blocking wait>, but let the	782	using this from a module, never require a blocking wait>. Instead, let the
556	caller decide whether the call will block or not (for example, by coupling	783	caller decide whether the call will block or not (for example, by coupling
557	condition variables with some kind of request results and supporting	784	condition variables with some kind of request results and supporting
558	callbacks so the caller knows that getting the result will not block,	785	callbacks so the caller knows that getting the result will not block,
559	while still supporting blocking waits if the caller so desires).	786	while still supporting blocking waits if the caller so desires).
560		787
561	Another reason I<never> to C<< ->recv >> in a module is that you cannot
562	sensibly have two C<< ->recv >>'s in parallel, as that would require
563	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
564	can supply.
565
566	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
567	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
568	versions and also integrates coroutines into AnyEvent, making blocking
569	C<< ->recv >> calls perfectly safe as long as they are done from another
570	coroutine (one that doesn't run the event loop).
571
572	You can ensure that C<< -recv >> never blocks by setting a callback and	788	You can ensure that C<< -recv >> never blocks by setting a callback and
573	only calling C<< ->recv >> from within that callback (or at a later	789	only calling C<< ->recv >> from within that callback (or at a later
574	time). This will work even when the event loop does not support blocking	790	time). This will work even when the event loop does not support blocking
575	waits otherwise.	791	waits otherwise.
576		792
577	=item $bool = $cv->ready	793	=item $bool = $cv->ready
578		794
579	Returns true when the condition is "true", i.e. whether C<send> or	795	Returns true when the condition is "true", i.e. whether C<send> or
580	C<croak> have been called.	796	C<croak> have been called.
581		797
582	=item $cb = $cv->cb ([new callback])	798	=item $cb = $cv->cb ($cb->($cv))
583		799
584	This is a mutator function that returns the callback set and optionally	800	This is a mutator function that returns the callback set and optionally
585	replaces it before doing so.	801	replaces it before doing so.
586		802
587	The callback will be called when the condition becomes "true", i.e. when	803	The callback will be called when the condition becomes (or already was)
588	C<send> or C<croak> are called. Calling C<recv> inside the callback	804	"true", i.e. when C<send> or C<croak> are called (or were called), with
		805	the only argument being the condition variable itself. Calling C<recv>
589	or at any later time is guaranteed not to block.	806	inside the callback or at any later time is guaranteed not to block.
590		807
591	=back	808	=back
592		809
		810	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		811
		812	The available backend classes are (every class has its own manpage):
		813
		814	=over 4
		815
		816	=item Backends that are autoprobed when no other event loop can be found.
		817
		818	EV is the preferred backend when no other event loop seems to be in
		819	use. If EV is not installed, then AnyEvent will fall back to its own
		820	pure-perl implementation, which is available everywhere as it comes with
		821	AnyEvent itself.
		822
		823	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		824	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		825
		826	=item Backends that are transparently being picked up when they are used.
		827
		828	These will be used when they are currently loaded when the first watcher
		829	is created, in which case it is assumed that the application is using
		830	them. This means that AnyEvent will automatically pick the right backend
		831	when the main program loads an event module before anything starts to
		832	create watchers. Nothing special needs to be done by the main program.
		833
		834	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		835	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		836	AnyEvent::Impl::Tk based on Tk, very broken.
		837	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		838	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		839	AnyEvent::Impl::Irssi used when running within irssi.
		840
		841	=item Backends with special needs.
		842
		843	Qt requires the Qt::Application to be instantiated first, but will
		844	otherwise be picked up automatically. As long as the main program
		845	instantiates the application before any AnyEvent watchers are created,
		846	everything should just work.
		847
		848	AnyEvent::Impl::Qt based on Qt.
		849
		850	Support for IO::Async can only be partial, as it is too broken and
		851	architecturally limited to even support the AnyEvent API. It also
		852	is the only event loop that needs the loop to be set explicitly, so
		853	it can only be used by a main program knowing about AnyEvent. See
		854	L<AnyEvent::Impl::Async> for the gory details.
		855
		856	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		857
		858	=item Event loops that are indirectly supported via other backends.
		859
		860	Some event loops can be supported via other modules:
		861
		862	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		863
		864	B<WxWidgets> has no support for watching file handles. However, you can
		865	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		866	polls 20 times per second, which was considered to be too horrible to even
		867	consider for AnyEvent.
		868
		869	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		870	backend, so it can be supported through POE.
		871
		872	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		873	load L<POE> when detecting them, in the hope that POE will pick them up,
		874	in which case everything will be automatic.
		875
		876	=back
		877
593	=head1 GLOBAL VARIABLES AND FUNCTIONS	878	=head1 GLOBAL VARIABLES AND FUNCTIONS
594		879
		880	These are not normally required to use AnyEvent, but can be useful to
		881	write AnyEvent extension modules.
		882
595	=over 4	883	=over 4
596		884
597	=item $AnyEvent::MODEL	885	=item $AnyEvent::MODEL
598		886
599	Contains C<undef> until the first watcher is being created. Then it	887	Contains C<undef> until the first watcher is being created, before the
		888	backend has been autodetected.
		889
600	contains the event model that is being used, which is the name of the	890	Afterwards it contains the event model that is being used, which is the
601	Perl class implementing the model. This class is usually one of the	891	name of the Perl class implementing the model. This class is usually one
602	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	892	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
603	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	893	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
604		894	will be C<urxvt::anyevent>).
605	The known classes so far are:
606
607	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
608	AnyEvent::Impl::Event based on Event, second best choice.
609	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
610	AnyEvent::Impl::Glib based on Glib, third-best choice.
611	AnyEvent::Impl::Tk based on Tk, very bad choice.
612	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
613	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
614	AnyEvent::Impl::POE based on POE, not generic enough for full support.
615
616	There is no support for WxWidgets, as WxWidgets has no support for
617	watching file handles. However, you can use WxWidgets through the
618	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
619	second, which was considered to be too horrible to even consider for
620	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
621	it's adaptor.
622
623	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
624	autodetecting them.
625		895
626	=item AnyEvent::detect	896	=item AnyEvent::detect
627		897
628	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	898	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
629	if necessary. You should only call this function right before you would	899	if necessary. You should only call this function right before you would
630	have created an AnyEvent watcher anyway, that is, as late as possible at	900	have created an AnyEvent watcher anyway, that is, as late as possible at
631	runtime.	901	runtime, and not e.g. while initialising of your module.
		902
		903	If you need to do some initialisation before AnyEvent watchers are
		904	created, use C<post_detect>.
632		905
633	=item $guard = AnyEvent::post_detect { BLOCK }	906	=item $guard = AnyEvent::post_detect { BLOCK }
634		907
635	Arranges for the code block to be executed as soon as the event model is	908	Arranges for the code block to be executed as soon as the event model is
636	autodetected (or immediately if this has already happened).	909	autodetected (or immediately if this has already happened).
637		910
		911	The block will be executed I<after> the actual backend has been detected
		912	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		913	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		914	other initialisations - see the sources of L<AnyEvent::Strict> or
		915	L<AnyEvent::AIO> to see how this is used.
		916
		917	The most common usage is to create some global watchers, without forcing
		918	event module detection too early, for example, L<AnyEvent::AIO> creates
		919	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		920	avoid autodetecting the event module at load time.
		921
638	If called in scalar or list context, then it creates and returns an object	922	If called in scalar or list context, then it creates and returns an object
639	that automatically removes the callback again when it is destroyed. See	923	that automatically removes the callback again when it is destroyed (or
		924	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
640	L<Coro::BDB> for a case where this is useful.	925	a case where this is useful.
		926
		927	Example: Create a watcher for the IO::AIO module and store it in
		928	C<$WATCHER>. Only do so after the event loop is initialised, though.
		929
		930	our WATCHER;
		931
		932	my $guard = AnyEvent::post_detect {
		933	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		934	};
		935
		936	# the ||= is important in case post_detect immediately runs the block,
		937	# as to not clobber the newly-created watcher. assigning both watcher and
		938	# post_detect guard to the same variable has the advantage of users being
		939	# able to just C<undef $WATCHER> if the watcher causes them grief.
		940
		941	$WATCHER ||= $guard;
641		942
642	=item @AnyEvent::post_detect	943	=item @AnyEvent::post_detect
643		944
644	If there are any code references in this array (you can C<push> to it	945	If there are any code references in this array (you can C<push> to it
645	before or after loading AnyEvent), then they will called directly after	946	before or after loading AnyEvent), then they will called directly after
646	the event loop has been chosen.	947	the event loop has been chosen.
647		948
648	You should check C<$AnyEvent::MODEL> before adding to this array, though:	949	You should check C<$AnyEvent::MODEL> before adding to this array, though:
649	if it contains a true value then the event loop has already been detected,	950	if it is defined then the event loop has already been detected, and the
650	and the array will be ignored.	951	array will be ignored.
651		952
652	Best use C<AnyEvent::post_detect { BLOCK }> instead.	953	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		954	it,as it takes care of these details.
		955
		956	This variable is mainly useful for modules that can do something useful
		957	when AnyEvent is used and thus want to know when it is initialised, but do
		958	not need to even load it by default. This array provides the means to hook
		959	into AnyEvent passively, without loading it.
653		960
654	=back	961	=back
655		962
656	=head1 WHAT TO DO IN A MODULE	963	=head1 WHAT TO DO IN A MODULE
657		964
…		…
712		1019
713		1020
714	=head1 OTHER MODULES	1021	=head1 OTHER MODULES
715		1022
716	The following is a non-exhaustive list of additional modules that use	1023	The following is a non-exhaustive list of additional modules that use
717	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1024	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
718	in the same program. Some of the modules come with AnyEvent, some are	1025	modules and other event loops in the same program. Some of the modules
719	available via CPAN.	1026	come with AnyEvent, most are available via CPAN.
720		1027
721	=over 4	1028	=over 4
722		1029
723	=item L<AnyEvent::Util>	1030	=item L<AnyEvent::Util>
724		1031
725	Contains various utility functions that replace often-used but blocking	1032	Contains various utility functions that replace often-used but blocking
726	functions such as C<inet_aton> by event-/callback-based versions.	1033	functions such as C<inet_aton> by event-/callback-based versions.
727
728	=item L<AnyEvent::Handle>
729
730	Provide read and write buffers and manages watchers for reads and writes.
731		1034
732	=item L<AnyEvent::Socket>	1035	=item L<AnyEvent::Socket>
733		1036
734	Provides various utility functions for (internet protocol) sockets,	1037	Provides various utility functions for (internet protocol) sockets,
735	addresses and name resolution. Also functions to create non-blocking tcp	1038	addresses and name resolution. Also functions to create non-blocking tcp
736	connections or tcp servers, with IPv6 and SRV record support and more.	1039	connections or tcp servers, with IPv6 and SRV record support and more.
737		1040
		1041	=item L<AnyEvent::Handle>
		1042
		1043	Provide read and write buffers, manages watchers for reads and writes,
		1044	supports raw and formatted I/O, I/O queued and fully transparent and
		1045	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
		1046
738	=item L<AnyEvent::DNS>	1047	=item L<AnyEvent::DNS>
739		1048
740	Provides rich asynchronous DNS resolver capabilities.	1049	Provides rich asynchronous DNS resolver capabilities.
741		1050
		1051	=item L<AnyEvent::HTTP>
		1052
		1053	A simple-to-use HTTP library that is capable of making a lot of concurrent
		1054	HTTP requests.
		1055
742	=item L<AnyEvent::HTTPD>	1056	=item L<AnyEvent::HTTPD>
743		1057
744	Provides a simple web application server framework.	1058	Provides a simple web application server framework.
745		1059
746	=item L<AnyEvent::FastPing>	1060	=item L<AnyEvent::FastPing>
747		1061
748	The fastest ping in the west.	1062	The fastest ping in the west.
749		1063
		1064	=item L<AnyEvent::DBI>
		1065
		1066	Executes L<DBI> requests asynchronously in a proxy process.
		1067
		1068	=item L<AnyEvent::AIO>
		1069
		1070	Truly asynchronous I/O, should be in the toolbox of every event
		1071	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
		1072	together.
		1073
		1074	=item L<AnyEvent::BDB>
		1075
		1076	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
		1077	L<BDB> and AnyEvent together.
		1078
		1079	=item L<AnyEvent::GPSD>
		1080
		1081	A non-blocking interface to gpsd, a daemon delivering GPS information.
		1082
750	=item L<Net::IRC3>	1083	=item L<AnyEvent::IRC>
751		1084
752	AnyEvent based IRC client module family.	1085	AnyEvent based IRC client module family (replacing the older Net::IRC3).
753		1086
754	=item L<Net::XMPP2>	1087	=item L<AnyEvent::XMPP>
755		1088
756	AnyEvent based XMPP (Jabber protocol) module family.	1089	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1090	Net::XMPP2>.
		1091
		1092	=item L<AnyEvent::IGS>
		1093
		1094	A non-blocking interface to the Internet Go Server protocol (used by
		1095	L<App::IGS>).
757		1096
758	=item L<Net::FCP>	1097	=item L<Net::FCP>
759		1098
760	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1099	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
761	of AnyEvent.	1100	of AnyEvent.
…		…
766		1105
767	=item L<Coro>	1106	=item L<Coro>
768		1107
769	Has special support for AnyEvent via L<Coro::AnyEvent>.	1108	Has special support for AnyEvent via L<Coro::AnyEvent>.
770		1109
771	=item L<AnyEvent::AIO>, L<IO::AIO>
772
773	Truly asynchronous I/O, should be in the toolbox of every event
774	programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
775	together.
776
777	=item L<AnyEvent::BDB>, L<BDB>
778
779	Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
780	IO::AIO and AnyEvent together.
781
782	=item L<IO::Lambda>
783
784	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
785
786	=back	1110	=back
787		1111
788	=cut	1112	=cut
789		1113
790	package AnyEvent;	1114	package AnyEvent;
791		1115
792	no warnings;	1116	# basically a tuned-down version of common::sense
793	use strict;	1117	sub common_sense {
		1118	# from common:.sense 1.0
		1119	${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
		1120	# use strict vars subs
		1121	$^H |= 0x00000600;
		1122	}
794		1123
		1124	BEGIN { AnyEvent::common_sense }
		1125
795	use Carp;	1126	use Carp ();
796		1127
797	our $VERSION = '4.05';	1128	our $VERSION = '5.202';
798	our $MODEL;	1129	our $MODEL;
799		1130
800	our $AUTOLOAD;	1131	our $AUTOLOAD;
801	our @ISA;	1132	our @ISA;
802		1133
803	our @REGISTRY;	1134	our @REGISTRY;
804		1135
805	our $WIN32;	1136	our $WIN32;
806		1137
		1138	our $VERBOSE;
		1139
807	BEGIN {	1140	BEGIN {
808	my $win32 = ! ! ($^O =~ /mswin32/i);	1141	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
809	eval "sub WIN32(){ $win32 }";	1142	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
810	}
811		1143
		1144	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1145	if ${^TAINT};
		1146
812	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1147	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1148
		1149	}
		1150
		1151	our $MAX_SIGNAL_LATENCY = 10;
813		1152
814	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1153	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
815		1154
816	{	1155	{
817	my $idx;	1156	my $idx;
…		…
819	for reverse split /\s*,\s*/,	1158	for reverse split /\s*,\s*/,
820	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1159	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
821	}	1160	}
822		1161
823	my @models = (	1162	my @models = (
824	[EV:: => AnyEvent::Impl::EV::],	1163	[EV:: => AnyEvent::Impl::EV:: , 1],
825	[Event:: => AnyEvent::Impl::Event::],
826	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1164	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
827	# everything below here will not be autoprobed	1165	# everything below here will not (normally) be autoprobed
828	# as the pureperl backend should work everywhere	1166	# as the pureperl backend should work everywhere
829	# and is usually faster	1167	# and is usually faster
		1168	[Event:: => AnyEvent::Impl::Event::, 1],
		1169	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1170	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1171	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
830	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1172	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
831	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
832	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
833	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1173	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
834	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1174	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
835	[Wx:: => AnyEvent::Impl::POE::],	1175	[Wx:: => AnyEvent::Impl::POE::],
836	[Prima:: => AnyEvent::Impl::POE::],	1176	[Prima:: => AnyEvent::Impl::POE::],
		1177	# IO::Async is just too broken - we would need workarounds for its
		1178	# byzantine signal and broken child handling, among others.
		1179	# IO::Async is rather hard to detect, as it doesn't have any
		1180	# obvious default class.
		1181	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1182	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1183	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1184	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
837	);	1185	);
838		1186
839	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);	1187	our %method = map +($_ => 1),
		1188	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
840		1189
841	our @post_detect;	1190	our @post_detect;
842		1191
843	sub post_detect(&) {	1192	sub post_detect(&) {
844	my ($cb) = @_;	1193	my ($cb) = @_;
845		1194
846	if ($MODEL) {	1195	if ($MODEL) {
847	$cb->();	1196	$cb->();
848		1197
849	1	1198	undef
850	} else {	1199	} else {
851	push @post_detect, $cb;	1200	push @post_detect, $cb;
852		1201
853	defined wantarray	1202	defined wantarray
854	? bless \$cb, "AnyEvent::Util::PostDetect"	1203	? bless \$cb, "AnyEvent::Util::postdetect"
855	: ()	1204	: ()
856	}	1205	}
857	}	1206	}
858		1207
859	sub AnyEvent::Util::PostDetect::DESTROY {	1208	sub AnyEvent::Util::postdetect::DESTROY {
860	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1209	@post_detect = grep $_ != ${$_[0]}, @post_detect;
861	}	1210	}
862		1211
863	sub detect() {	1212	sub detect() {
864	unless ($MODEL) {	1213	unless ($MODEL) {
865	no strict 'refs';
866	local $SIG{__DIE__};	1214	local $SIG{__DIE__};
867		1215
868	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1216	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
869	my $model = "AnyEvent::Impl::$1";	1217	my $model = "AnyEvent::Impl::$1";
870	if (eval "require $model") {	1218	if (eval "require $model") {
871	$MODEL = $model;	1219	$MODEL = $model;
872	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1220	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
873	} else {	1221	} else {
874	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1222	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
875	}	1223	}
876	}	1224	}
877		1225
878	# check for already loaded models	1226	# check for already loaded models
879	unless ($MODEL) {	1227	unless ($MODEL) {
880	for (@REGISTRY, @models) {	1228	for (@REGISTRY, @models) {
881	my ($package, $model) = @$_;	1229	my ($package, $model) = @$_;
882	if (${"$package\::VERSION"} > 0) {	1230	if (${"$package\::VERSION"} > 0) {
883	if (eval "require $model") {	1231	if (eval "require $model") {
884	$MODEL = $model;	1232	$MODEL = $model;
885	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1233	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
886	last;	1234	last;
887	}	1235	}
888	}	1236	}
889	}	1237	}
890		1238
891	unless ($MODEL) {	1239	unless ($MODEL) {
892	# try to load a model	1240	# try to autoload a model
893
894	for (@REGISTRY, @models) {	1241	for (@REGISTRY, @models) {
895	my ($package, $model) = @$_;	1242	my ($package, $model, $autoload) = @$_;
		1243	if (
		1244	$autoload
896	if (eval "require $package"	1245	and eval "require $package"
897	and ${"$package\::VERSION"} > 0	1246	and ${"$package\::VERSION"} > 0
898	and eval "require $model") {	1247	and eval "require $model"
		1248	) {
899	$MODEL = $model;	1249	$MODEL = $model;
900	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1250	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
901	last;	1251	last;
902	}	1252	}
903	}	1253	}
904		1254
905	$MODEL	1255	$MODEL
906	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1256	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
907	}	1257	}
908	}	1258	}
909		1259
		1260	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1261
910	unshift @ISA, $MODEL;	1262	unshift @ISA, $MODEL;
911	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1263
		1264	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
912		1265
913	(shift @post_detect)->() while @post_detect;	1266	(shift @post_detect)->() while @post_detect;
914	}	1267	}
915		1268
916	$MODEL	1269	$MODEL
…		…
918		1271
919	sub AUTOLOAD {	1272	sub AUTOLOAD {
920	(my $func = $AUTOLOAD) =~ s/.*://;	1273	(my $func = $AUTOLOAD) =~ s/.*://;
921		1274
922	$method{$func}	1275	$method{$func}
923	or croak "$func: not a valid method for AnyEvent objects";	1276	or Carp::croak "$func: not a valid method for AnyEvent objects";
924		1277
925	detect unless $MODEL;	1278	detect unless $MODEL;
926		1279
927	my $class = shift;	1280	my $class = shift;
928	$class->$func (@_);	1281	$class->$func (@_);
929	}	1282	}
930		1283
		1284	# utility function to dup a filehandle. this is used by many backends
		1285	# to support binding more than one watcher per filehandle (they usually
		1286	# allow only one watcher per fd, so we dup it to get a different one).
		1287	sub _dupfh($$;$$) {
		1288	my ($poll, $fh, $r, $w) = @_;
		1289
		1290	# cygwin requires the fh mode to be matching, unix doesn't
		1291	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
		1292
		1293	open my $fh2, $mode, $fh
		1294	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
		1295
		1296	# we assume CLOEXEC is already set by perl in all important cases
		1297
		1298	($fh2, $rw)
		1299	}
		1300
		1301	=head1 SIMPLIFIED AE API
		1302
		1303	Starting with version 5.0, AnyEvent officially supports a second, much
		1304	simpler, API that is designed to reduce the calling, typing and memory
		1305	overhead.
		1306
		1307	See the L<AE> manpage for details.
		1308
		1309	=cut
		1310
		1311	package AE;
		1312
		1313	our $VERSION = $AnyEvent::VERSION;
		1314
		1315	sub io($$$) {
		1316	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1317	}
		1318
		1319	sub timer($$$) {
		1320	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1321	}
		1322
		1323	sub signal($$) {
		1324	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1325	}
		1326
		1327	sub child($$) {
		1328	AnyEvent->child (pid => $_[0], cb => $_[1])
		1329	}
		1330
		1331	sub idle($) {
		1332	AnyEvent->idle (cb => $_[0])
		1333	}
		1334
		1335	sub cv(;&) {
		1336	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1337	}
		1338
		1339	sub now() {
		1340	AnyEvent->now
		1341	}
		1342
		1343	sub now_update() {
		1344	AnyEvent->now_update
		1345	}
		1346
		1347	sub time() {
		1348	AnyEvent->time
		1349	}
		1350
931	package AnyEvent::Base;	1351	package AnyEvent::Base;
932		1352
933	# default implementation for now and time	1353	# default implementations for many methods
934		1354
935	use Time::HiRes ();	1355	sub _time() {
		1356	# probe for availability of Time::HiRes
		1357	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1358	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
		1359	*_time = \&Time::HiRes::time;
		1360	# if (eval "use POSIX (); (POSIX::times())...
		1361	} else {
		1362	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
		1363	*_time = sub { time }; # epic fail
		1364	}
936		1365
937	sub time { Time::HiRes::time }	1366	&_time
938	sub now { Time::HiRes::time }	1367	}
		1368
		1369	sub time { _time }
		1370	sub now { _time }
		1371	sub now_update { }
939		1372
940	# default implementation for ->condvar	1373	# default implementation for ->condvar
941		1374
942	sub condvar {	1375	sub condvar {
943	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1376	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
944	}	1377	}
945		1378
946	# default implementation for ->signal	1379	# default implementation for ->signal
947		1380
948	our %SIG_CB;	1381	our $HAVE_ASYNC_INTERRUPT;
		1382
		1383	sub _have_async_interrupt() {
		1384	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1385	&& eval "use Async::Interrupt 1.02 (); 1")
		1386	unless defined $HAVE_ASYNC_INTERRUPT;
		1387
		1388	$HAVE_ASYNC_INTERRUPT
		1389	}
		1390
		1391	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1392	our (%SIG_ASY, %SIG_ASY_W);
		1393	our ($SIG_COUNT, $SIG_TW);
		1394
		1395	sub _signal_exec {
		1396	$HAVE_ASYNC_INTERRUPT
		1397	? $SIGPIPE_R->drain
		1398	: sysread $SIGPIPE_R, (my $dummy), 9;
		1399
		1400	while (%SIG_EV) {
		1401	for (keys %SIG_EV) {
		1402	delete $SIG_EV{$_};
		1403	$_->() for values %{ $SIG_CB{$_} || {} };
		1404	}
		1405	}
		1406	}
		1407
		1408	# install a dummy wakeup watcher to reduce signal catching latency
		1409	sub _sig_add() {
		1410	unless ($SIG_COUNT++) {
		1411	# try to align timer on a full-second boundary, if possible
		1412	my $NOW = AE::now;
		1413
		1414	$SIG_TW = AE::timer
		1415	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1416	$MAX_SIGNAL_LATENCY,
		1417	sub { } # just for the PERL_ASYNC_CHECK
		1418	;
		1419	}
		1420	}
		1421
		1422	sub _sig_del {
		1423	undef $SIG_TW
		1424	unless --$SIG_COUNT;
		1425	}
		1426
		1427	our $_sig_name_init; $_sig_name_init = sub {
		1428	eval q{ # poor man's autoloading
		1429	undef $_sig_name_init;
		1430
		1431	if (_have_async_interrupt) {
		1432	*sig2num = \&Async::Interrupt::sig2num;
		1433	*sig2name = \&Async::Interrupt::sig2name;
		1434	} else {
		1435	require Config;
		1436
		1437	my %signame2num;
		1438	@signame2num{ split ' ', $Config::Config{sig_name} }
		1439	= split ' ', $Config::Config{sig_num};
		1440
		1441	my @signum2name;
		1442	@signum2name[values %signame2num] = keys %signame2num;
		1443
		1444	*sig2num = sub($) {
		1445	$_[0] > 0 ? shift : $signame2num{+shift}
		1446	};
		1447	*sig2name = sub ($) {
		1448	$_[0] > 0 ? $signum2name[+shift] : shift
		1449	};
		1450	}
		1451	};
		1452	die if $@;
		1453	};
		1454
		1455	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1456	sub sig2name($) { &$_sig_name_init; &sig2name }
949		1457
950	sub signal {	1458	sub signal {
		1459	eval q{ # poor man's autoloading {}
		1460	# probe for availability of Async::Interrupt
		1461	if (_have_async_interrupt) {
		1462	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1463
		1464	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1465	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1466
		1467	} else {
		1468	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1469
		1470	require Fcntl;
		1471
		1472	if (AnyEvent::WIN32) {
		1473	require AnyEvent::Util;
		1474
		1475	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1476	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1477	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1478	} else {
		1479	pipe $SIGPIPE_R, $SIGPIPE_W;
		1480	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1481	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1482
		1483	# not strictly required, as $^F is normally 2, but let's make sure...
		1484	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1485	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1486	}
		1487
		1488	$SIGPIPE_R
		1489	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1490
		1491	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1492	}
		1493
		1494	*signal = sub {
951	my (undef, %arg) = @_;	1495	my (undef, %arg) = @_;
952		1496
953	my $signal = uc $arg{signal}	1497	my $signal = uc $arg{signal}
954	or Carp::croak "required option 'signal' is missing";	1498	or Carp::croak "required option 'signal' is missing";
955		1499
		1500	if ($HAVE_ASYNC_INTERRUPT) {
		1501	# async::interrupt
		1502
		1503	$signal = sig2num $signal;
956	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1504	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1505
		1506	$SIG_ASY{$signal} ||= new Async::Interrupt
		1507	cb => sub { undef $SIG_EV{$signal} },
		1508	signal => $signal,
		1509	pipe => [$SIGPIPE_R->filenos],
		1510	pipe_autodrain => 0,
		1511	;
		1512
		1513	} else {
		1514	# pure perl
		1515
		1516	# AE::Util has been loaded in signal
		1517	$signal = sig2name $signal;
		1518	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1519
957	$SIG{$signal} ||= sub {	1520	$SIG{$signal} ||= sub {
958	$_->() for values %{ $SIG_CB{$signal} || {} };	1521	local $!;
		1522	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1523	undef $SIG_EV{$signal};
		1524	};
		1525
		1526	# can't do signal processing without introducing races in pure perl,
		1527	# so limit the signal latency.
		1528	_sig_add;
		1529	}
		1530
		1531	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1532	};
		1533
		1534	*AnyEvent::Base::signal::DESTROY = sub {
		1535	my ($signal, $cb) = @{$_[0]};
		1536
		1537	_sig_del;
		1538
		1539	delete $SIG_CB{$signal}{$cb};
		1540
		1541	$HAVE_ASYNC_INTERRUPT
		1542	? delete $SIG_ASY{$signal}
		1543	: # delete doesn't work with older perls - they then
		1544	# print weird messages, or just unconditionally exit
		1545	# instead of getting the default action.
		1546	undef $SIG{$signal}
		1547	unless keys %{ $SIG_CB{$signal} };
		1548	};
959	};	1549	};
960		1550	die if $@;
961	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1551	&signal
962	}
963
964	sub AnyEvent::Base::Signal::DESTROY {
965	my ($signal, $cb) = @{$_[0]};
966
967	delete $SIG_CB{$signal}{$cb};
968
969	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };
970	}	1552	}
971		1553
972	# default implementation for ->child	1554	# default implementation for ->child
973		1555
974	our %PID_CB;	1556	our %PID_CB;
975	our $CHLD_W;	1557	our $CHLD_W;
976	our $CHLD_DELAY_W;	1558	our $CHLD_DELAY_W;
977	our $PID_IDLE;
978	our $WNOHANG;	1559	our $WNOHANG;
979		1560
980	sub _child_wait {	1561	sub _emit_childstatus($$) {
981	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1562	my (undef, $rpid, $rstatus) = @_;
		1563
		1564	$_->($rpid, $rstatus)
982	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1565	for values %{ $PID_CB{$rpid} || {} },
983	(values %{ $PID_CB{0} || {} });	1566	values %{ $PID_CB{0} || {} };
984	}
985
986	undef $PID_IDLE;
987	}	1567	}
988		1568
989	sub _sigchld {	1569	sub _sigchld {
990	# make sure we deliver these changes "synchronous" with the event loop.	1570	my $pid;
991	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {	1571
992	undef $CHLD_DELAY_W;	1572	AnyEvent->_emit_childstatus ($pid, $?)
993	&_child_wait;	1573	while ($pid = waitpid -1, $WNOHANG) > 0;
994	});
995	}	1574	}
996		1575
997	sub child {	1576	sub child {
998	my (undef, %arg) = @_;	1577	my (undef, %arg) = @_;
999		1578
1000	defined (my $pid = $arg{pid} + 0)	1579	defined (my $pid = $arg{pid} + 0)
1001	or Carp::croak "required option 'pid' is missing";	1580	or Carp::croak "required option 'pid' is missing";
1002		1581
1003	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1582	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1004		1583
1005	unless ($WNOHANG) {	1584	# WNOHANG is almost cetrainly 1 everywhere
		1585	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
		1586	? 1
1006	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1587	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1007	}
1008		1588
1009	unless ($CHLD_W) {	1589	unless ($CHLD_W) {
1010	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1590	$CHLD_W = AE::signal CHLD => \&_sigchld;
1011	# child could be a zombie already, so make at least one round	1591	# child could be a zombie already, so make at least one round
1012	&_sigchld;	1592	&_sigchld;
1013	}	1593	}
1014		1594
1015	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1595	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1016	}	1596	}
1017		1597
1018	sub AnyEvent::Base::Child::DESTROY {	1598	sub AnyEvent::Base::child::DESTROY {
1019	my ($pid, $cb) = @{$_[0]};	1599	my ($pid, $cb) = @{$_[0]};
1020		1600
1021	delete $PID_CB{$pid}{$cb};	1601	delete $PID_CB{$pid}{$cb};
1022	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1602	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1023		1603
1024	undef $CHLD_W unless keys %PID_CB;	1604	undef $CHLD_W unless keys %PID_CB;
1025	}	1605	}
1026		1606
		1607	# idle emulation is done by simply using a timer, regardless
		1608	# of whether the process is idle or not, and not letting
		1609	# the callback use more than 50% of the time.
		1610	sub idle {
		1611	my (undef, %arg) = @_;
		1612
		1613	my ($cb, $w, $rcb) = $arg{cb};
		1614
		1615	$rcb = sub {
		1616	if ($cb) {
		1617	$w = _time;
		1618	&$cb;
		1619	$w = _time - $w;
		1620
		1621	# never use more then 50% of the time for the idle watcher,
		1622	# within some limits
		1623	$w = 0.0001 if $w < 0.0001;
		1624	$w = 5 if $w > 5;
		1625
		1626	$w = AE::timer $w, 0, $rcb;
		1627	} else {
		1628	# clean up...
		1629	undef $w;
		1630	undef $rcb;
		1631	}
		1632	};
		1633
		1634	$w = AE::timer 0.05, 0, $rcb;
		1635
		1636	bless \\$cb, "AnyEvent::Base::idle"
		1637	}
		1638
		1639	sub AnyEvent::Base::idle::DESTROY {
		1640	undef $${$_[0]};
		1641	}
		1642
1027	package AnyEvent::CondVar;	1643	package AnyEvent::CondVar;
1028		1644
1029	our @ISA = AnyEvent::CondVar::Base::;	1645	our @ISA = AnyEvent::CondVar::Base::;
1030		1646
1031	package AnyEvent::CondVar::Base;	1647	package AnyEvent::CondVar::Base;
1032		1648
1033	use overload	1649	#use overload
1034	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1650	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1035	fallback => 1;	1651	# fallback => 1;
		1652
		1653	# save 300+ kilobytes by dirtily hardcoding overloading
		1654	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1655	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1656	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1657	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1658
		1659	our $WAITING;
1036		1660
1037	sub _send {	1661	sub _send {
1038	# nop	1662	# nop
1039	}	1663	}
1040		1664
…		…
1053	sub ready {	1677	sub ready {
1054	$_[0]{_ae_sent}	1678	$_[0]{_ae_sent}
1055	}	1679	}
1056		1680
1057	sub _wait {	1681	sub _wait {
		1682	$WAITING
		1683	and !$_[0]{_ae_sent}
		1684	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1685
		1686	local $WAITING = 1;
1058	AnyEvent->one_event while !$_[0]{_ae_sent};	1687	AnyEvent->one_event while !$_[0]{_ae_sent};
1059	}	1688	}
1060		1689
1061	sub recv {	1690	sub recv {
1062	$_[0]->_wait;	1691	$_[0]->_wait;
…		…
1064	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1693	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1065	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1694	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1066	}	1695	}
1067		1696
1068	sub cb {	1697	sub cb {
1069	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1698	my $cv = shift;
		1699
		1700	@_
		1701	and $cv->{_ae_cb} = shift
		1702	and $cv->{_ae_sent}
		1703	and (delete $cv->{_ae_cb})->($cv);
		1704
1070	$_[0]{_ae_cb}	1705	$cv->{_ae_cb}
1071	}	1706	}
1072		1707
1073	sub begin {	1708	sub begin {
1074	++$_[0]{_ae_counter};	1709	++$_[0]{_ae_counter};
1075	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1710	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1081	}	1716	}
1082		1717
1083	# undocumented/compatibility with pre-3.4	1718	# undocumented/compatibility with pre-3.4
1084	*broadcast = \&send;	1719	*broadcast = \&send;
1085	*wait = \&_wait;	1720	*wait = \&_wait;
		1721
		1722	=head1 ERROR AND EXCEPTION HANDLING
		1723
		1724	In general, AnyEvent does not do any error handling - it relies on the
		1725	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1726	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1727	checking of all AnyEvent methods, however, which is highly useful during
		1728	development.
		1729
		1730	As for exception handling (i.e. runtime errors and exceptions thrown while
		1731	executing a callback), this is not only highly event-loop specific, but
		1732	also not in any way wrapped by this module, as this is the job of the main
		1733	program.
		1734
		1735	The pure perl event loop simply re-throws the exception (usually
		1736	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1737	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1738	so on.
		1739
		1740	=head1 ENVIRONMENT VARIABLES
		1741
		1742	The following environment variables are used by this module or its
		1743	submodules.
		1744
		1745	Note that AnyEvent will remove I<all> environment variables starting with
		1746	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1747	enabled.
		1748
		1749	=over 4
		1750
		1751	=item C<PERL_ANYEVENT_VERBOSE>
		1752
		1753	By default, AnyEvent will be completely silent except in fatal
		1754	conditions. You can set this environment variable to make AnyEvent more
		1755	talkative.
		1756
		1757	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1758	conditions, such as not being able to load the event model specified by
		1759	C<PERL_ANYEVENT_MODEL>.
		1760
		1761	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1762	model it chooses.
		1763
		1764	When set to C<8> or higher, then AnyEvent will report extra information on
		1765	which optional modules it loads and how it implements certain features.
		1766
		1767	=item C<PERL_ANYEVENT_STRICT>
		1768
		1769	AnyEvent does not do much argument checking by default, as thorough
		1770	argument checking is very costly. Setting this variable to a true value
		1771	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1772	check the arguments passed to most method calls. If it finds any problems,
		1773	it will croak.
		1774
		1775	In other words, enables "strict" mode.
		1776
		1777	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
		1778	>>, it is definitely recommended to keep it off in production. Keeping
		1779	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1780	can be very useful, however.
		1781
		1782	=item C<PERL_ANYEVENT_MODEL>
		1783
		1784	This can be used to specify the event model to be used by AnyEvent, before
		1785	auto detection and -probing kicks in. It must be a string consisting
		1786	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		1787	and the resulting module name is loaded and if the load was successful,
		1788	used as event model. If it fails to load AnyEvent will proceed with
		1789	auto detection and -probing.
		1790
		1791	This functionality might change in future versions.
		1792
		1793	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		1794	could start your program like this:
		1795
		1796	PERL_ANYEVENT_MODEL=Perl perl ...
		1797
		1798	=item C<PERL_ANYEVENT_PROTOCOLS>
		1799
		1800	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1801	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1802	of auto probing).
		1803
		1804	Must be set to a comma-separated list of protocols or address families,
		1805	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1806	used, and preference will be given to protocols mentioned earlier in the
		1807	list.
		1808
		1809	This variable can effectively be used for denial-of-service attacks
		1810	against local programs (e.g. when setuid), although the impact is likely
		1811	small, as the program has to handle conenction and other failures anyways.
		1812
		1813	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1814	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1815	- only support IPv4, never try to resolve or contact IPv6
		1816	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1817	IPv6, but prefer IPv6 over IPv4.
		1818
		1819	=item C<PERL_ANYEVENT_EDNS0>
		1820
		1821	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1822	for DNS. This extension is generally useful to reduce DNS traffic, but
		1823	some (broken) firewalls drop such DNS packets, which is why it is off by
		1824	default.
		1825
		1826	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1827	EDNS0 in its DNS requests.
		1828
		1829	=item C<PERL_ANYEVENT_MAX_FORKS>
		1830
		1831	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1832	will create in parallel.
		1833
		1834	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1835
		1836	The default value for the C<max_outstanding> parameter for the default DNS
		1837	resolver - this is the maximum number of parallel DNS requests that are
		1838	sent to the DNS server.
		1839
		1840	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1841
		1842	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1843	configuration) in the default resolver. When set to the empty string, no
		1844	default config will be used.
		1845
		1846	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1847
		1848	When neither C<ca_file> nor C<ca_path> was specified during
		1849	L<AnyEvent::TLS> context creation, and either of these environment
		1850	variables exist, they will be used to specify CA certificate locations
		1851	instead of a system-dependent default.
		1852
		1853	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1854
		1855	When these are set to C<1>, then the respective modules are not
		1856	loaded. Mostly good for testing AnyEvent itself.
		1857
		1858	=back
1086		1859
1087	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1860	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1088		1861
1089	This is an advanced topic that you do not normally need to use AnyEvent in	1862	This is an advanced topic that you do not normally need to use AnyEvent in
1090	a module. This section is only of use to event loop authors who want to	1863	a module. This section is only of use to event loop authors who want to
…		…
1124		1897
1125	I<rxvt-unicode> also cheats a bit by not providing blocking access to	1898	I<rxvt-unicode> also cheats a bit by not providing blocking access to
1126	condition variables: code blocking while waiting for a condition will	1899	condition variables: code blocking while waiting for a condition will
1127	C<die>. This still works with most modules/usages, and blocking calls must	1900	C<die>. This still works with most modules/usages, and blocking calls must
1128	not be done in an interactive application, so it makes sense.	1901	not be done in an interactive application, so it makes sense.
1129
1130	=head1 ENVIRONMENT VARIABLES
1131
1132	The following environment variables are used by this module:
1133
1134	=over 4
1135
1136	=item C<PERL_ANYEVENT_VERBOSE>
1137
1138	By default, AnyEvent will be completely silent except in fatal
1139	conditions. You can set this environment variable to make AnyEvent more
1140	talkative.
1141
1142	When set to C<1> or higher, causes AnyEvent to warn about unexpected
1143	conditions, such as not being able to load the event model specified by
1144	C<PERL_ANYEVENT_MODEL>.
1145
1146	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1147	model it chooses.
1148
1149	=item C<PERL_ANYEVENT_MODEL>
1150
1151	This can be used to specify the event model to be used by AnyEvent, before
1152	auto detection and -probing kicks in. It must be a string consisting
1153	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1154	and the resulting module name is loaded and if the load was successful,
1155	used as event model. If it fails to load AnyEvent will proceed with
1156	auto detection and -probing.
1157
1158	This functionality might change in future versions.
1159
1160	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1161	could start your program like this:
1162
1163	PERL_ANYEVENT_MODEL=Perl perl ...
1164
1165	=item C<PERL_ANYEVENT_PROTOCOLS>
1166
1167	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1168	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1169	of auto probing).
1170
1171	Must be set to a comma-separated list of protocols or address families,
1172	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1173	used, and preference will be given to protocols mentioned earlier in the
1174	list.
1175
1176	This variable can effectively be used for denial-of-service attacks
1177	against local programs (e.g. when setuid), although the impact is likely
1178	small, as the program has to handle connection errors already-
1179
1180	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1181	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1182	- only support IPv4, never try to resolve or contact IPv6
1183	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1184	IPv6, but prefer IPv6 over IPv4.
1185
1186	=item C<PERL_ANYEVENT_EDNS0>
1187
1188	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1189	for DNS. This extension is generally useful to reduce DNS traffic, but
1190	some (broken) firewalls drop such DNS packets, which is why it is off by
1191	default.
1192
1193	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1194	EDNS0 in its DNS requests.
1195
1196	=item C<PERL_ANYEVENT_MAX_FORKS>
1197
1198	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1199	will create in parallel.
1200
1201	=back
1202		1902
1203	=head1 EXAMPLE PROGRAM	1903	=head1 EXAMPLE PROGRAM
1204		1904
1205	The following program uses an I/O watcher to read data from STDIN, a timer	1905	The following program uses an I/O watcher to read data from STDIN, a timer
1206	to display a message once per second, and a condition variable to quit the	1906	to display a message once per second, and a condition variable to quit the
…		…
1219	warn "read: $input\n"; # output what has been read	1919	warn "read: $input\n"; # output what has been read
1220	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1920	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1221	},	1921	},
1222	);	1922	);
1223		1923
1224	my $time_watcher; # can only be used once
1225
1226	sub new_timer {
1227	$timer = AnyEvent->timer (after => 1, cb => sub {	1924	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1228	warn "timeout\n"; # print 'timeout' about every second	1925	warn "timeout\n"; # print 'timeout' at most every second
1229	&new_timer; # and restart the time
1230	});	1926	});
1231	}
1232
1233	new_timer; # create first timer
1234		1927
1235	$cv->recv; # wait until user enters /^q/i	1928	$cv->recv; # wait until user enters /^q/i
1236		1929
1237	=head1 REAL-WORLD EXAMPLE	1930	=head1 REAL-WORLD EXAMPLE
1238		1931
…		…
1369	through AnyEvent. The benchmark creates a lot of timers (with a zero	2062	through AnyEvent. The benchmark creates a lot of timers (with a zero
1370	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2063	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1371	which it is), lets them fire exactly once and destroys them again.	2064	which it is), lets them fire exactly once and destroys them again.
1372		2065
1373	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2066	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1374	distribution.	2067	distribution. It uses the L<AE> interface, which makes a real difference
		2068	for the EV and Perl backends only.
1375		2069
1376	=head3 Explanation of the columns	2070	=head3 Explanation of the columns
1377		2071
1378	I<watcher> is the number of event watchers created/destroyed. Since	2072	I<watcher> is the number of event watchers created/destroyed. Since
1379	different event models feature vastly different performances, each event	2073	different event models feature vastly different performances, each event
…		…
1400	watcher.	2094	watcher.
1401		2095
1402	=head3 Results	2096	=head3 Results
1403		2097
1404	name watchers bytes create invoke destroy comment	2098	name watchers bytes create invoke destroy comment
1405	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	2099	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1406	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	2100	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1407	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	2101	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1408	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	2102	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1409	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	2103	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1410	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	2104	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
		2105	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
		2106	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1411	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	2107	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1412	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	2108	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1413	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	2109	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1414	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	2110	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1415		2111
1416	=head3 Discussion	2112	=head3 Discussion
1417		2113
1418	The benchmark does I<not> measure scalability of the event loop very	2114	The benchmark does I<not> measure scalability of the event loop very
1419	well. For example, a select-based event loop (such as the pure perl one)	2115	well. For example, a select-based event loop (such as the pure perl one)
…		…
1431	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2127	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1432	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2128	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1433	cycles with POE.	2129	cycles with POE.
1434		2130
1435	C<EV> is the sole leader regarding speed and memory use, which are both	2131	C<EV> is the sole leader regarding speed and memory use, which are both
1436	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2132	maximal/minimal, respectively. When using the L<AE> API there is zero
		2133	overhead (when going through the AnyEvent API create is about 5-6 times
		2134	slower, with other times being equal, so still uses far less memory than
1437	far less memory than any other event loop and is still faster than Event	2135	any other event loop and is still faster than Event natively).
1438	natively.
1439		2136
1440	The pure perl implementation is hit in a few sweet spots (both the	2137	The pure perl implementation is hit in a few sweet spots (both the
1441	constant timeout and the use of a single fd hit optimisations in the perl	2138	constant timeout and the use of a single fd hit optimisations in the perl
1442	interpreter and the backend itself). Nevertheless this shows that it	2139	interpreter and the backend itself). Nevertheless this shows that it
1443	adds very little overhead in itself. Like any select-based backend its	2140	adds very little overhead in itself. Like any select-based backend its
1444	performance becomes really bad with lots of file descriptors (and few of	2141	performance becomes really bad with lots of file descriptors (and few of
1445	them active), of course, but this was not subject of this benchmark.	2142	them active), of course, but this was not subject of this benchmark.
1446		2143
1447	The C<Event> module has a relatively high setup and callback invocation	2144	The C<Event> module has a relatively high setup and callback invocation
1448	cost, but overall scores in on the third place.	2145	cost, but overall scores in on the third place.
		2146
		2147	C<IO::Async> performs admirably well, about on par with C<Event>, even
		2148	when using its pure perl backend.
1449		2149
1450	C<Glib>'s memory usage is quite a bit higher, but it features a	2150	C<Glib>'s memory usage is quite a bit higher, but it features a
1451	faster callback invocation and overall ends up in the same class as	2151	faster callback invocation and overall ends up in the same class as
1452	C<Event>. However, Glib scales extremely badly, doubling the number of	2152	C<Event>. However, Glib scales extremely badly, doubling the number of
1453	watchers increases the processing time by more than a factor of four,	2153	watchers increases the processing time by more than a factor of four,
…		…
1514	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2214	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1515	(1%) are active. This mirrors the activity of large servers with many	2215	(1%) are active. This mirrors the activity of large servers with many
1516	connections, most of which are idle at any one point in time.	2216	connections, most of which are idle at any one point in time.
1517		2217
1518	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2218	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1519	distribution.	2219	distribution. It uses the L<AE> interface, which makes a real difference
		2220	for the EV and Perl backends only.
1520		2221
1521	=head3 Explanation of the columns	2222	=head3 Explanation of the columns
1522		2223
1523	I<sockets> is the number of sockets, and twice the number of "servers" (as	2224	I<sockets> is the number of sockets, and twice the number of "servers" (as
1524	each server has a read and write socket end).	2225	each server has a read and write socket end).
…		…
1531	it to another server. This includes deleting the old timeout and creating	2232	it to another server. This includes deleting the old timeout and creating
1532	a new one that moves the timeout into the future.	2233	a new one that moves the timeout into the future.
1533		2234
1534	=head3 Results	2235	=head3 Results
1535		2236
1536	name sockets create request	2237	name sockets create request
1537	EV 20000 69.01 11.16	2238	EV 20000 62.66 7.99
1538	Perl 20000 73.32 35.87	2239	Perl 20000 68.32 32.64
1539	Event 20000 212.62 257.32	2240	IOAsync 20000 174.06 101.15 epoll
1540	Glib 20000 651.16 1896.30	2241	IOAsync 20000 174.67 610.84 poll
		2242	Event 20000 202.69 242.91
		2243	Glib 20000 557.01 1689.52
1541	POE 20000 349.67 12317.24 uses POE::Loop::Event	2244	POE 20000 341.54 12086.32 uses POE::Loop::Event
1542		2245
1543	=head3 Discussion	2246	=head3 Discussion
1544		2247
1545	This benchmark I<does> measure scalability and overall performance of the	2248	This benchmark I<does> measure scalability and overall performance of the
1546	particular event loop.	2249	particular event loop.
…		…
1548	EV is again fastest. Since it is using epoll on my system, the setup time	2251	EV is again fastest. Since it is using epoll on my system, the setup time
1549	is relatively high, though.	2252	is relatively high, though.
1550		2253
1551	Perl surprisingly comes second. It is much faster than the C-based event	2254	Perl surprisingly comes second. It is much faster than the C-based event
1552	loops Event and Glib.	2255	loops Event and Glib.
		2256
		2257	IO::Async performs very well when using its epoll backend, and still quite
		2258	good compared to Glib when using its pure perl backend.
1553		2259
1554	Event suffers from high setup time as well (look at its code and you will	2260	Event suffers from high setup time as well (look at its code and you will
1555	understand why). Callback invocation also has a high overhead compared to	2261	understand why). Callback invocation also has a high overhead compared to
1556	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2262	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1557	uses select or poll in basically all documented configurations.	2263	uses select or poll in basically all documented configurations.
…		…
1620	=item * C-based event loops perform very well with small number of	2326	=item * C-based event loops perform very well with small number of
1621	watchers, as the management overhead dominates.	2327	watchers, as the management overhead dominates.
1622		2328
1623	=back	2329	=back
1624		2330
		2331	=head2 THE IO::Lambda BENCHMARK
		2332
		2333	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2334	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2335	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2336	shouldn't come as a surprise to anybody). As such, the benchmark is
		2337	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2338	very optimal. But how would AnyEvent compare when used without the extra
		2339	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2340
		2341	The benchmark itself creates an echo-server, and then, for 500 times,
		2342	connects to the echo server, sends a line, waits for the reply, and then
		2343	creates the next connection. This is a rather bad benchmark, as it doesn't
		2344	test the efficiency of the framework or much non-blocking I/O, but it is a
		2345	benchmark nevertheless.
		2346
		2347	name runtime
		2348	Lambda/select 0.330 sec
		2349	+ optimized 0.122 sec
		2350	Lambda/AnyEvent 0.327 sec
		2351	+ optimized 0.138 sec
		2352	Raw sockets/select 0.077 sec
		2353	POE/select, components 0.662 sec
		2354	POE/select, raw sockets 0.226 sec
		2355	POE/select, optimized 0.404 sec
		2356
		2357	AnyEvent/select/nb 0.085 sec
		2358	AnyEvent/EV/nb 0.068 sec
		2359	+state machine 0.134 sec
		2360
		2361	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2362	benchmarks actually make blocking connects and use 100% blocking I/O,
		2363	defeating the purpose of an event-based solution. All of the newly
		2364	written AnyEvent benchmarks use 100% non-blocking connects (using
		2365	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2366	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2367	generally require a lot more bookkeeping and event handling than blocking
		2368	connects (which involve a single syscall only).
		2369
		2370	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2371	offers similar expressive power as POE and IO::Lambda, using conventional
		2372	Perl syntax. This means that both the echo server and the client are 100%
		2373	non-blocking, further placing it at a disadvantage.
		2374
		2375	As you can see, the AnyEvent + EV combination even beats the
		2376	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2377	backend easily beats IO::Lambda and POE.
		2378
		2379	And even the 100% non-blocking version written using the high-level (and
		2380	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
		2381	higher level ("unoptimised") abstractions by a large margin, even though
		2382	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
		2383
		2384	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2385	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2386	part of the IO::Lambda distribution and were used without any changes.
		2387
		2388
		2389	=head1 SIGNALS
		2390
		2391	AnyEvent currently installs handlers for these signals:
		2392
		2393	=over 4
		2394
		2395	=item SIGCHLD
		2396
		2397	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		2398	emulation for event loops that do not support them natively. Also, some
		2399	event loops install a similar handler.
		2400
		2401	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2402	AnyEvent will reset it to default, to avoid losing child exit statuses.
		2403
		2404	=item SIGPIPE
		2405
		2406	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		2407	when AnyEvent gets loaded.
		2408
		2409	The rationale for this is that AnyEvent users usually do not really depend
		2410	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		2411	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		2412	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		2413	some random socket.
		2414
		2415	The rationale for installing a no-op handler as opposed to ignoring it is
		2416	that this way, the handler will be restored to defaults on exec.
		2417
		2418	Feel free to install your own handler, or reset it to defaults.
		2419
		2420	=back
		2421
		2422	=cut
		2423
		2424	undef $SIG{CHLD}
		2425	if $SIG{CHLD} eq 'IGNORE';
		2426
		2427	$SIG{PIPE} = sub { }
		2428	unless defined $SIG{PIPE};
		2429
		2430	=head1 RECOMMENDED/OPTIONAL MODULES
		2431
		2432	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2433	it's built-in modules) are required to use it.
		2434
		2435	That does not mean that AnyEvent won't take advantage of some additional
		2436	modules if they are installed.
		2437
		2438	This section epxlains which additional modules will be used, and how they
		2439	affect AnyEvent's operetion.
		2440
		2441	=over 4
		2442
		2443	=item L<Async::Interrupt>
		2444
		2445	This slightly arcane module is used to implement fast signal handling: To
		2446	my knowledge, there is no way to do completely race-free and quick
		2447	signal handling in pure perl. To ensure that signals still get
		2448	delivered, AnyEvent will start an interval timer to wake up perl (and
		2449	catch the signals) with some delay (default is 10 seconds, look for
		2450	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2451
		2452	If this module is available, then it will be used to implement signal
		2453	catching, which means that signals will not be delayed, and the event loop
		2454	will not be interrupted regularly, which is more efficient (And good for
		2455	battery life on laptops).
		2456
		2457	This affects not just the pure-perl event loop, but also other event loops
		2458	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2459
		2460	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2461	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2462	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2463	does nothing for those backends.
		2464
		2465	=item L<EV>
		2466
		2467	This module isn't really "optional", as it is simply one of the backend
		2468	event loops that AnyEvent can use. However, it is simply the best event
		2469	loop available in terms of features, speed and stability: It supports
		2470	the AnyEvent API optimally, implements all the watcher types in XS, does
		2471	automatic timer adjustments even when no monotonic clock is available,
		2472	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2473	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2474	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2475
		2476	=item L<Guard>
		2477
		2478	The guard module, when used, will be used to implement
		2479	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2480	lot less memory), but otherwise doesn't affect guard operation much. It is
		2481	purely used for performance.
		2482
		2483	=item L<JSON> and L<JSON::XS>
		2484
		2485	One of these modules is required when you want to read or write JSON data
		2486	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2487	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2488
		2489	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2490	installed.
		2491
		2492	=item L<Net::SSLeay>
		2493
		2494	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2495	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2496	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2497
		2498	=item L<Time::HiRes>
		2499
		2500	This module is part of perl since release 5.008. It will be used when the
		2501	chosen event library does not come with a timing source on it's own. The
		2502	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2503	try to use a monotonic clock for timing stability.
		2504
		2505	=back
		2506
1625		2507
1626	=head1 FORK	2508	=head1 FORK
1627		2509
1628	Most event libraries are not fork-safe. The ones who are usually are	2510	Most event libraries are not fork-safe. The ones who are usually are
1629	because they rely on inefficient but fork-safe C<select> or C<poll>	2511	because they rely on inefficient but fork-safe C<select> or C<poll>
1630	calls. Only L<EV> is fully fork-aware.	2512	calls. Only L<EV> is fully fork-aware.
1631		2513
1632	If you have to fork, you must either do so I<before> creating your first	2514	If you have to fork, you must either do so I<before> creating your first
1633	watcher OR you must not use AnyEvent at all in the child.	2515	watcher OR you must not use AnyEvent at all in the child OR you must do
		2516	something completely out of the scope of AnyEvent.
1634		2517
1635		2518
1636	=head1 SECURITY CONSIDERATIONS	2519	=head1 SECURITY CONSIDERATIONS
1637		2520
1638	AnyEvent can be forced to load any event model via	2521	AnyEvent can be forced to load any event model via
…		…
1643	specified in the variable.	2526	specified in the variable.
1644		2527
1645	You can make AnyEvent completely ignore this variable by deleting it	2528	You can make AnyEvent completely ignore this variable by deleting it
1646	before the first watcher gets created, e.g. with a C<BEGIN> block:	2529	before the first watcher gets created, e.g. with a C<BEGIN> block:
1647		2530
1648	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }	2531	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1649		2532
1650	use AnyEvent;	2533	use AnyEvent;
1651		2534
1652	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2535	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1653	be used to probe what backend is used and gain other information (which is	2536	be used to probe what backend is used and gain other information (which is
1654	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	2537	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		2538	$ENV{PERL_ANYEVENT_STRICT}.
		2539
		2540	Note that AnyEvent will remove I<all> environment variables starting with
		2541	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2542	enabled.
		2543
		2544
		2545	=head1 BUGS
		2546
		2547	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
		2548	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
		2549	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
		2550	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
		2551	pronounced).
1655		2552
1656		2553
1657	=head1 SEE ALSO	2554	=head1 SEE ALSO
1658		2555
1659	Utility functions: L<AnyEvent::Util>.	2556	Utility functions: L<AnyEvent::Util>.
…		…
1662	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2559	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1663		2560
1664	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2561	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1665	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2562	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1666	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2563	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1667	L<AnyEvent::Impl::POE>.	2564	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1668		2565
1669	Non-blocking file handles, sockets, TCP clients and	2566	Non-blocking file handles, sockets, TCP clients and
1670	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2567	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1671		2568
1672	Asynchronous DNS: L<AnyEvent::DNS>.	2569	Asynchronous DNS: L<AnyEvent::DNS>.
1673		2570
1674	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2571	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2572	L<Coro::Event>,
1675		2573
1676	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2574	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2575	L<AnyEvent::HTTP>.
1677		2576
1678		2577
1679	=head1 AUTHOR	2578	=head1 AUTHOR
1680		2579
1681	Marc Lehmann <schmorp@schmorp.de>	2580	Marc Lehmann <schmorp@schmorp.de>
1682	http://home.schmorp.de/	2581	http://home.schmorp.de/
1683		2582
1684	=cut	2583	=cut
1685		2584
1686	1	2585	1
1687		2586

Diff Legend

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