ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.253 by root, Tue Jul 21 06:00:47 2009 UTC vs.
Revision 1.381 by root, Thu Sep 1 22:09:25 2011 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - events independent of event loop implementation	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6	event loops.	6	FLTK and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
18		21
19	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21		24
22	# POSIX signal	25	# POSIX signal
…		…
43	in a tutorial or some gentle introduction, have a look at the	46	in a tutorial or some gentle introduction, have a look at the
44	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
45		48
46	=head1 SUPPORT	49	=head1 SUPPORT
47		50
		51	An FAQ document is available as L<AnyEvent::FAQ>.
		52
48	There is a mailinglist for discussing all things AnyEvent, and an IRC	53	There also is a mailinglist for discussing all things AnyEvent, and an IRC
49	channel, too.	54	channel, too.
50		55
51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	56	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52	Respository>, at L<http://anyevent.schmorp.de>, for more info.	57	Repository>, at L<http://anyevent.schmorp.de>, for more info.
53		58
54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	59	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
55		60
56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	61	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
57	nowadays. So what is different about AnyEvent?	62	nowadays. So what is different about AnyEvent?
…		…
73	module users into the same thing by forcing them to use the same event	78	module users into the same thing by forcing them to use the same event
74	model you use.	79	model you use.
75		80
76	For modules like POE or IO::Async (which is a total misnomer as it is	81	For modules like POE or IO::Async (which is a total misnomer as it is
77	actually doing all I/O I<synchronously>...), using them in your module is	82	actually doing all I/O I<synchronously>...), using them in your module is
78	like joining a cult: After you joined, you are dependent on them and you	83	like joining a cult: After you join, you are dependent on them and you
79	cannot use anything else, as they are simply incompatible to everything	84	cannot use anything else, as they are simply incompatible to everything
80	that isn't them. What's worse, all the potential users of your	85	that isn't them. What's worse, all the potential users of your
81	module are I<also> forced to use the same event loop you use.	86	module are I<also> forced to use the same event loop you use.
82		87
83	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
84	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	89	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
85	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	90	with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
86	your module uses one of those, every user of your module has to use it,	91	uses one of those, every user of your module has to use it, too. But if
87	too. But if your module uses AnyEvent, it works transparently with all	92	your module uses AnyEvent, it works transparently with all event models it
88	event models it supports (including stuff like IO::Async, as long as those	93	supports (including stuff like IO::Async, as long as those use one of the
89	use one of the supported event loops. It is trivial to add new event loops	94	supported event loops. It is easy to add new event loops to AnyEvent, too,
90	to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
91		96
92	In addition to being free of having to use I<the one and only true event	97	In addition to being free of having to use I<the one and only true event
93	model>, AnyEvent also is free of bloat and policy: with POE or similar	98	model>, AnyEvent also is free of bloat and policy: with POE or similar
94	modules, you get an enormous amount of code and strict rules you have to	99	modules, you get an enormous amount of code and strict rules you have to
95	follow. AnyEvent, on the other hand, is lean and up to the point, by only	100	follow. AnyEvent, on the other hand, is lean and to the point, by only
96	offering the functionality that is necessary, in as thin as a wrapper as	101	offering the functionality that is necessary, in as thin as a wrapper as
97	technically possible.	102	technically possible.
98		103
99	Of course, AnyEvent comes with a big (and fully optional!) toolbox	104	Of course, AnyEvent comes with a big (and fully optional!) toolbox
100	of useful functionality, such as an asynchronous DNS resolver, 100%	105	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
106	useful) and you want to force your users to use the one and only event	111	useful) and you want to force your users to use the one and only event
107	model, you should I<not> use this module.	112	model, you should I<not> use this module.
108		113
109	=head1 DESCRIPTION	114	=head1 DESCRIPTION
110		115
111	L<AnyEvent> provides an identical interface to multiple event loops. This	116	L<AnyEvent> provides a uniform interface to various event loops. This
112	allows module authors to utilise an event loop without forcing module	117	allows module authors to use event loop functionality without forcing
113	users to use the same event loop (as only a single event loop can coexist	118	module users to use a specific event loop implementation (since more
114	peacefully at any one time).	119	than one event loop cannot coexist peacefully).
115		120
116	The interface itself is vaguely similar, but not identical to the L<Event>	121	The interface itself is vaguely similar, but not identical to the L<Event>
117	module.	122	module.
118		123
119	During the first call of any watcher-creation method, the module tries	124	During the first call of any watcher-creation method, the module tries
120	to detect the currently loaded event loop by probing whether one of the	125	to detect the currently loaded event loop by probing whether one of the
121	following modules is already loaded: L<EV>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
122	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,	127	L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
123	L<POE>. The first one found is used. If none are found, the module tries	128	found is used. If none are detected, the module tries to load the first
124	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl	129	four modules in the order given; but note that if L<EV> is not
125	adaptor should always succeed) in the order given. The first one that can	130	available, the pure-perl L<AnyEvent::Loop> should always work, so
126	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
127	found, AnyEvent will fall back to a pure-perl event loop, which is not
128	very efficient, but should work everywhere.
129		132
130	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
131	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
132	that model the default. For example:	135	that model the default. For example:
133		136
…		…
135	use AnyEvent;	138	use AnyEvent;
136		139
137	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
138		141
139	The I<likely> means that, if any module loads another event model and	142	The I<likely> means that, if any module loads another event model and
140	starts using it, all bets are off. Maybe you should tell their authors to	143	starts using it, all bets are off - this case should be very rare though,
141	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
142		146
143	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
144	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	other event modules you can load it explicitly and enjoy the high
145	explicitly and enjoy the high availability of that event loop :)	149	availability of that event loop :)
146		150
147	=head1 WATCHERS	151	=head1 WATCHERS
148		152
149	AnyEvent has the central concept of a I<watcher>, which is an object that	153	AnyEvent has the central concept of a I<watcher>, which is an object that
150	stores relevant data for each kind of event you are waiting for, such as	154	stores relevant data for each kind of event you are waiting for, such as
…		…
155	callback when the event occurs (of course, only when the event model	159	callback when the event occurs (of course, only when the event model
156	is in control).	160	is in control).
157		161
158	Note that B<callbacks must not permanently change global variables>	162	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<<	163	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	164	callbacks must not C<die> >>. The former is good programming practice in
161	Perl and the latter stems from the fact that exception handling differs	165	Perl and the latter stems from the fact that exception handling differs
162	widely between event loops.	166	widely between event loops.
163		167
164	To disable the watcher you have to destroy it (e.g. by setting the	168	To disable a watcher you have to destroy it (e.g. by setting the
165	variable you store it in to C<undef> or otherwise deleting all references	169	variable you store it in to C<undef> or otherwise deleting all references
166	to it).	170	to it).
167		171
168	All watchers are created by calling a method on the C<AnyEvent> class.	172	All watchers are created by calling a method on the C<AnyEvent> class.
169		173
170	Many watchers either are used with "recursion" (repeating timers for	174	Many watchers either are used with "recursion" (repeating timers for
171	example), or need to refer to their watcher object in other ways.	175	example), or need to refer to their watcher object in other ways.
172		176
173	An any way to achieve that is this pattern:	177	One way to achieve that is this pattern:
174		178
175	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
176	# you can use $w here, for example to undef it	180	# you can use $w here, for example to undef it
177	undef $w;	181	undef $w;
178	});	182	});
…		…
180	Note that C<my $w; $w => combination. This is necessary because in Perl,	184	Note that C<my $w; $w => combination. This is necessary because in Perl,
181	my variables are only visible after the statement in which they are	185	my variables are only visible after the statement in which they are
182	declared.	186	declared.
183		187
184	=head2 I/O WATCHERS	188	=head2 I/O WATCHERS
		189
		190	$w = AnyEvent->io (
		191	fh => <filehandle_or_fileno>,
		192	poll => <"r" or "w">,
		193	cb => <callback>,
		194	);
185		195
186	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	196	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
187	with the following mandatory key-value pairs as arguments:	197	with the following mandatory key-value pairs as arguments:
188		198
189	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch	199	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
…		…
204		214
205	The I/O watcher might use the underlying file descriptor or a copy of it.	215	The I/O watcher might use the underlying file descriptor or a copy of it.
206	You must not close a file handle as long as any watcher is active on the	216	You must not close a file handle as long as any watcher is active on the
207	underlying file descriptor.	217	underlying file descriptor.
208		218
209	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
210	always use non-blocking calls when reading/writing from/to your file	220	always use non-blocking calls when reading/writing from/to your file
211	handles.	221	handles.
212		222
213	Example: wait for readability of STDIN, then read a line and disable the	223	Example: wait for readability of STDIN, then read a line and disable the
214	watcher.	224	watcher.
…		…
219	undef $w;	229	undef $w;
220	});	230	});
221		231
222	=head2 TIME WATCHERS	232	=head2 TIME WATCHERS
223		233
		234	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		235
		236	$w = AnyEvent->timer (
		237	after => <fractional_seconds>,
		238	interval => <fractional_seconds>,
		239	cb => <callback>,
		240	);
		241
224	You can create a time watcher by calling the C<< AnyEvent->timer >>	242	You can create a time watcher by calling the C<< AnyEvent->timer >>
225	method with the following mandatory arguments:	243	method with the following mandatory arguments:
226		244
227	C<after> specifies after how many seconds (fractional values are	245	C<after> specifies after how many seconds (fractional values are
228	supported) the callback should be invoked. C<cb> is the callback to invoke	246	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
230		248
231	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
232	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
233	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
234		252
235	The callback will normally be invoked once only. If you specify another	253	The callback will normally be invoked only once. If you specify another
236	parameter, C<interval>, as a strictly positive number (> 0), then the	254	parameter, C<interval>, as a strictly positive number (> 0), then the
237	callback will be invoked regularly at that interval (in fractional	255	callback will be invoked regularly at that interval (in fractional
238	seconds) after the first invocation. If C<interval> is specified with a	256	seconds) after the first invocation. If C<interval> is specified with a
239	false value, then it is treated as if it were missing.	257	false value, then it is treated as if it were not specified at all.
240		258
241	The callback will be rescheduled before invoking the callback, but no	259	The callback will be rescheduled before invoking the callback, but no
242	attempt is done to avoid timer drift in most backends, so the interval is	260	attempt is made to avoid timer drift in most backends, so the interval is
243	only approximate.	261	only approximate.
244		262
245	Example: fire an event after 7.7 seconds.	263	Example: fire an event after 7.7 seconds.
246		264
247	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
265		283
266	While most event loops expect timers to specified in a relative way, they	284	While most event loops expect timers to specified in a relative way, they
267	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
268	"jumps", for example, when ntp decides to set your clock backwards from	286	"jumps", for example, when ntp decides to set your clock backwards from
269	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to	287	the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
270	fire "after" a second might actually take six years to finally fire.	288	fire "after a second" might actually take six years to finally fire.
271		289
272	AnyEvent cannot compensate for this. The only event loop that is conscious	290	AnyEvent cannot compensate for this. The only event loop that is conscious
273	about these issues is L<EV>, which offers both relative (ev_timer, based	291	of these issues is L<EV>, which offers both relative (ev_timer, based
274	on true relative time) and absolute (ev_periodic, based on wallclock time)	292	on true relative time) and absolute (ev_periodic, based on wallclock time)
275	timers.	293	timers.
276		294
277	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
278	AnyEvent API.	296	AnyEvent API.
…		…
300	I<In almost all cases (in all cases if you don't care), this is the	318	I<In almost all cases (in all cases if you don't care), this is the
301	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
302		320
303	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
304	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
305	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
306		324
307	The rest of this section is only of relevance if you try to be very exact	325	The rest of this section is only of relevance if you try to be very exact
308	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
309		327
310	For a practical example of when these times differ, consider L<Event::Lib>	328	For a practical example of when these times differ, consider L<Event::Lib>
311	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
312		330
313	The event loop is running and has just invoked one of your callback at	331	The event loop is running and has just invoked one of your callbacks at
314	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
315	you wait a second by executing C<sleep 1> (blocking the process for a	333	you wait a second by executing C<sleep 1> (blocking the process for a
316	second) and then (at time=501) you create a relative timer that fires	334	second) and then (at time=501) you create a relative timer that fires
317	after three seconds.	335	after three seconds.
318		336
…		…
338	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
339	account.	357	account.
340		358
341	=item AnyEvent->now_update	359	=item AnyEvent->now_update
342		360
343	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache	361	Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
344	the current time for each loop iteration (see the discussion of L<<	362	time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
345	AnyEvent->now >>, above).	363	above).
346		364
347	When a callback runs for a long time (or when the process sleeps), then	365	When a callback runs for a long time (or when the process sleeps), then
348	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
349	might affect timers and time-outs.	367	might affect timers and time-outs.
350		368
351	When this is the case, you can call this method, which will update the	369	When this is the case, you can call this method, which will update the
352	event loop's idea of "current time".	370	event loop's idea of "current time".
353		371
		372	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		373	when mod_perl executes the script, then the event loop will have the wrong
		374	idea about the "current time" (being potentially far in the past, when the
		375	script ran the last time). In that case you should arrange a call to C<<
		376	AnyEvent->now_update >> each time the web server process wakes up again
		377	(e.g. at the start of your script, or in a handler).
		378
