ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.228 by root, Wed Jul 8 01:11:12 2009 UTC vs.
Revision 1.386 by root, Mon Sep 26 11:32:19 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	});
…		…
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
177		189
		190	$w = AnyEvent->io (
		191	fh => <filehandle_or_fileno>,
		192	poll => <"r" or "w">,
		193	cb => <callback>,
		194	);
		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> (I<not> file descriptor, see below) to	199	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182	watch for events (AnyEvent might or might not keep a reference to this	200	for events (AnyEvent might or might not keep a reference to this file
183	file handle). Note that only file handles pointing to things for which	201	handle). Note that only file handles pointing to things for which
184	non-blocking operation makes sense are allowed. This includes sockets,	202	non-blocking operation makes sense are allowed. This includes sockets,
185	most character devices, pipes, fifos and so on, but not for example files	203	most character devices, pipes, fifos and so on, but not for example files
186	or block devices.	204	or block devices.
187		205
188	C<poll> must be a string that is either C<r> or C<w>, which creates a	206	C<poll> must be a string that is either C<r> or C<w>, which creates a
…		…
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.
…		…
209	chomp (my $input = <STDIN>);	227	chomp (my $input = <STDIN>);
210	warn "read: $input\n";	228	warn "read: $input\n";
211	undef $w;	229	undef $w;
212	});	230	});
213		231
214	=head3 GETTING A FILE HANDLE FROM A FILE DESCRIPTOR
215
216	It is not uncommon to only have a file descriptor, while AnyEvent requires
217	a Perl file handle.
218
219	There are basically two methods to convert a file descriptor into a file handle. If you own
220	the file descriptor, you can open it with C<&=>, as in:
221
222	open my $fh, "<&=$fileno" or die "xxx: §!";
223
224	This will "own" the file descriptor, meaning that when C<$fh> is
225	destroyed, it will automatically close the C<$fileno>. Also, note that
226	the open mode (read, write, read/write) must correspond with how the
227	underlying file descriptor was opened.
228
229	In many cases, taking over the file descriptor is now what you want, in
230	which case the only alternative is to dup the file descriptor:
231
232	open my $fh, "<&$fileno" or die "xxx: $!";
233
234	This has the advantage of not closing the file descriptor and the
235	disadvantage of making a slow copy.
236
237	=head2 TIME WATCHERS	232	=head2 TIME WATCHERS
		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	);
238		241
239	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 >>
240	method with the following mandatory arguments:	243	method with the following mandatory arguments:
241		244
242	C<after> specifies after how many seconds (fractional values are	245	C<after> specifies after how many seconds (fractional values are
…		…
245		248
246	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
247	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
248	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
249		252
250	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
251	parameter, C<interval>, as a strictly positive number (> 0), then the	254	parameter, C<interval>, as a strictly positive number (> 0), then the
252	callback will be invoked regularly at that interval (in fractional	255	callback will be invoked regularly at that interval (in fractional
253	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
254	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.
255		258
256	The callback will be rescheduled before invoking the callback, but no	259	The callback will be rescheduled before invoking the callback, but no
257	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
258	only approximate.	261	only approximate.
259		262
260	Example: fire an event after 7.7 seconds.	263	Example: fire an event after 7.7 seconds.
261		264
262	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
280		283
281	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
282	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
283	"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
284	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
285	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.
286		289
287	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
288	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
289	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)
290	timers.	293	timers.
291		294
292	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
293	AnyEvent API.	296	AnyEvent API.
…		…
315	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
316	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
317		320
318	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
319	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
320	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
321		324
322	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
323	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
324		327
325	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>
326	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
327		330
328	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
329	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
330	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
331	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
332	after three seconds.	335	after three seconds.
333		336
…		…
353	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
354	account.	357	account.
355		358
356	=item AnyEvent->now_update	359	=item AnyEvent->now_update
357		360
358	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
359	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 >>,
360	AnyEvent->now >>, above).	363	above).
361		364
362	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
363	this "current" time will differ substantially from the real time, which	366	this "current" time will differ substantially from the real time, which
364	might affect timers and time-outs.	367	might affect timers and time-outs.
365		368
366	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
367	event loop's idea of "current time".	370	event loop's idea of "current time".
368		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
369	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.
370		380
371	=back	381	=back
372		382
373	=head2 SIGNAL WATCHERS	383	=head2 SIGNAL WATCHERS
		384
		385	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
374		386
375	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
376	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
377	callback to be invoked whenever a signal occurs.	389	callback to be invoked whenever a signal occurs.
378		390
…		…
384	invocation, and callback invocation will be synchronous. Synchronous means	396	invocation, and callback invocation will be synchronous. Synchronous means
385	that it might take a while until the signal gets handled by the process,	397	that it might take a while until the signal gets handled by the process,
386	but it is guaranteed not to interrupt any other callbacks.	398	but it is guaranteed not to interrupt any other callbacks.
387		399
388	The main advantage of using these watchers is that you can share a signal	400	The main advantage of using these watchers is that you can share a signal
389	between multiple watchers.	401	between multiple watchers, and AnyEvent will ensure that signals will not
		402	interrupt your program at bad times.
390		403
391	This watcher might use C<%SIG>, so programs overwriting those signals	404	This watcher might use C<%SIG> (depending on the event loop used),
392	directly will likely not work correctly.	405	so programs overwriting those signals directly will likely not work
		406	correctly.
393		407
394	Example: exit on SIGINT	408	Example: exit on SIGINT
395		409
396	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	410	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
397		411
		412	=head3 Restart Behaviour
		413
		414	While restart behaviour is up to the event loop implementation, most will
		415	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		416	pure perl implementation).
		417
		418	=head3 Safe/Unsafe Signals
		419
		420	Perl signals can be either "safe" (synchronous to opcode handling) or
		421	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		422	latter might corrupt your memory.
		423
		424	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		425	i.e. they will not interrupt your running perl program but will only be
		426	called as part of the normal event handling (just like timer, I/O etc.
		427	callbacks, too).
		428
		429	=head3 Signal Races, Delays and Workarounds
		430
		431	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		432	callbacks to signals in a generic way, which is a pity, as you cannot
		433	do race-free signal handling in perl, requiring C libraries for
		434	this. AnyEvent will try to do its best, which means in some cases,
		435	signals will be delayed. The maximum time a signal might be delayed is
		436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
		437	variable can be changed only before the first signal watcher is created,
		438	and should be left alone otherwise. This variable determines how often
		439	AnyEvent polls for signals (in case a wake-up was missed). Higher values
		440	will cause fewer spurious wake-ups, which is better for power and CPU
		441	saving.
		442
		443	All these problems can be avoided by installing the optional
		444	L<Async::Interrupt> module, which works with most event loops. It will not
		445	work with inherently broken event loops such as L<Event> or L<Event::Lib>
		446	(and not with L<POE> currently, as POE does its own workaround with
		447	one-second latency). For those, you just have to suffer the delays.
		448
398	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
399		450
		451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		452
400	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.
401		454
402	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,
403	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
404	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
405	any trace events (stopped/continued).	458	finished and an exit status is available, not on any trace events
		459	(stopped/continued).
406		460
407	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
408	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
409	callback arguments.	463	callback arguments.
410		464
…		…
426		480
427	This means you cannot create a child watcher as the very first	481	This means you cannot create a child watcher as the very first
428	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
429	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
430	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
		485
		486	As most event loops do not support waiting for child events, they will be
		487	emulated by AnyEvent in most cases, in which case the latency and race
		488	problems mentioned in the description of signal watchers apply.
431		489
432	Example: fork a process and wait for it	490	Example: fork a process and wait for it
433		491
434	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
435		493
…		…
447	# do something else, then wait for process exit	505	# do something else, then wait for process exit
448	$done->recv;	506	$done->recv;
449		507
450	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
451		509
452	Sometimes there is a need to do something, but it is not so important	510	$w = AnyEvent->idle (cb => <callback>);
453	to do it instantly, but only when there is nothing better to do. This
454	"nothing better to do" is usually defined to be "no other events need
455	attention by the event loop".
456		511
457	Idle watchers ideally get invoked when the event loop has nothing	512	This will repeatedly invoke the callback after the process becomes idle,
458	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.
459	events. Instead of blocking, the idle watcher is invoked.
460		514
461	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
462	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
463	will simply call the callback "from time to time".	526	will simply call the callback "from time to time".
464		527
465	Example: read lines from STDIN, but only process them when the	528	Example: read lines from STDIN, but only process them when the
466	program is otherwise idle:	529	program is otherwise idle:
…		…
482	});	545	});
483	});	546	});
484		547
485	=head2 CONDITION VARIABLES	548	=head2 CONDITION VARIABLES
486		549
		550	$cv = AnyEvent->condvar;
		551
		552	$cv->send (<list>);
		553	my @res = $cv->recv;
		554
487	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
488	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
489	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
490		558
491	AnyEvent is different, it expects somebody else to run the event loop and	559	AnyEvent is slightly different: it expects somebody else to run the event
492	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).
493		561
494	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
495	because they represent a condition that must become true.	563	they represent a condition that must become true.
		564
		565	Now is probably a good time to look at the examples further below.
496		566
497	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
498	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
499
500	C<cb>, which specifies a callback to be called when the condition variable	569	C<cb>, which specifies a callback to be called when the condition variable
501	becomes true, with the condition variable as the first argument (but not	570	becomes true, with the condition variable as the first argument (but not
502	the results).	571	the results).
503		572
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	647	Example: wait for a timer, but take advantage of the fact that condition
562	condition variables are also code references.	648	variables are also callable directly.
563		649
564	my $done = AnyEvent->condvar;	650	my $done = AnyEvent->condvar;
565	my $delay = AnyEvent->timer (after => 5, cb => $done);	651	my $delay = AnyEvent->timer (after => 5, cb => $done);
566	$done->recv;	652	$done->recv;
567		653
…		…
573		659
574	...	660	...
575		661
576	my @info = $couchdb->info->recv;	662	my @info = $couchdb->info->recv;
577		663
578	And this is how you would just ste a callback to be called whenever the	664	And this is how you would just set a callback to be called whenever the
579	results are available:	665	results are available:
580		666
581	$couchdb->info->cb (sub {	667	$couchdb->info->cb (sub {
582	my @info = $_[0]->recv;	668	my @info = $_[0]->recv;
583	});	669	});
…		…
601	immediately from within send.	687	immediately from within send.
602		688
603	Any arguments passed to the C<send> call will be returned by all	689	Any arguments passed to the C<send> call will be returned by all
604	future C<< ->recv >> calls.	690	future C<< ->recv >> calls.
605		691
606	Condition variables are overloaded so one can call them directly	692	Condition variables are overloaded so one can call them directly (as if
607	(as a code reference). Calling them directly is the same as calling	693	they were a code reference). Calling them directly is the same as calling
608	C<send>. Note, however, that many C-based event loops do not handle	694	C<send>.
609	overloading, so as tempting as it may be, passing a condition variable
610	instead of a callback does not work. Both the pure perl and EV loops
611	support overloading, however, as well as all functions that use perl to
612	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
613	example).
614		695
615	=item $cv->croak ($error)	696	=item $cv->croak ($error)
616		697
617	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
618	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
619		700
620	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
621	user/consumer.	702	user/consumer. Doing it this way instead of calling C<croak> directly
		703	delays the error detection, but has the overwhelming advantage that it
		704	diagnoses the error at the place where the result is expected, and not
		705	deep in some event callback with no connection to the actual code causing
		706	the problem.
