ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.210 by root, Wed May 13 15:19:43 2009 UTC vs.
Revision 1.340 by root, Fri Dec 3 18:39:06 2010 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
11	# file descriptor readable	15	# file handle or descriptor readable
12	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
13		17
14	# one-shot or repeating timers	18	# one-shot or repeating timers
15	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
16	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
17		21
18	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
19	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
20		24
21	# POSIX signal	25	# POSIX signal
…		…
39	=head1 INTRODUCTION/TUTORIAL	43	=head1 INTRODUCTION/TUTORIAL
40		44
41	This manpage is mainly a reference manual. If you are interested	45	This manpage is mainly a reference manual. If you are interested
42	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
43	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.
44		58
45	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	59	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
46		60
47	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
48	nowadays. So what is different about AnyEvent?	62	nowadays. So what is different about AnyEvent?
…		…
64	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
65	model you use.	79	model you use.
66		80
67	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
68	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
69	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
70	cannot use anything else, as they are simply incompatible to everything	84	cannot use anything else, as they are simply incompatible to everything
71	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
72	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.
73		87
74	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
75	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
76	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	90	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
77	your module uses one of those, every user of your module has to use it,	91	your module uses one of those, every user of your module has to use it,
78	too. But if your module uses AnyEvent, it works transparently with all	92	too. But if your module uses AnyEvent, it works transparently with all
79	event models it supports (including stuff like IO::Async, as long as those	93	event models it supports (including stuff like IO::Async, as long as those
80	use one of the supported event loops. It is trivial to add new event loops	94	use one of the supported event loops. It is easy to add new event loops
81	to AnyEvent, too, so it is future-proof).	95	to AnyEvent, too, so it is future-proof).
82		96
83	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
84	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
85	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
86	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
87	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
88	technically possible.	102	technically possible.
89		103
90	Of course, AnyEvent comes with a big (and fully optional!) toolbox	104	Of course, AnyEvent comes with a big (and fully optional!) toolbox
91	of useful functionality, such as an asynchronous DNS resolver, 100%	105	of useful functionality, such as an asynchronous DNS resolver, 100%
…		…
97	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
98	model, you should I<not> use this module.	112	model, you should I<not> use this module.
99		113
100	=head1 DESCRIPTION	114	=head1 DESCRIPTION
101		115
102	L<AnyEvent> provides an identical interface to multiple event loops. This	116	L<AnyEvent> provides a uniform interface to various event loops. This
103	allows module authors to utilise an event loop without forcing module	117	allows module authors to use event loop functionality without forcing
104	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
105	peacefully at any one time).	119	than one event loop cannot coexist peacefully).
106		120
107	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>
108	module.	122	module.
109		123
110	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
111	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
112	following modules is already loaded: L<EV>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,
113	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
114	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
115	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
116	adaptor should always succeed) in the order given. The first one that can	130	available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so
117	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
118	found, AnyEvent will fall back to a pure-perl event loop, which is not
119	very efficient, but should work everywhere.
120		132
121	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
122	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
123	that model the default. For example:	135	that model the default. For example:
124		136
…		…
126	use AnyEvent;	138	use AnyEvent;
127		139
128	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
129		141
130	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
131	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,
132	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
133		146
134	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called
135	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
136	explicitly and enjoy the high availability of that event loop :)	149	explicitly and enjoy the high availability of that event loop :)
137		150
…		…
146	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
147	is in control).	160	is in control).
148		161
149	Note that B<callbacks must not permanently change global variables>	162	Note that B<callbacks must not permanently change global variables>
150	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<<
151	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
152	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
153	widely between event loops.	166	widely between event loops.
154		167
155	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
156	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
157	to it).	170	to it).
158		171
159	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.
160		173
161	Many watchers either are used with "recursion" (repeating timers for	174	Many watchers either are used with "recursion" (repeating timers for
162	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.
163		176
164	An any way to achieve that is this pattern:	177	One way to achieve that is this pattern:
165		178
166	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
167	# you can use $w here, for example to undef it	180	# you can use $w here, for example to undef it
168	undef $w;	181	undef $w;
169	});	182	});
…		…
172	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
173	declared.	186	declared.
174		187
175	=head2 I/O WATCHERS	188	=head2 I/O WATCHERS
176		189
		190	$w = AnyEvent->io (
		191	fh => <filehandle_or_fileno>,
		192	poll => <"r" or "w">,
		193	cb => <callback>,
		194	);
		195
177	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
178	with the following mandatory key-value pairs as arguments:	197	with the following mandatory key-value pairs as arguments:
179		198
180	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
181	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
182	handle). Note that only file handles pointing to things for which	201	handle). Note that only file handles pointing to things for which
183	non-blocking operation makes sense are allowed. This includes sockets,	202	non-blocking operation makes sense are allowed. This includes sockets,
184	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
185	or block devices.	204	or block devices.
…		…
195		214
196	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.
197	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
198	underlying file descriptor.	217	underlying file descriptor.
199		218
200	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
201	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
202	handles.	221	handles.
203		222
204	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
205	watcher.	224	watcher.
…		…
210	undef $w;	229	undef $w;
211	});	230	});
212		231
213	=head2 TIME WATCHERS	232	=head2 TIME WATCHERS
214		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
215	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 >>
216	method with the following mandatory arguments:	243	method with the following mandatory arguments:
217		244
218	C<after> specifies after how many seconds (fractional values are	245	C<after> specifies after how many seconds (fractional values are
219	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
…		…
221		248
222	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
223	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
224	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
225		252
226	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
227	parameter, C<interval>, as a strictly positive number (> 0), then the	254	parameter, C<interval>, as a strictly positive number (> 0), then the
228	callback will be invoked regularly at that interval (in fractional	255	callback will be invoked regularly at that interval (in fractional
229	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
230	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.
231		258
232	The callback will be rescheduled before invoking the callback, but no	259	The callback will be rescheduled before invoking the callback, but no
233	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
234	only approximate.	261	only approximate.
235		262
236	Example: fire an event after 7.7 seconds.	263	Example: fire an event after 7.7 seconds.
237		264
238	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
…		…
256		283
257	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
258	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
259	"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
260	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
261	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.
262		289
263	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
264	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
265	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)
266	timers.	293	timers.
267		294
268	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
269	AnyEvent API.	296	AnyEvent API.
…		…
291	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
292	function to call when you want to know the current time.>	319	function to call when you want to know the current time.>
293		320
294	This function is also often faster then C<< AnyEvent->time >>, and	321	This function is also often faster then C<< AnyEvent->time >>, and
295	thus the preferred method if you want some timestamp (for example,	322	thus the preferred method if you want some timestamp (for example,
296	L<AnyEvent::Handle> uses this to update it's activity timeouts).	323	L<AnyEvent::Handle> uses this to update its activity timeouts).
297		324
298	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
299	with your timing, you can skip it without bad conscience.	326	with your timing; you can skip it without a bad conscience.
300		327
301	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>
302	and L<EV> and the following set-up:	329	and L<EV> and the following set-up:
303		330
304	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
305	time=500 (assume no other callbacks delay processing). In your callback,	332	time=500 (assume no other callbacks delay processing). In your callback,
306	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
307	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
308	after three seconds.	335	after three seconds.
309		336
…		…
340	might affect timers and time-outs.	367	might affect timers and time-outs.
341		368
342	When this is the case, you can call this method, which will update the	369	When this is the case, you can call this method, which will update the
343	event loop's idea of "current time".	370	event loop's idea of "current time".
344		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
345	Note that updating the time I<might> cause some events to be handled.	379	Note that updating the time I<might> cause some events to be handled.
346		380
347	=back	381	=back
348		382
349	=head2 SIGNAL WATCHERS	383	=head2 SIGNAL WATCHERS
		384
		385	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
350		386
351	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
352	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
353	callback to be invoked whenever a signal occurs.	389	callback to be invoked whenever a signal occurs.
354		390
…		…
360	invocation, and callback invocation will be synchronous. Synchronous means	396	invocation, and callback invocation will be synchronous. Synchronous means
361	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,
362	but it is guaranteed not to interrupt any other callbacks.	398	but it is guaranteed not to interrupt any other callbacks.
363		399
364	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
365	between multiple watchers.	401	between multiple watchers, and AnyEvent will ensure that signals will not
		402	interrupt your program at bad times.
366		403
367	This watcher might use C<%SIG>, so programs overwriting those signals	404	This watcher might use C<%SIG> (depending on the event loop used),
368	directly will likely not work correctly.	405	so programs overwriting those signals directly will likely not work
		406	correctly.
369		407
370	Example: exit on SIGINT	408	Example: exit on SIGINT
371		409
372	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	410	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
373		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
374	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
375		450
		451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		452
376	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.
377		454
378	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,
379	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
380	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
381	any trace events (stopped/continued).	458	finished and an exit status is available, not on any trace events
		459	(stopped/continued).
382		460
383	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
384	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
385	callback arguments.	463	callback arguments.
386		464
…		…
391		469
392	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
393	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
394	have exited already (and no SIGCHLD will be sent anymore).	472	have exited already (and no SIGCHLD will be sent anymore).
395		473
396	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
397	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
398	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.
399		480
400	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
401	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
402	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 the latency and race problems
		488	mentioned in the description of signal watchers apply.
403		489
404	Example: fork a process and wait for it	490	Example: fork a process and wait for it
405		491
406	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
407		493
…		…
419	# do something else, then wait for process exit	505	# do something else, then wait for process exit
420	$done->recv;	506	$done->recv;
421		507
422	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
423		509
424	Sometimes there is a need to do something, but it is not so important	510	$w = AnyEvent->idle (cb => <callback>);
425	to do it instantly, but only when there is nothing better to do. This
426	"nothing better to do" is usually defined to be "no other events need
427	attention by the event loop".
428		511
429	Idle watchers ideally get invoked when the event loop has nothing	512	This will repeatedly invoke the callback after the process becomes idle,
430	better to do, just before it would block the process to wait for new	513	until either the watcher is destroyed or new events have been detected.
431	events. Instead of blocking, the idle watcher is invoked.
432		514
433	Most event loops unfortunately do not really support idle watchers (only	515	Idle watchers are useful when there is a need to do something, but it
		516	is not so important (or wise) to do it instantly. The callback will be
		517	invoked only when there is "nothing better to do", which is usually
		518	defined as "all outstanding events have been handled and no new events
		519	have been detected". That means that idle watchers ideally get invoked
		520	when the event loop has just polled for new events but none have been
		521	detected. Instead of blocking to wait for more events, the idle watchers
		522	will be invoked.
		523
		524	Unfortunately, most event loops do not really support idle watchers (only
434	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	525	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
435	will simply call the callback "from time to time".	526	will simply call the callback "from time to time".
436		527
437	Example: read lines from STDIN, but only process them when the	528	Example: read lines from STDIN, but only process them when the
438	program is otherwise idle:	529	program is otherwise idle:
…		…
454	});	545	});
455	});	546	});
456		547
457	=head2 CONDITION VARIABLES	548	=head2 CONDITION VARIABLES
458		549
		550	$cv = AnyEvent->condvar;
		551
		552	$cv->send (<list>);
		553	my @res = $cv->recv;
		554
