ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.200 by root, Wed Apr 1 14:02:27 2009 UTC vs.
Revision 1.354 by root, Thu Aug 11 21:26:39 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	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.
		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	If you need to do some initialisation before AnyEvent watchers are
		940	created, use C<post_detect>.
693		941
694	=item $guard = AnyEvent::post_detect { BLOCK }	942	=item $guard = AnyEvent::post_detect { BLOCK }
695		943
696	Arranges for the code block to be executed as soon as the event model is	944	Arranges for the code block to be executed as soon as the event model is
697	autodetected (or immediately if this has already happened).	945	autodetected (or immediately if that has already happened).
		946
		947	The block will be executed I<after> the actual backend has been detected
		948	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		949	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		950	other initialisations - see the sources of L<AnyEvent::Strict> or
		951	L<AnyEvent::AIO> to see how this is used.
		952
		953	The most common usage is to create some global watchers, without forcing
		954	event module detection too early, for example, L<AnyEvent::AIO> creates
		955	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		956	avoid autodetecting the event module at load time.
698		957
699	If called in scalar or list context, then it creates and returns an object	958	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	959	that automatically removes the callback again when it is destroyed (or
		960	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
701	L<Coro::BDB> for a case where this is useful.	961	a case where this is useful.
		962
		963	Example: Create a watcher for the IO::AIO module and store it in
		964	C<$WATCHER>, but do so only do so after the event loop is initialised.
		965
		966	our WATCHER;
		967
		968	my $guard = AnyEvent::post_detect {
		969	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		970	};
		971
		972	# the ||= is important in case post_detect immediately runs the block,
		973	# as to not clobber the newly-created watcher. assigning both watcher and
		974	# post_detect guard to the same variable has the advantage of users being
		975	# able to just C<undef $WATCHER> if the watcher causes them grief.
		976
		977	$WATCHER ||= $guard;
702		978
703	=item @AnyEvent::post_detect	979	=item @AnyEvent::post_detect
704		980
705	If there are any code references in this array (you can C<push> to it	981	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	982	before or after loading AnyEvent), then they will be called directly
707	the event loop has been chosen.	983	after the event loop has been chosen.
708		984
709	You should check C<$AnyEvent::MODEL> before adding to this array, though:	985	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,	986	if it is defined then the event loop has already been detected, and the
711	and the array will be ignored.	987	array will be ignored.
712		988
713	Best use C<AnyEvent::post_detect { BLOCK }> instead.	989	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		990	it, as it takes care of these details.
		991
		992	This variable is mainly useful for modules that can do something useful
		993	when AnyEvent is used and thus want to know when it is initialised, but do
		994	not need to even load it by default. This array provides the means to hook
		995	into AnyEvent passively, without loading it.
		996
		997	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		998	together, you could put this into Coro (this is the actual code used by
		999	Coro to accomplish this):
		1000
		1001	if (defined $AnyEvent::MODEL) {
		1002	# AnyEvent already initialised, so load Coro::AnyEvent
		1003	require Coro::AnyEvent;
		1004	} else {
		1005	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1006	# as soon as it is
		1007	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1008	}
		1009
		1010	=item AnyEvent::postpone { BLOCK }
		1011
		1012	Arranges for the block to be executed as soon as possible, but not before
		1013	the call itself returns. In practise, the block will be executed just
		1014	before the event loop polls for new events, or shortly afterwards.
		1015
		1016	This function never returns anything (to make the C<return postpone { ...
		1017	}> idiom more useful.
		1018
		1019	To understand the usefulness of this function, consider a function that
		1020	asynchronously does something for you and returns some transaction
		1021	object or guard to let you cancel the operation. For example,
		1022	C<AnyEvent::Socket::tcp_connect>:
		1023
		1024	# start a conenction attempt unless one is active
		1025	$self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1026	delete $self->{connect_guard};
		1027	...
		1028	};
		1029
		1030	Imagine that this function could instantly call the callback, for
		1031	example, because it detects an obvious error such as a negative port
		1032	number. Invoking the callback before the function returns causes problems
		1033	however: the callback will be called and will try to delete the guard
		1034	object. But since the function hasn't returned yet, there is nothing to
		1035	delete. When the function eventually returns it will assign the guard
		1036	object to C<< $self->{connect_guard} >>, where it will likely never be
		1037	deleted, so the program thinks it is still trying to connect.
		1038
		1039	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1040	callback directly on error:
		1041
		1042	$cb->(undef), return # signal error to callback, BAD!
		1043	if $some_error_condition;
		1044
		1045	It should use C<postpone>:
		1046
		1047	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1048	if $some_error_condition;
714		1049
715	=back	1050	=back
716		1051
717	=head1 WHAT TO DO IN A MODULE	1052	=head1 WHAT TO DO IN A MODULE
718		1053
…		…
729	because it will stall the whole program, and the whole point of using	1064	because it will stall the whole program, and the whole point of using
730	events is to stay interactive.	1065	events is to stay interactive.
731		1066
732	It is fine, however, to call C<< ->recv >> when the user of your module	1067	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	1068	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 >>	1069	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).	1070	freely, as the user of your module knows what she is doing. Always).
736		1071
737	=head1 WHAT TO DO IN THE MAIN PROGRAM	1072	=head1 WHAT TO DO IN THE MAIN PROGRAM
738		1073
739	There will always be a single main program - the only place that should	1074	There will always be a single main program - the only place that should
740	dictate which event model to use.	1075	dictate which event model to use.
741		1076
742	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1077	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	1078	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.	1079	uses AnyEvent, but does not care which event loop is used, all it needs
		1080	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1081	available loop implementation.