622		707
623	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
624		709
625	=item $cv->end	710	=item $cv->end
626		711
…		…
628	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
629	to use a condition variable for the whole process.	714	to use a condition variable for the whole process.
630		715
631	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
632	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
633	>>, 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
634	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
635	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.
636		722
637	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
638	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
639	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).
640		726
…		…
662	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
663	sending.	749	sending.
664		750
665	The ping example mentioned above is slightly more complicated, as the	751	The ping example mentioned above is slightly more complicated, as the
666	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
667	begung can potentially be zero:	753	begun can potentially be zero:
668		754
669	my $cv = AnyEvent->condvar;	755	my $cv = AnyEvent->condvar;
670		756
671	my %result;	757	my %result;
672	$cv->begin (sub { $cv->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
673		759
674	for my $host (@list_of_hosts) {	760	for my $host (@list_of_hosts) {
675	$cv->begin;	761	$cv->begin;
676	ping_host_then_call_callback $host, sub {	762	ping_host_then_call_callback $host, sub {
677	$result{$host} = ...;	763	$result{$host} = ...;
…		…
693	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
694	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
695	doesn't execute once).	781	doesn't execute once).
696		782
697	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
698	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
699	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
700	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,
701	call C<end>.	787	call C<end>.
702		788
703	=back	789	=back
…		…
710	=over 4	796	=over 4
711		797
712	=item $cv->recv	798	=item $cv->recv
713		799
714	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
715	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
716	normally.	802	normally.
717		803
718	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
719	will return immediately.	805	will return immediately.
720		806
…		…
722	function will call C<croak>.	808	function will call C<croak>.
723		809
724	In list context, all parameters passed to C<send> will be returned,	810	In list context, all parameters passed to C<send> will be returned,
725	in scalar context only the first one will be returned.	811	in scalar context only the first one will be returned.
726		812
		813	Note that doing a blocking wait in a callback is not supported by any
		814	event loop, that is, recursive invocation of a blocking C<< ->recv
		815	>> is not allowed, and the C<recv> call will C<croak> if such a
		816	condition is detected. This condition can be slightly loosened by using
		817	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		818	any thread that doesn't run the event loop itself.
		819
727	Not all event models support a blocking wait - some die in that case	820	Not all event models support a blocking wait - some die in that case
728	(programs might want to do that to stay interactive), so I<if you are	821	(programs might want to do that to stay interactive), so I<if you are
729	using this from a module, never require a blocking wait>, but let the	822	using this from a module, never require a blocking wait>. Instead, let the
730	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
731	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
732	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,
733	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
734		827
735	Another reason I<never> to C<< ->recv >> in a module is that you cannot
736	sensibly have two C<< ->recv >>'s in parallel, as that would require
737	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
738	can supply.
739
740	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
741	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
742	versions and also integrates coroutines into AnyEvent, making blocking
743	C<< ->recv >> calls perfectly safe as long as they are done from another
744	coroutine (one that doesn't run the event loop).
745
746	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
747	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
748	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
749	waits otherwise.	831	waits otherwise.
750		832
751	=item $bool = $cv->ready	833	=item $bool = $cv->ready
…		…
757		839
758	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
759	replaces it before doing so.	841	replaces it before doing so.
760		842
761	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
762	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
763	variable itself. Calling C<recv> inside the callback or at any later time	845	condition variable itself. If the condition is already true, the
764	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.
765		848
766	=back	849	=back
767		850
		851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		852
		853	The available backend classes are (every class has its own manpage):
		854
		855	=over 4
		856
		857	=item Backends that are autoprobed when no other event loop can be found.
		858
		859	EV is the preferred backend when no other event loop seems to be in
		860	use. If EV is not installed, then AnyEvent will fall back to its own
		861	pure-perl implementation, which is available everywhere as it comes with
		862	AnyEvent itself.
		863
		864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
		866
		867	=item Backends that are transparently being picked up when they are used.
		868
		869	These will be used if they are already loaded when the first watcher
		870	is created, in which case it is assumed that the application is using
		871	them. This means that AnyEvent will automatically pick the right backend
		872	when the main program loads an event module before anything starts to
		873	create watchers. Nothing special needs to be done by the main program.
		874
		875	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		877	AnyEvent::Impl::Tk based on Tk, very broken.
		878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		880	AnyEvent::Impl::Irssi used when running within irssi.
		881	AnyEvent::Impl::IOAsync based on IO::Async.
		882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		883	AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
		884
		885	=item Backends with special needs.
		886
		887	Qt requires the Qt::Application to be instantiated first, but will
		888	otherwise be picked up automatically. As long as the main program
		889	instantiates the application before any AnyEvent watchers are created,
		890	everything should just work.
		891
		892	AnyEvent::Impl::Qt based on Qt.
		893
		894	=item Event loops that are indirectly supported via other backends.
		895
		896	Some event loops can be supported via other modules:
		897
		898	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		899
		900	B<WxWidgets> has no support for watching file handles. However, you can
		901	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		902	polls 20 times per second, which was considered to be too horrible to even
		903	consider for AnyEvent.
		904
		905	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		906	backend, so it can be supported through POE.
		907
		908	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		909	load L<POE> when detecting them, in the hope that POE will pick them up,
		910	in which case everything will be automatic.
		911
		912	=back
		913
768	=head1 GLOBAL VARIABLES AND FUNCTIONS	914	=head1 GLOBAL VARIABLES AND FUNCTIONS
769		915
		916	These are not normally required to use AnyEvent, but can be useful to
		917	write AnyEvent extension modules.
		918
770	=over 4	919	=over 4
771		920
772	=item $AnyEvent::MODEL	921	=item $AnyEvent::MODEL
773		922
774	Contains C<undef> until the first watcher is being created. Then it	923	Contains C<undef> until the first watcher is being created, before the
		924	backend has been autodetected.
		925
775	contains the event model that is being used, which is the name of the	926	Afterwards it contains the event model that is being used, which is the
776	Perl class implementing the model. This class is usually one of the	927	name of the Perl class implementing the model. This class is usually one
777	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	928	of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
778	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	929	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
779		930	will be C<urxvt::anyevent>).
780	The known classes so far are:
781
782	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
783	AnyEvent::Impl::Event based on Event, second best choice.
784	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
785	AnyEvent::Impl::Glib based on Glib, third-best choice.
786	AnyEvent::Impl::Tk based on Tk, very bad choice.
787	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
788	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
789	AnyEvent::Impl::POE based on POE, not generic enough for full support.
790
791	# warning, support for IO::Async is only partial, as it is too broken
792	# and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
793	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
794
795	There is no support for WxWidgets, as WxWidgets has no support for
796	watching file handles. However, you can use WxWidgets through the
797	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
798	second, which was considered to be too horrible to even consider for
799	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
800	it's adaptor.
801
802	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
803	autodetecting them.
804		931
805	=item AnyEvent::detect	932	=item AnyEvent::detect
806		933
807	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
808	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
809	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
810	runtime.	937	runtime, and not e.g. during initialisation of your module.
		938
		939	The effect of calling this function is as if a watcher had been created
		940	(specifically, actions that happen "when the first watcher is created"
		941	happen when calling detetc as well).
		942
		943	If you need to do some initialisation before AnyEvent watchers are
		944	created, use C<post_detect>.
811		945
812	=item $guard = AnyEvent::post_detect { BLOCK }	946	=item $guard = AnyEvent::post_detect { BLOCK }
813		947
814	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
815	autodetected (or immediately if this has already happened).	949	autodetected (or immediately if that has already happened).
		950
		951	The block will be executed I<after> the actual backend has been detected
		952	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		953	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		954	other initialisations - see the sources of L<AnyEvent::Strict> or
		955	L<AnyEvent::AIO> to see how this is used.
		956
		957	The most common usage is to create some global watchers, without forcing
		958	event module detection too early, for example, L<AnyEvent::AIO> creates
		959	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		960	avoid autodetecting the event module at load time.
816		961
817	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
818	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
819	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;
820		982
821	=item @AnyEvent::post_detect	983	=item @AnyEvent::post_detect
822		984
823	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
824	before or after loading AnyEvent), then they will called directly after	986	before or after loading AnyEvent), then they will be called directly
825	the event loop has been chosen.	987	after the event loop has been chosen.
826		988
827	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:
828	if it contains a true value then the event loop has already been detected,	990	if it is defined then the event loop has already been detected, and the
829	and the array will be ignored.	991	array will be ignored.
830		992
831	Best use C<AnyEvent::post_detect { BLOCK }> instead.	993	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		994	it, as it takes care of these details.
		995
		996	This variable is mainly useful for modules that can do something useful
		997	when AnyEvent is used and thus want to know when it is initialised, but do
		998	not need to even load it by default. This array provides the means to hook
		999	into AnyEvent passively, without loading it.
		1000
		1001	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1002	together, you could put this into Coro (this is the actual code used by
		1003	Coro to accomplish this):
		1004
		1005	if (defined $AnyEvent::MODEL) {
		1006	# AnyEvent already initialised, so load Coro::AnyEvent
		1007	require Coro::AnyEvent;
		1008	} else {
		1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1010	# as soon as it is
		1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1012	}
		1013
		1014	=item AnyEvent::postpone { BLOCK }
		1015
		1016	Arranges for the block to be executed as soon as possible, but not before
		1017	the call itself returns. In practise, the block will be executed just
		1018	before the event loop polls for new events, or shortly afterwards.
		1019
		1020	This function never returns anything (to make the C<return postpone { ...
		1021	}> idiom more useful.
		1022
		1023	To understand the usefulness of this function, consider a function that
		1024	asynchronously does something for you and returns some transaction
		1025	object or guard to let you cancel the operation. For example,
		1026	C<AnyEvent::Socket::tcp_connect>:
		1027
		1028	# start a conenction attempt unless one is active
		1029	$self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1030	delete $self->{connect_guard};
		1031	...
		1032	};
		1033
		1034	Imagine that this function could instantly call the callback, for
		1035	example, because it detects an obvious error such as a negative port
		1036	number. Invoking the callback before the function returns causes problems
		1037	however: the callback will be called and will try to delete the guard
		1038	object. But since the function hasn't returned yet, there is nothing to
		1039	delete. When the function eventually returns it will assign the guard
		1040	object to C<< $self->{connect_guard} >>, where it will likely never be
		1041	deleted, so the program thinks it is still trying to connect.
		1042
		1043	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1044	callback directly on error:
		1045
		1046	$cb->(undef), return # signal error to callback, BAD!
		1047	if $some_error_condition;
		1048
		1049	It should use C<postpone>:
		1050
		1051	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1052	if $some_error_condition;
		1053
		1054	=item AnyEvent::log $level, $msg[, @args]
		1055
		1056	Log the given C<$msg> at the given C<$level>.
		1057
		1058	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.
832		1071
833	=back	1072	=back
834		1073
835	=head1 WHAT TO DO IN A MODULE	1074	=head1 WHAT TO DO IN A MODULE
836		1075
…		…
847	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
848	events is to stay interactive.	1087	events is to stay interactive.
849		1088
850	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
851	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
852	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 >>
853	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).
854		1093
855	=head1 WHAT TO DO IN THE MAIN PROGRAM	1094	=head1 WHAT TO DO IN THE MAIN PROGRAM
856		1095
857	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
858	dictate which event model to use.	1097	dictate which event model to use.
859		1098
860	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
861	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
862	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.
863		1104
864	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
865	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
866	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
867	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
868	modules might create watchers when they are loaded, and AnyEvent will	1109	modules might create watchers when they are loaded, and AnyEvent will
869	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
870	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.
871		1112
872	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
873	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1114	C<AnyEvent::Loop> module, which gives you similar behaviour
874	everywhere, but letting AnyEvent chose the model is generally better.	1115	everywhere, but letting AnyEvent chose the model is generally better.
875		1116
876	=head2 MAINLOOP EMULATION	1117	=head2 MAINLOOP EMULATION
877		1118
878	Sometimes (often for short test scripts, or even standalone programs who	1119	Sometimes (often for short test scripts, or even standalone programs who
…		…
891		1132
892		1133
893	=head1 OTHER MODULES	1134	=head1 OTHER MODULES
894		1135
895	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
896	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1137	AnyEvent as a client and can therefore be mixed easily with other
897	in the same program. Some of the modules come with AnyEvent, some are	1138	AnyEvent modules and other event loops in the same program. Some of the
898	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 :)
899		1143
900	=over 4	1144	=over 4
901		1145
902	=item L<AnyEvent::Util>	1146	=item L<AnyEvent::Util>
903		1147
904	Contains various utility functions that replace often-used but blocking	1148	Contains various utility functions that replace often-used blocking
905	functions such as C<inet_aton> by event-/callback-based versions.	1149	functions such as C<inet_aton> with event/callback-based versions.
906		1150
907	=item L<AnyEvent::Socket>	1151	=item L<AnyEvent::Socket>
908		1152
909	Provides various utility functions for (internet protocol) sockets,	1153	Provides various utility functions for (internet protocol) sockets,
910	addresses and name resolution. Also functions to create non-blocking tcp	1154	addresses and name resolution. Also functions to create non-blocking tcp
…		…
912		1156
913	=item L<AnyEvent::Handle>	1157	=item L<AnyEvent::Handle>
914		1158
915	Provide read and write buffers, manages watchers for reads and writes,	1159	Provide read and write buffers, manages watchers for reads and writes,
916	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
917	non-blocking SSL/TLS.	1161	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
918		1162
919	=item L<AnyEvent::DNS>	1163	=item L<AnyEvent::DNS>
920		1164
921	Provides rich asynchronous DNS resolver capabilities.	1165	Provides rich asynchronous DNS resolver capabilities.
922		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
923	=item L<AnyEvent::HTTP>	1173	=item L<AnyEvent::AIO>
924		1174
925	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
926	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.
927		1197
928	=item L<AnyEvent::HTTPD>	1198	=item L<AnyEvent::HTTPD>
929		1199
930	Provides a simple web application server framework.	1200	A simple embedded webserver.
931		1201
932	=item L<AnyEvent::FastPing>	1202	=item L<AnyEvent::FastPing>
933		1203
934	The fastest ping in the west.	1204	The fastest ping in the west.
935		1205
936	=item L<AnyEvent::DBI>
937
938	Executes L<DBI> requests asynchronously in a proxy process.
939
940	=item L<AnyEvent::AIO>
941
942	Truly asynchronous I/O, should be in the toolbox of every event
943	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
944	together.
945
946	=item L<AnyEvent::BDB>
947
948	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
949	L<BDB> and AnyEvent together.
950
951	=item L<AnyEvent::GPSD>
952
953	A non-blocking interface to gpsd, a daemon delivering GPS information.
954
955	=item L<AnyEvent::IGS>
956
957	A non-blocking interface to the Internet Go Server protocol (used by
958	L<App::IGS>).
959
960	=item L<AnyEvent::IRC>
961
962	AnyEvent based IRC client module family (replacing the older Net::IRC3).
963
964	=item L<Net::XMPP2>
965
966	AnyEvent based XMPP (Jabber protocol) module family.
967
968	=item L<Net::FCP>
969
970	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
971	of AnyEvent.
972
973	=item L<Event::ExecFlow>
974
975	High level API for event-based execution flow control.
976
977	=item L<Coro>	1206	=item L<Coro>
978		1207
979	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:
980		1210
981	=item L<IO::Lambda>	1211	async {
		1212	Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
		1213	print "5 seconds later!\n";
982		1214
983	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.	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	};
984		1221
985	=back	1222	=back
986		1223
987	=cut	1224	=cut
988		1225
989	package AnyEvent;	1226	package AnyEvent;
990		1227
991	no warnings;	1228	# basically a tuned-down version of common::sense
992	use strict qw(vars subs);	1229	sub common_sense {
		1230	# from common:.sense 3.4
		1231	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
		1232	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
		1233	$^H |= 0x00000600;
		1234	}
993		1235
		1236	BEGIN { AnyEvent::common_sense }
		1237
994	use Carp;	1238	use Carp ();
995		1239
996	our $VERSION = 4.8;	1240	our $VERSION = '6.02';
997	our $MODEL;	1241	our $MODEL;
998
999	our $AUTOLOAD;
1000	our @ISA;	1242	our @ISA;
1001
1002	our @REGISTRY;	1243	our @REGISTRY;
1003		1244	our $VERBOSE;
1004	our $WIN32;	1245	our $MAX_SIGNAL_LATENCY = 10;
		1246	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1005		1247
1006	BEGIN {	1248	BEGIN {
1007	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1249	require "AnyEvent/constants.pl";
		1250
1008	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1251	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1009		1252
1010	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1253	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1011	if ${^TAINT};	1254	if ${^TAINT};
1012	}
1013		1255
1014	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1256	$ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
		1257	for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1015		1258
1016	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1259	@ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
		1260	if ${^TAINT};
1017		1261
1018	{	1262	# $ENV{PERL_ANYEVENT_xxx} now valid
		1263
		1264	$VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
		1265
1019	my $idx;	1266	my $idx;
1020	$PROTOCOL{$_} = ++$idx	1267	$PROTOCOL{$_} = ++$idx
1021	for reverse split /\s*,\s*/,	1268	for reverse split /\s*,\s*/,
1022	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1269	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1023	}	1270	}
1024		1271
		1272	our @post_detect;
		1273
		1274	sub post_detect(&) {
		1275	my ($cb) = @_;
		1276
		1277	push @post_detect, $cb;
		1278
		1279	defined wantarray
		1280	? bless \$cb, "AnyEvent::Util::postdetect"
		1281	: ()
		1282	}
		1283
		1284	sub AnyEvent::Util::postdetect::DESTROY {
		1285	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1286	}
		1287
		1288	our $POSTPONE_W;
		1289	our @POSTPONE;
		1290
		1291	sub _postpone_exec {
		1292	undef $POSTPONE_W;
		1293
		1294	&{ shift @POSTPONE }
		1295	while @POSTPONE;
		1296	}
		1297
		1298	sub postpone(&) {
		1299	push @POSTPONE, shift;
		1300
		1301	$POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
		1302
		1303	()
		1304	}
		1305
		1306	sub log($$;@) {
		1307	# only load the big bloated module when we actually are about to log something
		1308	if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
		1309	require AnyEvent::Log; # among other things, sets $VERBOSE to 9
		1310	# AnyEvent::Log overwrites this function
		1311	goto &log;
		1312	}
		1313
		1314	0 # not logged
		1315	}
		1316
		1317	sub logger($;$) {
		1318	package AnyEvent::Log;
		1319
		1320	my ($level, $renabled) = @_;
		1321
		1322	$$renabled = $level <= $VERBOSE;
		1323
		1324	my $pkg = (caller)[0];
		1325
		1326	my $logger = [$pkg, $level, $renabled];
		1327
		1328	our %LOGGER;
		1329	$LOGGER{$logger+0} = $logger;
		1330
		1331	require AnyEvent::Util;
		1332	my $guard = AnyEvent::Util::guard (sub {
		1333	# "clean up"
		1334	delete $LOGGER{$logger+0};
		1335	});
		1336
		1337	sub {
		1338	return 0 unless $$renabled;
		1339
		1340	$guard if 0; # keep guard alive, but don't cause runtime overhead
		1341	require AnyEvent::Log unless $AnyEvent::Log::VERSION;
		1342	package AnyEvent::Log;
		1343	_log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
		1344	}
		1345	}
		1346
		1347	if (length $ENV{PERL_ANYEVENT_LOG}) {
		1348	require AnyEvent::Log; # AnyEvent::Log does the thing for us
		1349	}
		1350
1025	my @models = (	1351	our @models = (
1026	[EV:: => AnyEvent::Impl::EV::],	1352	[EV:: => AnyEvent::Impl::EV::],
1027	[Event:: => AnyEvent::Impl::Event::],
1028	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1353	[AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1029	# everything below here will not be autoprobed	1354	# everything below here will not (normally) be autoprobed
1030	# as the pureperl backend should work everywhere	1355	# as the pure perl backend should work everywhere
1031	# and is usually faster	1356	# and is usually faster
		1357	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
		1358	[Event:: => AnyEvent::Impl::Event::], # slow, stable
		1359	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
		1360	# everything below here should not be autoloaded
		1361	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1032	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1362	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1033	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1034	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1035	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1363	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1036	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1364	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1037	[Wx:: => AnyEvent::Impl::POE::],	1365	[Wx:: => AnyEvent::Impl::POE::],
1038	[Prima:: => AnyEvent::Impl::POE::],	1366	[Prima:: => AnyEvent::Impl::POE::],
1039	# IO::Async is just too broken - we would need workaorunds for its	1367	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1040	# byzantine signal and broken child handling, among others.	1368	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1041	# IO::Async is rather hard to detect, as it doesn't have any	1369	[FLTK:: => AnyEvent::Impl::FLTK::],
1042	# obvious default class.
1043	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1044	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1045	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1046	);	1370	);
1047		1371
1048	our %method = map +($_ => 1),	1372	our @isa_hook;
		1373
		1374	sub _isa_set {
		1375	my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
		1376
		1377	@{"$pkg[$_-1]::ISA"} = $pkg[$_]
		1378	for 1 .. $#pkg;
		1379
		1380	grep $_ && $_->[1], @isa_hook
		1381	and AE::_reset ();
		1382	}
		1383
		1384	# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
		1385	sub _isa_hook($$;$) {
		1386	my ($i, $pkg, $reset_ae) = @_;
		1387
		1388	$isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
		1389
		1390	_isa_set;
		1391	}
		1392
		1393	# all autoloaded methods reserve the complete glob, not just the method slot.
		1394	# due to bugs in perls method cache implementation.
1049	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1395	our @methods = qw(io timer time now now_update signal child idle condvar);
1050		1396
1051	our @post_detect;
1052
1053	sub post_detect(&) {	1397	sub detect() {
1054	my ($cb) = @_;	1398	return $MODEL if $MODEL; # some programs keep references to detect
1055		1399
1056	if ($MODEL) {	1400	# IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1057	$cb->();	1401	# the author knows about the problems and what it does to AnyEvent as a whole
		1402	# (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
		1403	# anyway.
		1404	AnyEvent::log fatal => "AnyEvent: IO::Async::Loop::AnyEvent detected - this module is broken by design,\n"
		1405	. "abuses internals and breaks AnyEvent, will not continue."
		1406	if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1058		1407
1059	1	1408	local $!; # for good measure
		1409	local $SIG{__DIE__}; # we use eval
		1410
		1411	# free some memory
		1412	*detect = sub () { $MODEL };
		1413	# undef &func doesn't correctly update the method cache. grmbl.
		1414	# so we delete the whole glob. grmbl.
		1415	# otoh, perl doesn't let me undef an active usb, but it lets me free
		1416	# a glob with an active sub. hrm. i hope it works, but perl is
		1417	# usually buggy in this department. sigh.
		1418	delete @{"AnyEvent::"}{@methods};
		1419	undef @methods;
		1420
		1421	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
		1422	my $model = $1;
		1423	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
		1424	if (eval "require $model") {
		1425	AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
		1426	$MODEL = $model;
1060	} else {	1427	} else {
1061	push @post_detect, $cb;	1428	AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1062		1429	}
1063	defined wantarray
1064	? bless \$cb, "AnyEvent::Util::postdetect"
1065	: ()
1066	}	1430	}
1067	}
1068		1431
1069	sub AnyEvent::Util::postdetect::DESTROY {	1432	# check for already loaded models
1070	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1071	}
1072
1073	sub detect() {
1074	unless ($MODEL) {	1433	unless ($MODEL) {
1075	no strict 'refs';	1434	for (@REGISTRY, @models) {
1076	local $SIG{__DIE__};	1435	my ($package, $model) = @$_;
1077		1436	if (${"$package\::VERSION"} > 0) {
1078	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1079	my $model = "AnyEvent::Impl::$1";
1080	if (eval "require $model") {	1437	if (eval "require $model") {
		1438	AnyEvent::log 7 => "autodetected model '$model', using it.";
1081	$MODEL = $model;	1439	$MODEL = $model;
1082	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1440	last;
1083	} else {	1441	}
1084	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;
1085	}	1442	}
1086	}	1443	}
1087		1444
1088	# check for already loaded models
1089	unless ($MODEL) {	1445	unless ($MODEL) {
		1446	# try to autoload a model
1090	for (@REGISTRY, @models) {	1447	for (@REGISTRY, @models) {
1091	my ($package, $model) = @$_;	1448	my ($package, $model) = @$_;
		1449	if (
		1450	eval "require $package"
1092	if (${"$package\::VERSION"} > 0) {	1451	and ${"$package\::VERSION"} > 0
1093	if (eval "require $model") {	1452	and eval "require $model"
		1453	) {
		1454	AnyEvent::log 7 => "autoloaded model '$model', using it.";
1094	$MODEL = $model;	1455	$MODEL = $model;
1095	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;
1096	last;	1456	last;
1097	}
1098	}	1457	}
1099	}	1458	}
1100		1459
1101	unless ($MODEL) {
1102	# try to load a model
1103
1104	for (@REGISTRY, @models) {
1105	my ($package, $model) = @$_;
1106	if (eval "require $package"
1107	and ${"$package\::VERSION"} > 0
1108	and eval "require $model") {
1109	$MODEL = $model;
1110	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
1111	last;
1112	}
1113	}
1114
1115	$MODEL	1460	$MODEL
1116	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1461	or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1117	}
1118	}	1462	}
1119
1120	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1121
1122	unshift @ISA, $MODEL;
1123
1124	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1125
1126	(shift @post_detect)->() while @post_detect;
1127	}	1463	}
1128		1464
		1465	# free memory only needed for probing
		1466	undef @models;
		1467	undef @REGISTRY;
		1468
		1469	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1470
		1471	# now nuke some methods that are overridden by the backend.
		1472	# SUPER usage is not allowed in these.
		1473	for (qw(time signal child idle)) {
		1474	undef &{"AnyEvent::Base::$_"}
		1475	if defined &{"$MODEL\::$_"};
		1476	}
		1477
		1478	_isa_set;
		1479
		1480	# we're officially open!
		1481
		1482	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1483	require AnyEvent::Strict;
		1484	}
		1485
		1486	if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
		1487	require AnyEvent::Debug;
		1488	AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
		1489	}
		1490
		1491	if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
		1492	require AnyEvent::Socket;
		1493	require AnyEvent::Debug;
		1494
		1495	my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
		1496	$shell =~ s/\$\$/$$/g;
		1497
		1498	my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
		1499	$AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
		1500	}
		1501
		1502	# now the anyevent environment is set up as the user told us to, so
		1503	# call the actual user code - post detects
		1504
		1505	(shift @post_detect)->() while @post_detect;
		1506	undef @post_detect;
		1507
		1508	*post_detect = sub(&) {
		1509	shift->();
		1510
		1511	undef
		1512	};
		1513