459	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
460	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
461	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
462		558
463	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
464	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).
465		561
466	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
467	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.
468		566
469	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
470	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
471
472	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
473	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
474	the results).	571	the results).
475		572
476	After creation, the condition variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
477	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
478	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<<
479	->send >> method).	576	->send >> method).
480		577
481	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
482	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:
483	in time where multiple outstanding events have been processed. And yet	580
484	another way to call them is transactions - each condition variable can be	581	=over 4
485	used to represent a transaction, which finishes at some point and delivers	582
486	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
487		601
488	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
489	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,
490	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
491	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
…		…
504		618
505	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
506	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
507	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
508	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
509	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
510		624
511	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
512	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
513	for the send to occur.	627	for the send to occur.
514		628
515	Example: wait for a timer.	629	Example: wait for a timer.
516		630
517	# wait till the result is ready	631	# condition: "wait till the timer is fired"
518	my $result_ready = AnyEvent->condvar;	632	my $timer_fired = AnyEvent->condvar;
519		633
520	# do something such as adding a timer	634	# create the timer - we could wait for, say
521	# or socket watcher the calls $result_ready->send	635	# a handle becomign ready, or even an
522	# when the "result" is ready.	636	# AnyEvent::HTTP request to finish, but
523	# in this case, we simply use a timer:	637	# in this case, we simply use a timer:
524	my $w = AnyEvent->timer (	638	my $w = AnyEvent->timer (
525	after => 1,	639	after => 1,
526	cb => sub { $result_ready->send },	640	cb => sub { $timer_fired->send },
527	);	641	);
528		642
529	# this "blocks" (while handling events) till the callback	643	# this "blocks" (while handling events) till the callback
530	# calls send	644	# calls ->send
531	$result_ready->recv;	645	$timer_fired->recv;
532		646
533	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
534	condition variables are also code references.	648	variables are also callable directly.
535		649
536	my $done = AnyEvent->condvar;	650	my $done = AnyEvent->condvar;
537	my $delay = AnyEvent->timer (after => 5, cb => $done);	651	my $delay = AnyEvent->timer (after => 5, cb => $done);
538	$done->recv;	652	$done->recv;
539		653
…		…
545		659
546	...	660	...
547		661
548	my @info = $couchdb->info->recv;	662	my @info = $couchdb->info->recv;
549		663
550	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
551	results are available:	665	results are available:
552		666
553	$couchdb->info->cb (sub {	667	$couchdb->info->cb (sub {
554	my @info = $_[0]->recv;	668	my @info = $_[0]->recv;
555	});	669	});
…		…
573	immediately from within send.	687	immediately from within send.
574		688
575	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
576	future C<< ->recv >> calls.	690	future C<< ->recv >> calls.
577		691
578	Condition variables are overloaded so one can call them directly	692	Condition variables are overloaded so one can call them directly (as if
579	(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
580	C<send>. Note, however, that many C-based event loops do not handle	694	C<send>.
581	overloading, so as tempting as it may be, passing a condition variable
582	instead of a callback does not work. Both the pure perl and EV loops
583	support overloading, however, as well as all functions that use perl to
584	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
585	example).
586		695
587	=item $cv->croak ($error)	696	=item $cv->croak ($error)
588		697
589	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
590	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
591		700
592	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
593	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.
594		707
595	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
596		709
597	=item $cv->end	710	=item $cv->end
598
599	These two methods are EXPERIMENTAL and MIGHT CHANGE.
600		711
601	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
602	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
603	to use a condition variable for the whole process.	714	to use a condition variable for the whole process.
604		715
605	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
606	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
607	>>, 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
608	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
609	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.
610		722
611	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:
612		730
613	my $cv = AnyEvent->condvar;	731	my $cv = AnyEvent->condvar;
614		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
615	my %result;	757	my %result;
616	$cv->begin (sub { $cv->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
617		759
618	for my $host (@list_of_hosts) {	760	for my $host (@list_of_hosts) {
619	$cv->begin;	761	$cv->begin;
620	ping_host_then_call_callback $host, sub {	762	ping_host_then_call_callback $host, sub {
621	$result{$host} = ...;	763	$result{$host} = ...;
…		…
636	loop, which serves two important purposes: first, it sets the callback	778	loop, which serves two important purposes: first, it sets the callback
637	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
638	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
639	doesn't execute once).	781	doesn't execute once).
640		782
641	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
642	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
643	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
644	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>.
645		788
646	=back	789	=back
647		790
648	=head3 METHODS FOR CONSUMERS	791	=head3 METHODS FOR CONSUMERS
649		792
…		…
653	=over 4	796	=over 4
654		797
655	=item $cv->recv	798	=item $cv->recv
656		799
657	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
658	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
659	normally.	802	normally.
660		803
661	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
662	will return immediately.	805	will return immediately.
663		806
…		…
665	function will call C<croak>.	808	function will call C<croak>.
666		809
667	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,
668	in scalar context only the first one will be returned.	811	in scalar context only the first one will be returned.
669		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
670	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
671	(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
672	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
673	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
674	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
675	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,
676	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
677		827
678	Another reason I<never> to C<< ->recv >> in a module is that you cannot
679	sensibly have two C<< ->recv >>'s in parallel, as that would require
680	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
681	can supply.
682
683	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
684	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
685	versions and also integrates coroutines into AnyEvent, making blocking
686	C<< ->recv >> calls perfectly safe as long as they are done from another
687	coroutine (one that doesn't run the event loop).
688
689	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
690	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
691	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
692	waits otherwise.	831	waits otherwise.
693		832
694	=item $bool = $cv->ready	833	=item $bool = $cv->ready
…		…
700		839
701	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
702	replaces it before doing so.	841	replaces it before doing so.
703		842
704	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
705	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
706	variable itself. Calling C<recv> inside the callback or at any later time	845	condition variable itself. If the condition is already true, the
707	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.
708		848
709	=back	849	=back
710		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 implementation, 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
		882	=item Backends with special needs.
		883
		884	Qt requires the Qt::Application to be instantiated first, but will
		885	otherwise be picked up automatically. As long as the main program
		886	instantiates the application before any AnyEvent watchers are created,
		887	everything should just work.
		888
		889	AnyEvent::Impl::Qt based on Qt.
		890
		891	Support for IO::Async can only be partial, as it is too broken and
		892	architecturally limited to even support the AnyEvent API. It also
		893	is the only event loop that needs the loop to be set explicitly, so
		894	it can only be used by a main program knowing about AnyEvent. See
		895	L<AnyEvent::Impl::IOAsync> for the gory details.
		896
		897	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		898
		899	=item Event loops that are indirectly supported via other backends.
		900
		901	Some event loops can be supported via other modules:
		902
		903	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		904
		905	B<WxWidgets> has no support for watching file handles. However, you can
		906	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		907	polls 20 times per second, which was considered to be too horrible to even
		908	consider for AnyEvent.
		909
		910	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		911	backend, so it can be supported through POE.
		912
		913	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		914	load L<POE> when detecting them, in the hope that POE will pick them up,
		915	in which case everything will be automatic.
		916
		917	=back
		918
711	=head1 GLOBAL VARIABLES AND FUNCTIONS	919	=head1 GLOBAL VARIABLES AND FUNCTIONS
712		920
		921	These are not normally required to use AnyEvent, but can be useful to
		922	write AnyEvent extension modules.
		923
713	=over 4	924	=over 4
714		925
715	=item $AnyEvent::MODEL	926	=item $AnyEvent::MODEL
716		927
717	Contains C<undef> until the first watcher is being created. Then it	928	Contains C<undef> until the first watcher is being created, before the
		929	backend has been autodetected.
		930
718	contains the event model that is being used, which is the name of the	931	Afterwards it contains the event model that is being used, which is the
719	Perl class implementing the model. This class is usually one of the	932	name of the Perl class implementing the model. This class is usually one
720	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	933	of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
721	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	934	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
722		935	will be C<urxvt::anyevent>).
723	The known classes so far are:
724
725	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
726	AnyEvent::Impl::Event based on Event, second best choice.
727	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
728	AnyEvent::Impl::Glib based on Glib, third-best choice.
729	AnyEvent::Impl::Tk based on Tk, very bad choice.
730	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
731	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
732	AnyEvent::Impl::POE based on POE, not generic enough for full support.
733
734	There is no support for WxWidgets, as WxWidgets has no support for
735	watching file handles. However, you can use WxWidgets through the
736	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
737	second, which was considered to be too horrible to even consider for
738	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
739	it's adaptor.
740
741	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
742	autodetecting them.
743		936
744	=item AnyEvent::detect	937	=item AnyEvent::detect
745		938
746	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	939	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
747	if necessary. You should only call this function right before you would	940	if necessary. You should only call this function right before you would
748	have created an AnyEvent watcher anyway, that is, as late as possible at	941	have created an AnyEvent watcher anyway, that is, as late as possible at
749	runtime.	942	runtime, and not e.g. during initialisation of your module.
		943
		944	If you need to do some initialisation before AnyEvent watchers are
		945	created, use C<post_detect>.
750		946
751	=item $guard = AnyEvent::post_detect { BLOCK }	947	=item $guard = AnyEvent::post_detect { BLOCK }
752		948
753	Arranges for the code block to be executed as soon as the event model is	949	Arranges for the code block to be executed as soon as the event model is
754	autodetected (or immediately if this has already happened).	950	autodetected (or immediately if that has already happened).
		951
		952	The block will be executed I<after> the actual backend has been detected
		953	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		954	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		955	other initialisations - see the sources of L<AnyEvent::Strict> or
		956	L<AnyEvent::AIO> to see how this is used.
		957
		958	The most common usage is to create some global watchers, without forcing
		959	event module detection too early, for example, L<AnyEvent::AIO> creates
		960	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		961	avoid autodetecting the event module at load time.
755		962
756	If called in scalar or list context, then it creates and returns an object	963	If called in scalar or list context, then it creates and returns an object
757	that automatically removes the callback again when it is destroyed. See	964	that automatically removes the callback again when it is destroyed (or
		965	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
758	L<Coro::BDB> for a case where this is useful.	966	a case where this is useful.
		967
		968	Example: Create a watcher for the IO::AIO module and store it in
		969	C<$WATCHER>, but do so only do so after the event loop is initialised.
		970
		971	our WATCHER;
		972
		973	my $guard = AnyEvent::post_detect {
		974	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		975	};
		976
		977	# the ||= is important in case post_detect immediately runs the block,
		978	# as to not clobber the newly-created watcher. assigning both watcher and
		979	# post_detect guard to the same variable has the advantage of users being
		980	# able to just C<undef $WATCHER> if the watcher causes them grief.
		981
		982	$WATCHER ||= $guard;
759		983
760	=item @AnyEvent::post_detect	984	=item @AnyEvent::post_detect
761		985
762	If there are any code references in this array (you can C<push> to it	986	If there are any code references in this array (you can C<push> to it
763	before or after loading AnyEvent), then they will called directly after	987	before or after loading AnyEvent), then they will be called directly
764	the event loop has been chosen.	988	after the event loop has been chosen.
765		989
766	You should check C<$AnyEvent::MODEL> before adding to this array, though:	990	You should check C<$AnyEvent::MODEL> before adding to this array, though:
767	if it contains a true value then the event loop has already been detected,	991	if it is defined then the event loop has already been detected, and the
768	and the array will be ignored.	992	array will be ignored.
769		993
770	Best use C<AnyEvent::post_detect { BLOCK }> instead.	994	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		995	it, as it takes care of these details.
		996
		997	This variable is mainly useful for modules that can do something useful
		998	when AnyEvent is used and thus want to know when it is initialised, but do
		999	not need to even load it by default. This array provides the means to hook
		1000	into AnyEvent passively, without loading it.
		1001
		1002	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1003	together, you could put this into Coro (this is the actual code used by
		1004	Coro to accomplish this):
		1005
		1006	if (defined $AnyEvent::MODEL) {
		1007	# AnyEvent already initialised, so load Coro::AnyEvent
		1008	require Coro::AnyEvent;
		1009	} else {
		1010	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1011	# as soon as it is
		1012	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1013	}
771		1014
772	=back	1015	=back
773		1016
774	=head1 WHAT TO DO IN A MODULE	1017	=head1 WHAT TO DO IN A MODULE
775		1018
…		…
786	because it will stall the whole program, and the whole point of using	1029	because it will stall the whole program, and the whole point of using
787	events is to stay interactive.	1030	events is to stay interactive.
788		1031
789	It is fine, however, to call C<< ->recv >> when the user of your module	1032	It is fine, however, to call C<< ->recv >> when the user of your module
790	requests it (i.e. if you create a http request object ad have a method	1033	requests it (i.e. if you create a http request object ad have a method
791	called C<results> that returns the results, it should call C<< ->recv >>	1034	called C<results> that returns the results, it may call C<< ->recv >>
792	freely, as the user of your module knows what she is doing. always).	1035	freely, as the user of your module knows what she is doing. Always).
793		1036
794	=head1 WHAT TO DO IN THE MAIN PROGRAM	1037	=head1 WHAT TO DO IN THE MAIN PROGRAM
795		1038
796	There will always be a single main program - the only place that should	1039	There will always be a single main program - the only place that should
797	dictate which event model to use.	1040	dictate which event model to use.
798		1041
799	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1042	If the program is not event-based, it need not do anything special, even
800	do anything special (it does not need to be event-based) and let AnyEvent	1043	when it depends on a module that uses an AnyEvent. If the program itself
801	decide which implementation to chose if some module relies on it.	1044	uses AnyEvent, but does not care which event loop is used, all it needs
		1045	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1046	available loop implementation.
802		1047
803	If the main program relies on a specific event model - for example, in	1048	If the main program relies on a specific event model - for example, in
804	Gtk2 programs you have to rely on the Glib module - you should load the	1049	Gtk2 programs you have to rely on the Glib module - you should load the
805	event module before loading AnyEvent or any module that uses it: generally	1050	event module before loading AnyEvent or any module that uses it: generally
806	speaking, you should load it as early as possible. The reason is that	1051	speaking, you should load it as early as possible. The reason is that
807	modules might create watchers when they are loaded, and AnyEvent will	1052	modules might create watchers when they are loaded, and AnyEvent will
808	decide on the event model to use as soon as it creates watchers, and it	1053	decide on the event model to use as soon as it creates watchers, and it
809	might chose the wrong one unless you load the correct one yourself.	1054	might choose the wrong one unless you load the correct one yourself.
810		1055
811	You can chose to use a pure-perl implementation by loading the	1056	You can chose to use a pure-perl implementation by loading the
812	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour	1057	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
813	everywhere, but letting AnyEvent chose the model is generally better.	1058	everywhere, but letting AnyEvent chose the model is generally better.
814		1059
…		…
830		1075
831		1076
832	=head1 OTHER MODULES	1077	=head1 OTHER MODULES
833		1078
834	The following is a non-exhaustive list of additional modules that use	1079	The following is a non-exhaustive list of additional modules that use
835	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1080	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
836	in the same program. Some of the modules come with AnyEvent, some are	1081	modules and other event loops in the same program. Some of the modules
837	available via CPAN.	1082	come as part of AnyEvent, the others are available via CPAN.
838		1083
839	=over 4	1084	=over 4
840		1085
841	=item L<AnyEvent::Util>	1086	=item L<AnyEvent::Util>
842		1087
843	Contains various utility functions that replace often-used but blocking	1088	Contains various utility functions that replace often-used blocking
844	functions such as C<inet_aton> by event-/callback-based versions.	1089	functions such as C<inet_aton> with event/callback-based versions.
845		1090
846	=item L<AnyEvent::Socket>	1091	=item L<AnyEvent::Socket>
847		1092
848	Provides various utility functions for (internet protocol) sockets,	1093	Provides various utility functions for (internet protocol) sockets,
849	addresses and name resolution. Also functions to create non-blocking tcp	1094	addresses and name resolution. Also functions to create non-blocking tcp
…		…
851		1096
852	=item L<AnyEvent::Handle>	1097	=item L<AnyEvent::Handle>
853		1098
854	Provide read and write buffers, manages watchers for reads and writes,	1099	Provide read and write buffers, manages watchers for reads and writes,
855	supports raw and formatted I/O, I/O queued and fully transparent and	1100	supports raw and formatted I/O, I/O queued and fully transparent and
856	non-blocking SSL/TLS.	1101	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
857		1102
858	=item L<AnyEvent::DNS>	1103	=item L<AnyEvent::DNS>
859		1104
860	Provides rich asynchronous DNS resolver capabilities.	1105	Provides rich asynchronous DNS resolver capabilities.
861		1106
		1107	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1108
		1109	Implement event-based interfaces to the protocols of the same name (for
		1110	the curious, IGS is the International Go Server and FCP is the Freenet
		1111	Client Protocol).
		1112
		1113	=item L<AnyEvent::Handle::UDP>
		1114
		1115	Here be danger!
		1116
		1117	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1118	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1119	its use of a stream-based API with a protocol that isn't streamable, that
		1120	the only way to improve it is to delete it.
		1121
		1122	It features data corruption (but typically only under load) and general
		1123	confusion. On top, the author is not only clueless about UDP but also
		1124	fact-resistant - some gems of his understanding: "connect doesn't work
		1125	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1126	packets", "I don't need to implement proper error checking as UDP doesn't
		1127	support error checking" and so on - he doesn't even understand what's
		1128	wrong with his module when it is explained to him.
		1129
862	=item L<AnyEvent::HTTP>	1130	=item L<AnyEvent::DBI>
863		1131
864	A simple-to-use HTTP library that is capable of making a lot of concurrent	1132	Executes L<DBI> requests asynchronously in a proxy process for you,
865	HTTP requests.	1133	notifying you in an event-based way when the operation is finished.
		1134
		1135	=item L<AnyEvent::AIO>
		1136
		1137	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1138	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1139	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1140	file I/O, and much more.
866		1141
867	=item L<AnyEvent::HTTPD>	1142	=item L<AnyEvent::HTTPD>
868		1143
869	Provides a simple web application server framework.	1144	A simple embedded webserver.
870		1145
871	=item L<AnyEvent::FastPing>	1146	=item L<AnyEvent::FastPing>
872		1147
873	The fastest ping in the west.	1148	The fastest ping in the west.
874		1149
875	=item L<AnyEvent::DBI>
876
877	Executes L<DBI> requests asynchronously in a proxy process.
878
879	=item L<AnyEvent::AIO>
880
881	Truly asynchronous I/O, should be in the toolbox of every event
882	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
883	together.
884
885	=item L<AnyEvent::BDB>
886
887	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
888	L<BDB> and AnyEvent together.
889
890	=item L<AnyEvent::GPSD>
891
892	A non-blocking interface to gpsd, a daemon delivering GPS information.
893
894	=item L<AnyEvent::IGS>
895
896	A non-blocking interface to the Internet Go Server protocol (used by
897	L<App::IGS>).
898
899	=item L<AnyEvent::IRC>
900
901	AnyEvent based IRC client module family (replacing the older Net::IRC3).
902
903	=item L<Net::XMPP2>
904
905	AnyEvent based XMPP (Jabber protocol) module family.
906
907	=item L<Net::FCP>
908
909	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
910	of AnyEvent.
911
912	=item L<Event::ExecFlow>
913
914	High level API for event-based execution flow control.
915
916	=item L<Coro>	1150	=item L<Coro>
917		1151
918	Has special support for AnyEvent via L<Coro::AnyEvent>.	1152	Has special support for AnyEvent via L<Coro::AnyEvent>.
919		1153
920	=item L<IO::Lambda>
921
922	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
923
924	=back	1154	=back
925		1155
926	=cut	1156	=cut
927		1157
928	package AnyEvent;	1158	package AnyEvent;
929		1159
930	no warnings;	1160	# basically a tuned-down version of common::sense
931	use strict qw(vars subs);	1161	sub common_sense {
		1162	# from common:.sense 3.3
		1163	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00";
		1164	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
		1165	$^H |= 0x00000600;
		1166	}
932		1167
		1168	BEGIN { AnyEvent::common_sense }
		1169
933	use Carp;	1170	use Carp ();
934		1171
935	our $VERSION = 4.41;	1172	our $VERSION = '5.29';
936	our $MODEL;	1173	our $MODEL;
937		1174
938	our $AUTOLOAD;	1175	our $AUTOLOAD;
939	our @ISA;	1176	our @ISA;
940		1177
941	our @REGISTRY;	1178	our @REGISTRY;
942		1179
943	our $WIN32;	1180	our $VERBOSE;
944		1181
945	BEGIN {	1182	BEGIN {
946	my $win32 = ! ! ($^O =~ /mswin32/i);	1183	require "AnyEvent/constants.pl";
947	eval "sub WIN32(){ $win32 }";
948	}
949		1184
		1185	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
		1186
		1187	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1188	if ${^TAINT};
		1189
950	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1190	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1191
		1192	}
		1193
		1194	our $MAX_SIGNAL_LATENCY = 10;
951		1195
952	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1196	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
953		1197
954	{	1198	{
955	my $idx;	1199	my $idx;
…		…
957	for reverse split /\s*,\s*/,	1201	for reverse split /\s*,\s*/,
958	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1202	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
959	}	1203	}
960		1204
961	my @models = (	1205	my @models = (
962	[EV:: => AnyEvent::Impl::EV::],	1206	[EV:: => AnyEvent::Impl::EV:: , 1],
963	[Event:: => AnyEvent::Impl::Event::],
964	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1207	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
965	# everything below here will not be autoprobed	1208	# everything below here will not (normally) be autoprobed
966	# as the pureperl backend should work everywhere	1209	# as the pureperl backend should work everywhere
967	# and is usually faster	1210	# and is usually faster
		1211	[Event:: => AnyEvent::Impl::Event::, 1],
		1212	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1213	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1214	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
968	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1215	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
969	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
970	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
971	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1216	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
972	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1217	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
973	[Wx:: => AnyEvent::Impl::POE::],	1218	[Wx:: => AnyEvent::Impl::POE::],
974	[Prima:: => AnyEvent::Impl::POE::],	1219	[Prima:: => AnyEvent::Impl::POE::],
		1220	# IO::Async is just too broken - we would need workarounds for its
		1221	# byzantine signal and broken child handling, among others.
		1222	# IO::Async is rather hard to detect, as it doesn't have any
		1223	# obvious default class.
		1224	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1225	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1226	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1227	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
975	);	1228	);
976		1229
977	our %method = map +($_ => 1),	1230	our %method = map +($_ => 1),
978	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1231	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
979		1232
980	our @post_detect;	1233	our @post_detect;
981		1234
982	sub post_detect(&) {	1235	sub post_detect(&) {
983	my ($cb) = @_;	1236	my ($cb) = @_;
984		1237
985	if ($MODEL) {
986	$cb->();
987
988	1
989	} else {
990	push @post_detect, $cb;	1238	push @post_detect, $cb;
991		1239
992	defined wantarray	1240	defined wantarray
993	? bless \$cb, "AnyEvent::Util::postdetect"	1241	? bless \$cb, "AnyEvent::Util::postdetect"
994	: ()	1242	: ()
995	}
996	}	1243	}
997		1244
998	sub AnyEvent::Util::postdetect::DESTROY {	1245	sub AnyEvent::Util::postdetect::DESTROY {
999	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1246	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1000	}	1247	}
1001		1248
1002	sub detect() {	1249	sub detect() {
		1250	# free some memory
		1251	*detect = sub () { $MODEL };
		1252
		1253	local $!; # for good measure
		1254	local $SIG{__DIE__};
		1255
		1256	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1257	my $model = "AnyEvent::Impl::$1";
		1258	if (eval "require $model") {
		1259	$MODEL = $model;
		1260	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1261	} else {
		1262	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1263	}
		1264	}
		1265
		1266	# check for already loaded models
1003	unless ($MODEL) {	1267	unless ($MODEL) {
1004	no strict 'refs';	1268	for (@REGISTRY, @models) {
1005	local $SIG{__DIE__};	1269	my ($package, $model) = @$_;
1006		1270	if (${"$package\::VERSION"} > 0) {
1007	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1008	my $model = "AnyEvent::Impl::$1";
1009	if (eval "require $model") {	1271	if (eval "require $model") {
1010	$MODEL = $model;	1272	$MODEL = $model;
1011	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1273	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1012	} else {	1274	last;
1013	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1275	}
1014	}	1276	}
1015	}	1277	}
1016		1278
1017	# check for already loaded models
1018	unless ($MODEL) {	1279	unless ($MODEL) {
		1280	# try to autoload a model
1019	for (@REGISTRY, @models) {	1281	for (@REGISTRY, @models) {
1020	my ($package, $model) = @$_;	1282	my ($package, $model, $autoload) = @$_;
		1283	if (
		1284	$autoload
		1285	and eval "require $package"
1021	if (${"$package\::VERSION"} > 0) {	1286	and ${"$package\::VERSION"} > 0
1022	if (eval "require $model") {	1287	and eval "require $model"
		1288	) {
1023	$MODEL = $model;	1289	$MODEL = $model;
1024	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1290	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1025	last;	1291	last;
1026	}
1027	}	1292	}
1028	}	1293	}
1029		1294
1030	unless ($MODEL) {
1031	# try to load a model
1032
1033	for (@REGISTRY, @models) {
1034	my ($package, $model) = @$_;
1035	if (eval "require $package"
1036	and ${"$package\::VERSION"} > 0
1037	and eval "require $model") {
1038	$MODEL = $model;
1039	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
1040	last;
1041	}
1042	}
1043
1044	$MODEL	1295	$MODEL
1045	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1296	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
1046	}
1047	}	1297	}
1048
1049	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1050
1051	unshift @ISA, $MODEL;
1052
1053	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1054
1055	(shift @post_detect)->() while @post_detect;
1056	}	1298	}
		1299
		1300	@models = (); # free probe data
		1301
		1302	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1303	unshift @ISA, $MODEL;
		1304
		1305	# now nuke some methods that are overridden by the backend.
		1306	# SUPER is not allowed.
		1307	for (qw(time signal child idle)) {
		1308	undef &{"AnyEvent::Base::$_"}
		1309	if defined &{"$MODEL\::$_"};
		1310	}
		1311
		1312	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1313	eval { require AnyEvent::Strict };
		1314	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
		1315	if $@ && $VERBOSE;
		1316	}
		1317
		1318	(shift @post_detect)->() while @post_detect;
		1319
		1320	*post_detect = sub(&) {
		1321	shift->();
		1322
		1323	undef
		1324	};
1057		1325
1058	$MODEL	1326	$MODEL
1059	}	1327	}
1060		1328
1061	sub AUTOLOAD {	1329	sub AUTOLOAD {
1062	(my $func = $AUTOLOAD) =~ s/.*://;	1330	(my $func = $AUTOLOAD) =~ s/.*://;
1063		1331
1064	$method{$func}	1332	$method{$func}
1065	or croak "$func: not a valid method for AnyEvent objects";	1333	or Carp::croak "$func: not a valid AnyEvent class method";
1066		1334
1067	detect unless $MODEL;	1335	detect;
1068		1336
1069	my $class = shift;	1337	my $class = shift;
1070	$class->$func (@_);	1338	$class->$func (@_);
1071	}	1339	}
1072		1340
1073	# utility function to dup a filehandle. this is used by many backends	1341	# utility function to dup a filehandle. this is used by many backends
1074	# to support binding more than one watcher per filehandle (they usually	1342	# to support binding more than one watcher per filehandle (they usually
1075	# allow only one watcher per fd, so we dup it to get a different one).	1343	# allow only one watcher per fd, so we dup it to get a different one).
1076	sub _dupfh($$$$) {	1344	sub _dupfh($$;$$) {
1077	my ($poll, $fh, $r, $w) = @_;	1345	my ($poll, $fh, $r, $w) = @_;
1078		1346
1079	# cygwin requires the fh mode to be matching, unix doesn't	1347	# cygwin requires the fh mode to be matching, unix doesn't
1080	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1348	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1081	: $poll eq "w" ? ($w, ">")
1082	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1083		1349
1084	open my $fh2, "$mode&" . fileno $fh	1350	open my $fh2, $mode, $fh
1085	or die "cannot dup() filehandle: $!,";	1351	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1086		1352
1087	# we assume CLOEXEC is already set by perl in all important cases	1353	# we assume CLOEXEC is already set by perl in all important cases
1088		1354
1089	($fh2, $rw)	1355	($fh2, $rw)
1090	}	1356	}
1091		1357
		1358	=head1 SIMPLIFIED AE API
		1359
		1360	Starting with version 5.0, AnyEvent officially supports a second, much
		1361	simpler, API that is designed to reduce the calling, typing and memory
		1362	overhead by using function call syntax and a fixed number of parameters.
		1363
		1364	See the L<AE> manpage for details.
		1365
		1366	=cut
		1367
		1368	package AE;
		1369
		1370	our $VERSION = $AnyEvent::VERSION;
		1371
		1372	# fall back to the main API by default - backends and AnyEvent::Base
		1373	# implementations can overwrite these.
		1374
		1375	sub io($$$) {
		1376	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1377	}
		1378
		1379	sub timer($$$) {
		1380	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1381	}
		1382
		1383	sub signal($$) {
		1384	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1385	}
		1386
		1387	sub child($$) {
		1388	AnyEvent->child (pid => $_[0], cb => $_[1])
		1389	}
		1390
		1391	sub idle($) {
		1392	AnyEvent->idle (cb => $_[0])
		1393	}
		1394
		1395	sub cv(;&) {
		1396	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1397	}
		1398
		1399	sub now() {
		1400	AnyEvent->now
		1401	}
		1402
		1403	sub now_update() {
		1404	AnyEvent->now_update
		1405	}
		1406
		1407	sub time() {
		1408	AnyEvent->time
		1409	}
		1410
1092	package AnyEvent::Base;	1411	package AnyEvent::Base;
1093		1412
1094	# default implementations for many methods	1413	# default implementations for many methods
1095		1414
1096	BEGIN {	1415	sub time {
		1416	eval q{ # poor man's autoloading {}
		1417	# probe for availability of Time::HiRes
1097	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1418	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1419	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1098	*_time = \&Time::HiRes::time;	1420	*AE::time = \&Time::HiRes::time;
1099	# if (eval "use POSIX (); (POSIX::times())...	1421	# if (eval "use POSIX (); (POSIX::times())...
1100	} else {	1422	} else {
		1423	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1101	*_time = sub { time }; # epic fail	1424	*AE::time = sub (){ time }; # epic fail
		1425	}
		1426
		1427	*time = sub { AE::time }; # different prototypes
		1428	};
		1429	die if $@;
		1430
		1431	&time
		1432	}
		1433
		1434	*now = \&time;
		1435
		1436	sub now_update { }
		1437
		1438	# default implementation for ->condvar
		1439
		1440	sub condvar {
		1441	eval q{ # poor man's autoloading {}
		1442	*condvar = sub {
		1443	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1444	};
		1445
		1446	*AE::cv = sub (;&) {
		1447	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1448	};
		1449	};
		1450	die if $@;
		1451
		1452	&condvar
		1453	}
		1454
		1455	# default implementation for ->signal
		1456
		1457	our $HAVE_ASYNC_INTERRUPT;
		1458
		1459	sub _have_async_interrupt() {
		1460	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1461	&& eval "use Async::Interrupt 1.02 (); 1")
		1462	unless defined $HAVE_ASYNC_INTERRUPT;
		1463
		1464	$HAVE_ASYNC_INTERRUPT
		1465	}
		1466
		1467	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1468	our (%SIG_ASY, %SIG_ASY_W);
		1469	our ($SIG_COUNT, $SIG_TW);
		1470
		1471	# install a dummy wakeup watcher to reduce signal catching latency
		1472	# used by Impls
		1473	sub _sig_add() {
		1474	unless ($SIG_COUNT++) {
		1475	# try to align timer on a full-second boundary, if possible
		1476	my $NOW = AE::now;
		1477
		1478	$SIG_TW = AE::timer
		1479	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1480	$MAX_SIGNAL_LATENCY,
		1481	sub { } # just for the PERL_ASYNC_CHECK
		1482	;
1102	}	1483	}
1103	}	1484	}
1104		1485
1105	sub time { _time }	1486	sub _sig_del {
1106	sub now { _time }	1487	undef $SIG_TW
1107	sub now_update { }	1488	unless --$SIG_COUNT;
1108
1109	# default implementation for ->condvar
1110
1111	sub condvar {
1112	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1113	}	1489	}
1114		1490
1115	# default implementation for ->signal	1491	our $_sig_name_init; $_sig_name_init = sub {
		1492	eval q{ # poor man's autoloading {}
		1493	undef $_sig_name_init;
1116		1494
1117	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1495	if (_have_async_interrupt) {
		1496	*sig2num = \&Async::Interrupt::sig2num;
		1497	*sig2name = \&Async::Interrupt::sig2name;
		1498	} else {
		1499	require Config;
1118		1500
1119	sub _signal_exec {	1501	my %signame2num;
1120	sysread $SIGPIPE_R, my $dummy, 4;	1502	@signame2num{ split ' ', $Config::Config{sig_name} }
		1503	= split ' ', $Config::Config{sig_num};
1121		1504
1122	while (%SIG_EV) {	1505	my @signum2name;
1123	for (keys %SIG_EV) {	1506	@signum2name[values %signame2num] = keys %signame2num;
1124	delete $SIG_EV{$_};	1507
1125	$_->() for values %{ $SIG_CB{$_} || {} };	1508	*sig2num = sub($) {
		1509	$_[0] > 0 ? shift : $signame2num{+shift}
		1510	};
		1511	*sig2name = sub ($) {
		1512	$_[0] > 0 ? $signum2name[+shift] : shift
		1513	};
1126	}	1514	}
1127	}	1515	};
1128	}	1516	die if $@;
		1517	};
		1518
		1519	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1520	sub sig2name($) { &$_sig_name_init; &sig2name }
1129		1521
1130	sub signal {	1522	sub signal {
1131	my (undef, %arg) = @_;	1523	eval q{ # poor man's autoloading {}
		1524	# probe for availability of Async::Interrupt
		1525	if (_have_async_interrupt) {
		1526	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1132		1527
1133	unless ($SIGPIPE_R) {	1528	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1134	require Fcntl;	1529	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1135		1530
1136	if (AnyEvent::WIN32) {
1137	require AnyEvent::Util;
1138
1139	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1140	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1141	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1142	} else {	1531	} else {
		1532	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1533
		1534	if (AnyEvent::WIN32) {
		1535	require AnyEvent::Util;
		1536
		1537	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1538	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1539	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1540	} else {
1143	pipe $SIGPIPE_R, $SIGPIPE_W;	1541	pipe $SIGPIPE_R, $SIGPIPE_W;
1144	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1542	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1145	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1543	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
		1544
		1545	# not strictly required, as $^F is normally 2, but let's make sure...
		1546	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1547	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1548	}
		1549
		1550	$SIGPIPE_R
		1551	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1552
		1553	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1146	}	1554	}
1147		1555
1148	$SIGPIPE_R	1556	*signal = $HAVE_ASYNC_INTERRUPT
1149	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1557	? sub {
		1558	my (undef, %arg) = @_;
1150		1559
1151	# not strictly required, as $^F is normally 2, but let's make sure...	1560	# async::interrupt
1152	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1153	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1154
1155	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1156	}
1157
1158	my $signal = uc $arg{signal}	1561	my $signal = sig2num $arg{signal};
1159	or Carp::croak "required option 'signal' is missing";
1160
1161	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1562	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1563
		1564	$SIG_ASY{$signal} ||= new Async::Interrupt
		1565	cb => sub { undef $SIG_EV{$signal} },
		1566	signal => $signal,
		1567	pipe => [$SIGPIPE_R->filenos],
		1568	pipe_autodrain => 0,
		1569	;
		1570
		1571	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1572	}
		1573	: sub {
		1574	my (undef, %arg) = @_;
		1575
		1576	# pure perl
		1577	my $signal = sig2name $arg{signal};
		1578	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1579
1162	$SIG{$signal} ||= sub {	1580	$SIG{$signal} ||= sub {
1163	local $!;	1581	local $!;
1164	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1582	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1165	undef $SIG_EV{$signal};	1583	undef $SIG_EV{$signal};
		1584	};
		1585
		1586	# can't do signal processing without introducing races in pure perl,
		1587	# so limit the signal latency.
		1588	_sig_add;
		1589
		1590	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1591	}
		1592	;
		1593
		1594	*AnyEvent::Base::signal::DESTROY = sub {
		1595	my ($signal, $cb) = @{$_[0]};
		1596
		1597	_sig_del;
		1598
		1599	delete $SIG_CB{$signal}{$cb};
		1600
		1601	$HAVE_ASYNC_INTERRUPT
		1602	? delete $SIG_ASY{$signal}
		1603	: # delete doesn't work with older perls - they then
		1604	# print weird messages, or just unconditionally exit
		1605	# instead of getting the default action.
		1606	undef $SIG{$signal}
		1607	unless keys %{ $SIG_CB{$signal} };
		1608	};
		1609
		1610	*_signal_exec = sub {
		1611	$HAVE_ASYNC_INTERRUPT
		1612	? $SIGPIPE_R->drain
		1613	: sysread $SIGPIPE_R, (my $dummy), 9;
		1614
		1615	while (%SIG_EV) {
		1616	for (keys %SIG_EV) {
		1617	delete $SIG_EV{$_};
		1618	$_->() for values %{ $SIG_CB{$_} || {} };
		1619	}
		1620	}
		1621	};
1166	};	1622	};
		1623	die if $@;
1167		1624
1168	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1625	&signal
1169	}
1170
1171	sub AnyEvent::Base::signal::DESTROY {
1172	my ($signal, $cb) = @{$_[0]};
1173
1174	delete $SIG_CB{$signal}{$cb};
1175
1176	# delete doesn't work with older perls - they then
1177	# print weird messages, or just unconditionally exit
1178	# instead of getting the default action.
1179	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1180	}	1626	}
1181		1627
1182	# default implementation for ->child	1628	# default implementation for ->child
1183		1629
1184	our %PID_CB;	1630	our %PID_CB;
1185	our $CHLD_W;	1631	our $CHLD_W;
1186	our $CHLD_DELAY_W;	1632	our $CHLD_DELAY_W;
1187	our $WNOHANG;	1633	our $WNOHANG;
1188		1634
1189	sub _sigchld {	1635	# used by many Impl's
1190	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1636	sub _emit_childstatus($$) {
		1637	my (undef, $rpid, $rstatus) = @_;
		1638
		1639	$_->($rpid, $rstatus)
1191	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1640	for values %{ $PID_CB{$rpid} || {} },
1192	(values %{ $PID_CB{0} || {} });	1641	values %{ $PID_CB{0} || {} };
1193	}
1194	}	1642	}
1195		1643
1196	sub child {	1644	sub child {
		1645	eval q{ # poor man's autoloading {}
		1646	*_sigchld = sub {
		1647	my $pid;
		1648
		1649	AnyEvent->_emit_childstatus ($pid, $?)
		1650	while ($pid = waitpid -1, $WNOHANG) > 0;
		1651	};
		1652
		1653	*child = sub {
1197	my (undef, %arg) = @_;	1654	my (undef, %arg) = @_;
1198		1655
1199	defined (my $pid = $arg{pid} + 0)	1656	defined (my $pid = $arg{pid} + 0)
1200	or Carp::croak "required option 'pid' is missing";	1657	or Carp::croak "required option 'pid' is missing";
1201		1658
1202	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1659	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1203		1660
		1661	# WNOHANG is almost cetrainly 1 everywhere
		1662	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
		1663	? 1
1204	$WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1664	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1205		1665
1206	unless ($CHLD_W) {	1666	unless ($CHLD_W) {
1207	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1667	$CHLD_W = AE::signal CHLD => \&_sigchld;
1208	# child could be a zombie already, so make at least one round	1668	# child could be a zombie already, so make at least one round
1209	&_sigchld;	1669	&_sigchld;
1210	}	1670	}
1211		1671
1212	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1672	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1213	}	1673	};
1214		1674
1215	sub AnyEvent::Base::child::DESTROY {	1675	*AnyEvent::Base::child::DESTROY = sub {
1216	my ($pid, $cb) = @{$_[0]};	1676	my ($pid, $cb) = @{$_[0]};
1217		1677
1218	delete $PID_CB{$pid}{$cb};	1678	delete $PID_CB{$pid}{$cb};
1219	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1679	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1220		1680
1221	undef $CHLD_W unless keys %PID_CB;	1681	undef $CHLD_W unless keys %PID_CB;
		1682	};
		1683	};
		1684	die if $@;
		1685
		1686	&child
1222	}	1687	}
1223		1688
1224	# idle emulation is done by simply using a timer, regardless	1689	# idle emulation is done by simply using a timer, regardless
1225	# of whether the process is idle or not, and not letting	1690	# of whether the process is idle or not, and not letting
1226	# the callback use more than 50% of the time.	1691	# the callback use more than 50% of the time.
1227	sub idle {	1692	sub idle {
		1693	eval q{ # poor man's autoloading {}
		1694	*idle = sub {
1228	my (undef, %arg) = @_;	1695	my (undef, %arg) = @_;
1229		1696
1230	my ($cb, $w, $rcb) = $arg{cb};	1697	my ($cb, $w, $rcb) = $arg{cb};
1231		1698
1232	$rcb = sub {	1699	$rcb = sub {
1233	if ($cb) {	1700	if ($cb) {
1234	$w = _time;	1701	$w = _time;
1235	&$cb;	1702	&$cb;
1236	$w = _time - $w;	1703	$w = _time - $w;
1237		1704
1238	# never use more then 50% of the time for the idle watcher,	1705	# never use more then 50% of the time for the idle watcher,
1239	# within some limits	1706	# within some limits
1240	$w = 0.0001 if $w < 0.0001;	1707	$w = 0.0001 if $w < 0.0001;
1241	$w = 5 if $w > 5;	1708	$w = 5 if $w > 5;
1242		1709
1243	$w = AnyEvent->timer (after => $w, cb => $rcb);	1710	$w = AE::timer $w, 0, $rcb;
1244	} else {	1711	} else {
1245	# clean up...	1712	# clean up...
1246	undef $w;	1713	undef $w;
1247	undef $rcb;	1714	undef $rcb;
		1715	}
		1716	};
		1717
		1718	$w = AE::timer 0.05, 0, $rcb;
		1719
		1720	bless \\$cb, "AnyEvent::Base::idle"
1248	}	1721	};
		1722
		1723	*AnyEvent::Base::idle::DESTROY = sub {
		1724	undef $${$_[0]};
		1725	};
1249	};	1726	};
		1727	die if $@;
1250		1728
1251	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1729	&idle
1252
1253	bless \\$cb, "AnyEvent::Base::idle"
1254	}
1255
1256	sub AnyEvent::Base::idle::DESTROY {
1257	undef $${$_[0]};
1258	}	1730	}
1259		1731
1260	package AnyEvent::CondVar;	1732	package AnyEvent::CondVar;
1261		1733
1262	our @ISA = AnyEvent::CondVar::Base::;	1734	our @ISA = AnyEvent::CondVar::Base::;
1263		1735
		1736	# only to be used for subclassing
		1737	sub new {
		1738	my $class = shift;
		1739	bless AnyEvent->condvar (@_), $class
		1740	}
		1741