745		1082
746	If the main program relies on a specific event model - for example, in	1083	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	1084	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	1085	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	1086	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	1087	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	1088	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.	1089	might choose the wrong one unless you load the correct one yourself.
753		1090
754	You can chose to use a pure-perl implementation by loading the	1091	You can chose to use a pure-perl implementation by loading the
755	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1092	C<AnyEvent::Loop> module, which gives you similar behaviour
756	everywhere, but letting AnyEvent chose the model is generally better.	1093	everywhere, but letting AnyEvent chose the model is generally better.
757		1094
758	=head2 MAINLOOP EMULATION	1095	=head2 MAINLOOP EMULATION
759		1096
760	Sometimes (often for short test scripts, or even standalone programs who	1097	Sometimes (often for short test scripts, or even standalone programs who
…		…
773		1110
774		1111
775	=head1 OTHER MODULES	1112	=head1 OTHER MODULES
776		1113
777	The following is a non-exhaustive list of additional modules that use	1114	The following is a non-exhaustive list of additional modules that use
778	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1115	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
779	in the same program. Some of the modules come with AnyEvent, some are	1116	modules and other event loops in the same program. Some of the modules
780	available via CPAN.	1117	come as part of AnyEvent, the others are available via CPAN.
781		1118
782	=over 4	1119	=over 4
783		1120
784	=item L<AnyEvent::Util>	1121	=item L<AnyEvent::Util>
785		1122
786	Contains various utility functions that replace often-used but blocking	1123	Contains various utility functions that replace often-used blocking
787	functions such as C<inet_aton> by event-/callback-based versions.	1124	functions such as C<inet_aton> with event/callback-based versions.
788		1125
789	=item L<AnyEvent::Socket>	1126	=item L<AnyEvent::Socket>
790		1127
791	Provides various utility functions for (internet protocol) sockets,	1128	Provides various utility functions for (internet protocol) sockets,
792	addresses and name resolution. Also functions to create non-blocking tcp	1129	addresses and name resolution. Also functions to create non-blocking tcp
…		…
794		1131
795	=item L<AnyEvent::Handle>	1132	=item L<AnyEvent::Handle>
796		1133
797	Provide read and write buffers, manages watchers for reads and writes,	1134	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	1135	supports raw and formatted I/O, I/O queued and fully transparent and
799	non-blocking SSL/TLS.	1136	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
800		1137
801	=item L<AnyEvent::DNS>	1138	=item L<AnyEvent::DNS>
802		1139
803	Provides rich asynchronous DNS resolver capabilities.	1140	Provides rich asynchronous DNS resolver capabilities.
804		1141
		1142	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1143
		1144	Implement event-based interfaces to the protocols of the same name (for
		1145	the curious, IGS is the International Go Server and FCP is the Freenet
		1146	Client Protocol).
		1147
		1148	=item L<AnyEvent::Handle::UDP>
		1149
		1150	Here be danger!
		1151
		1152	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1153	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1154	its use of a stream-based API with a protocol that isn't streamable, that
		1155	the only way to improve it is to delete it.
		1156
		1157	It features data corruption (but typically only under load) and general
		1158	confusion. On top, the author is not only clueless about UDP but also
		1159	fact-resistant - some gems of his understanding: "connect doesn't work
		1160	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1161	packets", "I don't need to implement proper error checking as UDP doesn't
		1162	support error checking" and so on - he doesn't even understand what's
		1163	wrong with his module when it is explained to him.
		1164
805	=item L<AnyEvent::HTTP>	1165	=item L<AnyEvent::DBI>
806		1166
807	A simple-to-use HTTP library that is capable of making a lot of concurrent	1167	Executes L<DBI> requests asynchronously in a proxy process for you,
808	HTTP requests.	1168	notifying you in an event-based way when the operation is finished.
		1169
		1170	=item L<AnyEvent::AIO>
		1171
		1172	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1173	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1174	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1175	file I/O, and much more.
809		1176
810	=item L<AnyEvent::HTTPD>	1177	=item L<AnyEvent::HTTPD>
811		1178
812	Provides a simple web application server framework.	1179	A simple embedded webserver.
813		1180
814	=item L<AnyEvent::FastPing>	1181	=item L<AnyEvent::FastPing>
815		1182
816	The fastest ping in the west.	1183	The fastest ping in the west.
817		1184
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>	1185	=item L<Coro>
860		1186
861	Has special support for AnyEvent via L<Coro::AnyEvent>.	1187	Has special support for AnyEvent via L<Coro::AnyEvent>.
862		1188
863	=item L<IO::Lambda>
864
865	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
866
867	=back	1189	=back
868		1190
869	=cut	1191	=cut
870		1192
871	package AnyEvent;	1193	package AnyEvent;
872		1194
873	no warnings;	1195	# basically a tuned-down version of common::sense
874	use strict qw(vars subs);	1196	sub common_sense {
		1197	# from common:.sense 3.4
		1198	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
		1199	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
		1200	$^H |= 0x00000600;
		1201	}
875		1202
		1203	BEGIN { AnyEvent::common_sense }
		1204
876	use Carp;	1205	use Carp ();
877		1206
878	our $VERSION = 4.35;	1207	our $VERSION = '5.34';
879	our $MODEL;	1208	our $MODEL;
880		1209
881	our $AUTOLOAD;	1210	our $AUTOLOAD;
882	our @ISA;	1211	our @ISA;
883		1212
884	our @REGISTRY;	1213	our @REGISTRY;
885		1214
886	our $WIN32;	1215	our $VERBOSE;
887		1216
888	BEGIN {	1217	BEGIN {
889	my $win32 = ! ! ($^O =~ /mswin32/i);	1218	require "AnyEvent/constants.pl";
890	eval "sub WIN32(){ $win32 }";
891	}
892		1219
		1220	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
		1221
		1222	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1223	if ${^TAINT};
		1224
893	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1225	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1226
		1227	}
		1228
		1229	our $MAX_SIGNAL_LATENCY = 10;
894		1230
895	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1231	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
896		1232
897	{	1233	{
898	my $idx;	1234	my $idx;
…		…
900	for reverse split /\s*,\s*/,	1236	for reverse split /\s*,\s*/,
901	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1237	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
902	}	1238	}
903		1239
904	my @models = (	1240	my @models = (
905	[EV:: => AnyEvent::Impl::EV::],	1241	[EV:: => AnyEvent::Impl::EV:: , 1],
906	[Event:: => AnyEvent::Impl::Event::],	1242	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
907	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
908	# everything below here will not be autoprobed	1243	# everything below here will not (normally) be autoprobed
909	# as the pureperl backend should work everywhere	1244	# as the pure perl backend should work everywhere
910	# and is usually faster	1245	# and is usually faster
		1246	[Event:: => AnyEvent::Impl::Event::, 1],
		1247	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1248	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1249	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
911	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1250	[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	1251	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
915	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1252	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
916	[Wx:: => AnyEvent::Impl::POE::],	1253	[Wx:: => AnyEvent::Impl::POE::],
917	[Prima:: => AnyEvent::Impl::POE::],	1254	[Prima:: => AnyEvent::Impl::POE::],
		1255	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::],
		1256	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
		1257	[FLTK:: => AnyEvent::Impl::FLTK::],
918	);	1258	);
919		1259
920	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);	1260	our %method = map +($_ => 1),
		1261	qw(io timer time now now_update signal child idle condvar DESTROY);
921		1262
922	our @post_detect;	1263	our @post_detect;
923		1264
924	sub post_detect(&) {	1265	sub post_detect(&) {
925	my ($cb) = @_;	1266	my ($cb) = @_;
926		1267
927	if ($MODEL) {
928	$cb->();
929
930	1
931	} else {
932	push @post_detect, $cb;	1268	push @post_detect, $cb;
933		1269
934	defined wantarray	1270	defined wantarray
935	? bless \$cb, "AnyEvent::Util::PostDetect"	1271	? bless \$cb, "AnyEvent::Util::postdetect"
936	: ()	1272	: ()
		1273	}
		1274
		1275	sub AnyEvent::Util::postdetect::DESTROY {
		1276	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1277	}
		1278
		1279	sub detect() {
		1280	# free some memory
		1281	*detect = sub () { $MODEL };
		1282
		1283	local $!; # for good measure
		1284	local $SIG{__DIE__};
		1285
		1286	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1287	my $model = "AnyEvent::Impl::$1";
		1288	if (eval "require $model") {
		1289	$MODEL = $model;
		1290	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1291	} else {
		1292	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1293	}
937	}	1294	}
938	}
939		1295
940	sub AnyEvent::Util::PostDetect::DESTROY {	1296	# check for already loaded models
941	@post_detect = grep $_ != ${$_[0]}, @post_detect;
942	}
943
944	sub detect() {
945	unless ($MODEL) {	1297	unless ($MODEL) {
946	no strict 'refs';	1298	for (@REGISTRY, @models) {
947	local $SIG{__DIE__};	1299	my ($package, $model) = @$_;
948		1300	if (${"$package\::VERSION"} > 0) {
949	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
950	my $model = "AnyEvent::Impl::$1";
951	if (eval "require $model") {	1301	if (eval "require $model") {
952	$MODEL = $model;	1302	$MODEL = $model;
953	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1303	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
954	} else {	1304	last;
955	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1305	}
956	}	1306	}
957	}	1307	}
958		1308
959	# check for already loaded models
960	unless ($MODEL) {	1309	unless ($MODEL) {
		1310	# try to autoload a model
961	for (@REGISTRY, @models) {	1311	for (@REGISTRY, @models) {
962	my ($package, $model) = @$_;	1312	my ($package, $model, $autoload) = @$_;
		1313	if (
		1314	$autoload
		1315	and eval "require $package"
963	if (${"$package\::VERSION"} > 0) {	1316	and ${"$package\::VERSION"} > 0
964	if (eval "require $model") {	1317	and eval "require $model"
		1318	) {
965	$MODEL = $model;	1319	$MODEL = $model;
966	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1320	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
967	last;	1321	last;
968	}
969	}	1322	}
970	}	1323	}
971		1324
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	1325	$MODEL
987	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1326	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
988	}
989	}	1327	}
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	}	1328	}
		1329
		1330	@models = (); # free probe data
		1331
		1332	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1333	unshift @ISA, $MODEL;
		1334
		1335	# now nuke some methods that are overridden by the backend.
		1336	# SUPER is not allowed.
		1337	for (qw(time signal child idle)) {
		1338	undef &{"AnyEvent::Base::$_"}
		1339	if defined &{"$MODEL\::$_"};
		1340	}
		1341
		1342	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1343	eval { require AnyEvent::Strict };
		1344	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
		1345	if $@ && $VERBOSE;
		1346	}
		1347
		1348	(shift @post_detect)->() while @post_detect;
		1349
		1350	*post_detect = sub(&) {
		1351	shift->();
		1352
		1353	undef
		1354	};