1129	$MODEL	1514	$MODEL
1130	}	1515	}
1131		1516
1132	sub AUTOLOAD {	1517	for my $name (@methods) {
1133	(my $func = $AUTOLOAD) =~ s/.*://;	1518	*$name = sub {
1134		1519	detect;
1135	$method{$func}	1520	# we use goto because
1136	or croak "$func: not a valid method for AnyEvent objects";	1521	# a) it makes the thunk more transparent
1137		1522	# b) it allows us to delete the thunk later
1138	detect unless $MODEL;	1523	goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1139		1524	};
1140	my $class = shift;
1141	$class->$func (@_);
1142	}	1525	}
1143		1526
1144	# utility function to dup a filehandle. this is used by many backends	1527	# utility function to dup a filehandle. this is used by many backends
1145	# to support binding more than one watcher per filehandle (they usually	1528	# to support binding more than one watcher per filehandle (they usually
1146	# allow only one watcher per fd, so we dup it to get a different one).	1529	# allow only one watcher per fd, so we dup it to get a different one).
1147	sub _dupfh($$;$$) {	1530	sub _dupfh($$;$$) {
1148	my ($poll, $fh, $r, $w) = @_;	1531	my ($poll, $fh, $r, $w) = @_;
1149		1532
1150	# cygwin requires the fh mode to be matching, unix doesn't	1533	# cygwin requires the fh mode to be matching, unix doesn't
1151	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1534	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1152	: $poll eq "w" ? ($w, ">")
1153	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1154		1535
1155	open my $fh2, "$mode&" . fileno $fh	1536	open my $fh2, $mode, $fh
1156	or die "cannot dup() filehandle: $!,";	1537	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1157		1538
1158	# we assume CLOEXEC is already set by perl in all important cases	1539	# we assume CLOEXEC is already set by perl in all important cases
1159		1540
1160	($fh2, $rw)	1541	($fh2, $rw)
1161	}	1542	}
1162		1543
		1544	=head1 SIMPLIFIED AE API
		1545
		1546	Starting with version 5.0, AnyEvent officially supports a second, much
		1547	simpler, API that is designed to reduce the calling, typing and memory
		1548	overhead by using function call syntax and a fixed number of parameters.
		1549
		1550	See the L<AE> manpage for details.
		1551
		1552	=cut
		1553
		1554	package AE;
		1555
		1556	our $VERSION = $AnyEvent::VERSION;
		1557
		1558	sub _reset() {
		1559	eval q{
		1560	# fall back to the main API by default - backends and AnyEvent::Base
		1561	# implementations can overwrite these.
		1562
		1563	sub io($$$) {
		1564	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1565	}
		1566
		1567	sub timer($$$) {
		1568	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1569	}
		1570
		1571	sub signal($$) {
		1572	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1573	}
		1574
		1575	sub child($$) {
		1576	AnyEvent->child (pid => $_[0], cb => $_[1])
		1577	}
		1578
		1579	sub idle($) {
		1580	AnyEvent->idle (cb => $_[0]);
		1581	}
		1582
		1583	sub cv(;&) {
		1584	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1585	}
		1586
		1587	sub now() {
		1588	AnyEvent->now
		1589	}
		1590
		1591	sub now_update() {
		1592	AnyEvent->now_update
		1593	}
		1594
		1595	sub time() {
		1596	AnyEvent->time
		1597	}
		1598
		1599	*postpone = \&AnyEvent::postpone;
		1600	*log = \&AnyEvent::log;
		1601	};
		1602	die if $@;
		1603	}
		1604
		1605	BEGIN { _reset }
		1606