1264	package AnyEvent::CondVar::Base;	1742	package AnyEvent::CondVar::Base;
1265		1743
1266	use overload	1744	#use overload
1267	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1745	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1268	fallback => 1;	1746	# fallback => 1;
		1747
		1748	# save 300+ kilobytes by dirtily hardcoding overloading
		1749	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1750	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1751	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1752	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1753
		1754	our $WAITING;
1269		1755
1270	sub _send {	1756	sub _send {
1271	# nop	1757	# nop
1272	}	1758	}
1273		1759
…		…
1286	sub ready {	1772	sub ready {
1287	$_[0]{_ae_sent}	1773	$_[0]{_ae_sent}
1288	}	1774	}
1289		1775
1290	sub _wait {	1776	sub _wait {
		1777	$WAITING
		1778	and !$_[0]{_ae_sent}
		1779	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1780
		1781	local $WAITING = 1;
1291	AnyEvent->one_event while !$_[0]{_ae_sent};	1782	AnyEvent->one_event while !$_[0]{_ae_sent};
1292	}	1783	}
1293		1784
1294	sub recv {	1785	sub recv {
1295	$_[0]->_wait;	1786	$_[0]->_wait;
…		…
1297	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1788	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1298	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1789	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1299	}	1790	}
1300		1791
1301	sub cb {	1792	sub cb {
1302	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1793	my $cv = shift;
		1794
		1795	@_
		1796	and $cv->{_ae_cb} = shift
		1797	and $cv->{_ae_sent}
		1798	and (delete $cv->{_ae_cb})->($cv);
		1799
1303	$_[0]{_ae_cb}	1800	$cv->{_ae_cb}
1304	}	1801	}
1305		1802
1306	sub begin {	1803	sub begin {
1307	++$_[0]{_ae_counter};	1804	++$_[0]{_ae_counter};
1308	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1805	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1336	so on.	1833	so on.
1337		1834
1338	=head1 ENVIRONMENT VARIABLES	1835	=head1 ENVIRONMENT VARIABLES
1339		1836
1340	The following environment variables are used by this module or its	1837	The following environment variables are used by this module or its
1341	submodules:	1838	submodules.
		1839
		1840	Note that AnyEvent will remove I<all> environment variables starting with
		1841	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1842	enabled.
1342		1843
1343	=over 4	1844	=over 4
1344		1845
1345	=item C<PERL_ANYEVENT_VERBOSE>	1846	=item C<PERL_ANYEVENT_VERBOSE>
1346		1847
…		…
1353	C<PERL_ANYEVENT_MODEL>.	1854	C<PERL_ANYEVENT_MODEL>.
1354		1855
1355	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1856	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1356	model it chooses.	1857	model it chooses.
1357		1858
		1859	When set to C<8> or higher, then AnyEvent will report extra information on
		1860	which optional modules it loads and how it implements certain features.
		1861
1358	=item C<PERL_ANYEVENT_STRICT>	1862	=item C<PERL_ANYEVENT_STRICT>
1359		1863
1360	AnyEvent does not do much argument checking by default, as thorough	1864	AnyEvent does not do much argument checking by default, as thorough
1361	argument checking is very costly. Setting this variable to a true value	1865	argument checking is very costly. Setting this variable to a true value
1362	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1866	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1363	check the arguments passed to most method calls. If it finds any problems	1867	check the arguments passed to most method calls. If it finds any problems,
1364	it will croak.	1868	it will croak.
1365		1869
1366	In other words, enables "strict" mode.	1870	In other words, enables "strict" mode.
1367		1871
1368	Unlike C<use strict>, it is definitely recommended ot keep it off in	1872	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1369	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1873	>>, it is definitely recommended to keep it off in production. Keeping
1370	developing programs can be very useful, however.	1874	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1875	can be very useful, however.
1371		1876
1372	=item C<PERL_ANYEVENT_MODEL>	1877	=item C<PERL_ANYEVENT_MODEL>
1373		1878
1374	This can be used to specify the event model to be used by AnyEvent, before	1879	This can be used to specify the event model to be used by AnyEvent, before
1375	auto detection and -probing kicks in. It must be a string consisting	1880	auto detection and -probing kicks in. It must be a string consisting
…		…
1418		1923
1419	=item C<PERL_ANYEVENT_MAX_FORKS>	1924	=item C<PERL_ANYEVENT_MAX_FORKS>
1420		1925
1421	The maximum number of child processes that C<AnyEvent::Util::fork_call>	1926	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1422	will create in parallel.	1927	will create in parallel.
		1928
		1929	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1930
		1931	The default value for the C<max_outstanding> parameter for the default DNS
		1932	resolver - this is the maximum number of parallel DNS requests that are
		1933	sent to the DNS server.
		1934
		1935	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1936
		1937	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1938	configuration) in the default resolver. When set to the empty string, no
		1939	default config will be used.
		1940
		1941	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1942
		1943	When neither C<ca_file> nor C<ca_path> was specified during
		1944	L<AnyEvent::TLS> context creation, and either of these environment
		1945	variables exist, they will be used to specify CA certificate locations
		1946	instead of a system-dependent default.
		1947
		1948	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1949
		1950	When these are set to C<1>, then the respective modules are not
		1951	loaded. Mostly good for testing AnyEvent itself.
1423		1952
1424	=back	1953	=back
1425		1954
1426	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1955	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1427		1956
…		…
1485	warn "read: $input\n"; # output what has been read	2014	warn "read: $input\n"; # output what has been read
1486	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2015	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1487	},	2016	},
1488	);	2017	);
1489		2018
1490	my $time_watcher; # can only be used once
1491
1492	sub new_timer {
1493	$timer = AnyEvent->timer (after => 1, cb => sub {	2019	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1494	warn "timeout\n"; # print 'timeout' about every second	2020	warn "timeout\n"; # print 'timeout' at most every second
1495	&new_timer; # and restart the time
1496	});	2021	});
1497	}
1498
1499	new_timer; # create first timer
1500		2022
1501	$cv->recv; # wait until user enters /^q/i	2023	$cv->recv; # wait until user enters /^q/i
1502		2024
1503	=head1 REAL-WORLD EXAMPLE	2025	=head1 REAL-WORLD EXAMPLE
1504		2026
…		…
1577		2099
1578	The actual code goes further and collects all errors (C<die>s, exceptions)	2100	The actual code goes further and collects all errors (C<die>s, exceptions)
1579	that occurred during request processing. The C<result> method detects	2101	that occurred during request processing. The C<result> method detects
1580	whether an exception as thrown (it is stored inside the $txn object)	2102	whether an exception as thrown (it is stored inside the $txn object)
1581	and just throws the exception, which means connection errors and other	2103	and just throws the exception, which means connection errors and other
1582	problems get reported tot he code that tries to use the result, not in a	2104	problems get reported to the code that tries to use the result, not in a
1583	random callback.	2105	random callback.
1584		2106
1585	All of this enables the following usage styles:	2107	All of this enables the following usage styles:
1586		2108
1587	1. Blocking:	2109	1. Blocking:
…		…
1635	through AnyEvent. The benchmark creates a lot of timers (with a zero	2157	through AnyEvent. The benchmark creates a lot of timers (with a zero
1636	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2158	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1637	which it is), lets them fire exactly once and destroys them again.	2159	which it is), lets them fire exactly once and destroys them again.
1638		2160
1639	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2161	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1640	distribution.	2162	distribution. It uses the L<AE> interface, which makes a real difference
		2163	for the EV and Perl backends only.