354	Note that updating the time I<might> cause some events to be handled.	379	Note that updating the time I<might> cause some events to be handled.
355		380
356	=back	381	=back
357		382
358	=head2 SIGNAL WATCHERS	383	=head2 SIGNAL WATCHERS
		384
		385	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
359		386
360	You can watch for signals using a signal watcher, C<signal> is the signal	387	You can watch for signals using a signal watcher, C<signal> is the signal
361	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	388	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362	callback to be invoked whenever a signal occurs.	389	callback to be invoked whenever a signal occurs.
363		390
…		…
380		407
381	Example: exit on SIGINT	408	Example: exit on SIGINT
382		409
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	410	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		411
		412	=head3 Restart Behaviour
		413
		414	While restart behaviour is up to the event loop implementation, most will
		415	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		416	pure perl implementation).
		417
		418	=head3 Safe/Unsafe Signals
		419
		420	Perl signals can be either "safe" (synchronous to opcode handling) or
		421	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		422	latter might corrupt your memory.
		423
		424	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		425	i.e. they will not interrupt your running perl program but will only be
		426	called as part of the normal event handling (just like timer, I/O etc.
		427	callbacks, too).
		428
385	=head3 Signal Races, Delays and Workarounds	429	=head3 Signal Races, Delays and Workarounds
386		430
387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	431	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388	callbacks to signals in a generic way, which is a pity, as you cannot do	432	callbacks to signals in a generic way, which is a pity, as you cannot
389	race-free signal handling in perl. AnyEvent will try to do it's best, but	433	do race-free signal handling in perl, requiring C libraries for
		434	this. AnyEvent will try to do its best, which means in some cases,
390	in some cases, signals will be delayed. The maximum time a signal might	435	signals will be delayed. The maximum time a signal might be delayed is
391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	437	variable can be changed only before the first signal watcher is created,
393	watcher is created, and should be left alone otherwise. Higher values	438	and should be left alone otherwise. This variable determines how often
		439	AnyEvent polls for signals (in case a wake-up was missed). Higher values
394	will cause fewer spurious wake-ups, which is better for power and CPU	440	will cause fewer spurious wake-ups, which is better for power and CPU
		441	saving.
		442
395	saving. All these problems can be avoided by installing the optional	443	All these problems can be avoided by installing the optional
396	L<Async::Interrupt> module. This will not work with inherently broken	444	L<Async::Interrupt> module, which works with most event loops. It will not
397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>	445	work with inherently broken event loops such as L<Event> or L<Event::Lib>
398	currently, as POE does it's own workaround with one-second latency). With	446	(and not with L<POE> currently, as POE does its own workaround with
399	those, you just have to suffer the delays.	447	one-second latency). For those, you just have to suffer the delays.
400		448
401	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
402		450
		451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		452
403	You can also watch on a child process exit and catch its exit status.	453	You can also watch for a child process exit and catch its exit status.
404		454
405	The child process is specified by the C<pid> argument (if set to C<0>, it	455	The child process is specified by the C<pid> argument (on some backends,
406	watches for any child process exit). The watcher will triggered only when	456	using C<0> watches for any child process exit, on others this will
407	the child process has finished and an exit status is available, not on	457	croak). The watcher will be triggered only when the child process has
408	any trace events (stopped/continued).	458	finished and an exit status is available, not on any trace events
		459	(stopped/continued).
409		460
410	The callback will be called with the pid and exit status (as returned by	461	The callback will be called with the pid and exit status (as returned by
411	waitpid), so unlike other watcher types, you I<can> rely on child watcher	462	waitpid), so unlike other watcher types, you I<can> rely on child watcher
412	callback arguments.	463	callback arguments.
413		464
…		…
431	thing in an AnyEvent program, you I<have> to create at least one	482	thing in an AnyEvent program, you I<have> to create at least one
432	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
433	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
434		485
435	As most event loops do not support waiting for child events, they will be	486	As most event loops do not support waiting for child events, they will be
436	emulated by AnyEvent in most cases, in which the latency and race problems	487	emulated by AnyEvent in most cases, in which case the latency and race
437	mentioned in the description of signal watchers apply.	488	problems mentioned in the description of signal watchers apply.
438		489
439	Example: fork a process and wait for it	490	Example: fork a process and wait for it
440		491
441	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
442		493
…		…
454	# do something else, then wait for process exit	505	# do something else, then wait for process exit
455	$done->recv;	506	$done->recv;
456		507
457	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
458		509
459	Sometimes there is a need to do something, but it is not so important	510	$w = AnyEvent->idle (cb => <callback>);
460	to do it instantly, but only when there is nothing better to do. This
461	"nothing better to do" is usually defined to be "no other events need
462	attention by the event loop".
463		511
464	Idle watchers ideally get invoked when the event loop has nothing	512	This will repeatedly invoke the callback after the process becomes idle,
465	better to do, just before it would block the process to wait for new	513	until either the watcher is destroyed or new events have been detected.
466	events. Instead of blocking, the idle watcher is invoked.
467		514
468	Most event loops unfortunately do not really support idle watchers (only	515	Idle watchers are useful when there is a need to do something, but it
		516	is not so important (or wise) to do it instantly. The callback will be
		517	invoked only when there is "nothing better to do", which is usually
		518	defined as "all outstanding events have been handled and no new events
		519	have been detected". That means that idle watchers ideally get invoked
		520	when the event loop has just polled for new events but none have been
		521	detected. Instead of blocking to wait for more events, the idle watchers
		522	will be invoked.
		523
		524	Unfortunately, most event loops do not really support idle watchers (only
469	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	525	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
470	will simply call the callback "from time to time".	526	will simply call the callback "from time to time".
471		527
472	Example: read lines from STDIN, but only process them when the	528	Example: read lines from STDIN, but only process them when the
473	program is otherwise idle:	529	program is otherwise idle:
…		…
489	});	545	});
490	});	546	});
491		547
492	=head2 CONDITION VARIABLES	548	=head2 CONDITION VARIABLES
493		549
		550	$cv = AnyEvent->condvar;
		551
		552	$cv->send (<list>);
		553	my @res = $cv->recv;
		554