999		1355
1000	$MODEL	1356	$MODEL
1001	}	1357	}
1002		1358
1003	sub AUTOLOAD {	1359	sub AUTOLOAD {
1004	(my $func = $AUTOLOAD) =~ s/.*://;	1360	(my $func = $AUTOLOAD) =~ s/.*://;
1005		1361
1006	$method{$func}	1362	$method{$func}
1007	or croak "$func: not a valid method for AnyEvent objects";	1363	or Carp::croak "$func: not a valid AnyEvent class method";
1008		1364
1009	detect unless $MODEL;	1365	detect;
1010		1366
1011	my $class = shift;	1367	my $class = shift;
1012	$class->$func (@_);	1368	$class->$func (@_);
		1369	}
		1370
		1371	our $POSTPONE_W;
		1372	our @POSTPONE;
		1373
		1374	sub _postpone_exec {
		1375	undef $POSTPONE_W;
		1376	(pop @POSTPONE)->()
		1377	while @POSTPONE;
		1378	}
		1379
		1380	sub postpone(&) {
		1381	push @POSTPONE, shift;
		1382
		1383	$POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
		1384
		1385	()
1013	}	1386	}
1014		1387
1015	# utility function to dup a filehandle. this is used by many backends	1388	# utility function to dup a filehandle. this is used by many backends
1016	# to support binding more than one watcher per filehandle (they usually	1389	# 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).	1390	# allow only one watcher per fd, so we dup it to get a different one).
1018	sub _dupfh($$$$) {	1391	sub _dupfh($$;$$) {
1019	my ($poll, $fh, $r, $w) = @_;	1392	my ($poll, $fh, $r, $w) = @_;
1020		1393
1021	# cygwin requires the fh mode to be matching, unix doesn't	1394	# cygwin requires the fh mode to be matching, unix doesn't
1022	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1395	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		1396
1026	open my $fh2, "$mode&" . fileno $fh	1397	open my $fh2, $mode, $fh
1027	or die "cannot dup() filehandle: $!";	1398	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1028		1399
1029	# we assume CLOEXEC is already set by perl in all important cases	1400	# we assume CLOEXEC is already set by perl in all important cases
1030		1401
1031	($fh2, $rw)	1402	($fh2, $rw)
1032	}	1403	}
1033		1404
		1405	=head1 SIMPLIFIED AE API
		1406
		1407	Starting with version 5.0, AnyEvent officially supports a second, much
		1408	simpler, API that is designed to reduce the calling, typing and memory
		1409	overhead by using function call syntax and a fixed number of parameters.
		1410
		1411	See the L<AE> manpage for details.
		1412
		1413	=cut
		1414
		1415	package AE;
		1416
		1417	our $VERSION = $AnyEvent::VERSION;
		1418
		1419	# fall back to the main API by default - backends and AnyEvent::Base
		1420	# implementations can overwrite these.
		1421
		1422	sub io($$$) {
		1423	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1424	}
		1425
		1426	sub timer($$$) {
		1427	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1428	}
		1429
		1430	sub signal($$) {
		1431	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1432	}
		1433
		1434	sub child($$) {
		1435	AnyEvent->child (pid => $_[0], cb => $_[1])
		1436	}
		1437
		1438	sub idle($) {
		1439	AnyEvent->idle (cb => $_[0])
		1440	}
		1441
		1442	sub cv(;&) {
		1443	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1444	}
		1445
		1446	sub now() {
		1447	AnyEvent->now
		1448	}
		1449
		1450	sub now_update() {
		1451	AnyEvent->now_update
		1452	}
		1453
		1454	sub time() {
		1455	AnyEvent->time
		1456	}
		1457
		1458	*postpone = \&AnyEvent::postpone;
		1459