1163	package AnyEvent::Base;	1607	package AnyEvent::Base;
1164		1608
1165	# default implementations for many methods	1609	# default implementations for many methods
1166		1610
1167	BEGIN {	1611	sub time {
		1612	eval q{ # poor man's autoloading {}
		1613	# probe for availability of Time::HiRes
1168	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1614	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1615	*time = sub { Time::HiRes::time () };
1169	*_time = \&Time::HiRes::time;	1616	*AE::time = \& Time::HiRes::time ;
		1617	*now = \&time;
		1618	AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1170	# if (eval "use POSIX (); (POSIX::times())...	1619	# if (eval "use POSIX (); (POSIX::times())...
1171	} else {	1620	} else {
1172	*_time = sub { time }; # epic fail	1621	*time = sub { CORE::time };
		1622	*AE::time = sub (){ CORE::time };
		1623	*now = \&time;
		1624	AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
		1625	}
		1626	};
		1627	die if $@;
		1628
		1629	&time
		1630	}
		1631
		1632	*now = \&time;
		1633	sub now_update { }
		1634
		1635	sub _poll {
		1636	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1637	}
		1638
		1639	# default implementation for ->condvar
		1640	# in fact, the default should not be overwritten
		1641
		1642	sub condvar {
		1643	eval q{ # poor man's autoloading {}
		1644	*condvar = sub {
		1645	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1646	};
		1647
		1648	*AE::cv = sub (;&) {
		1649	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1650	};
		1651	};
		1652	die if $@;
		1653
		1654	&condvar
		1655	}
		1656
		1657	# default implementation for ->signal
		1658
		1659	our $HAVE_ASYNC_INTERRUPT;
		1660
		1661	sub _have_async_interrupt() {
		1662	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1663	&& eval "use Async::Interrupt 1.02 (); 1")
		1664	unless defined $HAVE_ASYNC_INTERRUPT;
		1665
		1666	$HAVE_ASYNC_INTERRUPT
		1667	}
		1668
		1669	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1670	our (%SIG_ASY, %SIG_ASY_W);
		1671	our ($SIG_COUNT, $SIG_TW);
		1672
		1673	# install a dummy wakeup watcher to reduce signal catching latency
		1674	# used by Impls
		1675	sub _sig_add() {
		1676	unless ($SIG_COUNT++) {
		1677	# try to align timer on a full-second boundary, if possible
		1678	my $NOW = AE::now;
		1679
		1680	$SIG_TW = AE::timer
		1681	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1682	$MAX_SIGNAL_LATENCY,
		1683	sub { } # just for the PERL_ASYNC_CHECK
		1684	;
1173	}	1685	}
1174	}	1686	}
1175		1687
1176	sub time { _time }	1688	sub _sig_del {
1177	sub now { _time }	1689	undef $SIG_TW
1178	sub now_update { }	1690	unless --$SIG_COUNT;
1179
1180	# default implementation for ->condvar
1181
1182	sub condvar {
1183	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1184	}	1691	}
1185		1692
1186	# default implementation for ->signal	1693	our $_sig_name_init; $_sig_name_init = sub {
		1694	eval q{ # poor man's autoloading {}
		1695	undef $_sig_name_init;
1187		1696
1188	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1697	if (_have_async_interrupt) {
		1698	*sig2num = \&Async::Interrupt::sig2num;
		1699	*sig2name = \&Async::Interrupt::sig2name;
		1700	} else {
		1701	require Config;
1189		1702
1190	sub _signal_exec {	1703	my %signame2num;
1191	sysread $SIGPIPE_R, my $dummy, 4;	1704	@signame2num{ split ' ', $Config::Config{sig_name} }
		1705	= split ' ', $Config::Config{sig_num};
1192		1706
1193	while (%SIG_EV) {	1707	my @signum2name;
1194	for (keys %SIG_EV) {	1708	@signum2name[values %signame2num] = keys %signame2num;
1195	delete $SIG_EV{$_};	1709
1196	$_->() for values %{ $SIG_CB{$_} || {} };	1710	*sig2num = sub($) {
		1711	$_[0] > 0 ? shift : $signame2num{+shift}
		1712	};
		1713	*sig2name = sub ($) {
		1714	$_[0] > 0 ? $signum2name[+shift] : shift
		1715	};
1197	}	1716	}
1198	}	1717	};
1199	}	1718	die if $@;
		1719	};
		1720
		1721	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1722	sub sig2name($) { &$_sig_name_init; &sig2name }