494	If you are familiar with some event loops you will know that all of them	555	If you are familiar with some event loops you will know that all of them
495	require you to run some blocking "loop", "run" or similar function that	556	require you to run some blocking "loop", "run" or similar function that
496	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
497		558
498	AnyEvent is slightly different: it expects somebody else to run the event	559	AnyEvent is slightly different: it expects somebody else to run the event
499	loop and will only block when necessary (usually when told by the user).	560	loop and will only block when necessary (usually when told by the user).
500		561
501	The instrument to do that is called a "condition variable", so called	562	The tool to do that is called a "condition variable", so called because
502	because they represent a condition that must become true.	563	they represent a condition that must become true.
503		564
504	Now is probably a good time to look at the examples further below.	565	Now is probably a good time to look at the examples further below.
505		566
506	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
507	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
…		…
512	After creation, the condition variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
513	by calling the C<send> method (or calling the condition variable as if it	574	by calling the C<send> method (or calling the condition variable as if it
514	were a callback, read about the caveats in the description for the C<<	575	were a callback, read about the caveats in the description for the C<<
515	->send >> method).	576	->send >> method).
516		577
517	Condition variables are similar to callbacks, except that you can	578	Since condition variables are the most complex part of the AnyEvent API, here are
518	optionally wait for them. They can also be called merge points - points	579	some different mental models of what they are - pick the ones you can connect to:
519	in time where multiple outstanding events have been processed. And yet	580
520	another way to call them is transactions - each condition variable can be	581	=over 4
521	used to represent a transaction, which finishes at some point and delivers	582
522	a result. And yet some people know them as "futures" - a promise to	583	=item * Condition variables are like callbacks - you can call them (and pass them instead
523	compute/deliver something that you can wait for.	584	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		585
		586	=item * Condition variables are signals - one side can emit or send them,
		587	the other side can wait for them, or install a handler that is called when
		588	the signal fires.
		589
		590	=item * Condition variables are like "Merge Points" - points in your program
		591	where you merge multiple independent results/control flows into one.
		592
		593	=item * Condition variables represent a transaction - functions that start
		594	some kind of transaction can return them, leaving the caller the choice
		595	between waiting in a blocking fashion, or setting a callback.
		596
		597	=item * Condition variables represent future values, or promises to deliver
		598	some result, long before the result is available.
		599
		600	=back
524		601
525	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
526	for example, if you write a module that does asynchronous http requests,	603	for example, if you write a module that does asynchronous http requests,
527	then a condition variable would be the ideal candidate to signal the	604	then a condition variable would be the ideal candidate to signal the
528	availability of results. The user can either act when the callback is	605	availability of results. The user can either act when the callback is
…		…
541		618
542	Condition variables are represented by hash refs in perl, and the keys	619	Condition variables are represented by hash refs in perl, and the keys
543	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing	620	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
544	easy (it is often useful to build your own transaction class on top of	621	easy (it is often useful to build your own transaction class on top of
545	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call	622	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
546	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
547		624
548	There are two "sides" to a condition variable - the "producer side" which	625	There are two "sides" to a condition variable - the "producer side" which
549	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
550	for the send to occur.	627	for the send to occur.
551		628
552	Example: wait for a timer.	629	Example: wait for a timer.
553		630
554	# wait till the result is ready	631	# condition: "wait till the timer is fired"
555	my $result_ready = AnyEvent->condvar;	632	my $timer_fired = AnyEvent->condvar;
556		633
557	# do something such as adding a timer	634	# create the timer - we could wait for, say
558	# or socket watcher the calls $result_ready->send	635	# a handle becomign ready, or even an
559	# when the "result" is ready.	636	# AnyEvent::HTTP request to finish, but
560	# in this case, we simply use a timer:	637	# in this case, we simply use a timer:
561	my $w = AnyEvent->timer (	638	my $w = AnyEvent->timer (
562	after => 1,	639	after => 1,
563	cb => sub { $result_ready->send },	640	cb => sub { $timer_fired->send },
564	);	641	);
565		642
566	# this "blocks" (while handling events) till the callback	643	# this "blocks" (while handling events) till the callback
567	# calls -<send	644	# calls ->send
568	$result_ready->recv;	645	$timer_fired->recv;
569		646
570	Example: wait for a timer, but take advantage of the fact that condition	647	Example: wait for a timer, but take advantage of the fact that condition
571	variables are also callable directly.	648	variables are also callable directly.
572		649
573	my $done = AnyEvent->condvar;	650	my $done = AnyEvent->condvar;
…		…
616	they were a code reference). Calling them directly is the same as calling	693	they were a code reference). Calling them directly is the same as calling
617	C<send>.	694	C<send>.
618		695
619	=item $cv->croak ($error)	696	=item $cv->croak ($error)
620		697
621	Similar to send, but causes all call's to C<< ->recv >> to invoke	698	Similar to send, but causes all calls to C<< ->recv >> to invoke
622	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
623		700
624	This can be used to signal any errors to the condition variable	701	This can be used to signal any errors to the condition variable
625	user/consumer. Doing it this way instead of calling C<croak> directly	702	user/consumer. Doing it this way instead of calling C<croak> directly
626	delays the error detetcion, but has the overwhelmign advantage that it	703	delays the error detection, but has the overwhelming advantage that it
627	diagnoses the error at the place where the result is expected, and not	704	diagnoses the error at the place where the result is expected, and not
628	deep in some event clalback without connection to the actual code causing	705	deep in some event callback with no connection to the actual code causing
629	the problem.	706	the problem.
630		707
631	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
632		709
633	=item $cv->end	710	=item $cv->end
…		…
636	one. For example, a function that pings many hosts in parallel might want	713	one. For example, a function that pings many hosts in parallel might want
637	to use a condition variable for the whole process.	714	to use a condition variable for the whole process.
638		715
639	Every call to C<< ->begin >> will increment a counter, and every call to	716	Every call to C<< ->begin >> will increment a counter, and every call to
640	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	717	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
641	>>, the (last) callback passed to C<begin> will be executed. That callback	718	>>, the (last) callback passed to C<begin> will be executed, passing the
642	is I<supposed> to call C<< ->send >>, but that is not required. If no	719	condvar as first argument. That callback is I<supposed> to call C<< ->send
643	callback was set, C<send> will be called without any arguments.	720	>>, but that is not required. If no group callback was set, C<send> will
		721	be called without any arguments.
644		722
645	You can think of C<< $cv->send >> giving you an OR condition (one call	723	You can think of C<< $cv->send >> giving you an OR condition (one call
646	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	724	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
647	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	725	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
648		726
…		…
670	one call to C<begin>, so the condvar waits for all calls to C<end> before	748	one call to C<begin>, so the condvar waits for all calls to C<end> before
671	sending.	749	sending.
672		750
673	The ping example mentioned above is slightly more complicated, as the	751	The ping example mentioned above is slightly more complicated, as the
674	there are results to be passwd back, and the number of tasks that are	752	there are results to be passwd back, and the number of tasks that are
675	begung can potentially be zero:	753	begun can potentially be zero:
676		754
677	my $cv = AnyEvent->condvar;	755	my $cv = AnyEvent->condvar;
678		756
679	my %result;	757	my %result;
680	$cv->begin (sub { $cv->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
681		759
682	for my $host (@list_of_hosts) {	760	for my $host (@list_of_hosts) {
683	$cv->begin;	761	$cv->begin;
684	ping_host_then_call_callback $host, sub {	762	ping_host_then_call_callback $host, sub {
685	$result{$host} = ...;	763	$result{$host} = ...;
…		…
701	to be called once the counter reaches C<0>, and second, it ensures that	779	to be called once the counter reaches C<0>, and second, it ensures that
702	C<send> is called even when C<no> hosts are being pinged (the loop	780	C<send> is called even when C<no> hosts are being pinged (the loop
703	doesn't execute once).	781	doesn't execute once).
704		782
705	This is the general pattern when you "fan out" into multiple (but	783	This is the general pattern when you "fan out" into multiple (but
706	potentially none) subrequests: use an outer C<begin>/C<end> pair to set	784	potentially zero) subrequests: use an outer C<begin>/C<end> pair to set
707	the callback and ensure C<end> is called at least once, and then, for each	785	the callback and ensure C<end> is called at least once, and then, for each
708	subrequest you start, call C<begin> and for each subrequest you finish,	786	subrequest you start, call C<begin> and for each subrequest you finish,
709	call C<end>.	787	call C<end>.
710		788
711	=back	789	=back
…		…
718	=over 4	796	=over 4
719		797
720	=item $cv->recv	798	=item $cv->recv
721		799
722	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
723	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
724	normally.	802	normally.
725		803
726	You can only wait once on a condition - additional calls are valid but	804	You can only wait once on a condition - additional calls are valid but
727	will return immediately.	805	will return immediately.
728		806
…		…
745	caller decide whether the call will block or not (for example, by coupling	823	caller decide whether the call will block or not (for example, by coupling
746	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
747	callbacks so the caller knows that getting the result will not block,	825	callbacks so the caller knows that getting the result will not block,
748	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
749		827
750	You can ensure that C<< -recv >> never blocks by setting a callback and	828	You can ensure that C<< ->recv >> never blocks by setting a callback and
751	only calling C<< ->recv >> from within that callback (or at a later	829	only calling C<< ->recv >> from within that callback (or at a later
752	time). This will work even when the event loop does not support blocking	830	time). This will work even when the event loop does not support blocking
753	waits otherwise.	831	waits otherwise.
754		832
755	=item $bool = $cv->ready	833	=item $bool = $cv->ready
…		…
761		839
762	This is a mutator function that returns the callback set and optionally	840	This is a mutator function that returns the callback set and optionally
763	replaces it before doing so.	841	replaces it before doing so.
764		842
765	The callback will be called when the condition becomes "true", i.e. when	843	The callback will be called when the condition becomes "true", i.e. when
766	C<send> or C<croak> are called, with the only argument being the condition	844	C<send> or C<croak> are called, with the only argument being the
767	variable itself. Calling C<recv> inside the callback or at any later time	845	condition variable itself. If the condition is already true, the
768	is guaranteed not to block.	846	callback is called immediately when it is set. Calling C<recv> inside
		847	the callback or at any later time is guaranteed not to block.
769		848
770	=back	849	=back
771		850
772	=head1 SUPPORTED EVENT LOOPS/BACKENDS	851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
773		852
…		…
776	=over 4	855	=over 4
777		856
778	=item Backends that are autoprobed when no other event loop can be found.	857	=item Backends that are autoprobed when no other event loop can be found.
779		858
780	EV is the preferred backend when no other event loop seems to be in	859	EV is the preferred backend when no other event loop seems to be in
781	use. If EV is not installed, then AnyEvent will try Event, and, failing	860	use. If EV is not installed, then AnyEvent will fall back to its own
782	that, will fall back to its own pure-perl implementation, which is	861	pure-perl implementation, which is available everywhere as it comes with
783	available everywhere as it comes with AnyEvent itself.	862	AnyEvent itself.
784		863
785	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
786	AnyEvent::Impl::Event based on Event, very stable, few glitches.
787	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
788		866
789	=item Backends that are transparently being picked up when they are used.	867	=item Backends that are transparently being picked up when they are used.
790		868
791	These will be used when they are currently loaded when the first watcher	869	These will be used if they are already loaded when the first watcher
792	is created, in which case it is assumed that the application is using	870	is created, in which case it is assumed that the application is using
793	them. This means that AnyEvent will automatically pick the right backend	871	them. This means that AnyEvent will automatically pick the right backend
794	when the main program loads an event module before anything starts to	872	when the main program loads an event module before anything starts to
795	create watchers. Nothing special needs to be done by the main program.	873	create watchers. Nothing special needs to be done by the main program.
796		874
		875	AnyEvent::Impl::Event based on Event, very stable, few glitches.
797	AnyEvent::Impl::Glib based on Glib, slow but very stable.	876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
798	AnyEvent::Impl::Tk based on Tk, very broken.	877	AnyEvent::Impl::Tk based on Tk, very broken.
799	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
800	AnyEvent::Impl::POE based on POE, very slow, some limitations.	879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		880	AnyEvent::Impl::Irssi used when running within irssi.
		881	AnyEvent::Impl::IOAsync based on IO::Async.
		882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		883	AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
801		884
802	=item Backends with special needs.	885	=item Backends with special needs.
803		886
804	Qt requires the Qt::Application to be instantiated first, but will	887	Qt requires the Qt::Application to be instantiated first, but will
805	otherwise be picked up automatically. As long as the main program	888	otherwise be picked up automatically. As long as the main program
806	instantiates the application before any AnyEvent watchers are created,	889	instantiates the application before any AnyEvent watchers are created,
807	everything should just work.	890	everything should just work.
808		891
809	AnyEvent::Impl::Qt based on Qt.	892	AnyEvent::Impl::Qt based on Qt.
810		893
811	Support for IO::Async can only be partial, as it is too broken and
812	architecturally limited to even support the AnyEvent API. It also
813	is the only event loop that needs the loop to be set explicitly, so
814	it can only be used by a main program knowing about AnyEvent. See
815	L<AnyEvent::Impl::Async> for the gory details.
816
817	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
818
819	=item Event loops that are indirectly supported via other backends.	894	=item Event loops that are indirectly supported via other backends.
820		895
821	Some event loops can be supported via other modules:	896	Some event loops can be supported via other modules:
822		897
823	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.	898	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
…		…
848	Contains C<undef> until the first watcher is being created, before the	923	Contains C<undef> until the first watcher is being created, before the
849	backend has been autodetected.	924	backend has been autodetected.
850		925
851	Afterwards it contains the event model that is being used, which is the	926	Afterwards it contains the event model that is being used, which is the
852	name of the Perl class implementing the model. This class is usually one	927	name of the Perl class implementing the model. This class is usually one
853	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the	928	of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
854	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it	929	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
855	will be C<urxvt::anyevent>).	930	will be C<urxvt::anyevent>).
856		931
857	=item AnyEvent::detect	932	=item AnyEvent::detect
858		933
859	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
860	if necessary. You should only call this function right before you would	935	if necessary. You should only call this function right before you would
861	have created an AnyEvent watcher anyway, that is, as late as possible at	936	have created an AnyEvent watcher anyway, that is, as late as possible at
862	runtime, and not e.g. while initialising of your module.	937	runtime, and not e.g. during initialisation of your module.
		938
		939	The effect of calling this function is as if a watcher had been created
		940	(specifically, actions that happen "when the first watcher is created"
		941	happen when calling detetc as well).
863		942
864	If you need to do some initialisation before AnyEvent watchers are	943	If you need to do some initialisation before AnyEvent watchers are
865	created, use C<post_detect>.	944	created, use C<post_detect>.
866		945
867	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
868		947
869	Arranges for the code block to be executed as soon as the event model is	948	Arranges for the code block to be executed as soon as the event model is
870	autodetected (or immediately if this has already happened).	949	autodetected (or immediately if that has already happened).
871		950
872	The block will be executed I<after> the actual backend has been detected	951	The block will be executed I<after> the actual backend has been detected
873	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been	952	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
874	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do	953	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
875	other initialisations - see the sources of L<AnyEvent::Strict> or	954	other initialisations - see the sources of L<AnyEvent::Strict> or
…		…
884	that automatically removes the callback again when it is destroyed (or	963	that automatically removes the callback again when it is destroyed (or
885	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for	964	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
886	a case where this is useful.	965	a case where this is useful.
887		966
888	Example: Create a watcher for the IO::AIO module and store it in	967	Example: Create a watcher for the IO::AIO module and store it in
889	C<$WATCHER>. Only do so after the event loop is initialised, though.	968	C<$WATCHER>, but do so only do so after the event loop is initialised.
890		969
891	our WATCHER;	970	our WATCHER;
892		971
893	my $guard = AnyEvent::post_detect {	972	my $guard = AnyEvent::post_detect {
894	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);	973	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
…		…
902	$WATCHER ||= $guard;	981	$WATCHER ||= $guard;
903		982
904	=item @AnyEvent::post_detect	983	=item @AnyEvent::post_detect
905		984
906	If there are any code references in this array (you can C<push> to it	985	If there are any code references in this array (you can C<push> to it
907	before or after loading AnyEvent), then they will called directly after	986	before or after loading AnyEvent), then they will be called directly
908	the event loop has been chosen.	987	after the event loop has been chosen.
909		988
910	You should check C<$AnyEvent::MODEL> before adding to this array, though:	989	You should check C<$AnyEvent::MODEL> before adding to this array, though:
911	if it is defined then the event loop has already been detected, and the	990	if it is defined then the event loop has already been detected, and the
912	array will be ignored.	991	array will be ignored.
913		992
914	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	993	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
915	it,as it takes care of these details.	994	it, as it takes care of these details.
916		995
917	This variable is mainly useful for modules that can do something useful	996	This variable is mainly useful for modules that can do something useful
918	when AnyEvent is used and thus want to know when it is initialised, but do	997	when AnyEvent is used and thus want to know when it is initialised, but do
919	not need to even load it by default. This array provides the means to hook	998	not need to even load it by default. This array provides the means to hook
920	into AnyEvent passively, without loading it.	999	into AnyEvent passively, without loading it.
921		1000
		1001	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1002	together, you could put this into Coro (this is the actual code used by
		1003	Coro to accomplish this):
		1004
		1005	if (defined $AnyEvent::MODEL) {
		1006	# AnyEvent already initialised, so load Coro::AnyEvent
		1007	require Coro::AnyEvent;
		1008	} else {
		1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1010	# as soon as it is
		1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1012	}
		1013
		1014	=item AnyEvent::postpone { BLOCK }
		1015
		1016	Arranges for the block to be executed as soon as possible, but not before
		1017	the call itself returns. In practise, the block will be executed just
		1018	before the event loop polls for new events, or shortly afterwards.
		1019
		1020	This function never returns anything (to make the C<return postpone { ...
		1021	}> idiom more useful.
		1022
		1023	To understand the usefulness of this function, consider a function that
		1024	asynchronously does something for you and returns some transaction
		1025	object or guard to let you cancel the operation. For example,
		1026	C<AnyEvent::Socket::tcp_connect>:
		1027
		1028	# start a conenction attempt unless one is active
		1029	$self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1030	delete $self->{connect_guard};
		1031	...
		1032	};
		1033
		1034	Imagine that this function could instantly call the callback, for
		1035	example, because it detects an obvious error such as a negative port
		1036	number. Invoking the callback before the function returns causes problems
		1037	however: the callback will be called and will try to delete the guard
		1038	object. But since the function hasn't returned yet, there is nothing to
		1039	delete. When the function eventually returns it will assign the guard
		1040	object to C<< $self->{connect_guard} >>, where it will likely never be
		1041	deleted, so the program thinks it is still trying to connect.
		1042
		1043	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1044	callback directly on error:
		1045
		1046	$cb->(undef), return # signal error to callback, BAD!
		1047	if $some_error_condition;
		1048
		1049	It should use C<postpone>:
		1050
		1051	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1052	if $some_error_condition;
		1053
		1054	=item AnyEvent::log $level, $msg[, @args]
		1055
		1056	Log the given C<$msg> at the given C<$level>.
		1057
		1058	If L<AnyEvent::Log> is not loaded then this function makes a simple test
		1059	to see whether the message will be logged. If the test succeeds it will
		1060	load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
		1061	the L<AnyEvent::Log> documentation for details.
		1062
		1063	If the test fails it will simply return. Right now this happens when a
		1064	numerical loglevel is used and it is larger than the level specified via
		1065	C<$ENV{PERL_ANYEVENT_VERBOSE}>.
		1066
		1067	If you want to sprinkle loads of logging calls around your code, consider
		1068	creating a logger callback with the C<AnyEvent::Log::logger> function,
		1069	which can reduce typing, codesize and can reduce the logging overhead
		1070	enourmously.
		1071
922	=back	1072	=back
923		1073
924	=head1 WHAT TO DO IN A MODULE	1074	=head1 WHAT TO DO IN A MODULE
925		1075
926	As a module author, you should C<use AnyEvent> and call AnyEvent methods	1076	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
936	because it will stall the whole program, and the whole point of using	1086	because it will stall the whole program, and the whole point of using
937	events is to stay interactive.	1087	events is to stay interactive.
938		1088
939	It is fine, however, to call C<< ->recv >> when the user of your module	1089	It is fine, however, to call C<< ->recv >> when the user of your module
940	requests it (i.e. if you create a http request object ad have a method	1090	requests it (i.e. if you create a http request object ad have a method
941	called C<results> that returns the results, it should call C<< ->recv >>	1091	called C<results> that returns the results, it may call C<< ->recv >>
942	freely, as the user of your module knows what she is doing. always).	1092	freely, as the user of your module knows what she is doing. Always).
943		1093
944	=head1 WHAT TO DO IN THE MAIN PROGRAM	1094	=head1 WHAT TO DO IN THE MAIN PROGRAM
945		1095
946	There will always be a single main program - the only place that should	1096	There will always be a single main program - the only place that should
947	dictate which event model to use.	1097	dictate which event model to use.
948		1098
949	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1099	If the program is not event-based, it need not do anything special, even
950	do anything special (it does not need to be event-based) and let AnyEvent	1100	when it depends on a module that uses an AnyEvent. If the program itself
951	decide which implementation to chose if some module relies on it.	1101	uses AnyEvent, but does not care which event loop is used, all it needs
		1102	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1103	available loop implementation.
952		1104
953	If the main program relies on a specific event model - for example, in	1105	If the main program relies on a specific event model - for example, in
954	Gtk2 programs you have to rely on the Glib module - you should load the	1106	Gtk2 programs you have to rely on the Glib module - you should load the
955	event module before loading AnyEvent or any module that uses it: generally	1107	event module before loading AnyEvent or any module that uses it: generally
956	speaking, you should load it as early as possible. The reason is that	1108	speaking, you should load it as early as possible. The reason is that
957	modules might create watchers when they are loaded, and AnyEvent will	1109	modules might create watchers when they are loaded, and AnyEvent will
958	decide on the event model to use as soon as it creates watchers, and it	1110	decide on the event model to use as soon as it creates watchers, and it
959	might chose the wrong one unless you load the correct one yourself.	1111	might choose the wrong one unless you load the correct one yourself.
960		1112
961	You can chose to use a pure-perl implementation by loading the	1113	You can chose to use a pure-perl implementation by loading the
962	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1114	C<AnyEvent::Loop> module, which gives you similar behaviour
963	everywhere, but letting AnyEvent chose the model is generally better.	1115	everywhere, but letting AnyEvent chose the model is generally better.
964		1116
965	=head2 MAINLOOP EMULATION	1117	=head2 MAINLOOP EMULATION
966		1118
967	Sometimes (often for short test scripts, or even standalone programs who	1119	Sometimes (often for short test scripts, or even standalone programs who
…		…
980		1132
981		1133
982	=head1 OTHER MODULES	1134	=head1 OTHER MODULES
983		1135
984	The following is a non-exhaustive list of additional modules that use	1136	The following is a non-exhaustive list of additional modules that use
985	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1137	AnyEvent as a client and can therefore be mixed easily with other
986	modules and other event loops in the same program. Some of the modules	1138	AnyEvent modules and other event loops in the same program. Some of the
987	come with AnyEvent, most are available via CPAN.	1139	modules come as part of AnyEvent, the others are available via CPAN (see
		1140	L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
		1141	a longer non-exhaustive list), and the list is heavily biased towards
		1142	modules of the AnyEvent author himself :)
988		1143
989	=over 4	1144	=over 4
990		1145
991	=item L<AnyEvent::Util>	1146	=item L<AnyEvent::Util>
992		1147
993	Contains various utility functions that replace often-used but blocking	1148	Contains various utility functions that replace often-used blocking
994	functions such as C<inet_aton> by event-/callback-based versions.	1149	functions such as C<inet_aton> with event/callback-based versions.
995		1150
996	=item L<AnyEvent::Socket>	1151	=item L<AnyEvent::Socket>
997		1152
998	Provides various utility functions for (internet protocol) sockets,	1153	Provides various utility functions for (internet protocol) sockets,
999	addresses and name resolution. Also functions to create non-blocking tcp	1154	addresses and name resolution. Also functions to create non-blocking tcp
…		…
1001		1156
1002	=item L<AnyEvent::Handle>	1157	=item L<AnyEvent::Handle>
1003		1158
1004	Provide read and write buffers, manages watchers for reads and writes,	1159	Provide read and write buffers, manages watchers for reads and writes,
1005	supports raw and formatted I/O, I/O queued and fully transparent and	1160	supports raw and formatted I/O, I/O queued and fully transparent and
1006	non-blocking SSL/TLS (via L<AnyEvent::TLS>.	1161	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1007		1162
1008	=item L<AnyEvent::DNS>	1163	=item L<AnyEvent::DNS>
1009		1164
1010	Provides rich asynchronous DNS resolver capabilities.	1165	Provides rich asynchronous DNS resolver capabilities.
1011		1166
		1167	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1168
		1169	Implement event-based interfaces to the protocols of the same name (for
		1170	the curious, IGS is the International Go Server and FCP is the Freenet
		1171	Client Protocol).
		1172
1012	=item L<AnyEvent::HTTP>	1173	=item L<AnyEvent::AIO>
1013		1174
1014	A simple-to-use HTTP library that is capable of making a lot of concurrent	1175	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1015	HTTP requests.	1176	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1177	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1178	file I/O, and much more.
		1179
		1180	=item L<AnyEvent::Filesys::Notify>
		1181
		1182	AnyEvent is good for non-blocking stuff, but it can't detect file or
		1183	path changes (e.g. "watch this directory for new files", "watch this
		1184	file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
		1185	do just that in a portbale fashion, supporting inotify on GNU/Linux and
		1186	some weird, without doubt broken, stuff on OS X to monitor files. It can
		1187	fall back to blocking scans at regular intervals transparently on other
		1188	platforms, so it's about as portable as it gets.
		1189
		1190	(I haven't used it myself, but I haven't heard anybody complaining about
		1191	it yet).
		1192
		1193	=item L<AnyEvent::DBI>
		1194
		1195	Executes L<DBI> requests asynchronously in a proxy process for you,
		1196	notifying you in an event-based way when the operation is finished.
1016		1197
1017	=item L<AnyEvent::HTTPD>	1198	=item L<AnyEvent::HTTPD>
1018		1199
1019	Provides a simple web application server framework.	1200	A simple embedded webserver.
1020		1201
1021	=item L<AnyEvent::FastPing>	1202	=item L<AnyEvent::FastPing>
1022		1203
1023	The fastest ping in the west.	1204	The fastest ping in the west.
1024		1205
1025	=item L<AnyEvent::DBI>
1026
1027	Executes L<DBI> requests asynchronously in a proxy process.
1028
1029	=item L<AnyEvent::AIO>
1030
1031	Truly asynchronous I/O, should be in the toolbox of every event
1032	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1033	together.
1034
1035	=item L<AnyEvent::BDB>
1036
1037	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1038	L<BDB> and AnyEvent together.
1039
1040	=item L<AnyEvent::GPSD>
1041
1042	A non-blocking interface to gpsd, a daemon delivering GPS information.
1043
1044	=item L<AnyEvent::IRC>
1045
1046	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1047
1048	=item L<AnyEvent::XMPP>
1049
1050	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1051	Net::XMPP2>.
1052
1053	=item L<AnyEvent::IGS>
1054
1055	A non-blocking interface to the Internet Go Server protocol (used by
1056	L<App::IGS>).
1057
1058	=item L<Net::FCP>
1059
1060	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1061	of AnyEvent.
1062
1063	=item L<Event::ExecFlow>
1064
1065	High level API for event-based execution flow control.
1066
1067	=item L<Coro>	1206	=item L<Coro>
1068		1207
1069	Has special support for AnyEvent via L<Coro::AnyEvent>.	1208	Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
		1209	to simply invert the flow control - don't call us, we will call you:
		1210
		1211	async {
		1212	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1213	print "5 seconds later!\n";
		1214
		1215	Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
		1216	my $line = <STDIN>; # works for ttys
		1217
		1218	AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
		1219	my ($body, $hdr) = Coro::rouse_wait;
		1220	};
1070		1221
1071	=back	1222	=back
1072		1223
1073	=cut	1224	=cut
1074		1225
1075	package AnyEvent;	1226	package AnyEvent;
1076		1227
1077	# basically a tuned-down version of common::sense	1228	# basically a tuned-down version of common::sense
1078	sub common_sense {	1229	sub common_sense {
1079	# no warnings	1230	# from common:.sense 3.4
1080	${^WARNING_BITS} ^= ${^WARNING_BITS};	1231	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1081	# use strict vars subs	1232	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1082	$^H |= 0x00000600;	1233	$^H |= 0x00000600;
1083	}	1234	}
1084		1235
1085	BEGIN { AnyEvent::common_sense }	1236	BEGIN { AnyEvent::common_sense }
1086		1237
1087	use Carp ();	1238	use Carp ();
1088		1239
1089	our $VERSION = 4.86;	1240	our $VERSION = '6.02';
1090	our $MODEL;	1241	our $MODEL;
1091		1242
1092	our $AUTOLOAD;
1093	our @ISA;	1243	our @ISA;
1094		1244
1095	our @REGISTRY;	1245	our @REGISTRY;
1096		1246
1097	our $WIN32;
1098
1099	our $VERBOSE;	1247	our $VERBOSE;
1100		1248
1101	BEGIN {	1249	BEGIN {
1102	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1250	require "AnyEvent/constants.pl";
		1251
1103	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1252	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1104		1253
1105	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1254	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1106	if ${^TAINT};	1255	if ${^TAINT};
1107		1256
1108	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1257	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1258	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1109		1259
		1260	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1261	if ${^TAINT};
		1262
		1263	# $ENV{PERL_ANYEVENT_xxx} now valid
		1264
		1265	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1110	}	1266	}
1111		1267
1112	our $MAX_SIGNAL_LATENCY = 10;	1268	our $MAX_SIGNAL_LATENCY = 10;
1113		1269
1114	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1270	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
…		…
1118	$PROTOCOL{$_} = ++$idx	1274	$PROTOCOL{$_} = ++$idx
1119	for reverse split /\s*,\s*/,	1275	for reverse split /\s*,\s*/,
1120	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1276	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1121	}	1277	}
1122		1278
		1279	our @post_detect;
		1280
		1281	sub post_detect(&) {
		1282	my ($cb) = @_;
		1283
		1284	push @post_detect, $cb;
		1285
		1286	defined wantarray
		1287	? bless \$cb, "AnyEvent::Util::postdetect"
		1288	: ()
		1289	}
		1290
		1291	sub AnyEvent::Util::postdetect::DESTROY {
		1292	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1293	}
		1294
		1295	our $POSTPONE_W;
		1296	our @POSTPONE;
		1297
		1298	sub _postpone_exec {
		1299	undef $POSTPONE_W;
		1300
		1301	&{ shift @POSTPONE }
		1302	while @POSTPONE;
		1303	}
		1304
		1305	sub postpone(&) {
		1306	push @POSTPONE, shift;
		1307
		1308	$POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
		1309
		1310	()
		1311	}
		1312
		1313	sub log($$;@) {
		1314	# only load the big bloated module when we actually are about to log something
		1315	if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
		1316	require AnyEvent::Log;
		1317	# AnyEvent::Log overwrites this function
		1318	goto &log;
		1319	}
		1320
		1321	0 # not logged
		1322	}
		1323
		1324	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1325	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1326	}
		1327
1123	my @models = (	1328	our @models = (
1124	[EV:: => AnyEvent::Impl::EV::],	1329	[EV:: => AnyEvent::Impl::EV:: , 1],
1125	[Event:: => AnyEvent::Impl::Event::],	1330	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1126	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
1127	# everything below here will not be autoprobed	1331	# everything below here will not (normally) be autoprobed
1128	# as the pureperl backend should work everywhere	1332	# as the pure perl backend should work everywhere
1129	# and is usually faster	1333	# and is usually faster
		1334	[Event:: => AnyEvent::Impl::Event::, 1],
1130	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1335	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1131	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1336	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1337	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1132	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1338	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1133	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1339	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1134	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1340	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1135	[Wx:: => AnyEvent::Impl::POE::],	1341	[Wx:: => AnyEvent::Impl::POE::],
1136	[Prima:: => AnyEvent::Impl::POE::],	1342	[Prima:: => AnyEvent::Impl::POE::],
1137	# IO::Async is just too broken - we would need workarounds for its	1343	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1138	# byzantine signal and broken child handling, among others.	1344	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1139	# IO::Async is rather hard to detect, as it doesn't have any	1345	[FLTK:: => AnyEvent::Impl::FLTK::],
1140	# obvious default class.
1141	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1142	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1143	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1144	);	1346	);
1145		1347
1146	our %method = map +($_ => 1),	1348	our @isa_hook;
		1349
		1350	sub _isa_set {
		1351	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1352
		1353	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1354	for 1 .. $#pkg;
		1355
		1356	grep $_ && $_->[1], @isa_hook
		1357	and AE::_reset ();
		1358	}
		1359
		1360	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1361	sub _isa_hook($$;$) {
		1362	my ($i, $pkg, $reset_ae) = @_;
		1363
		1364	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1365
		1366	_isa_set;
		1367	}
		1368
		1369	# all autoloaded methods reserve the complete glob, not just the method slot.
		1370	# due to bugs in perls method cache implementation.
1147	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1371	our @methods = qw(io timer time now now_update signal child idle condvar);
1148		1372
1149	our @post_detect;
1150
1151	sub post_detect(&) {	1373	sub detect() {
1152	my ($cb) = @_;	1374	return $MODEL if $MODEL; # some programs keep references to detect
1153		1375
1154	if ($MODEL) {	1376	local $!; # for good measure
1155	$cb->();	1377	local $SIG{__DIE__}; # we use eval
1156		1378
1157	undef	1379	# free some memory
		1380	*detect = sub () { $MODEL };
		1381	# undef &func doesn't correctly update the method cache. grmbl.
		1382	# so we delete the whole glob. grmbl.
		1383	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1384	# a glob with an active sub. hrm. i hope it works, but perl is
		1385	# usually buggy in this department. sigh.
		1386	delete @{"AnyEvent::"}{@methods};
		1387	undef @methods;
		1388
		1389	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
		1390	my $model = $1;
		1391	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
		1392	if (eval "require $model") {
		1393	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
		1394	$MODEL = $model;
1158	} else {	1395	} else {
1159	push @post_detect, $cb;	1396	AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1160		1397	}
1161	defined wantarray
1162	? bless \$cb, "AnyEvent::Util::postdetect"
1163	: ()
1164	}	1398	}
1165	}
1166		1399
1167	sub AnyEvent::Util::postdetect::DESTROY {	1400	# check for already loaded models
1168	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1169	}
1170
1171	sub detect() {
1172	unless ($MODEL) {	1401	unless ($MODEL) {
1173	local $SIG{__DIE__};	1402	for (@REGISTRY, @models) {
1174		1403	my ($package, $model) = @$_;
1175	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1404	if (${"$package\::VERSION"} > 0) {
1176	my $model = "AnyEvent::Impl::$1";
1177	if (eval "require $model") {	1405	if (eval "require $model") {
		1406	AnyEvent::log 7 => "autodetected model '$model', using it.";
1178	$MODEL = $model;	1407	$MODEL = $model;
1179	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1408	last;
1180	} else {	1409	}
1181	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1182	}	1410	}
1183	}	1411	}
1184		1412
1185	# check for already loaded models
1186	unless ($MODEL) {	1413	unless ($MODEL) {
		1414	# try to autoload a model
1187	for (@REGISTRY, @models) {	1415	for (@REGISTRY, @models) {
1188	my ($package, $model) = @$_;	1416	my ($package, $model, $autoload) = @$_;
		1417	if (
		1418	$autoload
		1419	and eval "require $package"
1189	if (${"$package\::VERSION"} > 0) {	1420	and ${"$package\::VERSION"} > 0
1190	if (eval "require $model") {	1421	and eval "require $model"
		1422	) {
		1423	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1191	$MODEL = $model;	1424	$MODEL = $model;
1192	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1193	last;	1425	last;
1194	}
1195	}	1426	}
1196	}	1427	}
1197		1428
1198	unless ($MODEL) {
1199	# try to load a model
1200
1201	for (@REGISTRY, @models) {
1202	my ($package, $model) = @$_;
1203	if (eval "require $package"
1204	and ${"$package\::VERSION"} > 0
1205	and eval "require $model") {
1206	$MODEL = $model;
1207	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1208	last;
1209	}
1210	}
1211
1212	$MODEL	1429	$MODEL
1213	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1430	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1214	}
1215	}	1431	}
1216
1217	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1218
1219	unshift @ISA, $MODEL;
1220
1221	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1222
1223	(shift @post_detect)->() while @post_detect;
1224	}	1432	}
1225		1433
		1434	# free memory only needed for probing
		1435	undef @models;
		1436	undef @REGISTRY;
		1437
		1438	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1439
		1440	# now nuke some methods that are overridden by the backend.
		1441	# SUPER usage is not allowed in these.
		1442	for (qw(time signal child idle)) {
		1443	undef &{"AnyEvent::Base::$_"}
		1444	if defined &{"$MODEL\::$_"};
		1445	}
		1446
		1447	_isa_set;
		1448
		1449	# we're officially open!
		1450
		1451	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1452	require AnyEvent::Strict;
		1453	}
		1454
		1455	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1456	require AnyEvent::Debug;
		1457	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1458	}
		1459
		1460	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1461	require AnyEvent::Socket;
		1462	require AnyEvent::Debug;
		1463
		1464	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1465	$shell =~ s/\$\$/$$/g;
		1466
		1467	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1468	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1469	}
		1470
		1471	# now the anyevent environment is set up as the user told us to, so
		1472	# call the actual user code - post detects
		1473
		1474	(shift @post_detect)->() while @post_detect;
		1475	undef @post_detect;
		1476
		1477	*post_detect = sub(&) {
		1478	shift->();
		1479
		1480	undef
		1481	};
		1482
1226	$MODEL	1483	$MODEL
1227	}	1484	}
1228		1485
1229	sub AUTOLOAD {	1486	for my $name (@methods) {
1230	(my $func = $AUTOLOAD) =~ s/.*://;	1487	*$name = sub {
1231		1488	detect;
1232	$method{$func}	1489	# we use goto because
1233	or Carp::croak "$func: not a valid method for AnyEvent objects";	1490	# a) it makes the thunk more transparent
1234		1491	# b) it allows us to delete the thunk later
1235	detect unless $MODEL;	1492	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1236		1493	};
1237	my $class = shift;
1238	$class->$func (@_);
1239	}	1494	}
1240		1495
1241	# utility function to dup a filehandle. this is used by many backends	1496	# utility function to dup a filehandle. this is used by many backends
1242	# to support binding more than one watcher per filehandle (they usually	1497	# to support binding more than one watcher per filehandle (they usually
1243	# allow only one watcher per fd, so we dup it to get a different one).	1498	# allow only one watcher per fd, so we dup it to get a different one).
…		…
1253	# we assume CLOEXEC is already set by perl in all important cases	1508	# we assume CLOEXEC is already set by perl in all important cases
1254		1509
1255	($fh2, $rw)	1510	($fh2, $rw)
1256	}	1511	}
1257		1512
		1513	=head1 SIMPLIFIED AE API
		1514
		1515	Starting with version 5.0, AnyEvent officially supports a second, much
		1516	simpler, API that is designed to reduce the calling, typing and memory
		1517	overhead by using function call syntax and a fixed number of parameters.
		1518
		1519	See the L<AE> manpage for details.
		1520
		1521	=cut
		1522
		1523	package AE;
		1524
		1525	our $VERSION = $AnyEvent::VERSION;
		1526
		1527	sub _reset() {
		1528	eval q{
		1529	# fall back to the main API by default - backends and AnyEvent::Base
		1530	# implementations can overwrite these.
		1531
		1532	sub io($$$) {
		1533	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1534	}
		1535
		1536	sub timer($$$) {
		1537	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1538	}
		1539
		1540	sub signal($$) {
		1541	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1542	}
		1543
		1544	sub child($$) {
		1545	AnyEvent->child (pid => $_[0], cb => $_[1])
		1546	}
		1547
		1548	sub idle($) {
		1549	AnyEvent->idle (cb => $_[0]);
		1550	}
		1551
		1552	sub cv(;&) {
		1553	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1554	}
		1555
		1556	sub now() {
		1557	AnyEvent->now
		1558	}
		1559
		1560	sub now_update() {
		1561	AnyEvent->now_update
		1562	}
		1563
		1564	sub time() {
		1565	AnyEvent->time
		1566	}
		1567
		1568	*postpone = \&AnyEvent::postpone;
		1569	*log = \&AnyEvent::log;
		1570	};
		1571	die if $@;
		1572	}
		1573
		1574	BEGIN { _reset }
		1575
1258	package AnyEvent::Base;	1576	package AnyEvent::Base;
1259		1577
1260	# default implementations for many methods	1578	# default implementations for many methods
1261		1579
1262	sub _time {	1580	sub time {
		1581	eval q{ # poor man's autoloading {}
1263	# probe for availability of Time::HiRes	1582	# probe for availability of Time::HiRes
1264	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1583	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1265	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1584	*time = sub { Time::HiRes::time () };
1266	*_time = \&Time::HiRes::time;	1585	*AE::time = \& Time::HiRes::time ;
		1586	*now = \&time;
		1587	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1267	# if (eval "use POSIX (); (POSIX::times())...	1588	# if (eval "use POSIX (); (POSIX::times())...
1268	} else {	1589	} else {
		1590	*time = sub { CORE::time };
		1591	*AE::time = sub (){ CORE::time };
		1592	*now = \&time;
1269	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1593	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1270	*_time = sub { time }; # epic fail	1594	}
1271	}	1595	};
		1596	die if $@;
1272		1597
1273	&_time	1598	&time
1274	}	1599	}
1275		1600
1276	sub time { _time }	1601	*now = \&time;
1277	sub now { _time }
1278	sub now_update { }	1602	sub now_update { }
1279		1603
		1604	sub _poll {
		1605	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1606	}
		1607
1280	# default implementation for ->condvar	1608	# default implementation for ->condvar
		1609	# in fact, the default should not be overwritten
1281		1610
1282	sub condvar {	1611	sub condvar {
		1612	eval q{ # poor man's autoloading {}
		1613	*condvar = sub {
1283	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1614	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1615	};
		1616
		1617	*AE::cv = sub (;&) {
		1618	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1619	};
		1620	};
		1621	die if $@;
		1622
		1623	&condvar
1284	}	1624	}
1285		1625
1286	# default implementation for ->signal	1626	# default implementation for ->signal
1287		1627
1288	our $HAVE_ASYNC_INTERRUPT;	1628	our $HAVE_ASYNC_INTERRUPT;
		1629
		1630	sub _have_async_interrupt() {
		1631	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1632	&& eval "use Async::Interrupt 1.02 (); 1")
		1633	unless defined $HAVE_ASYNC_INTERRUPT;
		1634
		1635	$HAVE_ASYNC_INTERRUPT
		1636	}
		1637
1289	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1638	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1290	our (%SIG_ASY, %SIG_ASY_W);	1639	our (%SIG_ASY, %SIG_ASY_W);
1291	our ($SIG_COUNT, $SIG_TW);	1640	our ($SIG_COUNT, $SIG_TW);
1292		1641
1293	sub _signal_exec {
1294	$HAVE_ASYNC_INTERRUPT
1295	? $SIGPIPE_R->drain
1296	: sysread $SIGPIPE_R, my $dummy, 9;
1297
1298	while (%SIG_EV) {
1299	for (keys %SIG_EV) {
1300	delete $SIG_EV{$_};
1301	$_->() for values %{ $SIG_CB{$_} || {} };
1302	}
1303	}
1304	}
1305
1306	# install a dumym wakeupw atcher to reduce signal catching latency	1642	# install a dummy wakeup watcher to reduce signal catching latency
		1643	# used by Impls
1307	sub _sig_add() {	1644	sub _sig_add() {
1308	unless ($SIG_COUNT++) {	1645	unless ($SIG_COUNT++) {
1309	# try to align timer on a full-second boundary, if possible	1646	# try to align timer on a full-second boundary, if possible
1310	my $NOW = AnyEvent->now;	1647	my $NOW = AE::now;
1311		1648
1312	$SIG_TW = AnyEvent->timer (	1649	$SIG_TW = AE::timer
1313	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1650	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1314	interval => $MAX_SIGNAL_LATENCY,	1651	$MAX_SIGNAL_LATENCY,
1315	cb => sub { }, # just for the PERL_ASYNC_CHECK	1652	sub { } # just for the PERL_ASYNC_CHECK
1316	);	1653	;
1317	}	1654	}
1318	}	1655	}
1319		1656
1320	sub _sig_del {	1657	sub _sig_del {
1321	undef $SIG_TW	1658	undef $SIG_TW
1322	unless --$SIG_COUNT;	1659	unless --$SIG_COUNT;
1323	}	1660	}
1324		1661
		1662	our $_sig_name_init; $_sig_name_init = sub {
		1663	eval q{ # poor man's autoloading {}
		1664	undef $_sig_name_init;
		1665
		1666	if (_have_async_interrupt) {
		1667	*sig2num = \&Async::Interrupt::sig2num;
		1668	*sig2name = \&Async::Interrupt::sig2name;
		1669	} else {
		1670	require Config;
		1671
		1672	my %signame2num;
		1673	@signame2num{ split ' ', $Config::Config{sig_name} }
		1674	= split ' ', $Config::Config{sig_num};
		1675
		1676	my @signum2name;
		1677	@signum2name[values %signame2num] = keys %signame2num;
		1678
		1679	*sig2num = sub($) {
		1680	$_[0] > 0 ? shift : $signame2num{+shift}
		1681	};
		1682	*sig2name = sub ($) {
		1683	$_[0] > 0 ? $signum2name[+shift] : shift
		1684	};
		1685	}
		1686	};
		1687	die if $@;
		1688	};
		1689
		1690	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1691	sub sig2name($) { &$_sig_name_init; &sig2name }
		1692
1325	sub _signal {	1693	sub signal {
1326	my (undef, %arg) = @_;	1694	eval q{ # poor man's autoloading {}
		1695	# probe for availability of Async::Interrupt
		1696	if (_have_async_interrupt) {
		1697	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1327		1698
1328	my $signal = uc $arg{signal}	1699	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1329	or Carp::croak "required option 'signal' is missing";	1700	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1330		1701
1331	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1702	} else {
		1703	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1332		1704
1333	if ($HAVE_ASYNC_INTERRUPT) {	1705	if (AnyEvent::WIN32) {
1334	# async::interrupt	1706	require AnyEvent::Util;
1335		1707
1336	$SIG_ASY{$signal} ||= do {	1708	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1337	my $asy = new Async::Interrupt	1709	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1338	cb => sub { undef $SIG_EV{$signal} },	1710	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1339	signal => $signal,	1711	} else {
1340	pipe => [$SIGPIPE_R->filenos],	1712	pipe $SIGPIPE_R, $SIGPIPE_W;
		1713	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
		1714	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
		1715
		1716	# not strictly required, as $^F is normally 2, but let's make sure...
		1717	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1718	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1341	;	1719	}
1342	$asy->pipe_autodrain (0);
1343		1720
1344	$asy	1721	$SIGPIPE_R
		1722	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1723
		1724	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1725	}
		1726
		1727	*signal = $HAVE_ASYNC_INTERRUPT
		1728	? sub {
		1729	my (undef, %arg) = @_;
		1730
		1731	# async::interrupt
		1732	my $signal = sig2num $arg{signal};
		1733	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1734
		1735	$SIG_ASY{$signal} ||= new Async::Interrupt
		1736	cb => sub { undef $SIG_EV{$signal} },
		1737	signal => $signal,
		1738	pipe => [$SIGPIPE_R->filenos],
		1739	pipe_autodrain => 0,
		1740	;
		1741
		1742	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1743	}
		1744	: sub {
		1745	my (undef, %arg) = @_;
		1746
		1747	# pure perl
		1748	my $signal = sig2name $arg{signal};
		1749	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1750
		1751	$SIG{$signal} ||= sub {
		1752	local $!;
		1753	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1754	undef $SIG_EV{$signal};
		1755	};
		1756
		1757	# can't do signal processing without introducing races in pure perl,
		1758	# so limit the signal latency.
		1759	_sig_add;
		1760
		1761	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1762	}
		1763	;
		1764
		1765	*AnyEvent::Base::signal::DESTROY = sub {
		1766	my ($signal, $cb) = @{$_[0]};
		1767
		1768	_sig_del;
		1769
		1770	delete $SIG_CB{$signal}{$cb};
		1771
		1772	$HAVE_ASYNC_INTERRUPT
		1773	? delete $SIG_ASY{$signal}
		1774	: # delete doesn't work with older perls - they then
		1775	# print weird messages, or just unconditionally exit
		1776	# instead of getting the default action.
		1777	undef $SIG{$signal}
		1778	unless keys %{ $SIG_CB{$signal} };
1345	};	1779	};
1346		1780
1347	} else {	1781	*_signal_exec = sub {
1348	# pure perl	1782	$HAVE_ASYNC_INTERRUPT
		1783	? $SIGPIPE_R->drain
		1784	: sysread $SIGPIPE_R, (my $dummy), 9;
1349		1785
1350	$SIG{$signal} ||= sub {	1786	while (%SIG_EV) {
1351	local $!;	1787	for (keys %SIG_EV) {
1352	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1788	delete $SIG_EV{$_};
1353	undef $SIG_EV{$signal};	1789	&$_ for values %{ $SIG_CB{$_} || {} };
		1790	}
		1791	}
1354	};	1792	};
1355
1356	# can't do signal processing without introducing races in pure perl,
1357	# so limit the signal latency.
1358	_sig_add;
1359	}	1793	};
		1794	die if $@;
1360		1795
1361	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1362	}
1363
1364	sub signal {
1365	# probe for availability of Async::Interrupt
1366	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1367	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1368
1369	$HAVE_ASYNC_INTERRUPT = 1;
1370	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1371	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1372
1373	} else {
1374	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1375
1376	require Fcntl;
1377
1378	if (AnyEvent::WIN32) {
1379	require AnyEvent::Util;
1380
1381	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1382	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1383	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1384	} else {
1385	pipe $SIGPIPE_R, $SIGPIPE_W;
1386	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1387	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1388
1389	# not strictly required, as $^F is normally 2, but let's make sure...
1390	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1391	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1392	}
1393
1394	$SIGPIPE_R
1395	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1396
1397	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1398	}
1399
1400	*signal = \&_signal;
1401	&signal	1796	&signal
1402	}
1403
1404	sub AnyEvent::Base::signal::DESTROY {
1405	my ($signal, $cb) = @{$_[0]};
1406
1407	_sig_del;
1408
1409	delete $SIG_CB{$signal}{$cb};
1410
1411	$HAVE_ASYNC_INTERRUPT
1412	? delete $SIG_ASY{$signal}
1413	: # delete doesn't work with older perls - they then
1414	# print weird messages, or just unconditionally exit
1415	# instead of getting the default action.
1416	undef $SIG{$signal}
1417	unless keys %{ $SIG_CB{$signal} };
1418	}	1797	}
1419		1798
1420	# default implementation for ->child	1799	# default implementation for ->child
1421		1800
1422	our %PID_CB;	1801	our %PID_CB;
1423	our $CHLD_W;	1802	our $CHLD_W;
1424	our $CHLD_DELAY_W;	1803	our $CHLD_DELAY_W;
1425	our $WNOHANG;
1426		1804
1427	sub _sigchld {	1805	# used by many Impl's
1428	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1806	sub _emit_childstatus($$) {
1429	$_->($pid, $?)	1807	my (undef, $rpid, $rstatus) = @_;
		1808
		1809	$_->($rpid, $rstatus)
1430	for values %{ $PID_CB{$pid} || {} },	1810	for values %{ $PID_CB{$rpid} || {} },
1431	values %{ $PID_CB{0} || {} };	1811	values %{ $PID_CB{0} || {} };
1432	}
1433	}	1812	}
1434		1813
1435	sub child {	1814	sub child {
		1815	eval q{ # poor man's autoloading {}
		1816	*_sigchld = sub {
		1817	my $pid;
		1818
		1819	AnyEvent->_emit_childstatus ($pid, $?)
		1820	while ($pid = waitpid -1, WNOHANG) > 0;
		1821	};
		1822
		1823	*child = sub {
1436	my (undef, %arg) = @_;	1824	my (undef, %arg) = @_;
1437		1825
1438	defined (my $pid = $arg{pid} + 0)	1826	my $pid = $arg{pid};
1439	or Carp::croak "required option 'pid' is missing";	1827	my $cb = $arg{cb};
1440		1828
1441	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1829	$PID_CB{$pid}{$cb+0} = $cb;
1442		1830
1443	# WNOHANG is almost cetrainly 1 everywhere
1444	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1445	? 1
1446	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1447
1448	unless ($CHLD_W) {	1831	unless ($CHLD_W) {
1449	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1832	$CHLD_W = AE::signal CHLD => \&_sigchld;
1450	# child could be a zombie already, so make at least one round	1833	# child could be a zombie already, so make at least one round
1451	&_sigchld;	1834	&_sigchld;
1452	}	1835	}
1453		1836
1454	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1837	bless [$pid, $cb+0], "AnyEvent::Base::child"
1455	}	1838	};
1456		1839
1457	sub AnyEvent::Base::child::DESTROY {	1840	*AnyEvent::Base::child::DESTROY = sub {
1458	my ($pid, $cb) = @{$_[0]};	1841	my ($pid, $icb) = @{$_[0]};
1459		1842
1460	delete $PID_CB{$pid}{$cb};	1843	delete $PID_CB{$pid}{$icb};
1461	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1844	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1462		1845
1463	undef $CHLD_W unless keys %PID_CB;	1846	undef $CHLD_W unless keys %PID_CB;
		1847	};
		1848	};
		1849	die if $@;
		1850
		1851	&child
1464	}	1852	}
1465		1853
1466	# idle emulation is done by simply using a timer, regardless	1854	# idle emulation is done by simply using a timer, regardless
1467	# of whether the process is idle or not, and not letting	1855	# of whether the process is idle or not, and not letting
1468	# the callback use more than 50% of the time.	1856	# the callback use more than 50% of the time.
1469	sub idle {	1857	sub idle {
		1858	eval q{ # poor man's autoloading {}
		1859	*idle = sub {
1470	my (undef, %arg) = @_;	1860	my (undef, %arg) = @_;
1471		1861
1472	my ($cb, $w, $rcb) = $arg{cb};	1862	my ($cb, $w, $rcb) = $arg{cb};
1473		1863
1474	$rcb = sub {	1864	$rcb = sub {
1475	if ($cb) {	1865	if ($cb) {
1476	$w = _time;	1866	$w = AE::time;
1477	&$cb;	1867	&$cb;
1478	$w = _time - $w;	1868	$w = AE::time - $w;
1479		1869
1480	# never use more then 50% of the time for the idle watcher,	1870	# never use more then 50% of the time for the idle watcher,
1481	# within some limits	1871	# within some limits
1482	$w = 0.0001 if $w < 0.0001;	1872	$w = 0.0001 if $w < 0.0001;
1483	$w = 5 if $w > 5;	1873	$w = 5 if $w > 5;
1484		1874
1485	$w = AnyEvent->timer (after => $w, cb => $rcb);	1875	$w = AE::timer $w, 0, $rcb;
1486	} else {	1876	} else {
1487	# clean up...	1877	# clean up...
1488	undef $w;	1878	undef $w;
1489	undef $rcb;	1879	undef $rcb;
		1880	}
		1881	};
		1882
		1883	$w = AE::timer 0.05, 0, $rcb;
		1884
		1885	bless \\$cb, "AnyEvent::Base::idle"
1490	}	1886	};
		1887
		1888	*AnyEvent::Base::idle::DESTROY = sub {
		1889	undef $${$_[0]};
		1890	};
1491	};	1891	};
		1892	die if $@;
1492		1893
1493	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1894	&idle
1494
1495	bless \\$cb, "AnyEvent::Base::idle"
1496	}
1497
1498	sub AnyEvent::Base::idle::DESTROY {
1499	undef $${$_[0]};
1500	}	1895	}
1501		1896
1502	package AnyEvent::CondVar;	1897	package AnyEvent::CondVar;
1503		1898
1504	our @ISA = AnyEvent::CondVar::Base::;	1899	our @ISA = AnyEvent::CondVar::Base::;
		1900
		1901	# only to be used for subclassing
		1902	sub new {
		1903	my $class = shift;
		1904	bless AnyEvent->condvar (@_), $class
		1905	}