1641		2164
1642	=head3 Explanation of the columns	2165	=head3 Explanation of the columns
1643		2166
1644	I<watcher> is the number of event watchers created/destroyed. Since	2167	I<watcher> is the number of event watchers created/destroyed. Since
1645	different event models feature vastly different performances, each event	2168	different event models feature vastly different performances, each event
…		…
1666	watcher.	2189	watcher.
1667		2190
1668	=head3 Results	2191	=head3 Results
1669		2192
1670	name watchers bytes create invoke destroy comment	2193	name watchers bytes create invoke destroy comment
1671	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2194	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1672	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2195	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1673	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2196	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1674	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2197	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1675	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2198	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1676	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2199	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
		2200	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
		2201	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1677	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2202	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1678	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2203	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1679	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2204	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1680	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2205	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1681		2206
1682	=head3 Discussion	2207	=head3 Discussion
1683		2208
1684	The benchmark does I<not> measure scalability of the event loop very	2209	The benchmark does I<not> measure scalability of the event loop very
1685	well. For example, a select-based event loop (such as the pure perl one)	2210	well. For example, a select-based event loop (such as the pure perl one)
…		…
1697	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2222	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1698	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2223	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1699	cycles with POE.	2224	cycles with POE.
1700		2225
1701	C<EV> is the sole leader regarding speed and memory use, which are both	2226	C<EV> is the sole leader regarding speed and memory use, which are both
1702	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2227	maximal/minimal, respectively. When using the L<AE> API there is zero
		2228	overhead (when going through the AnyEvent API create is about 5-6 times
		2229	slower, with other times being equal, so still uses far less memory than
1703	far less memory than any other event loop and is still faster than Event	2230	any other event loop and is still faster than Event natively).
1704	natively.
1705		2231
1706	The pure perl implementation is hit in a few sweet spots (both the	2232	The pure perl implementation is hit in a few sweet spots (both the
1707	constant timeout and the use of a single fd hit optimisations in the perl	2233	constant timeout and the use of a single fd hit optimisations in the perl
1708	interpreter and the backend itself). Nevertheless this shows that it	2234	interpreter and the backend itself). Nevertheless this shows that it
1709	adds very little overhead in itself. Like any select-based backend its	2235	adds very little overhead in itself. Like any select-based backend its
1710	performance becomes really bad with lots of file descriptors (and few of	2236	performance becomes really bad with lots of file descriptors (and few of
1711	them active), of course, but this was not subject of this benchmark.	2237	them active), of course, but this was not subject of this benchmark.
1712		2238
1713	The C<Event> module has a relatively high setup and callback invocation	2239	The C<Event> module has a relatively high setup and callback invocation
1714	cost, but overall scores in on the third place.	2240	cost, but overall scores in on the third place.
		2241
		2242	C<IO::Async> performs admirably well, about on par with C<Event>, even
		2243	when using its pure perl backend.
