ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.218 by root, Wed Jun 24 10:03:42 2009 UTC vs.
Revision 1.376 by root, Thu Aug 25 06:34:11 2011 UTC

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

Diff Legend

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