1505		1906
1506	package AnyEvent::CondVar::Base;	1907	package AnyEvent::CondVar::Base;
1507		1908
1508	#use overload	1909	#use overload
1509	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1910	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
…		…
1519		1920
1520	sub _send {	1921	sub _send {
1521	# nop	1922	# nop
1522	}	1923	}
1523		1924
		1925	sub _wait {
		1926	AnyEvent->_poll until $_[0]{_ae_sent};
		1927	}
		1928
1524	sub send {	1929	sub send {
1525	my $cv = shift;	1930	my $cv = shift;
1526	$cv->{_ae_sent} = [@_];	1931	$cv->{_ae_sent} = [@_];
1527	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};	1932	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1528	$cv->_send;	1933	$cv->_send;
…		…
1535		1940
1536	sub ready {	1941	sub ready {
1537	$_[0]{_ae_sent}	1942	$_[0]{_ae_sent}
1538	}	1943	}
1539		1944
1540	sub _wait {
1541	$WAITING
1542	and !$_[0]{_ae_sent}
1543	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1544
1545	local $WAITING = 1;
1546	AnyEvent->one_event while !$_[0]{_ae_sent};
1547	}
1548
1549	sub recv {	1945	sub recv {
		1946	unless ($_[0]{_ae_sent}) {
		1947	$WAITING
		1948	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1949
		1950	local $WAITING = 1;
1550	$_[0]->_wait;	1951	$_[0]->_wait;
		1952	}
1551		1953
1552	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1954	$_[0]{_ae_croak}
1553	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1955	and Carp::croak $_[0]{_ae_croak};
		1956
		1957	wantarray
		1958	? @{ $_[0]{_ae_sent} }
		1959	: $_[0]{_ae_sent}[0]
1554	}	1960	}
1555		1961
1556	sub cb {	1962	sub cb {
1557	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1963	my $cv = shift;
		1964
		1965	@_
		1966	and $cv->{_ae_cb} = shift
		1967	and $cv->{_ae_sent}
		1968	and (delete $cv->{_ae_cb})->($cv);
		1969
1558	$_[0]{_ae_cb}	1970	$cv->{_ae_cb}
1559	}	1971	}
1560		1972
1561	sub begin {	1973	sub begin {
1562	++$_[0]{_ae_counter};	1974	++$_[0]{_ae_counter};
1563	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1975	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1568	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	1980	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1569	}	1981	}
1570		1982
1571	# undocumented/compatibility with pre-3.4	1983	# undocumented/compatibility with pre-3.4
1572	*broadcast = \&send;	1984	*broadcast = \&send;
1573	*wait = \&_wait;	1985	*wait = \&recv;
1574		1986
1575	=head1 ERROR AND EXCEPTION HANDLING	1987	=head1 ERROR AND EXCEPTION HANDLING
1576		1988
1577	In general, AnyEvent does not do any error handling - it relies on the	1989	In general, AnyEvent does not do any error handling - it relies on the
1578	caller to do that if required. The L<AnyEvent::Strict> module (see also	1990	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1590	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2002	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1591	so on.	2003	so on.
1592		2004
1593	=head1 ENVIRONMENT VARIABLES	2005	=head1 ENVIRONMENT VARIABLES
1594		2006
1595	The following environment variables are used by this module or its	2007	AnyEvent supports a number of environment variables that tune the
1596	submodules.	2008	runtime behaviour. They are usually evaluated when AnyEvent is
		2009	loaded, initialised, or a submodule that uses them is loaded. Many of
		2010	them also cause AnyEvent to load additional modules - for example,
		2011	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2012	loaded.
1597		2013
1598	Note that AnyEvent will remove I<all> environment variables starting with	2014	All the environment variables documented here start with
1599	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2015	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1600	enabled.	2016	namespace. Other modules are encouraged (but by no means required) to use
		2017	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2018	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2019	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2020	variables starting with C<AE_>, see below).
		2021
		2022	All variables can also be set via the C<AE_> prefix, that is, instead
		2023	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2024	case there is a clash btween anyevent and another program that uses
		2025	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2026	variable to the empty string, as those variables take precedence.
		2027
		2028	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2029	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2030	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2031	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2032	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2033	is set).
		2034
		2035	The exact algorithm is currently:
		2036
		2037	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2038	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2039	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2040
		2041	This ensures that child processes will not see the C<AE_> variables.
		2042
		2043	The following environment variables are currently known to AnyEvent:
1601		2044
1602	=over 4	2045	=over 4
1603		2046
1604	=item C<PERL_ANYEVENT_VERBOSE>	2047	=item C<PERL_ANYEVENT_VERBOSE>
1605		2048
1606	By default, AnyEvent will be completely silent except in fatal	2049	By default, AnyEvent will only log messages with loglevel C<3>
1607	conditions. You can set this environment variable to make AnyEvent more	2050	(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
		2051	environment variable to a numerical loglevel to make AnyEvent more (or
1608	talkative.	2052	less) talkative.
1609		2053
		2054	If you want to do more than just set the global logging level
		2055	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2056	complex specifications.
		2057
		2058	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2059	the default logging settings.
		2060
1610	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2061	When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1611	conditions, such as not being able to load the event model specified by	2062	unexpected conditions, such as not being able to load the event model
1612	C<PERL_ANYEVENT_MODEL>.	2063	specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
		2064	exception - this is the minimum recommended level.
1613		2065
1614	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2066	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1615	model it chooses.	2067	chooses.
1616		2068
1617	When set to C<8> or higher, then AnyEvent will report extra information on	2069	When set to C<8> or higher (debug), then AnyEvent will report extra information on
1618	which optional modules it loads and how it implements certain features.	2070	which optional modules it loads and how it implements certain features.
		2071
		2072	=item C<PERL_ANYEVENT_LOG>
		2073
		2074	Accepts rather complex logging specifications. For example, you could log
		2075	all C<debug> messages of some module to stderr, warnings and above to
		2076	stderr, and errors and above to syslog, with:
		2077
		2078	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2079
		2080	For the rather extensive details, see L<AnyEvent::Log>.
		2081
		2082	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2083	so will take effect even before AnyEvent has initialised itself.
		2084
		2085	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2086	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2087	using the latter saves a few hundred kB of memory until the first message
		2088	is being logged.
1619		2089
1620	=item C<PERL_ANYEVENT_STRICT>	2090	=item C<PERL_ANYEVENT_STRICT>
1621		2091
1622	AnyEvent does not do much argument checking by default, as thorough	2092	AnyEvent does not do much argument checking by default, as thorough
1623	argument checking is very costly. Setting this variable to a true value	2093	argument checking is very costly. Setting this variable to a true value
…		…
1625	check the arguments passed to most method calls. If it finds any problems,	2095	check the arguments passed to most method calls. If it finds any problems,
1626	it will croak.	2096	it will croak.
1627		2097
1628	In other words, enables "strict" mode.	2098	In other words, enables "strict" mode.
1629		2099
1630	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>	2100	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1631	>>, it is definitely recommended to keep it off in production. Keeping	2101	>>, it is definitely recommended to keep it off in production. Keeping
1632	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs	2102	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1633	can be very useful, however.	2103	can be very useful, however.
1634		2104
		2105	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2106
		2107	If this env variable is set, then its contents will be interpreted by
		2108	C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
		2109	C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
		2110	that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
		2111
		2112	This happens when the first watcher is created.
		2113
		2114	For example, to bind a debug shell on a unix domain socket in
		2115	F<< /tmp/debug<pid>.sock >>, you could use this:
		2116
		2117	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2118
		2119	Note that creating sockets in F</tmp> is very unsafe on multiuser
		2120	systems.
		2121
		2122	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2123
		2124	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2125	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
		2126
1635	=item C<PERL_ANYEVENT_MODEL>	2127	=item C<PERL_ANYEVENT_MODEL>
1636		2128
1637	This can be used to specify the event model to be used by AnyEvent, before	2129	This can be used to specify the event model to be used by AnyEvent, before
1638	auto detection and -probing kicks in. It must be a string consisting	2130	auto detection and -probing kicks in.
1639	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2131
		2132	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2133	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1640	and the resulting module name is loaded and if the load was successful,	2134	resulting module name is loaded and - if the load was successful - used as
1641	used as event model. If it fails to load AnyEvent will proceed with	2135	event model backend. If it fails to load then AnyEvent will proceed with
1642	auto detection and -probing.	2136	auto detection and -probing.
1643		2137
1644	This functionality might change in future versions.	2138	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2139	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2140	the end of a string designates a module name and quotes it appropriately).
1645		2141
1646	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2142	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1647	could start your program like this:	2143	could start your program like this:
1648		2144
1649	PERL_ANYEVENT_MODEL=Perl perl ...	2145	PERL_ANYEVENT_MODEL=Perl perl ...
1650		2146
1651	=item C<PERL_ANYEVENT_PROTOCOLS>	2147	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1667	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2163	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1668	- only support IPv4, never try to resolve or contact IPv6	2164	- only support IPv4, never try to resolve or contact IPv6
1669	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2165	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1670	IPv6, but prefer IPv6 over IPv4.	2166	IPv6, but prefer IPv6 over IPv4.
1671		2167
		2168	=item C<PERL_ANYEVENT_HOSTS>
		2169
		2170	This variable, if specified, overrides the F</etc/hosts> file used by
		2171	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2172	from that file instead.
		2173