1200		1723
1201	sub signal {	1724	sub signal {
1202	my (undef, %arg) = @_;	1725	eval q{ # poor man's autoloading {}
		1726	# probe for availability of Async::Interrupt
		1727	if (_have_async_interrupt) {
		1728	AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1203		1729
1204	unless ($SIGPIPE_R) {	1730	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1205	require Fcntl;	1731	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1206		1732
1207	if (AnyEvent::WIN32) {
1208	require AnyEvent::Util;
1209
1210	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1211	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1212	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1213	} else {	1733	} else {
		1734	AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
		1735
		1736	if (AnyEvent::WIN32) {
		1737	require AnyEvent::Util;
		1738
		1739	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1740	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1741	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1742	} else {
1214	pipe $SIGPIPE_R, $SIGPIPE_W;	1743	pipe $SIGPIPE_R, $SIGPIPE_W;
1215	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1744	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1216	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1745	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1217		1746
1218	# not strictly required, as $^F is normally 2, but let's make sure...	1747	# not strictly required, as $^F is normally 2, but let's make sure...
1219	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1748	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1220	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1749	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1750	}
		1751
		1752	$SIGPIPE_R
		1753	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1754
		1755	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1221	}	1756	}
1222		1757
1223	$SIGPIPE_R	1758	*signal = $HAVE_ASYNC_INTERRUPT
1224	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1759	? sub {
		1760	my (undef, %arg) = @_;
1225		1761
1226	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1762	# async::interrupt
1227	}
1228
1229	my $signal = uc $arg{signal}	1763	my $signal = sig2num $arg{signal};
1230	or Carp::croak "required option 'signal' is missing";
1231
1232	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1764	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1765
		1766	$SIG_ASY{$signal} ||= new Async::Interrupt
		1767	cb => sub { undef $SIG_EV{$signal} },
		1768	signal => $signal,
		1769	pipe => [$SIGPIPE_R->filenos],
		1770	pipe_autodrain => 0,
		1771	;
		1772
		1773	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1774	}
		1775	: sub {
		1776	my (undef, %arg) = @_;
		1777
		1778	# pure perl
		1779	my $signal = sig2name $arg{signal};
		1780	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1781
1233	$SIG{$signal} ||= sub {	1782	$SIG{$signal} ||= sub {
1234	local $!;	1783	local $!;
1235	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1784	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1236	undef $SIG_EV{$signal};	1785	undef $SIG_EV{$signal};
		1786	};
		1787
		1788	# can't do signal processing without introducing races in pure perl,
		1789	# so limit the signal latency.
		1790	_sig_add;
		1791
		1792	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1793	}
		1794	;
		1795
		1796	*AnyEvent::Base::signal::DESTROY = sub {
		1797	my ($signal, $cb) = @{$_[0]};
		1798
		1799	_sig_del;
		1800
		1801	delete $SIG_CB{$signal}{$cb};
		1802
		1803	$HAVE_ASYNC_INTERRUPT
		1804	? delete $SIG_ASY{$signal}
		1805	: # delete doesn't work with older perls - they then
		1806	# print weird messages, or just unconditionally exit
		1807	# instead of getting the default action.
		1808	undef $SIG{$signal}
		1809	unless keys %{ $SIG_CB{$signal} };
		1810	};
		1811
		1812	*_signal_exec = sub {
		1813	$HAVE_ASYNC_INTERRUPT
		1814	? $SIGPIPE_R->drain
		1815	: sysread $SIGPIPE_R, (my $dummy), 9;
		1816
		1817	while (%SIG_EV) {
		1818	for (keys %SIG_EV) {
		1819	delete $SIG_EV{$_};
		1820	&$_ for values %{ $SIG_CB{$_} || {} };
		1821	}
		1822	}
		1823	};
1237	};	1824	};
		1825	die if $@;
1238		1826
1239	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1827	&signal
1240	}
1241
1242	sub AnyEvent::Base::signal::DESTROY {
1243	my ($signal, $cb) = @{$_[0]};
1244
1245	delete $SIG_CB{$signal}{$cb};
1246
1247	# delete doesn't work with older perls - they then
1248	# print weird messages, or just unconditionally exit
1249	# instead of getting the default action.
1250	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1251	}	1828	}
1252		1829
1253	# default implementation for ->child	1830	# default implementation for ->child
1254		1831
1255	our %PID_CB;	1832	our %PID_CB;
1256	our $CHLD_W;	1833	our $CHLD_W;
1257	our $CHLD_DELAY_W;	1834	our $CHLD_DELAY_W;
1258	our $WNOHANG;
1259		1835
1260	sub _sigchld {	1836	# used by many Impl's
1261	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1837	sub _emit_childstatus($$) {
		1838	my (undef, $rpid, $rstatus) = @_;
		1839
		1840	$_->($rpid, $rstatus)
1262	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1841	for values %{ $PID_CB{$rpid} || {} },
1263	(values %{ $PID_CB{0} || {} });	1842	values %{ $PID_CB{0} || {} };
1264	}
1265	}	1843	}
1266		1844
1267	sub child {	1845	sub child {
		1846	eval q{ # poor man's autoloading {}
		1847	*_sigchld = sub {
		1848	my $pid;
		1849
		1850	AnyEvent->_emit_childstatus ($pid, $?)
		1851	while ($pid = waitpid -1, WNOHANG) > 0;
		1852	};
		1853
		1854	*child = sub {
1268	my (undef, %arg) = @_;	1855	my (undef, %arg) = @_;
1269		1856
1270	defined (my $pid = $arg{pid} + 0)	1857	my $pid = $arg{pid};
1271	or Carp::croak "required option 'pid' is missing";	1858	my $cb = $arg{cb};
1272		1859
1273	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1860	$PID_CB{$pid}{$cb+0} = $cb;
1274		1861
1275	$WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1276
1277	unless ($CHLD_W) {	1862	unless ($CHLD_W) {
1278	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1863	$CHLD_W = AE::signal CHLD => \&_sigchld;
1279	# child could be a zombie already, so make at least one round	1864	# child could be a zombie already, so make at least one round
1280	&_sigchld;	1865	&_sigchld;
1281	}	1866	}
1282		1867
1283	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1868	bless [$pid, $cb+0], "AnyEvent::Base::child"
1284	}	1869	};
1285		1870
1286	sub AnyEvent::Base::child::DESTROY {	1871	*AnyEvent::Base::child::DESTROY = sub {
1287	my ($pid, $cb) = @{$_[0]};	1872	my ($pid, $icb) = @{$_[0]};
1288		1873
1289	delete $PID_CB{$pid}{$cb};	1874	delete $PID_CB{$pid}{$icb};
1290	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1875	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1291		1876
1292	undef $CHLD_W unless keys %PID_CB;	1877	undef $CHLD_W unless keys %PID_CB;
		1878	};
		1879	};
		1880	die if $@;
		1881
		1882	&child
1293	}	1883	}
1294		1884
1295	# idle emulation is done by simply using a timer, regardless	1885	# idle emulation is done by simply using a timer, regardless
1296	# of whether the process is idle or not, and not letting	1886	# of whether the process is idle or not, and not letting
1297	# the callback use more than 50% of the time.	1887	# the callback use more than 50% of the time.
1298	sub idle {	1888	sub idle {
		1889	eval q{ # poor man's autoloading {}
		1890	*idle = sub {
1299	my (undef, %arg) = @_;	1891	my (undef, %arg) = @_;
1300		1892
1301	my ($cb, $w, $rcb) = $arg{cb};	1893	my ($cb, $w, $rcb) = $arg{cb};
1302		1894
1303	$rcb = sub {	1895	$rcb = sub {
1304	if ($cb) {	1896	if ($cb) {
1305	$w = _time;	1897	$w = AE::time;
1306	&$cb;	1898	&$cb;
1307	$w = _time - $w;	1899	$w = AE::time - $w;
1308		1900
1309	# never use more then 50% of the time for the idle watcher,	1901	# never use more then 50% of the time for the idle watcher,
1310	# within some limits	1902	# within some limits
1311	$w = 0.0001 if $w < 0.0001;	1903	$w = 0.0001 if $w < 0.0001;
1312	$w = 5 if $w > 5;	1904	$w = 5 if $w > 5;
1313		1905
1314	$w = AnyEvent->timer (after => $w, cb => $rcb);	1906	$w = AE::timer $w, 0, $rcb;
1315	} else {	1907	} else {
1316	# clean up...	1908	# clean up...
1317	undef $w;	1909	undef $w;
1318	undef $rcb;	1910	undef $rcb;
		1911	}
		1912	};
		1913
		1914	$w = AE::timer 0.05, 0, $rcb;
		1915
		1916	bless \\$cb, "AnyEvent::Base::idle"
1319	}	1917	};
		1918
		1919	*AnyEvent::Base::idle::DESTROY = sub {
		1920	undef $${$_[0]};
		1921	};
1320	};	1922	};
		1923	die if $@;
1321		1924
1322	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1925	&idle
1323
1324	bless \\$cb, "AnyEvent::Base::idle"
1325	}
1326
1327	sub AnyEvent::Base::idle::DESTROY {
1328	undef $${$_[0]};
1329	}	1926	}
1330		1927
1331	package AnyEvent::CondVar;	1928	package AnyEvent::CondVar;
1332		1929
1333	our @ISA = AnyEvent::CondVar::Base::;	1930	our @ISA = AnyEvent::CondVar::Base::;
1334		1931
		1932	# only to be used for subclassing
		1933	sub new {
		1934	my $class = shift;
		1935	bless AnyEvent->condvar (@_), $class
		1936	}
		1937