1715		2244
1716	C<Glib>'s memory usage is quite a bit higher, but it features a	2245	C<Glib>'s memory usage is quite a bit higher, but it features a
1717	faster callback invocation and overall ends up in the same class as	2246	faster callback invocation and overall ends up in the same class as
1718	C<Event>. However, Glib scales extremely badly, doubling the number of	2247	C<Event>. However, Glib scales extremely badly, doubling the number of
1719	watchers increases the processing time by more than a factor of four,	2248	watchers increases the processing time by more than a factor of four,
…		…
1780	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2309	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1781	(1%) are active. This mirrors the activity of large servers with many	2310	(1%) are active. This mirrors the activity of large servers with many
1782	connections, most of which are idle at any one point in time.	2311	connections, most of which are idle at any one point in time.
1783		2312
1784	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2313	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1785	distribution.	2314	distribution. It uses the L<AE> interface, which makes a real difference
		2315	for the EV and Perl backends only.
1786		2316
1787	=head3 Explanation of the columns	2317	=head3 Explanation of the columns
1788		2318
1789	I<sockets> is the number of sockets, and twice the number of "servers" (as	2319	I<sockets> is the number of sockets, and twice the number of "servers" (as
1790	each server has a read and write socket end).	2320	each server has a read and write socket end).
…		…
1797	it to another server. This includes deleting the old timeout and creating	2327	it to another server. This includes deleting the old timeout and creating
1798	a new one that moves the timeout into the future.	2328	a new one that moves the timeout into the future.
1799		2329
1800	=head3 Results	2330	=head3 Results
1801		2331
1802	name sockets create request	2332	name sockets create request
1803	EV 20000 69.01 11.16	2333	EV 20000 62.66 7.99
1804	Perl 20000 73.32 35.87	2334	Perl 20000 68.32 32.64
1805	Event 20000 212.62 257.32	2335	IOAsync 20000 174.06 101.15 epoll
1806	Glib 20000 651.16 1896.30	2336	IOAsync 20000 174.67 610.84 poll
		2337	Event 20000 202.69 242.91
		2338	Glib 20000 557.01 1689.52