1034	package AnyEvent::Base;	1460	package AnyEvent::Base;
1035		1461
1036	# default implementation for now and time	1462	# default implementations for many methods
1037		1463
1038	BEGIN {	1464	sub time {
		1465	eval q{ # poor man's autoloading {}
		1466	# probe for availability of Time::HiRes
1039	if (eval "use Time::HiRes (); time (); 1") {	1467	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1468	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1040	*_time = \&Time::HiRes::time;	1469	*AE::time = \&Time::HiRes::time;
1041	# if (eval "use POSIX (); (POSIX::times())...	1470	# if (eval "use POSIX (); (POSIX::times())...
1042	} else {	1471	} else {
		1472	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1043	*_time = sub { time }; # epic fail	1473	*AE::time = sub (){ time }; # epic fail
		1474	}
		1475
		1476	*time = sub { AE::time }; # different prototypes
		1477	};
		1478	die if $@;
		1479
		1480	&time
		1481	}
		1482
		1483	*now = \&time;
		1484
		1485	sub now_update { }
		1486
		1487	sub _poll {
		1488	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1489	}
		1490
		1491	# default implementation for ->condvar
		1492	# in fact, the default should not be overwritten
		1493
		1494	sub condvar {
		1495	eval q{ # poor man's autoloading {}
		1496	*condvar = sub {
		1497	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1498	};
		1499
		1500	*AE::cv = sub (;&) {
		1501	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1502	};
		1503	};
		1504	die if $@;
		1505
		1506	&condvar
		1507	}
		1508
		1509	# default implementation for ->signal
		1510
		1511	our $HAVE_ASYNC_INTERRUPT;
		1512
		1513	sub _have_async_interrupt() {
		1514	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1515	&& eval "use Async::Interrupt 1.02 (); 1")
		1516	unless defined $HAVE_ASYNC_INTERRUPT;
		1517
		1518	$HAVE_ASYNC_INTERRUPT
		1519	}
		1520
		1521	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1522	our (%SIG_ASY, %SIG_ASY_W);
		1523	our ($SIG_COUNT, $SIG_TW);
		1524
		1525	# install a dummy wakeup watcher to reduce signal catching latency
		1526	# used by Impls
		1527	sub _sig_add() {
		1528	unless ($SIG_COUNT++) {
		1529	# try to align timer on a full-second boundary, if possible
		1530	my $NOW = AE::now;
		1531
		1532	$SIG_TW = AE::timer
		1533	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1534	$MAX_SIGNAL_LATENCY,
		1535	sub { } # just for the PERL_ASYNC_CHECK
		1536	;
1044	}	1537	}
1045	}	1538	}
1046		1539
1047	sub time { _time }	1540	sub _sig_del {
1048	sub now { _time }	1541	undef $SIG_TW
1049		1542	unless --$SIG_COUNT;
1050	# default implementation for ->condvar
1051
1052	sub condvar {
1053	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
1054	}	1543	}
1055		1544
1056	# default implementation for ->signal	1545	our $_sig_name_init; $_sig_name_init = sub {
		1546	eval q{ # poor man's autoloading {}
		1547	undef $_sig_name_init;
1057		1548
1058	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1549	if (_have_async_interrupt) {
		1550	*sig2num = \&Async::Interrupt::sig2num;
		1551	*sig2name = \&Async::Interrupt::sig2name;
		1552	} else {
		1553	require Config;
1059		1554
1060	sub _signal_exec {	1555	my %signame2num;
1061	sysread $SIGPIPE_R, my $dummy, 4;	1556	@signame2num{ split ' ', $Config::Config{sig_name} }
		1557	= split ' ', $Config::Config{sig_num};
1062		1558
1063	while (%SIG_EV) {	1559	my @signum2name;
1064	for (keys %SIG_EV) {	1560	@signum2name[values %signame2num] = keys %signame2num;
1065	delete $SIG_EV{$_};	1561
1066	$_->() for values %{ $SIG_CB{$_} || {} };	1562	*sig2num = sub($) {
		1563	$_[0] > 0 ? shift : $signame2num{+shift}
		1564	};
		1565	*sig2name = sub ($) {
		1566	$_[0] > 0 ? $signum2name[+shift] : shift
		1567	};
1067	}	1568	}
1068	}	1569	};
1069	}	1570	die if $@;
		1571	};
		1572
		1573	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1574	sub sig2name($) { &$_sig_name_init; &sig2name }
1070		1575
1071	sub signal {	1576	sub signal {
1072	my (undef, %arg) = @_;	1577	eval q{ # poor man's autoloading {}
		1578	# probe for availability of Async::Interrupt
		1579	if (_have_async_interrupt) {
		1580	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1073		1581
1074	unless ($SIGPIPE_R) {	1582	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1075	require Fcntl;	1583	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1076		1584
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 {	1585	} else {
		1586	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1587
		1588	if (AnyEvent::WIN32) {
		1589	require AnyEvent::Util;
		1590
		1591	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1592	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1593	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1594	} else {
1084	pipe $SIGPIPE_R, $SIGPIPE_W;	1595	pipe $SIGPIPE_R, $SIGPIPE_W;
1085	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1596	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	1597	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
		1598
		1599	# not strictly required, as $^F is normally 2, but let's make sure...
		1600	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1601	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1602	}
		1603
		1604	$SIGPIPE_R
		1605	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1606
		1607	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1087	}	1608	}
1088		1609
1089	$SIGPIPE_R	1610	*signal = $HAVE_ASYNC_INTERRUPT
1090	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1611	? sub {
		1612	my (undef, %arg) = @_;
1091		1613
1092	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1614	# async::interrupt
1093	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1094
1095	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1096	}
1097
1098	my $signal = uc $arg{signal}	1615	my $signal = sig2num $arg{signal};
1099	or Carp::croak "required option 'signal' is missing";
1100
1101	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1616	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1617
		1618	$SIG_ASY{$signal} ||= new Async::Interrupt
		1619	cb => sub { undef $SIG_EV{$signal} },
		1620	signal => $signal,
		1621	pipe => [$SIGPIPE_R->filenos],
		1622	pipe_autodrain => 0,
		1623	;
		1624
		1625	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1626	}
		1627	: sub {
		1628	my (undef, %arg) = @_;
		1629
		1630	# pure perl
		1631	my $signal = sig2name $arg{signal};
		1632	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1633
1102	$SIG{$signal} ||= sub {	1634	$SIG{$signal} ||= sub {
		1635	local $!;
1103	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1636	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1104	undef $SIG_EV{$signal};	1637	undef $SIG_EV{$signal};
		1638	};
		1639
		1640	# can't do signal processing without introducing races in pure perl,
		1641	# so limit the signal latency.
		1642	_sig_add;
		1643
		1644	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1645	}
		1646	;
		1647
		1648	*AnyEvent::Base::signal::DESTROY = sub {
		1649	my ($signal, $cb) = @{$_[0]};
		1650
		1651	_sig_del;
		1652
		1653	delete $SIG_CB{$signal}{$cb};
		1654
		1655	$HAVE_ASYNC_INTERRUPT
		1656	? delete $SIG_ASY{$signal}
		1657	: # delete doesn't work with older perls - they then
		1658	# print weird messages, or just unconditionally exit
		1659	# instead of getting the default action.
		1660	undef $SIG{$signal}
		1661	unless keys %{ $SIG_CB{$signal} };
		1662	};
		1663
		1664	*_signal_exec = sub {
		1665	$HAVE_ASYNC_INTERRUPT
		1666	? $SIGPIPE_R->drain
		1667	: sysread $SIGPIPE_R, (my $dummy), 9;
		1668
		1669	while (%SIG_EV) {
		1670	for (keys %SIG_EV) {
		1671	delete $SIG_EV{$_};
		1672	$_->() for values %{ $SIG_CB{$_} || {} };
		1673	}
		1674	}
		1675	};
1105	};	1676	};
		1677	die if $@;
1106		1678
1107	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1679	&signal
1108	}
1109
1110	sub AnyEvent::Base::Signal::DESTROY {
1111	my ($signal, $cb) = @{$_[0]};
1112
1113	delete $SIG_CB{$signal}{$cb};
1114
1115	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1116	}	1680	}
1117		1681
1118	# default implementation for ->child	1682	# default implementation for ->child
1119		1683
1120	our %PID_CB;	1684	our %PID_CB;
1121	our $CHLD_W;	1685	our $CHLD_W;
1122	our $CHLD_DELAY_W;	1686	our $CHLD_DELAY_W;
1123	our $PID_IDLE;
1124	our $WNOHANG;
1125		1687
1126	sub _child_wait {	1688	# used by many Impl's
1127	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1689	sub _emit_childstatus($$) {
		1690	my (undef, $rpid, $rstatus) = @_;
		1691
		1692	$_->($rpid, $rstatus)
1128	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1693	for values %{ $PID_CB{$rpid} || {} },
1129	(values %{ $PID_CB{0} || {} });	1694	values %{ $PID_CB{0} || {} };
1130	}
1131
1132	undef $PID_IDLE;
1133	}
1134
1135	sub _sigchld {
1136	# make sure we deliver these changes "synchronous" with the event loop.
1137	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1138	undef $CHLD_DELAY_W;
1139	&_child_wait;
1140	});
1141	}	1695	}
1142		1696
1143	sub child {	1697	sub child {
		1698	eval q{ # poor man's autoloading {}
		1699	*_sigchld = sub {
		1700	my $pid;
		1701
		1702	AnyEvent->_emit_childstatus ($pid, $?)
		1703	while ($pid = waitpid -1, WNOHANG) > 0;
		1704	};
		1705
		1706	*child = sub {
1144	my (undef, %arg) = @_;	1707	my (undef, %arg) = @_;
1145		1708
1146	defined (my $pid = $arg{pid} + 0)	1709	my $pid = $arg{pid};
1147	or Carp::croak "required option 'pid' is missing";	1710	my $cb = $arg{cb};
1148		1711
1149	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1712	$PID_CB{$pid}{$cb+0} = $cb;
1150		1713
1151	unless ($WNOHANG) {
1152	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1153	}
1154
1155	unless ($CHLD_W) {	1714	unless ($CHLD_W) {
1156	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1715	$CHLD_W = AE::signal CHLD => \&_sigchld;
1157	# child could be a zombie already, so make at least one round	1716	# child could be a zombie already, so make at least one round
1158	&_sigchld;	1717	&_sigchld;
1159	}	1718	}
1160		1719
1161	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1720	bless [$pid, $cb+0], "AnyEvent::Base::child"
1162	}	1721	};
1163		1722
1164	sub AnyEvent::Base::Child::DESTROY {	1723	*AnyEvent::Base::child::DESTROY = sub {
1165	my ($pid, $cb) = @{$_[0]};	1724	my ($pid, $icb) = @{$_[0]};
1166		1725
1167	delete $PID_CB{$pid}{$cb};	1726	delete $PID_CB{$pid}{$icb};
1168	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1727	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1169		1728
1170	undef $CHLD_W unless keys %PID_CB;	1729	undef $CHLD_W unless keys %PID_CB;
		1730	};
		1731	};
		1732	die if $@;
		1733
		1734	&child
		1735	}
		1736
		1737	# idle emulation is done by simply using a timer, regardless
		1738	# of whether the process is idle or not, and not letting
		1739	# the callback use more than 50% of the time.
		1740	sub idle {
		1741	eval q{ # poor man's autoloading {}
		1742	*idle = sub {
		1743	my (undef, %arg) = @_;
		1744
		1745	my ($cb, $w, $rcb) = $arg{cb};
		1746
		1747	$rcb = sub {
		1748	if ($cb) {
		1749	$w = _time;
		1750	&$cb;
		1751	$w = _time - $w;
		1752
		1753	# never use more then 50% of the time for the idle watcher,
		1754	# within some limits
		1755	$w = 0.0001 if $w < 0.0001;
		1756	$w = 5 if $w > 5;
		1757
		1758	$w = AE::timer $w, 0, $rcb;
		1759	} else {
		1760	# clean up...
		1761	undef $w;
		1762	undef $rcb;
		1763	}
		1764	};
		1765
		1766	$w = AE::timer 0.05, 0, $rcb;
		1767
		1768	bless \\$cb, "AnyEvent::Base::idle"
		1769	};
		1770
		1771	*AnyEvent::Base::idle::DESTROY = sub {
		1772	undef $${$_[0]};
		1773	};
		1774	};
		1775	die if $@;
		1776
		1777	&idle
1171	}	1778	}
1172		1779
1173	package AnyEvent::CondVar;	1780	package AnyEvent::CondVar;
1174		1781
1175	our @ISA = AnyEvent::CondVar::Base::;	1782	our @ISA = AnyEvent::CondVar::Base::;
1176		1783
		1784	# only to be used for subclassing
		1785	sub new {
		1786	my $class = shift;
		1787	bless AnyEvent->condvar (@_), $class
		1788	}
		1789