1335	package AnyEvent::CondVar::Base;	1938	package AnyEvent::CondVar::Base;
1336		1939
1337	use overload	1940	#use overload
1338	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1941	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1339	fallback => 1;	1942	# fallback => 1;
		1943
		1944	# save 300+ kilobytes by dirtily hardcoding overloading
		1945	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1946	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1947	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1948	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1949
		1950	our $WAITING;
1340		1951
1341	sub _send {	1952	sub _send {
1342	# nop	1953	# nop
		1954	}
		1955
		1956	sub _wait {
		1957	AnyEvent->_poll until $_[0]{_ae_sent};
1343	}	1958	}
1344		1959
1345	sub send {	1960	sub send {
1346	my $cv = shift;	1961	my $cv = shift;
1347	$cv->{_ae_sent} = [@_];	1962	$cv->{_ae_sent} = [@_];
…		…
1356		1971
1357	sub ready {	1972	sub ready {
1358	$_[0]{_ae_sent}	1973	$_[0]{_ae_sent}
1359	}	1974	}
1360		1975
1361	sub _wait {
1362	AnyEvent->one_event while !$_[0]{_ae_sent};
1363	}
1364
1365	sub recv {	1976	sub recv {
		1977	unless ($_[0]{_ae_sent}) {
		1978	$WAITING
		1979	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1980
		1981	local $WAITING = 1;
1366	$_[0]->_wait;	1982	$_[0]->_wait;
		1983	}
1367		1984
1368	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1985	$_[0]{_ae_croak}
1369	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1986	and Carp::croak $_[0]{_ae_croak};
		1987
		1988	wantarray
		1989	? @{ $_[0]{_ae_sent} }
		1990	: $_[0]{_ae_sent}[0]
1370	}	1991	}
1371		1992
1372	sub cb {	1993	sub cb {
1373	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1994	my $cv = shift;
		1995
		1996	@_
		1997	and $cv->{_ae_cb} = shift
		1998	and $cv->{_ae_sent}
		1999	and (delete $cv->{_ae_cb})->($cv);
		2000
1374	$_[0]{_ae_cb}	2001	$cv->{_ae_cb}
1375	}	2002	}
1376		2003
1377	sub begin {	2004	sub begin {
1378	++$_[0]{_ae_counter};	2005	++$_[0]{_ae_counter};
1379	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	2006	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1384	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	2011	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1385	}	2012	}
1386		2013
1387	# undocumented/compatibility with pre-3.4	2014	# undocumented/compatibility with pre-3.4
1388	*broadcast = \&send;	2015	*broadcast = \&send;
1389	*wait = \&_wait;	2016	*wait = \&recv;
1390		2017
1391	=head1 ERROR AND EXCEPTION HANDLING	2018	=head1 ERROR AND EXCEPTION HANDLING
1392		2019
1393	In general, AnyEvent does not do any error handling - it relies on the	2020	In general, AnyEvent does not do any error handling - it relies on the
1394	caller to do that if required. The L<AnyEvent::Strict> module (see also	2021	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1406	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and	2033	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1407	so on.	2034	so on.
1408		2035
1409	=head1 ENVIRONMENT VARIABLES	2036	=head1 ENVIRONMENT VARIABLES
1410		2037
1411	The following environment variables are used by this module or its	2038	AnyEvent supports a number of environment variables that tune the
1412	submodules.	2039	runtime behaviour. They are usually evaluated when AnyEvent is
		2040	loaded, initialised, or a submodule that uses them is loaded. Many of
		2041	them also cause AnyEvent to load additional modules - for example,
		2042	C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
		2043	loaded.
1413		2044
1414	Note that AnyEvent will remove I<all> environment variables starting with	2045	All the environment variables documented here start with
1415	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is	2046	C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1416	enabled.	2047	namespace. Other modules are encouraged (but by no means required) to use
		2048	C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
		2049	namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
		2050	be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
		2051	variables starting with C<AE_>, see below).
		2052
		2053	All variables can also be set via the C<AE_> prefix, that is, instead
		2054	of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
		2055	case there is a clash btween anyevent and another program that uses
		2056	C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
		2057	variable to the empty string, as those variables take precedence.
		2058
		2059	When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
		2060	to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
		2061	exists. If taint mode is on, then AnyEvent will remove I<all> environment
		2062	variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
		2063	with C<undef> or the empty string, if the corresaponding C<AE_> variable
		2064	is set).
		2065
		2066	The exact algorithm is currently:
		2067
		2068	1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
		2069	2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
		2070	3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
		2071
		2072	This ensures that child processes will not see the C<AE_> variables.
		2073
		2074	The following environment variables are currently known to AnyEvent:
1417		2075
1418	=over 4	2076	=over 4
1419		2077
1420	=item C<PERL_ANYEVENT_VERBOSE>	2078	=item C<PERL_ANYEVENT_VERBOSE>
1421		2079
1422	By default, AnyEvent will be completely silent except in fatal	2080	By default, AnyEvent will only log messages with loglevel C<3>
1423	conditions. You can set this environment variable to make AnyEvent more	2081	(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
		2082	environment variable to a numerical loglevel to make AnyEvent more (or
1424	talkative.	2083	less) talkative.
1425		2084
		2085	If you want to do more than just set the global logging level
		2086	you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
		2087	complex specifications.
		2088
		2089	When set to C<0> (C<off>), then no messages whatsoever will be logged with
		2090	the default logging settings.
		2091
1426	When set to C<1> or higher, causes AnyEvent to warn about unexpected	2092	When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1427	conditions, such as not being able to load the event model specified by	2093	unexpected conditions, such as not being able to load the event model
1428	C<PERL_ANYEVENT_MODEL>.	2094	specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
		2095	exception - this is the minimum recommended level.
1429		2096
1430	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	2097	When set to C<7> or higher (info), cause AnyEvent to report which event model it
1431	model it chooses.	2098	chooses.
		2099
		2100	When set to C<8> or higher (debug), then AnyEvent will report extra information on
		2101	which optional modules it loads and how it implements certain features.
		2102
		2103	=item C<PERL_ANYEVENT_LOG>
		2104
		2105	Accepts rather complex logging specifications. For example, you could log
		2106	all C<debug> messages of some module to stderr, warnings and above to
		2107	stderr, and errors and above to syslog, with:
		2108
		2109	PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
		2110
		2111	For the rather extensive details, see L<AnyEvent::Log>.
		2112
		2113	This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
		2114	so will take effect even before AnyEvent has initialised itself.
		2115
		2116	Note that specifying this environment variable causes the L<AnyEvent::Log>
		2117	module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
		2118	using the latter saves a few hundred kB of memory until the first message
		2119	is being logged.
1432		2120
1433	=item C<PERL_ANYEVENT_STRICT>	2121	=item C<PERL_ANYEVENT_STRICT>
1434		2122
1435	AnyEvent does not do much argument checking by default, as thorough	2123	AnyEvent does not do much argument checking by default, as thorough
1436	argument checking is very costly. Setting this variable to a true value	2124	argument checking is very costly. Setting this variable to a true value
…		…
1438	check the arguments passed to most method calls. If it finds any problems,	2126	check the arguments passed to most method calls. If it finds any problems,
1439	it will croak.	2127	it will croak.
1440		2128
1441	In other words, enables "strict" mode.	2129	In other words, enables "strict" mode.
1442		2130
1443	Unlike C<use strict>, it is definitely recommended to keep it off in	2131	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1444	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	2132	>>, it is definitely recommended to keep it off in production. Keeping
1445	developing programs can be very useful, however.	2133	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		2134	can be very useful, however.
		2135
		2136	=item C<PERL_ANYEVENT_DEBUG_SHELL>
		2137
		2138	If this env variable is nonempty, then its contents will be interpreted by
		2139	C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
		2140	replacing every occurance of C<$$> by the process pid). The shell object
		2141	is saved in C<$AnyEvent::Debug::SHELL>.
		2142
		2143	This happens when the first watcher is created.
		2144
		2145	For example, to bind a debug shell on a unix domain socket in
		2146	F<< /tmp/debug<pid>.sock >>, you could use this:
		2147
		2148	PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
		2149	# connect with e.g.: socat readline /tmp/debug123.sock
		2150
		2151	Or to bind to tcp port 4545 on localhost:
		2152
		2153	PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
		2154	# connect with e.g.: telnet localhost 4545
		2155
		2156	Note that creating sockets in F</tmp> or on localhost is very unsafe on
		2157	multiuser systems.
		2158
		2159	=item C<PERL_ANYEVENT_DEBUG_WRAP>
		2160
		2161	Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
		2162	debugging purposes. See C<AnyEvent::Debug::wrap> for details.
1446		2163
1447	=item C<PERL_ANYEVENT_MODEL>	2164	=item C<PERL_ANYEVENT_MODEL>
1448		2165
1449	This can be used to specify the event model to be used by AnyEvent, before	2166	This can be used to specify the event model to be used by AnyEvent, before
1450	auto detection and -probing kicks in. It must be a string consisting	2167	auto detection and -probing kicks in.
1451	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	2168
		2169	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		2170	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1452	and the resulting module name is loaded and if the load was successful,	2171	resulting module name is loaded and - if the load was successful - used as
1453	used as event model. If it fails to load AnyEvent will proceed with	2172	event model backend. If it fails to load then AnyEvent will proceed with
1454	auto detection and -probing.	2173	auto detection and -probing.
1455		2174
1456	This functionality might change in future versions.	2175	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		2176	nothing gets prepended and the module name is used as-is (hint: C<::> at
		2177	the end of a string designates a module name and quotes it appropriately).
1457		2178
1458	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	2179	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1459	could start your program like this:	2180	could start your program like this:
1460		2181
1461	PERL_ANYEVENT_MODEL=Perl perl ...	2182	PERL_ANYEVENT_MODEL=Perl perl ...
1462		2183
1463	=item C<PERL_ANYEVENT_PROTOCOLS>	2184	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1479	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	2200	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1480	- only support IPv4, never try to resolve or contact IPv6	2201	- only support IPv4, never try to resolve or contact IPv6
1481	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	2202	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1482	IPv6, but prefer IPv6 over IPv4.	2203	IPv6, but prefer IPv6 over IPv4.
1483		2204
		2205	=item C<PERL_ANYEVENT_HOSTS>
		2206
		2207	This variable, if specified, overrides the F</etc/hosts> file used by
		2208	L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
		2209	from that file instead.
		2210
1484	=item C<PERL_ANYEVENT_EDNS0>	2211	=item C<PERL_ANYEVENT_EDNS0>
1485		2212
1486	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension	2213	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1487	for DNS. This extension is generally useful to reduce DNS traffic, but	2214	DNS. This extension is generally useful to reduce DNS traffic, especially
1488	some (broken) firewalls drop such DNS packets, which is why it is off by	2215	when DNSSEC is involved, but some (broken) firewalls drop such DNS
1489	default.	2216	packets, which is why it is off by default.
1490		2217
1491	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce	2218	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1492	EDNS0 in its DNS requests.	2219	EDNS0 in its DNS requests.
1493		2220
1494	=item C<PERL_ANYEVENT_MAX_FORKS>	2221	=item C<PERL_ANYEVENT_MAX_FORKS>
…		…
1502	resolver - this is the maximum number of parallel DNS requests that are	2229	resolver - this is the maximum number of parallel DNS requests that are
1503	sent to the DNS server.	2230	sent to the DNS server.
1504		2231
1505	=item C<PERL_ANYEVENT_RESOLV_CONF>	2232	=item C<PERL_ANYEVENT_RESOLV_CONF>
1506		2233
1507	The file to use instead of F</etc/resolv.conf> (or OS-specific	2234	The absolute path to a F<resolv.conf>-style file to use instead of
1508	configuration) in the default resolver. When set to the empty string, no	2235	F</etc/resolv.conf> (or the OS-specific configuration) in the default
1509	default config will be used.	2236	resolver, or the empty string to select the default configuration.
1510		2237
1511	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.	2238	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1512		2239
1513	When neither C<ca_file> nor C<ca_path> was specified during	2240	When neither C<ca_file> nor C<ca_path> was specified during
1514	L<AnyEvent::TLS> context creation, and either of these environment	2241	L<AnyEvent::TLS> context creation, and either of these environment
1515	variables exist, they will be used to specify CA certificate locations	2242	variables are nonempty, they will be used to specify CA certificate
1516	instead of a system-dependent default.	2243	locations instead of a system-dependent default.
		2244
		2245	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		2246
		2247	When these are set to C<1>, then the respective modules are not
		2248	loaded. Mostly good for testing AnyEvent itself.
1517		2249
1518	=back	2250	=back
1519		2251
1520	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	2252	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1521		2253
…		…
1579	warn "read: $input\n"; # output what has been read	2311	warn "read: $input\n"; # output what has been read
1580	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2312	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1581	},	2313	},
1582	);	2314	);
1583		2315
1584	my $time_watcher; # can only be used once
1585
1586	sub new_timer {
1587	$timer = AnyEvent->timer (after => 1, cb => sub {	2316	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1588	warn "timeout\n"; # print 'timeout' about every second	2317	warn "timeout\n"; # print 'timeout' at most every second
1589	&new_timer; # and restart the time
1590	});	2318	});
1591	}
1592
1593	new_timer; # create first timer
1594		2319
1595	$cv->recv; # wait until user enters /^q/i	2320	$cv->recv; # wait until user enters /^q/i
1596		2321
1597	=head1 REAL-WORLD EXAMPLE	2322	=head1 REAL-WORLD EXAMPLE
1598		2323
…		…
1671		2396
1672	The actual code goes further and collects all errors (C<die>s, exceptions)	2397	The actual code goes further and collects all errors (C<die>s, exceptions)
1673	that occurred during request processing. The C<result> method detects	2398	that occurred during request processing. The C<result> method detects
1674	whether an exception as thrown (it is stored inside the $txn object)	2399	whether an exception as thrown (it is stored inside the $txn object)
1675	and just throws the exception, which means connection errors and other	2400	and just throws the exception, which means connection errors and other
1676	problems get reported tot he code that tries to use the result, not in a	2401	problems get reported to the code that tries to use the result, not in a
1677	random callback.	2402	random callback.
1678		2403
1679	All of this enables the following usage styles:	2404	All of this enables the following usage styles:
1680		2405
1681	1. Blocking:	2406	1. Blocking:
…		…
1729	through AnyEvent. The benchmark creates a lot of timers (with a zero	2454	through AnyEvent. The benchmark creates a lot of timers (with a zero
1730	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2455	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1731	which it is), lets them fire exactly once and destroys them again.	2456	which it is), lets them fire exactly once and destroys them again.
1732		2457
1733	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2458	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1734	distribution.	2459	distribution. It uses the L<AE> interface, which makes a real difference
		2460	for the EV and Perl backends only.
