ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.247 by root, Sat Jul 18 22:24:17 2009 UTC vs.
Revision 1.380 by root, Thu Sep 1 04:07:18 2011 UTC

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

Diff Legend

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