ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.202 by root, Wed Apr 1 15:29:00 2009 UTC vs.
Revision 1.380 by root, Thu Sep 1 04:07:18 2011 UTC

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

Diff Legend

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