1735		2461
1736	=head3 Explanation of the columns	2462	=head3 Explanation of the columns
1737		2463
1738	I<watcher> is the number of event watchers created/destroyed. Since	2464	I<watcher> is the number of event watchers created/destroyed. Since
1739	different event models feature vastly different performances, each event	2465	different event models feature vastly different performances, each event
…		…
1760	watcher.	2486	watcher.
1761		2487
1762	=head3 Results	2488	=head3 Results
1763		2489
1764	name watchers bytes create invoke destroy comment	2490	name watchers bytes create invoke destroy comment
1765	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2491	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1766	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2492	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1767	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2493	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1768	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2494	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1769	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2495	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1770	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2496	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1771	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2497	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1772	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2498	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1773	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2499	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1774	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2500	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1775	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2501	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1776	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2502	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1777		2503
1778	=head3 Discussion	2504	=head3 Discussion
1779		2505
1780	The benchmark does I<not> measure scalability of the event loop very	2506	The benchmark does I<not> measure scalability of the event loop very
1781	well. For example, a select-based event loop (such as the pure perl one)	2507	well. For example, a select-based event loop (such as the pure perl one)
…		…
1793	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2519	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1794	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2520	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1795	cycles with POE.	2521	cycles with POE.
1796		2522
1797	C<EV> is the sole leader regarding speed and memory use, which are both	2523	C<EV> is the sole leader regarding speed and memory use, which are both
1798	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2524	maximal/minimal, respectively. When using the L<AE> API there is zero
		2525	overhead (when going through the AnyEvent API create is about 5-6 times
		2526	slower, with other times being equal, so still uses far less memory than
1799	far less memory than any other event loop and is still faster than Event	2527	any other event loop and is still faster than Event natively).
1800	natively.
1801		2528
1802	The pure perl implementation is hit in a few sweet spots (both the	2529	The pure perl implementation is hit in a few sweet spots (both the
1803	constant timeout and the use of a single fd hit optimisations in the perl	2530	constant timeout and the use of a single fd hit optimisations in the perl
1804	interpreter and the backend itself). Nevertheless this shows that it	2531	interpreter and the backend itself). Nevertheless this shows that it
1805	adds very little overhead in itself. Like any select-based backend its	2532	adds very little overhead in itself. Like any select-based backend its
…		…
1853	(even when used without AnyEvent), but most event loops have acceptable	2580	(even when used without AnyEvent), but most event loops have acceptable
1854	performance with or without AnyEvent.	2581	performance with or without AnyEvent.
1855		2582
1856	=item * The overhead AnyEvent adds is usually much smaller than the overhead of	2583	=item * The overhead AnyEvent adds is usually much smaller than the overhead of
1857	the actual event loop, only with extremely fast event loops such as EV	2584	the actual event loop, only with extremely fast event loops such as EV
1858	adds AnyEvent significant overhead.	2585	does AnyEvent add significant overhead.
1859		2586
1860	=item * You should avoid POE like the plague if you want performance or	2587	=item * You should avoid POE like the plague if you want performance or
1861	reasonable memory usage.	2588	reasonable memory usage.
1862		2589
1863	=back	2590	=back
…		…
1879	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2606	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1880	(1%) are active. This mirrors the activity of large servers with many	2607	(1%) are active. This mirrors the activity of large servers with many
1881	connections, most of which are idle at any one point in time.	2608	connections, most of which are idle at any one point in time.
1882		2609
1883	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2610	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1884	distribution.	2611	distribution. It uses the L<AE> interface, which makes a real difference
		2612	for the EV and Perl backends only.