1177	package AnyEvent::CondVar::Base;	1790	package AnyEvent::CondVar::Base;
1178		1791
1179	use overload	1792	#use overload
1180	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1793	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1181	fallback => 1;	1794	# fallback => 1;
		1795
		1796	# save 300+ kilobytes by dirtily hardcoding overloading
		1797	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1798	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1799	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1800	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1801
		1802	our $WAITING;
1182		1803
1183	sub _send {	1804	sub _send {
1184	# nop	1805	# nop
		1806	}
		1807
		1808	sub _wait {
		1809	AnyEvent->_poll until $_[0]{_ae_sent};
1185	}	1810	}
1186		1811
1187	sub send {	1812	sub send {
1188	my $cv = shift;	1813	my $cv = shift;
1189	$cv->{_ae_sent} = [@_];	1814	$cv->{_ae_sent} = [@_];
…		…
1198		1823
1199	sub ready {	1824	sub ready {
1200	$_[0]{_ae_sent}	1825	$_[0]{_ae_sent}
1201	}	1826	}
1202		1827
1203	sub _wait {
1204	AnyEvent->one_event while !$_[0]{_ae_sent};
1205	}
1206
1207	sub recv {	1828	sub recv {
		1829	unless ($_[0]{_ae_sent}) {
		1830	$WAITING
		1831	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1832
		1833	local $WAITING = 1;
1208	$_[0]->_wait;	1834	$_[0]->_wait;
		1835	}
1209		1836
1210	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1837	$_[0]{_ae_croak}
1211	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1838	and Carp::croak $_[0]{_ae_croak};
		1839
		1840	wantarray
		1841	? @{ $_[0]{_ae_sent} }
		1842	: $_[0]{_ae_sent}[0]
1212	}	1843	}
1213		1844
1214	sub cb {	1845	sub cb {
1215	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1846	my $cv = shift;
		1847
		1848	@_
		1849	and $cv->{_ae_cb} = shift
		1850	and $cv->{_ae_sent}
		1851	and (delete $cv->{_ae_cb})->($cv);
		1852
1216	$_[0]{_ae_cb}	1853	$cv->{_ae_cb}
1217	}	1854	}
1218		1855
1219	sub begin {	1856	sub begin {
1220	++$_[0]{_ae_counter};	1857	++$_[0]{_ae_counter};
1221	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1858	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1226	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	1863	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1227	}	1864	}
1228		1865
1229	# undocumented/compatibility with pre-3.4	1866	# undocumented/compatibility with pre-3.4
1230	*broadcast = \&send;	1867	*broadcast = \&send;
1231	*wait = \&_wait;	1868	*wait = \&recv;
1232		1869
1233	=head1 ERROR AND EXCEPTION HANDLING	1870	=head1 ERROR AND EXCEPTION HANDLING
1234		1871
1235	In general, AnyEvent does not do any error handling - it relies on the	1872	In general, AnyEvent does not do any error handling - it relies on the
1236	caller to do that if required. The L<AnyEvent::Strict> module (see also	1873	caller to do that if required. The L<AnyEvent::Strict> module (see also
…		…
1249	so on.	1886	so on.
1250		1887
1251	=head1 ENVIRONMENT VARIABLES	1888	=head1 ENVIRONMENT VARIABLES
1252		1889
1253	The following environment variables are used by this module or its	1890	The following environment variables are used by this module or its
1254	submodules:	1891	submodules.
		1892
		1893	Note that AnyEvent will remove I<all> environment variables starting with
		1894	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1895	enabled.
1255		1896
1256	=over 4	1897	=over 4
1257		1898
1258	=item C<PERL_ANYEVENT_VERBOSE>	1899	=item C<PERL_ANYEVENT_VERBOSE>
1259		1900
…		…
1266	C<PERL_ANYEVENT_MODEL>.	1907	C<PERL_ANYEVENT_MODEL>.
1267		1908
1268	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1909	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1269	model it chooses.	1910	model it chooses.
1270		1911
		1912	When set to C<8> or higher, then AnyEvent will report extra information on
		1913	which optional modules it loads and how it implements certain features.
		1914
1271	=item C<PERL_ANYEVENT_STRICT>	1915	=item C<PERL_ANYEVENT_STRICT>
1272		1916
1273	AnyEvent does not do much argument checking by default, as thorough	1917	AnyEvent does not do much argument checking by default, as thorough
1274	argument checking is very costly. Setting this variable to a true value	1918	argument checking is very costly. Setting this variable to a true value
1275	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1919	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1276	check the arguments passed to most method calls. If it finds any problems	1920	check the arguments passed to most method calls. If it finds any problems,
1277	it will croak.	1921	it will croak.
1278		1922
1279	In other words, enables "strict" mode.	1923	In other words, enables "strict" mode.
1280		1924
1281	Unlike C<use strict>, it is definitely recommended ot keep it off in	1925	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1282	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1926	>>, it is definitely recommended to keep it off in production. Keeping
1283	developing programs can be very useful, however.	1927	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1928	can be very useful, however.
1284		1929
1285	=item C<PERL_ANYEVENT_MODEL>	1930	=item C<PERL_ANYEVENT_MODEL>
1286		1931
1287	This can be used to specify the event model to be used by AnyEvent, before	1932	This can be used to specify the event model to be used by AnyEvent, before
1288	auto detection and -probing kicks in. It must be a string consisting	1933	auto detection and -probing kicks in. It must be a string consisting
…		…
1291	used as event model. If it fails to load AnyEvent will proceed with	1936	used as event model. If it fails to load AnyEvent will proceed with
1292	auto detection and -probing.	1937	auto detection and -probing.
1293		1938
1294	This functionality might change in future versions.	1939	This functionality might change in future versions.
1295		1940
1296	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	1941	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1297	could start your program like this:	1942	could start your program like this:
1298		1943
1299	PERL_ANYEVENT_MODEL=Perl perl ...	1944	PERL_ANYEVENT_MODEL=Perl perl ...
1300		1945
1301	=item C<PERL_ANYEVENT_PROTOCOLS>	1946	=item C<PERL_ANYEVENT_PROTOCOLS>
…		…
1331		1976
1332	=item C<PERL_ANYEVENT_MAX_FORKS>	1977	=item C<PERL_ANYEVENT_MAX_FORKS>
1333		1978
1334	The maximum number of child processes that C<AnyEvent::Util::fork_call>	1979	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1335	will create in parallel.	1980	will create in parallel.
		1981
		1982	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1983
		1984	The default value for the C<max_outstanding> parameter for the default DNS
		1985	resolver - this is the maximum number of parallel DNS requests that are
		1986	sent to the DNS server.
		1987
		1988	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1989
		1990	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1991	configuration) in the default resolver. When set to the empty string, no
		1992	default config will be used.
		1993
		1994	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1995
		1996	When neither C<ca_file> nor C<ca_path> was specified during
		1997	L<AnyEvent::TLS> context creation, and either of these environment
		1998	variables exist, they will be used to specify CA certificate locations
		1999	instead of a system-dependent default.
		2000
		2001	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		2002
		2003	When these are set to C<1>, then the respective modules are not
		2004	loaded. Mostly good for testing AnyEvent itself.
1336		2005
1337	=back	2006	=back
1338		2007
1339	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	2008	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1340		2009
…		…
1398	warn "read: $input\n"; # output what has been read	2067	warn "read: $input\n"; # output what has been read
1399	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2068	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1400	},	2069	},
1401	);	2070	);
1402		2071
1403	my $time_watcher; # can only be used once
1404
1405	sub new_timer {
1406	$timer = AnyEvent->timer (after => 1, cb => sub {	2072	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1407	warn "timeout\n"; # print 'timeout' about every second	2073	warn "timeout\n"; # print 'timeout' at most every second
1408	&new_timer; # and restart the time
1409	});	2074	});
1410	}
1411
1412	new_timer; # create first timer
1413		2075
1414	$cv->recv; # wait until user enters /^q/i	2076	$cv->recv; # wait until user enters /^q/i
1415		2077
1416	=head1 REAL-WORLD EXAMPLE	2078	=head1 REAL-WORLD EXAMPLE
1417		2079
…		…
1490		2152
1491	The actual code goes further and collects all errors (C<die>s, exceptions)	2153	The actual code goes further and collects all errors (C<die>s, exceptions)
1492	that occurred during request processing. The C<result> method detects	2154	that occurred during request processing. The C<result> method detects
1493	whether an exception as thrown (it is stored inside the $txn object)	2155	whether an exception as thrown (it is stored inside the $txn object)
1494	and just throws the exception, which means connection errors and other	2156	and just throws the exception, which means connection errors and other
1495	problems get reported tot he code that tries to use the result, not in a	2157	problems get reported to the code that tries to use the result, not in a
1496	random callback.	2158	random callback.
1497		2159
1498	All of this enables the following usage styles:	2160	All of this enables the following usage styles:
1499		2161
1500	1. Blocking:	2162	1. Blocking:
…		…
1548	through AnyEvent. The benchmark creates a lot of timers (with a zero	2210	through AnyEvent. The benchmark creates a lot of timers (with a zero
1549	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2211	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1550	which it is), lets them fire exactly once and destroys them again.	2212	which it is), lets them fire exactly once and destroys them again.
1551		2213
1552	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2214	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1553	distribution.	2215	distribution. It uses the L<AE> interface, which makes a real difference
		2216	for the EV and Perl backends only.