1672	=item C<PERL_ANYEVENT_EDNS0>	2174	=item C<PERL_ANYEVENT_EDNS0>
1673		2175
1674	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2176	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1675	for DNS. This extension is generally useful to reduce DNS traffic, but	2177	DNS. This extension is generally useful to reduce DNS traffic, especially
1676	some (broken) firewalls drop such DNS packets, which is why it is off by	2178	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1677	default.	2179	packets, which is why it is off by default.
1678		2180
1679	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2181	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1680	EDNS0 in its DNS requests.	2182	EDNS0 in its DNS requests.
1681		2183
1682	=item C<PERL_ANYEVENT_MAX_FORKS>	2184	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1690	resolver - this is the maximum number of parallel DNS requests that are	2192	resolver - this is the maximum number of parallel DNS requests that are
1691	sent to the DNS server.	2193	sent to the DNS server.
1692		2194
1693	=item C<PERL_ANYEVENT_RESOLV_CONF>	2195	=item C<PERL_ANYEVENT_RESOLV_CONF>
1694		2196
1695	The file to use instead of F</etc/resolv.conf> (or OS-specific	2197	The absolute path to a F<resolv.conf>-style file to use instead of
1696	configuration) in the default resolver. When set to the empty string, no	2198	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1697	default config will be used.	2199	resolver, or the empty string to select the default configuration.
1698		2200
1699	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2201	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1700		2202
1701	When neither C<ca_file> nor C<ca_path> was specified during	2203	When neither C<ca_file> nor C<ca_path> was specified during
1702	L<AnyEvent::TLS> context creation, and either of these environment	2204	L<AnyEvent::TLS> context creation, and either of these environment
1703	variables exist, they will be used to specify CA certificate locations	2205	variables are nonempty, they will be used to specify CA certificate
1704	instead of a system-dependent default.	2206	locations instead of a system-dependent default.
1705		2207
1706	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>	2208	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1707		2209
1708	When these are set to C<1>, then the respective modules are not	2210	When these are set to C<1>, then the respective modules are not
1709	loaded. Mostly good for testing AnyEvent itself.	2211	loaded. Mostly good for testing AnyEvent itself.
…		…
1772	warn "read: $input\n"; # output what has been read	2274	warn "read: $input\n"; # output what has been read
1773	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2275	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1774	},	2276	},
1775	);	2277	);
1776		2278
1777	my $time_watcher; # can only be used once
1778
1779	sub new_timer {
1780	$timer = AnyEvent->timer (after => 1, cb => sub {	2279	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1781	warn "timeout\n"; # print 'timeout' about every second	2280	warn "timeout\n"; # print 'timeout' at most every second
1782	&new_timer; # and restart the time
1783	});	2281	});
1784	}
1785
1786	new_timer; # create first timer
1787		2282
1788	$cv->recv; # wait until user enters /^q/i	2283	$cv->recv; # wait until user enters /^q/i
1789		2284
1790	=head1 REAL-WORLD EXAMPLE	2285	=head1 REAL-WORLD EXAMPLE
1791		2286
…		…
1864		2359
1865	The actual code goes further and collects all errors (C<die>s, exceptions)	2360	The actual code goes further and collects all errors (C<die>s, exceptions)
1866	that occurred during request processing. The C<result> method detects	2361	that occurred during request processing. The C<result> method detects
1867	whether an exception as thrown (it is stored inside the $txn object)	2362	whether an exception as thrown (it is stored inside the $txn object)
1868	and just throws the exception, which means connection errors and other	2363	and just throws the exception, which means connection errors and other
1869	problems get reported tot he code that tries to use the result, not in a	2364	problems get reported to the code that tries to use the result, not in a
1870	random callback.	2365	random callback.
1871		2366
1872	All of this enables the following usage styles:	2367	All of this enables the following usage styles:
1873		2368
1874	1. Blocking:	2369	1. Blocking:
…		…
1922	through AnyEvent. The benchmark creates a lot of timers (with a zero	2417	through AnyEvent. The benchmark creates a lot of timers (with a zero
1923	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2418	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1924	which it is), lets them fire exactly once and destroys them again.	2419	which it is), lets them fire exactly once and destroys them again.
1925		2420
1926	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2421	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1927	distribution.	2422	distribution. It uses the L<AE> interface, which makes a real difference
		2423	for the EV and Perl backends only.