1885		2613
1886	=head3 Explanation of the columns	2614	=head3 Explanation of the columns
1887		2615
1888	I<sockets> is the number of sockets, and twice the number of "servers" (as	2616	I<sockets> is the number of sockets, and twice the number of "servers" (as
1889	each server has a read and write socket end).	2617	each server has a read and write socket end).
…		…
1897	a new one that moves the timeout into the future.	2625	a new one that moves the timeout into the future.
1898		2626
1899	=head3 Results	2627	=head3 Results
1900		2628
1901	name sockets create request	2629	name sockets create request
1902	EV 20000 69.01 11.16	2630	EV 20000 62.66 7.99
1903	Perl 20000 73.32 35.87	2631	Perl 20000 68.32 32.64
1904	IOAsync 20000 157.00 98.14 epoll	2632	IOAsync 20000 174.06 101.15 epoll
1905	IOAsync 20000 159.31 616.06 poll	2633	IOAsync 20000 174.67 610.84 poll
1906	Event 20000 212.62 257.32	2634	Event 20000 202.69 242.91
1907	Glib 20000 651.16 1896.30	2635	Glib 20000 557.01 1689.52
1908	POE 20000 349.67 12317.24 uses POE::Loop::Event	2636	POE 20000 341.54 12086.32 uses POE::Loop::Event
1909		2637
1910	=head3 Discussion	2638	=head3 Discussion
1911		2639
1912	This benchmark I<does> measure scalability and overall performance of the	2640	This benchmark I<does> measure scalability and overall performance of the
1913	particular event loop.	2641	particular event loop.
…		…
2039	As you can see, the AnyEvent + EV combination even beats the	2767	As you can see, the AnyEvent + EV combination even beats the
2040	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2768	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2041	backend easily beats IO::Lambda and POE.	2769	backend easily beats IO::Lambda and POE.
2042		2770
2043	And even the 100% non-blocking version written using the high-level (and	2771	And even the 100% non-blocking version written using the high-level (and
2044	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2772	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2045	large margin, even though it does all of DNS, tcp-connect and socket I/O	2773	higher level ("unoptimised") abstractions by a large margin, even though
2046	in a non-blocking way.	2774	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2047		2775
2048	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2776	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2049	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2777	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2050	part of the IO::lambda distribution and were used without any changes.	2778	part of the IO::Lambda distribution and were used without any changes.
2051		2779
2052		2780
2053	=head1 SIGNALS	2781	=head1 SIGNALS
2054		2782
2055	AnyEvent currently installs handlers for these signals:	2783	AnyEvent currently installs handlers for these signals:
…		…
2060		2788
2061	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2789	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2062	emulation for event loops that do not support them natively. Also, some	2790	emulation for event loops that do not support them natively. Also, some
2063	event loops install a similar handler.	2791	event loops install a similar handler.
2064		2792
2065	If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will	2793	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2066	reset it to default, to avoid losing child exit statuses.	2794	AnyEvent will reset it to default, to avoid losing child exit statuses.
2067		2795
2068	=item SIGPIPE	2796	=item SIGPIPE
2069		2797
2070	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2798	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2071	when AnyEvent gets loaded.	2799	when AnyEvent gets loaded.
…		…
2089	if $SIG{CHLD} eq 'IGNORE';	2817	if $SIG{CHLD} eq 'IGNORE';
2090		2818
2091	$SIG{PIPE} = sub { }	2819	$SIG{PIPE} = sub { }
2092	unless defined $SIG{PIPE};	2820	unless defined $SIG{PIPE};
2093		2821
		2822	=head1 RECOMMENDED/OPTIONAL MODULES
		2823
		2824	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2825	its built-in modules) are required to use it.
		2826
		2827	That does not mean that AnyEvent won't take advantage of some additional
		2828	modules if they are installed.
		2829
		2830	This section explains which additional modules will be used, and how they
		2831	affect AnyEvent's operation.
		2832
		2833	=over 4
		2834
		2835	=item L<Async::Interrupt>
		2836
		2837	This slightly arcane module is used to implement fast signal handling: To
		2838	my knowledge, there is no way to do completely race-free and quick
		2839	signal handling in pure perl. To ensure that signals still get
		2840	delivered, AnyEvent will start an interval timer to wake up perl (and
		2841	catch the signals) with some delay (default is 10 seconds, look for
		2842	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2843
		2844	If this module is available, then it will be used to implement signal
		2845	catching, which means that signals will not be delayed, and the event loop
		2846	will not be interrupted regularly, which is more efficient (and good for
		2847	battery life on laptops).
		2848
		2849	This affects not just the pure-perl event loop, but also other event loops
		2850	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2851
		2852	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2853	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2854	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2855	does nothing for those backends.
		2856
		2857	=item L<EV>
		2858
		2859	This module isn't really "optional", as it is simply one of the backend
		2860	event loops that AnyEvent can use. However, it is simply the best event
		2861	loop available in terms of features, speed and stability: It supports
		2862	the AnyEvent API optimally, implements all the watcher types in XS, does
		2863	automatic timer adjustments even when no monotonic clock is available,
		2864	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2865	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2866	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2867
		2868	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2869	then this module will do nothing for you.
		2870
		2871	=item L<Guard>
		2872
		2873	The guard module, when used, will be used to implement
		2874	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2875	lot less memory), but otherwise doesn't affect guard operation much. It is
		2876	purely used for performance.
		2877
		2878	=item L<JSON> and L<JSON::XS>
		2879
		2880	One of these modules is required when you want to read or write JSON data
		2881	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
		2882	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2883
		2884	=item L<Net::SSLeay>
		2885
		2886	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2887	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2888	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2889
		2890	=item L<Time::HiRes>
		2891
		2892	This module is part of perl since release 5.008. It will be used when the
		2893	chosen event library does not come with a timing source of its own. The
		2894	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
		2895	try to use a monotonic clock for timing stability.
		2896
		2897	=back
		2898
		2899
2094	=head1 FORK	2900	=head1 FORK
2095		2901
2096	Most event libraries are not fork-safe. The ones who are usually are	2902	Most event libraries are not fork-safe. The ones who are usually are
2097	because they rely on inefficient but fork-safe C<select> or C<poll>	2903	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2098	calls. Only L<EV> is fully fork-aware.	2904	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2905	are usually badly thought-out hacks that are incompatible with fork in
		2906	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2907	continue event-processing in both parent and child (or both, if you know
		2908	what you are doing).
		2909
		2910	This means that, in general, you cannot fork and do event processing in
		2911	the child if the event library was initialised before the fork (which
		2912	usually happens when the first AnyEvent watcher is created, or the library
		2913	is loaded).
2099		2914
2100	If you have to fork, you must either do so I<before> creating your first	2915	If you have to fork, you must either do so I<before> creating your first
2101	watcher OR you must not use AnyEvent at all in the child.	2916	watcher OR you must not use AnyEvent at all in the child OR you must do
		2917	something completely out of the scope of AnyEvent.
		2918
		2919	The problem of doing event processing in the parent I<and> the child
		2920	is much more complicated: even for backends that I<are> fork-aware or
		2921	fork-safe, their behaviour is not usually what you want: fork clones all
		2922	watchers, that means all timers, I/O watchers etc. are active in both
		2923	parent and child, which is almost never what you want. USing C<exec>
		2924	to start worker children from some kind of manage rprocess is usually
		2925	preferred, because it is much easier and cleaner, at the expense of having
		2926	to have another binary.
2102		2927
2103		2928
2104	=head1 SECURITY CONSIDERATIONS	2929	=head1 SECURITY CONSIDERATIONS
2105		2930
2106	AnyEvent can be forced to load any event model via	2931	AnyEvent can be forced to load any event model via
…		…
2136	pronounced).	2961	pronounced).
2137		2962
2138		2963
2139	=head1 SEE ALSO	2964	=head1 SEE ALSO
2140		2965
2141	Utility functions: L<AnyEvent::Util>.	2966	Tutorial/Introduction: L<AnyEvent::Intro>.
2142		2967
2143	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2968	FAQ: L<AnyEvent::FAQ>.
2144	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2969
		2970	Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
		2971	(simply logging).
		2972
		2973	Development/Debugging: L<AnyEvent::Strict> (stricter checking),
		2974	L<AnyEvent::Debug> (interactive shell, watcher tracing).
		2975
		2976	Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
		2977	L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
		2978	L<Qt>, L<POE>, L<FLTK>.
2145		2979
2146	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2980	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2147	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2981	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2148	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2982	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
		2983	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2149	L<AnyEvent::Impl::POE>.	2984	L<AnyEvent::Impl::FLTK>.
2150		2985
2151	Non-blocking file handles, sockets, TCP clients and	2986	Non-blocking handles, pipes, stream sockets, TCP clients and
2152	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2987	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2153		2988
2154	Asynchronous DNS: L<AnyEvent::DNS>.	2989	Asynchronous DNS: L<AnyEvent::DNS>.
2155		2990
2156	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2991	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2157		2992
2158	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2993	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
		2994	L<AnyEvent::HTTP>.
2159		2995
2160		2996
2161	=head1 AUTHOR	2997	=head1 AUTHOR
2162		2998
2163	Marc Lehmann <schmorp@schmorp.de>	2999	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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