1554		2217
1555	=head3 Explanation of the columns	2218	=head3 Explanation of the columns
1556		2219
1557	I<watcher> is the number of event watchers created/destroyed. Since	2220	I<watcher> is the number of event watchers created/destroyed. Since
1558	different event models feature vastly different performances, each event	2221	different event models feature vastly different performances, each event
…		…
1579	watcher.	2242	watcher.
1580		2243
1581	=head3 Results	2244	=head3 Results
1582		2245
1583	name watchers bytes create invoke destroy comment	2246	name watchers bytes create invoke destroy comment
1584	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2247	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1585	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2248	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1586	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2249	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1587	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2250	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1588	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2251	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1589	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2252	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
		2253	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
		2254	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1590	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2255	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1591	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2256	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1592	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2257	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1593	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2258	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1594		2259
1595	=head3 Discussion	2260	=head3 Discussion
1596		2261
1597	The benchmark does I<not> measure scalability of the event loop very	2262	The benchmark does I<not> measure scalability of the event loop very
1598	well. For example, a select-based event loop (such as the pure perl one)	2263	well. For example, a select-based event loop (such as the pure perl one)
…		…
1610	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2275	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1611	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2276	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1612	cycles with POE.	2277	cycles with POE.
1613		2278
1614	C<EV> is the sole leader regarding speed and memory use, which are both	2279	C<EV> is the sole leader regarding speed and memory use, which are both
1615	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2280	maximal/minimal, respectively. When using the L<AE> API there is zero
		2281	overhead (when going through the AnyEvent API create is about 5-6 times
		2282	slower, with other times being equal, so still uses far less memory than
1616	far less memory than any other event loop and is still faster than Event	2283	any other event loop and is still faster than Event natively).
1617	natively.
1618		2284
1619	The pure perl implementation is hit in a few sweet spots (both the	2285	The pure perl implementation is hit in a few sweet spots (both the
1620	constant timeout and the use of a single fd hit optimisations in the perl	2286	constant timeout and the use of a single fd hit optimisations in the perl
1621	interpreter and the backend itself). Nevertheless this shows that it	2287	interpreter and the backend itself). Nevertheless this shows that it
1622	adds very little overhead in itself. Like any select-based backend its	2288	adds very little overhead in itself. Like any select-based backend its
1623	performance becomes really bad with lots of file descriptors (and few of	2289	performance becomes really bad with lots of file descriptors (and few of
1624	them active), of course, but this was not subject of this benchmark.	2290	them active), of course, but this was not subject of this benchmark.
1625		2291
1626	The C<Event> module has a relatively high setup and callback invocation	2292	The C<Event> module has a relatively high setup and callback invocation
1627	cost, but overall scores in on the third place.	2293	cost, but overall scores in on the third place.
		2294
		2295	C<IO::Async> performs admirably well, about on par with C<Event>, even
		2296	when using its pure perl backend.