1928		2424
1929	=head3 Explanation of the columns	2425	=head3 Explanation of the columns
1930		2426
1931	I<watcher> is the number of event watchers created/destroyed. Since	2427	I<watcher> is the number of event watchers created/destroyed. Since
1932	different event models feature vastly different performances, each event	2428	different event models feature vastly different performances, each event
…		…
1953	watcher.	2449	watcher.
1954		2450
1955	=head3 Results	2451	=head3 Results
1956		2452
1957	name watchers bytes create invoke destroy comment	2453	name watchers bytes create invoke destroy comment
1958	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2454	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1959	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2455	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1960	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2456	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1961	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2457	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1962	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2458	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1963	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2459	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1964	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2460	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1965	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2461	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1966	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2462	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1967	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2463	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1968	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2464	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1969	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2465	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1970		2466
1971	=head3 Discussion	2467	=head3 Discussion
1972		2468
1973	The benchmark does I<not> measure scalability of the event loop very	2469	The benchmark does I<not> measure scalability of the event loop very
1974	well. For example, a select-based event loop (such as the pure perl one)	2470	well. For example, a select-based event loop (such as the pure perl one)
…		…
1986	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2482	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1987	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2483	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1988	cycles with POE.	2484	cycles with POE.
1989		2485
1990	C<EV> is the sole leader regarding speed and memory use, which are both	2486	C<EV> is the sole leader regarding speed and memory use, which are both
1991	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2487	maximal/minimal, respectively. When using the L<AE> API there is zero
		2488	overhead (when going through the AnyEvent API create is about 5-6 times
		2489	slower, with other times being equal, so still uses far less memory than
1992	far less memory than any other event loop and is still faster than Event	2490	any other event loop and is still faster than Event natively).
1993	natively.
1994		2491
1995	The pure perl implementation is hit in a few sweet spots (both the	2492	The pure perl implementation is hit in a few sweet spots (both the
1996	constant timeout and the use of a single fd hit optimisations in the perl	2493	constant timeout and the use of a single fd hit optimisations in the perl
1997	interpreter and the backend itself). Nevertheless this shows that it	2494	interpreter and the backend itself). Nevertheless this shows that it
1998	adds very little overhead in itself. Like any select-based backend its	2495	adds very little overhead in itself. Like any select-based backend its
…		…
2046	(even when used without AnyEvent), but most event loops have acceptable	2543	(even when used without AnyEvent), but most event loops have acceptable
2047	performance with or without AnyEvent.	2544	performance with or without AnyEvent.
2048		2545
2049	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2546	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2050	the actual event loop, only with extremely fast event loops such as EV	2547	the actual event loop, only with extremely fast event loops such as EV
2051	adds AnyEvent significant overhead.	2548	does AnyEvent add significant overhead.
2052		2549
2053	=item * You should avoid POE like the plague if you want performance or	2550	=item * You should avoid POE like the plague if you want performance or
2054	reasonable memory usage.	2551	reasonable memory usage.
2055		2552
2056	=back	2553	=back
…		…
2072	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2569	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2073	(1%) are active. This mirrors the activity of large servers with many	2570	(1%) are active. This mirrors the activity of large servers with many
2074	connections, most of which are idle at any one point in time.	2571	connections, most of which are idle at any one point in time.
2075		2572
2076	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2573	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2077	distribution.	2574	distribution. It uses the L<AE> interface, which makes a real difference
		2575	for the EV and Perl backends only.