1807	POE 20000 349.67 12317.24 uses POE::Loop::Event	2339	POE 20000 341.54 12086.32 uses POE::Loop::Event
1808		2340
1809	=head3 Discussion	2341	=head3 Discussion
1810		2342
1811	This benchmark I<does> measure scalability and overall performance of the	2343	This benchmark I<does> measure scalability and overall performance of the
1812	particular event loop.	2344	particular event loop.
…		…
1814	EV is again fastest. Since it is using epoll on my system, the setup time	2346	EV is again fastest. Since it is using epoll on my system, the setup time
1815	is relatively high, though.	2347	is relatively high, though.
1816		2348
1817	Perl surprisingly comes second. It is much faster than the C-based event	2349	Perl surprisingly comes second. It is much faster than the C-based event
1818	loops Event and Glib.	2350	loops Event and Glib.
		2351
		2352	IO::Async performs very well when using its epoll backend, and still quite
		2353	good compared to Glib when using its pure perl backend.
1819		2354
1820	Event suffers from high setup time as well (look at its code and you will	2355	Event suffers from high setup time as well (look at its code and you will
1821	understand why). Callback invocation also has a high overhead compared to	2356	understand why). Callback invocation also has a high overhead compared to
1822	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2357	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1823	uses select or poll in basically all documented configurations.	2358	uses select or poll in basically all documented configurations.
…		…
1886	=item * C-based event loops perform very well with small number of	2421	=item * C-based event loops perform very well with small number of
1887	watchers, as the management overhead dominates.	2422	watchers, as the management overhead dominates.
1888		2423
1889	=back	2424	=back
1890		2425
		2426	=head2 THE IO::Lambda BENCHMARK
		2427
		2428	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2429	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2430	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2431	shouldn't come as a surprise to anybody). As such, the benchmark is
		2432	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2433	very optimal. But how would AnyEvent compare when used without the extra
		2434	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2435
		2436	The benchmark itself creates an echo-server, and then, for 500 times,
		2437	connects to the echo server, sends a line, waits for the reply, and then
		2438	creates the next connection. This is a rather bad benchmark, as it doesn't
		2439	test the efficiency of the framework or much non-blocking I/O, but it is a
		2440	benchmark nevertheless.
		2441
		2442	name runtime
		2443	Lambda/select 0.330 sec
		2444	+ optimized 0.122 sec
		2445	Lambda/AnyEvent 0.327 sec
		2446	+ optimized 0.138 sec
		2447	Raw sockets/select 0.077 sec
		2448	POE/select, components 0.662 sec
		2449	POE/select, raw sockets 0.226 sec
		2450	POE/select, optimized 0.404 sec
		2451
		2452	AnyEvent/select/nb 0.085 sec
		2453	AnyEvent/EV/nb 0.068 sec
		2454	+state machine 0.134 sec
		2455
		2456	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2457	benchmarks actually make blocking connects and use 100% blocking I/O,
		2458	defeating the purpose of an event-based solution. All of the newly
		2459	written AnyEvent benchmarks use 100% non-blocking connects (using
		2460	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2461	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2462	generally require a lot more bookkeeping and event handling than blocking
		2463	connects (which involve a single syscall only).
		2464
		2465	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2466	offers similar expressive power as POE and IO::Lambda, using conventional
		2467	Perl syntax. This means that both the echo server and the client are 100%
		2468	non-blocking, further placing it at a disadvantage.
		2469
		2470	As you can see, the AnyEvent + EV combination even beats the
		2471	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2472	backend easily beats IO::Lambda and POE.
		2473
		2474	And even the 100% non-blocking version written using the high-level (and
		2475	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
		2476	higher level ("unoptimised") abstractions by a large margin, even though
		2477	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
		2478
		2479	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2480	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2481	part of the IO::Lambda distribution and were used without any changes.
		2482
1891		2483
1892	=head1 SIGNALS	2484	=head1 SIGNALS
1893		2485
1894	AnyEvent currently installs handlers for these signals:	2486	AnyEvent currently installs handlers for these signals:
1895		2487
…		…
1898	=item SIGCHLD	2490	=item SIGCHLD
1899		2491
1900	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2492	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1901	emulation for event loops that do not support them natively. Also, some	2493	emulation for event loops that do not support them natively. Also, some
1902	event loops install a similar handler.	2494	event loops install a similar handler.
		2495
		2496	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2497	AnyEvent will reset it to default, to avoid losing child exit statuses.
1903		2498
1904	=item SIGPIPE	2499	=item SIGPIPE
1905		2500
1906	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2501	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1907	when AnyEvent gets loaded.	2502	when AnyEvent gets loaded.
…		…
1919		2514
1920	=back	2515	=back
1921		2516
1922	=cut	2517	=cut
1923		2518
		2519	undef $SIG{CHLD}
		2520	if $SIG{CHLD} eq 'IGNORE';
		2521
1924	$SIG{PIPE} = sub { }	2522	$SIG{PIPE} = sub { }
1925	unless defined $SIG{PIPE};	2523	unless defined $SIG{PIPE};
1926		2524
		2525	=head1 RECOMMENDED/OPTIONAL MODULES
		2526
		2527	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2528	its built-in modules) are required to use it.
		2529
		2530	That does not mean that AnyEvent won't take advantage of some additional
		2531	modules if they are installed.
		2532
		2533	This section explains which additional modules will be used, and how they
		2534	affect AnyEvent's operation.
		2535
		2536	=over 4
		2537
		2538	=item L<Async::Interrupt>
		2539
		2540	This slightly arcane module is used to implement fast signal handling: To
		2541	my knowledge, there is no way to do completely race-free and quick
		2542	signal handling in pure perl. To ensure that signals still get
		2543	delivered, AnyEvent will start an interval timer to wake up perl (and
		2544	catch the signals) with some delay (default is 10 seconds, look for
		2545	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2546
		2547	If this module is available, then it will be used to implement signal
		2548	catching, which means that signals will not be delayed, and the event loop
		2549	will not be interrupted regularly, which is more efficient (and good for
		2550	battery life on laptops).
		2551
		2552	This affects not just the pure-perl event loop, but also other event loops
		2553	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2554
		2555	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2556	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2557	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2558	does nothing for those backends.
		2559
		2560	=item L<EV>
		2561
		2562	This module isn't really "optional", as it is simply one of the backend
		2563	event loops that AnyEvent can use. However, it is simply the best event
		2564	loop available in terms of features, speed and stability: It supports
		2565	the AnyEvent API optimally, implements all the watcher types in XS, does
		2566	automatic timer adjustments even when no monotonic clock is available,
		2567	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2568	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2569	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2570
		2571	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2572	then this module will do nothing for you.
		2573
		2574	=item L<Guard>
		2575
		2576	The guard module, when used, will be used to implement
		2577	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2578	lot less memory), but otherwise doesn't affect guard operation much. It is
		2579	purely used for performance.
		2580
		2581	=item L<JSON> and L<JSON::XS>
		2582
		2583	One of these modules is required when you want to read or write JSON data
		2584	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
		2585	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2586
		2587	=item L<Net::SSLeay>
		2588
		2589	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2590	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2591	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2592
		2593	=item L<Time::HiRes>
		2594
		2595	This module is part of perl since release 5.008. It will be used when the
		2596	chosen event library does not come with a timing source of its own. The
		2597	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2598	try to use a monotonic clock for timing stability.
		2599
		2600	=back
		2601
1927		2602
1928	=head1 FORK	2603	=head1 FORK
1929		2604
1930	Most event libraries are not fork-safe. The ones who are usually are	2605	Most event libraries are not fork-safe. The ones who are usually are
1931	because they rely on inefficient but fork-safe C<select> or C<poll>	2606	because they rely on inefficient but fork-safe C<select> or C<poll> calls
1932	calls. Only L<EV> is fully fork-aware.	2607	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2608	are usually badly thought-out hacks that are incompatible with fork in
		2609	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2610	continue event-processing in both parent and child (or both, if you know
		2611	what you are doing).
		2612
		2613	This means that, in general, you cannot fork and do event processing in
		2614	the child if the event library was initialised before the fork (which
		2615	usually happens when the first AnyEvent watcher is created, or the library
		2616	is loaded).
1933		2617
1934	If you have to fork, you must either do so I<before> creating your first	2618	If you have to fork, you must either do so I<before> creating your first
1935	watcher OR you must not use AnyEvent at all in the child.	2619	watcher OR you must not use AnyEvent at all in the child OR you must do
		2620	something completely out of the scope of AnyEvent.
		2621
		2622	The problem of doing event processing in the parent I<and> the child
		2623	is much more complicated: even for backends that I<are> fork-aware or
		2624	fork-safe, their behaviour is not usually what you want: fork clones all
		2625	watchers, that means all timers, I/O watchers etc. are active in both
		2626	parent and child, which is almost never what you want. USing C<exec>
		2627	to start worker children from some kind of manage rprocess is usually
		2628	preferred, because it is much easier and cleaner, at the expense of having
		2629	to have another binary.
1936		2630
1937		2631
1938	=head1 SECURITY CONSIDERATIONS	2632	=head1 SECURITY CONSIDERATIONS
1939		2633
1940	AnyEvent can be forced to load any event model via	2634	AnyEvent can be forced to load any event model via
…		…
1952	use AnyEvent;	2646	use AnyEvent;
1953		2647
1954	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2648	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1955	be used to probe what backend is used and gain other information (which is	2649	be used to probe what backend is used and gain other information (which is
1956	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and	2650	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1957	$ENV{PERL_ANYEGENT_STRICT}.	2651	$ENV{PERL_ANYEVENT_STRICT}.
		2652
		2653	Note that AnyEvent will remove I<all> environment variables starting with
		2654	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2655	enabled.
1958		2656
1959		2657
1960	=head1 BUGS	2658	=head1 BUGS
1961		2659
1962	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	2660	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
…		…
1966	pronounced).	2664	pronounced).
1967		2665
1968		2666
1969	=head1 SEE ALSO	2667	=head1 SEE ALSO
1970		2668
		2669	Tutorial/Introduction: L<AnyEvent::Intro>.
		2670
		2671	FAQ: L<AnyEvent::FAQ>.
		2672
1971	Utility functions: L<AnyEvent::Util>.	2673	Utility functions: L<AnyEvent::Util>.
1972		2674
1973	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2675	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1974	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2676	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1975		2677
1976	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2678	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1977	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2679	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1978	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2680	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1979	L<AnyEvent::Impl::POE>.	2681	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1980		2682
1981	Non-blocking file handles, sockets, TCP clients and	2683	Non-blocking file handles, sockets, TCP clients and
1982	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2684	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1983		2685
1984	Asynchronous DNS: L<AnyEvent::DNS>.	2686	Asynchronous DNS: L<AnyEvent::DNS>.
1985		2687
1986	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2688	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
1987		2689
1988	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2690	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
		2691	L<AnyEvent::HTTP>.
1989		2692
1990		2693
1991	=head1 AUTHOR	2694	=head1 AUTHOR
1992		2695
1993	Marc Lehmann <schmorp@schmorp.de>	2696	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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