1628		2297
1629	C<Glib>'s memory usage is quite a bit higher, but it features a	2298	C<Glib>'s memory usage is quite a bit higher, but it features a
1630	faster callback invocation and overall ends up in the same class as	2299	faster callback invocation and overall ends up in the same class as
1631	C<Event>. However, Glib scales extremely badly, doubling the number of	2300	C<Event>. However, Glib scales extremely badly, doubling the number of
1632	watchers increases the processing time by more than a factor of four,	2301	watchers increases the processing time by more than a factor of four,
…		…
1693	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2362	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1694	(1%) are active. This mirrors the activity of large servers with many	2363	(1%) are active. This mirrors the activity of large servers with many
1695	connections, most of which are idle at any one point in time.	2364	connections, most of which are idle at any one point in time.
1696		2365
1697	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2366	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1698	distribution.	2367	distribution. It uses the L<AE> interface, which makes a real difference
		2368	for the EV and Perl backends only.
1699		2369
1700	=head3 Explanation of the columns	2370	=head3 Explanation of the columns
1701		2371
1702	I<sockets> is the number of sockets, and twice the number of "servers" (as	2372	I<sockets> is the number of sockets, and twice the number of "servers" (as
1703	each server has a read and write socket end).	2373	each server has a read and write socket end).
…		…
1710	it to another server. This includes deleting the old timeout and creating	2380	it to another server. This includes deleting the old timeout and creating
1711	a new one that moves the timeout into the future.	2381	a new one that moves the timeout into the future.
1712		2382
1713	=head3 Results	2383	=head3 Results
1714		2384
1715	name sockets create request	2385	name sockets create request
1716	EV 20000 69.01 11.16	2386	EV 20000 62.66 7.99
1717	Perl 20000 73.32 35.87	2387	Perl 20000 68.32 32.64
1718	Event 20000 212.62 257.32	2388	IOAsync 20000 174.06 101.15 epoll
1719	Glib 20000 651.16 1896.30	2389	IOAsync 20000 174.67 610.84 poll
		2390	Event 20000 202.69 242.91
		2391	Glib 20000 557.01 1689.52
1720	POE 20000 349.67 12317.24 uses POE::Loop::Event	2392	POE 20000 341.54 12086.32 uses POE::Loop::Event
1721		2393
1722	=head3 Discussion	2394	=head3 Discussion
1723		2395
1724	This benchmark I<does> measure scalability and overall performance of the	2396	This benchmark I<does> measure scalability and overall performance of the
1725	particular event loop.	2397	particular event loop.
…		…
1727	EV is again fastest. Since it is using epoll on my system, the setup time	2399	EV is again fastest. Since it is using epoll on my system, the setup time
1728	is relatively high, though.	2400	is relatively high, though.
1729		2401
1730	Perl surprisingly comes second. It is much faster than the C-based event	2402	Perl surprisingly comes second. It is much faster than the C-based event
1731	loops Event and Glib.	2403	loops Event and Glib.
		2404
		2405	IO::Async performs very well when using its epoll backend, and still quite
		2406	good compared to Glib when using its pure perl backend.