2078		2576
2079	=head3 Explanation of the columns	2577	=head3 Explanation of the columns
2080		2578
2081	I<sockets> is the number of sockets, and twice the number of "servers" (as	2579	I<sockets> is the number of sockets, and twice the number of "servers" (as
2082	each server has a read and write socket end).	2580	each server has a read and write socket end).
…		…
2090	a new one that moves the timeout into the future.	2588	a new one that moves the timeout into the future.
2091		2589
2092	=head3 Results	2590	=head3 Results
2093		2591
2094	name sockets create request	2592	name sockets create request
2095	EV 20000 69.01 11.16	2593	EV 20000 62.66 7.99
2096	Perl 20000 73.32 35.87	2594	Perl 20000 68.32 32.64
2097	IOAsync 20000 157.00 98.14 epoll	2595	IOAsync 20000 174.06 101.15 epoll
2098	IOAsync 20000 159.31 616.06 poll	2596	IOAsync 20000 174.67 610.84 poll
2099	Event 20000 212.62 257.32	2597	Event 20000 202.69 242.91
2100	Glib 20000 651.16 1896.30	2598	Glib 20000 557.01 1689.52
2101	POE 20000 349.67 12317.24 uses POE::Loop::Event	2599	POE 20000 341.54 12086.32 uses POE::Loop::Event
2102		2600
2103	=head3 Discussion	2601	=head3 Discussion
2104		2602
2105	This benchmark I<does> measure scalability and overall performance of the	2603	This benchmark I<does> measure scalability and overall performance of the
2106	particular event loop.	2604	particular event loop.
…		…
2232	As you can see, the AnyEvent + EV combination even beats the	2730	As you can see, the AnyEvent + EV combination even beats the
2233	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2731	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2234	backend easily beats IO::Lambda and POE.	2732	backend easily beats IO::Lambda and POE.
2235		2733
2236	And even the 100% non-blocking version written using the high-level (and	2734	And even the 100% non-blocking version written using the high-level (and
2237	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2735	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2238	large margin, even though it does all of DNS, tcp-connect and socket I/O	2736	higher level ("unoptimised") abstractions by a large margin, even though
2239	in a non-blocking way.	2737	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2240		2738
2241	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2739	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2242	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2740	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2243	part of the IO::lambda distribution and were used without any changes.	2741	part of the IO::Lambda distribution and were used without any changes.
2244		2742
2245		2743
2246	=head1 SIGNALS	2744	=head1 SIGNALS
2247		2745
2248	AnyEvent currently installs handlers for these signals:	2746	AnyEvent currently installs handlers for these signals:
…		…
2285	unless defined $SIG{PIPE};	2783	unless defined $SIG{PIPE};
2286		2784
2287	=head1 RECOMMENDED/OPTIONAL MODULES	2785	=head1 RECOMMENDED/OPTIONAL MODULES
2288		2786
2289	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and	2787	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2290	it's built-in modules) are required to use it.	2788	its built-in modules) are required to use it.
2291		2789
2292	That does not mean that AnyEvent won't take advantage of some additional	2790	That does not mean that AnyEvent won't take advantage of some additional
2293	modules if they are installed.	2791	modules if they are installed.
2294		2792
2295	This section epxlains which additional modules will be used, and how they	2793	This section explains which additional modules will be used, and how they
2296	affect AnyEvent's operetion.	2794	affect AnyEvent's operation.
2297		2795
2298	=over 4	2796	=over 4
2299		2797
2300	=item L<Async::Interrupt>	2798	=item L<Async::Interrupt>
2301		2799
…		…
2306	catch the signals) with some delay (default is 10 seconds, look for	2804	catch the signals) with some delay (default is 10 seconds, look for
2307	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2805	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2308		2806
2309	If this module is available, then it will be used to implement signal	2807	If this module is available, then it will be used to implement signal
2310	catching, which means that signals will not be delayed, and the event loop	2808	catching, which means that signals will not be delayed, and the event loop
2311	will not be interrupted regularly, which is more efficient (And good for	2809	will not be interrupted regularly, which is more efficient (and good for
2312	battery life on laptops).	2810	battery life on laptops).
2313		2811
2314	This affects not just the pure-perl event loop, but also other event loops	2812	This affects not just the pure-perl event loop, but also other event loops
2315	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2813	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2316		2814
…		…
2328	automatic timer adjustments even when no monotonic clock is available,	2826	automatic timer adjustments even when no monotonic clock is available,
2329	can take avdantage of advanced kernel interfaces such as C<epoll> and	2827	can take avdantage of advanced kernel interfaces such as C<epoll> and
2330	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2828	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2331	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2829	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2332		2830
		2831	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2832	then this module will do nothing for you.
		2833
2333	=item L<Guard>	2834	=item L<Guard>
2334		2835
2335	The guard module, when used, will be used to implement	2836	The guard module, when used, will be used to implement
2336	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2837	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2337	lot less memory), but otherwise doesn't affect guard operation much. It is	2838	lot less memory), but otherwise doesn't affect guard operation much. It is
2338	purely used for performance.	2839	purely used for performance.
2339		2840
2340	=item L<JSON> and L<JSON::XS>	2841	=item L<JSON> and L<JSON::XS>
2341		2842
2342	This module is required when you want to read or write JSON data via	2843	One of these modules is required when you want to read or write JSON data
2343	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2844	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2344	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2845	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2345
2346	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2347	installed.
2348		2846
2349	=item L<Net::SSLeay>	2847	=item L<Net::SSLeay>
2350		2848
2351	Implementing TLS/SSL in Perl is certainly interesting, but not very	2849	Implementing TLS/SSL in Perl is certainly interesting, but not very
2352	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2850	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2353	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.	2851	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2354		2852
2355	=item L<Time::HiRes>	2853	=item L<Time::HiRes>
2356		2854
2357	This module is part of perl since release 5.008. It will be used when the	2855	This module is part of perl since release 5.008. It will be used when the
2358	chosen event library does not come with a timing source on it's own. The	2856	chosen event library does not come with a timing source of its own. The
2359	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to	2857	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2360	try to use a monotonic clock for timing stability.	2858	try to use a monotonic clock for timing stability.
2361		2859
2362	=back	2860	=back
2363		2861
2364		2862
2365	=head1 FORK	2863	=head1 FORK
2366		2864
2367	Most event libraries are not fork-safe. The ones who are usually are	2865	Most event libraries are not fork-safe. The ones who are usually are
2368	because they rely on inefficient but fork-safe C<select> or C<poll>	2866	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2369	calls. Only L<EV> is fully fork-aware.	2867	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2868	are usually badly thought-out hacks that are incompatible with fork in
		2869	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2870	continue event-processing in both parent and child (or both, if you know
		2871	what you are doing).
		2872
		2873	This means that, in general, you cannot fork and do event processing in
		2874	the child if the event library was initialised before the fork (which
		2875	usually happens when the first AnyEvent watcher is created, or the library
		2876	is loaded).
2370		2877
2371	If you have to fork, you must either do so I<before> creating your first	2878	If you have to fork, you must either do so I<before> creating your first
2372	watcher OR you must not use AnyEvent at all in the child OR you must do	2879	watcher OR you must not use AnyEvent at all in the child OR you must do
2373	something completely out of the scope of AnyEvent.	2880	something completely out of the scope of AnyEvent.
		2881
		2882	The problem of doing event processing in the parent I<and> the child
		2883	is much more complicated: even for backends that I<are> fork-aware or
		2884	fork-safe, their behaviour is not usually what you want: fork clones all
		2885	watchers, that means all timers, I/O watchers etc. are active in both
		2886	parent and child, which is almost never what you want. USing C<exec>
		2887	to start worker children from some kind of manage rprocess is usually
		2888	preferred, because it is much easier and cleaner, at the expense of having
		2889	to have another binary.
2374		2890
2375		2891
2376	=head1 SECURITY CONSIDERATIONS	2892	=head1 SECURITY CONSIDERATIONS
2377		2893
2378	AnyEvent can be forced to load any event model via	2894	AnyEvent can be forced to load any event model via
…		…
2408	pronounced).	2924	pronounced).
2409		2925
2410		2926
2411	=head1 SEE ALSO	2927	=head1 SEE ALSO
2412		2928
2413	Utility functions: L<AnyEvent::Util>.	2929	Tutorial/Introduction: L<AnyEvent::Intro>.
2414		2930
2415	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2931	FAQ: L<AnyEvent::FAQ>.
2416	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2932
		2933	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2934	(simply logging).
		2935
		2936	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2937	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2938
		2939	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2940	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2941	L<Qt>, L<POE>, L<FLTK>.
2417		2942
2418	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2943	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2419	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2944	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2420	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2945	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2421	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2946	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
		2947	L<AnyEvent::Impl::FLTK>.
2422		2948
2423	Non-blocking file handles, sockets, TCP clients and	2949	Non-blocking handles, pipes, stream sockets, TCP clients and
2424	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2950	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2425		2951
2426	Asynchronous DNS: L<AnyEvent::DNS>.	2952	Asynchronous DNS: L<AnyEvent::DNS>.
2427		2953
2428	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,	2954	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2429	L<Coro::Event>,
2430		2955
2431	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,	2956	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2432	L<AnyEvent::HTTP>.	2957	L<AnyEvent::HTTP>.
2433		2958
2434		2959
2435	=head1 AUTHOR	2960	=head1 AUTHOR
2436		2961

Diff Legend

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