1732		2407
1733	Event suffers from high setup time as well (look at its code and you will	2408	Event suffers from high setup time as well (look at its code and you will
1734	understand why). Callback invocation also has a high overhead compared to	2409	understand why). Callback invocation also has a high overhead compared to
1735	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2410	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1736	uses select or poll in basically all documented configurations.	2411	uses select or poll in basically all documented configurations.
…		…
1799	=item * C-based event loops perform very well with small number of	2474	=item * C-based event loops perform very well with small number of
1800	watchers, as the management overhead dominates.	2475	watchers, as the management overhead dominates.
1801		2476
1802	=back	2477	=back
1803		2478
		2479	=head2 THE IO::Lambda BENCHMARK
		2480
		2481	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2482	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2483	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2484	shouldn't come as a surprise to anybody). As such, the benchmark is
		2485	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2486	very optimal. But how would AnyEvent compare when used without the extra
		2487	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2488
		2489	The benchmark itself creates an echo-server, and then, for 500 times,
		2490	connects to the echo server, sends a line, waits for the reply, and then
		2491	creates the next connection. This is a rather bad benchmark, as it doesn't
		2492	test the efficiency of the framework or much non-blocking I/O, but it is a
		2493	benchmark nevertheless.
		2494
		2495	name runtime
		2496	Lambda/select 0.330 sec
		2497	+ optimized 0.122 sec
		2498	Lambda/AnyEvent 0.327 sec
		2499	+ optimized 0.138 sec
		2500	Raw sockets/select 0.077 sec
		2501	POE/select, components 0.662 sec
		2502	POE/select, raw sockets 0.226 sec
		2503	POE/select, optimized 0.404 sec
		2504
		2505	AnyEvent/select/nb 0.085 sec
		2506	AnyEvent/EV/nb 0.068 sec
		2507	+state machine 0.134 sec
		2508
		2509	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2510	benchmarks actually make blocking connects and use 100% blocking I/O,
		2511	defeating the purpose of an event-based solution. All of the newly
		2512	written AnyEvent benchmarks use 100% non-blocking connects (using
		2513	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2514	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2515	generally require a lot more bookkeeping and event handling than blocking
		2516	connects (which involve a single syscall only).
		2517
		2518	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2519	offers similar expressive power as POE and IO::Lambda, using conventional
		2520	Perl syntax. This means that both the echo server and the client are 100%
		2521	non-blocking, further placing it at a disadvantage.
		2522
		2523	As you can see, the AnyEvent + EV combination even beats the
		2524	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2525	backend easily beats IO::Lambda and POE.
		2526
		2527	And even the 100% non-blocking version written using the high-level (and
		2528	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
		2529	higher level ("unoptimised") abstractions by a large margin, even though
		2530	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
		2531
		2532	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2533	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2534	part of the IO::Lambda distribution and were used without any changes.
		2535
1804		2536
1805	=head1 SIGNALS	2537	=head1 SIGNALS
1806		2538
1807	AnyEvent currently installs handlers for these signals:	2539	AnyEvent currently installs handlers for these signals:
1808		2540
…		…
1811	=item SIGCHLD	2543	=item SIGCHLD
1812		2544
1813	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2545	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1814	emulation for event loops that do not support them natively. Also, some	2546	emulation for event loops that do not support them natively. Also, some
1815	event loops install a similar handler.	2547	event loops install a similar handler.
		2548
		2549	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2550	AnyEvent will reset it to default, to avoid losing child exit statuses.
1816		2551
1817	=item SIGPIPE	2552	=item SIGPIPE
1818		2553
1819	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2554	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1820	when AnyEvent gets loaded.	2555	when AnyEvent gets loaded.
…		…
1832		2567
1833	=back	2568	=back
1834		2569
1835	=cut	2570	=cut
1836		2571
		2572	undef $SIG{CHLD}
		2573	if $SIG{CHLD} eq 'IGNORE';
		2574
1837	$SIG{PIPE} = sub { }	2575	$SIG{PIPE} = sub { }
1838	unless defined $SIG{PIPE};	2576	unless defined $SIG{PIPE};
1839		2577
		2578	=head1 RECOMMENDED/OPTIONAL MODULES
		2579
		2580	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2581	its built-in modules) are required to use it.
		2582
		2583	That does not mean that AnyEvent won't take advantage of some additional
		2584	modules if they are installed.
		2585
		2586	This section explains which additional modules will be used, and how they
		2587	affect AnyEvent's operation.
		2588
		2589	=over 4
		2590
		2591	=item L<Async::Interrupt>
		2592
		2593	This slightly arcane module is used to implement fast signal handling: To
		2594	my knowledge, there is no way to do completely race-free and quick
		2595	signal handling in pure perl. To ensure that signals still get
		2596	delivered, AnyEvent will start an interval timer to wake up perl (and
		2597	catch the signals) with some delay (default is 10 seconds, look for
		2598	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2599
		2600	If this module is available, then it will be used to implement signal
		2601	catching, which means that signals will not be delayed, and the event loop
		2602	will not be interrupted regularly, which is more efficient (and good for
		2603	battery life on laptops).
		2604
		2605	This affects not just the pure-perl event loop, but also other event loops
		2606	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2607
		2608	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2609	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2610	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2611	does nothing for those backends.
		2612
		2613	=item L<EV>
		2614
		2615	This module isn't really "optional", as it is simply one of the backend
		2616	event loops that AnyEvent can use. However, it is simply the best event
		2617	loop available in terms of features, speed and stability: It supports
		2618	the AnyEvent API optimally, implements all the watcher types in XS, does
		2619	automatic timer adjustments even when no monotonic clock is available,
		2620	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2621	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2622	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2623
		2624	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2625	then this module will do nothing for you.
		2626
		2627	=item L<Guard>
		2628
		2629	The guard module, when used, will be used to implement
		2630	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2631	lot less memory), but otherwise doesn't affect guard operation much. It is
		2632	purely used for performance.
		2633
		2634	=item L<JSON> and L<JSON::XS>
		2635
		2636	One of these modules is required when you want to read or write JSON data
		2637	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
		2638	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2639
		2640	=item L<Net::SSLeay>
		2641
		2642	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2643	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2644	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2645
		2646	=item L<Time::HiRes>
		2647
		2648	This module is part of perl since release 5.008. It will be used when the
		2649	chosen event library does not come with a timing source of its own. The
		2650	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
		2651	try to use a monotonic clock for timing stability.
		2652
		2653	=back
		2654
1840		2655
1841	=head1 FORK	2656	=head1 FORK
1842		2657
1843	Most event libraries are not fork-safe. The ones who are usually are	2658	Most event libraries are not fork-safe. The ones who are usually are
1844	because they rely on inefficient but fork-safe C<select> or C<poll>	2659	because they rely on inefficient but fork-safe C<select> or C<poll> calls
1845	calls. Only L<EV> is fully fork-aware.	2660	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2661	are usually badly thought-out hacks that are incompatible with fork in
		2662	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2663	continue event-processing in both parent and child (or both, if you know
		2664	what you are doing).
		2665
		2666	This means that, in general, you cannot fork and do event processing in
		2667	the child if the event library was initialised before the fork (which
		2668	usually happens when the first AnyEvent watcher is created, or the library
		2669	is loaded).
1846		2670
1847	If you have to fork, you must either do so I<before> creating your first	2671	If you have to fork, you must either do so I<before> creating your first
1848	watcher OR you must not use AnyEvent at all in the child.	2672	watcher OR you must not use AnyEvent at all in the child OR you must do
		2673	something completely out of the scope of AnyEvent.
		2674
		2675	The problem of doing event processing in the parent I<and> the child
		2676	is much more complicated: even for backends that I<are> fork-aware or
		2677	fork-safe, their behaviour is not usually what you want: fork clones all
		2678	watchers, that means all timers, I/O watchers etc. are active in both
		2679	parent and child, which is almost never what you want. USing C<exec>
		2680	to start worker children from some kind of manage rprocess is usually
		2681	preferred, because it is much easier and cleaner, at the expense of having
		2682	to have another binary.
1849		2683
1850		2684
1851	=head1 SECURITY CONSIDERATIONS	2685	=head1 SECURITY CONSIDERATIONS
1852		2686
1853	AnyEvent can be forced to load any event model via	2687	AnyEvent can be forced to load any event model via
…		…
1865	use AnyEvent;	2699	use AnyEvent;
1866		2700
1867	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2701	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1868	be used to probe what backend is used and gain other information (which is	2702	be used to probe what backend is used and gain other information (which is
1869	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and	2703	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1870	$ENV{PERL_ANYEGENT_STRICT}.	2704	$ENV{PERL_ANYEVENT_STRICT}.
		2705
		2706	Note that AnyEvent will remove I<all> environment variables starting with
		2707	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2708	enabled.
1871		2709
1872		2710
1873	=head1 BUGS	2711	=head1 BUGS
1874		2712
1875	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	2713	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
…		…
1879	pronounced).	2717	pronounced).
1880		2718
1881		2719
1882	=head1 SEE ALSO	2720	=head1 SEE ALSO
1883		2721
		2722	Tutorial/Introduction: L<AnyEvent::Intro>.
		2723
		2724	FAQ: L<AnyEvent::FAQ>.
		2725
1884	Utility functions: L<AnyEvent::Util>.	2726	Utility functions: L<AnyEvent::Util>.
1885		2727
1886	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2728	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
1887	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2729	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1888		2730
1889	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2731	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1890	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2732	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1891	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2733	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1892	L<AnyEvent::Impl::POE>.	2734	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1893		2735
1894	Non-blocking file handles, sockets, TCP clients and	2736	Non-blocking file handles, sockets, TCP clients and
1895	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2737	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1896		2738
1897	Asynchronous DNS: L<AnyEvent::DNS>.	2739	Asynchronous DNS: L<AnyEvent::DNS>.
1898		2740
1899	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2741	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
1900		2742
1901	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2743	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
		2744	L<AnyEvent::HTTP>.
1902		2745
1903		2746
1904	=head1 AUTHOR	2747	=head1 AUTHOR
1905		2748
1906	Marc Lehmann <schmorp@schmorp.de>	2749	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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