ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.126 by root, Fri May 23 23:44:55 2008 UTC vs.
Revision 1.355 by root, Fri Aug 12 00:53:29 2011 UTC

1	=head1 => NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
		6	and POE are various supported event loops/environments.
6		7
7	=head1 SYNOPSIS	8	=head1 SYNOPSIS
8		9
9	use AnyEvent;	10	use AnyEvent;
10		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
		15	# file handle or descriptor readable
11	my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub {	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
		17
		18	# one-shot or repeating timers
		19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
		20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
		21
		22	print AnyEvent->now; # prints current event loop time
		23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
		24
		25	# POSIX signal
		26	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
		27
		28	# child process exit
		29	my $w = AnyEvent->child (pid => $pid, cb => sub {
		30	my ($pid, $status) = @_;
12	...	31	...
13	});	32	});
14		33
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {	34	# called when event loop idle (if applicable)
16	...	35	my $w = AnyEvent->idle (cb => sub { ... });
17	});
18		36
19	my $w = AnyEvent->condvar; # stores whether a condition was flagged	37	my $w = AnyEvent->condvar; # stores whether a condition was flagged
20	$w->send; # wake up current and all future recv's	38	$w->send; # wake up current and all future recv's
21	$w->recv; # enters "main loop" till $condvar gets ->send	39	$w->recv; # enters "main loop" till $condvar gets ->send
		40	# use a condvar in callback mode:
		41	$w->cb (sub { $_[0]->recv });
		42
		43	=head1 INTRODUCTION/TUTORIAL
		44
		45	This manpage is mainly a reference manual. If you are interested
		46	in a tutorial or some gentle introduction, have a look at the
		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.
22		58
23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	59	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24		60
25	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
26	nowadays. So what is different about AnyEvent?	62	nowadays. So what is different about AnyEvent?
27		63
28	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	64	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29	policy> and AnyEvent is I<small and efficient>.	65	policy> and AnyEvent is I<small and efficient>.
30		66
31	First and foremost, I<AnyEvent is not an event model> itself, it only	67	First and foremost, I<AnyEvent is not an event model> itself, it only
32	interfaces to whatever event model the main program happens to use in a	68	interfaces to whatever event model the main program happens to use, in a
33	pragmatic way. For event models and certain classes of immortals alike,	69	pragmatic way. For event models and certain classes of immortals alike,
34	the statement "there can only be one" is a bitter reality: In general,	70	the statement "there can only be one" is a bitter reality: In general,
35	only one event loop can be active at the same time in a process. AnyEvent	71	only one event loop can be active at the same time in a process. AnyEvent
36	helps hiding the differences between those event loops.	72	cannot change this, but it can hide the differences between those event
		73	loops.
37		74
38	The goal of AnyEvent is to offer module authors the ability to do event	75	The goal of AnyEvent is to offer module authors the ability to do event
39	programming (waiting for I/O or timer events) without subscribing to a	76	programming (waiting for I/O or timer events) without subscribing to a
40	religion, a way of living, and most importantly: without forcing your	77	religion, a way of living, and most importantly: without forcing your
41	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
42	model you use.	79	model you use.
43		80
44	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
45	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
46	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
47	cannot use anything else, as it is simply incompatible to everything that	84	cannot use anything else, as they are simply incompatible to everything
48	isn't itself. What's worse, all the potential users of your module are	85	that isn't them. What's worse, all the potential users of your
49	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.
50		87
51	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	88	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52	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
53	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
54	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
55	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
56	event models it supports (including stuff like POE and IO::Async, as long	93	supports (including stuff like IO::Async, as long as those use one of the
57	as those use one of the supported event loops. It is trivial to add new	94	supported event loops. It is easy to add new event loops to AnyEvent, too,
58	event loops to AnyEvent, too, so it is future-proof).	95	so it is future-proof).
59		96
60	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
61	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
62	modules, you get an enourmous amount of code and strict rules you have to	99	modules, you get an enormous amount of code and strict rules you have to
63	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
64	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
65	technically possible.	102	technically possible.
66		103
		104	Of course, AnyEvent comes with a big (and fully optional!) toolbox
		105	of useful functionality, such as an asynchronous DNS resolver, 100%
		106	non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
		107	such as Windows) and lots of real-world knowledge and workarounds for
		108	platform bugs and differences.
		109
67	Of course, if you want lots of policy (this can arguably be somewhat	110	Now, if you I<do want> lots of policy (this can arguably be somewhat
68	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
69	model, you should I<not> use this module.	112	model, you should I<not> use this module.
70		113
71	=head1 DESCRIPTION	114	=head1 DESCRIPTION
72		115
73	L<AnyEvent> provides an identical interface to multiple event loops. This	116	L<AnyEvent> provides a uniform interface to various event loops. This
74	allows module authors to utilise an event loop without forcing module	117	allows module authors to use event loop functionality without forcing
75	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
76	peacefully at any one time).	119	than one event loop cannot coexist peacefully).
77		120
78	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>
79	module.	122	module.
80		123
81	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
82	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
83	following modules is already loaded: L<EV>,	126	following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
84	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
85	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
86	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
87	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
88	be successfully loaded will be used. If, after this, still none could be	131	the other two are not normally tried.
89	found, AnyEvent will fall back to a pure-perl event loop, which is not
90	very efficient, but should work everywhere.
91		132
92	Because AnyEvent first checks for modules that are already loaded, loading	133	Because AnyEvent first checks for modules that are already loaded, loading
93	an event model explicitly before first using AnyEvent will likely make	134	an event model explicitly before first using AnyEvent will likely make
94	that model the default. For example:	135	that model the default. For example:
95		136
…		…
97	use AnyEvent;	138	use AnyEvent;
98		139
99	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
100		141
101	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
102	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,
103	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
104		146
105	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
106	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
107	explicitly.	149	availability of that event loop :)
108		150
109	=head1 WATCHERS	151	=head1 WATCHERS
110		152
111	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
112	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
113	the callback to call, the filehandle to watch, etc.	155	the callback to call, the file handle to watch, etc.
114		156
115	These watchers are normal Perl objects with normal Perl lifetime. After	157	These watchers are normal Perl objects with normal Perl lifetime. After
116	creating a watcher it will immediately "watch" for events and invoke the	158	creating a watcher it will immediately "watch" for events and invoke the
117	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
118	is in control).	160	is in control).
119		161
		162	Note that B<callbacks must not permanently change global variables>
		163	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
		164	callbacks must not C<die> >>. The former is good programming practice in
		165	Perl and the latter stems from the fact that exception handling differs
		166	widely between event loops.
		167
120	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
121	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
122	to it).	170	to it).
123		171
124	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.
125		173
126	Many watchers either are used with "recursion" (repeating timers for	174	Many watchers either are used with "recursion" (repeating timers for
127	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.
128		176
129	An any way to achieve that is this pattern:	177	One way to achieve that is this pattern:
130		178
131	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	179	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
132	# you can use $w here, for example to undef it	180	# you can use $w here, for example to undef it
133	undef $w;	181	undef $w;
134	});	182	});
135		183
136	Note that C<my $w; $w => combination. This is necessary because in Perl,	184	Note that C<my $w; $w => combination. This is necessary because in Perl,
137	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
138	declared.	186	declared.
139		187
140	=head2 I/O WATCHERS	188	=head2 I/O WATCHERS
141		189
		190	$w = AnyEvent->io (
		191	fh => <filehandle_or_fileno>,
		192	poll => <"r" or "w">,
		193	cb => <callback>,
		194	);
		195
142	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
143	with the following mandatory key-value pairs as arguments:	197	with the following mandatory key-value pairs as arguments:
144		198
145	C<fh> 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
		200	for events (AnyEvent might or might not keep a reference to this file
		201	handle). Note that only file handles pointing to things for which
		202	non-blocking operation makes sense are allowed. This includes sockets,
		203	most character devices, pipes, fifos and so on, but not for example files
		204	or block devices.
		205
146	for events. C<poll> must be a string that is either C<r> or C<w>,	206	C<poll> must be a string that is either C<r> or C<w>, which creates a
147	which creates a watcher waiting for "r"eadable or "w"ritable events,	207	watcher waiting for "r"eadable or "w"ritable events, respectively.
		208
148	respectively. C<cb> is the callback to invoke each time the file handle	209	C<cb> is the callback to invoke each time the file handle becomes ready.
149	becomes ready.
150		210
151	Although the callback might get passed parameters, their value and	211	Although the callback might get passed parameters, their value and
152	presence is undefined and you cannot rely on them. Portable AnyEvent	212	presence is undefined and you cannot rely on them. Portable AnyEvent
153	callbacks cannot use arguments passed to I/O watcher callbacks.	213	callbacks cannot use arguments passed to I/O watcher callbacks.
154		214
155	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.
156	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
157	underlying file descriptor.	217	underlying file descriptor.
158		218
159	Some event loops issue spurious readyness notifications, so you should	219	Some event loops issue spurious readiness notifications, so you should
160	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
161	handles.	221	handles.
162		222
163	Example:
164
165	# wait for readability of STDIN, then read a line and disable the watcher	223	Example: wait for readability of STDIN, then read a line and disable the
		224	watcher.
		225
166	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	226	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
167	chomp (my $input = <STDIN>);	227	chomp (my $input = <STDIN>);
168	warn "read: $input\n";	228	warn "read: $input\n";
169	undef $w;	229	undef $w;
170	});	230	});
171		231
172	=head2 TIME WATCHERS	232	=head2 TIME WATCHERS
173		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
174	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 >>
175	method with the following mandatory arguments:	243	method with the following mandatory arguments:
176		244
177	C<after> specifies after how many seconds (fractional values are	245	C<after> specifies after how many seconds (fractional values are
178	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
…		…
180		248
181	Although the callback might get passed parameters, their value and	249	Although the callback might get passed parameters, their value and
182	presence is undefined and you cannot rely on them. Portable AnyEvent	250	presence is undefined and you cannot rely on them. Portable AnyEvent
183	callbacks cannot use arguments passed to time watcher callbacks.	251	callbacks cannot use arguments passed to time watcher callbacks.
184		252
185	The timer callback will be invoked at most once: if you want a repeating	253	The callback will normally be invoked only once. If you specify another
186	timer you have to create a new watcher (this is a limitation by both Tk	254	parameter, C<interval>, as a strictly positive number (> 0), then the
187	and Glib).	255	callback will be invoked regularly at that interval (in fractional
		256	seconds) after the first invocation. If C<interval> is specified with a
		257	false value, then it is treated as if it were not specified at all.
188		258
189	Example:	259	The callback will be rescheduled before invoking the callback, but no
		260	attempt is made to avoid timer drift in most backends, so the interval is
		261	only approximate.
190		262
191	# fire an event after 7.7 seconds	263	Example: fire an event after 7.7 seconds.
		264
192	my $w = AnyEvent->timer (after => 7.7, cb => sub {	265	my $w = AnyEvent->timer (after => 7.7, cb => sub {
193	warn "timeout\n";	266	warn "timeout\n";
194	});	267	});
195		268
196	# to cancel the timer:	269	# to cancel the timer:
197	undef $w;	270	undef $w;
198		271
199	Example 2:
200
201	# fire an event after 0.5 seconds, then roughly every second	272	Example 2: fire an event after 0.5 seconds, then roughly every second.
202	my $w;
203		273
204	my $cb = sub {
205	# cancel the old timer while creating a new one
206	$w = AnyEvent->timer (after => 1, cb => $cb);	274	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
		275	warn "timeout\n";
207	};	276	};
208
209	# start the "loop" by creating the first watcher
210	$w = AnyEvent->timer (after => 0.5, cb => $cb);
211		277
212	=head3 TIMING ISSUES	278	=head3 TIMING ISSUES
213		279
214	There are two ways to handle timers: based on real time (relative, "fire	280	There are two ways to handle timers: based on real time (relative, "fire
215	in 10 seconds") and based on wallclock time (absolute, "fire at 12	281	in 10 seconds") and based on wallclock time (absolute, "fire at 12
…		…
217		283
218	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
219	use absolute time internally. This makes a difference when your clock	285	use absolute time internally. This makes a difference when your clock
220	"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
221	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
222	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.
223		289
224	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
225	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
226	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)
227	timers.	293	timers.
228		294
229	AnyEvent always prefers relative timers, if available, matching the	295	AnyEvent always prefers relative timers, if available, matching the
230	AnyEvent API.	296	AnyEvent API.
231		297
		298	AnyEvent has two additional methods that return the "current time":
		299
		300	=over 4
		301
		302	=item AnyEvent->time
		303
		304	This returns the "current wallclock time" as a fractional number of
		305	seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
		306	return, and the result is guaranteed to be compatible with those).
		307
		308	It progresses independently of any event loop processing, i.e. each call
		309	will check the system clock, which usually gets updated frequently.
		310
		311	=item AnyEvent->now
		312
		313	This also returns the "current wallclock time", but unlike C<time>, above,
		314	this value might change only once per event loop iteration, depending on
		315	the event loop (most return the same time as C<time>, above). This is the
		316	time that AnyEvent's timers get scheduled against.
		317
		318	I<In almost all cases (in all cases if you don't care), this is the
		319	function to call when you want to know the current time.>
		320
		321	This function is also often faster then C<< AnyEvent->time >>, and
		322	thus the preferred method if you want some timestamp (for example,
		323	L<AnyEvent::Handle> uses this to update its activity timeouts).
		324
		325	The rest of this section is only of relevance if you try to be very exact
		326	with your timing; you can skip it without a bad conscience.
		327
		328	For a practical example of when these times differ, consider L<Event::Lib>
		329	and L<EV> and the following set-up:
		330
		331	The event loop is running and has just invoked one of your callbacks at
		332	time=500 (assume no other callbacks delay processing). In your callback,
		333	you wait a second by executing C<sleep 1> (blocking the process for a
		334	second) and then (at time=501) you create a relative timer that fires
		335	after three seconds.
		336
		337	With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
		338	both return C<501>, because that is the current time, and the timer will
		339	be scheduled to fire at time=504 (C<501> + C<3>).
		340
		341	With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
		342	time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
		343	last event processing phase started. With L<EV>, your timer gets scheduled
		344	to run at time=503 (C<500> + C<3>).
		345
		346	In one sense, L<Event::Lib> is more exact, as it uses the current time
		347	regardless of any delays introduced by event processing. However, most
		348	callbacks do not expect large delays in processing, so this causes a
		349	higher drift (and a lot more system calls to get the current time).
		350
		351	In another sense, L<EV> is more exact, as your timer will be scheduled at
		352	the same time, regardless of how long event processing actually took.
		353
		354	In either case, if you care (and in most cases, you don't), then you
		355	can get whatever behaviour you want with any event loop, by taking the
		356	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
		357	account.
		358
		359	=item AnyEvent->now_update
		360
		361	Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
		362	time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
		363	above).
		364
		365	When a callback runs for a long time (or when the process sleeps), then
		366	this "current" time will differ substantially from the real time, which
		367	might affect timers and time-outs.
		368
		369	When this is the case, you can call this method, which will update the
		370	event loop's idea of "current time".
		371
		372	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		373	when mod_perl executes the script, then the event loop will have the wrong
		374	idea about the "current time" (being potentially far in the past, when the
		375	script ran the last time). In that case you should arrange a call to C<<
		376	AnyEvent->now_update >> each time the web server process wakes up again
		377	(e.g. at the start of your script, or in a handler).
		378
		379	Note that updating the time I<might> cause some events to be handled.
		380
		381	=back
		382
232	=head2 SIGNAL WATCHERS	383	=head2 SIGNAL WATCHERS
233		384
		385	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		386
234	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
235	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to	388	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
236	be invoked whenever a signal occurs.	389	callback to be invoked whenever a signal occurs.
237		390
238	Although the callback might get passed parameters, their value and	391	Although the callback might get passed parameters, their value and
239	presence is undefined and you cannot rely on them. Portable AnyEvent	392	presence is undefined and you cannot rely on them. Portable AnyEvent
240	callbacks cannot use arguments passed to signal watcher callbacks.	393	callbacks cannot use arguments passed to signal watcher callbacks.
241		394
242	Multiple signal occurances can be clumped together into one callback	395	Multiple signal occurrences can be clumped together into one callback
243	invocation, and callback invocation will be synchronous. synchronous means	396	invocation, and callback invocation will be synchronous. Synchronous means
244	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,
245	but it is guarenteed not to interrupt any other callbacks.	398	but it is guaranteed not to interrupt any other callbacks.
246		399
247	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
248	between multiple watchers.	401	between multiple watchers, and AnyEvent will ensure that signals will not
		402	interrupt your program at bad times.
249		403
250	This watcher might use C<%SIG>, so programs overwriting those signals	404	This watcher might use C<%SIG> (depending on the event loop used),
251	directly will likely not work correctly.	405	so programs overwriting those signals directly will likely not work
		406	correctly.
252		407
253	Example: exit on SIGINT	408	Example: exit on SIGINT
254		409
255	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	410	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
256		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
257	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
258		450
		451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		452
259	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.
260		454
261	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,
262	watches for any child process exit). The watcher will trigger as often	456	using C<0> watches for any child process exit, on others this will
263	as status change for the child are received. This works by installing a	457	croak). The watcher will be triggered only when the child process has
264	signal handler for C<SIGCHLD>. The callback will be called with the pid	458	finished and an exit status is available, not on any trace events
265	and exit status (as returned by waitpid), so unlike other watcher types,	459	(stopped/continued).
266	you I<can> rely on child watcher callback arguments.	460
		461	The callback will be called with the pid and exit status (as returned by
		462	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		463	callback arguments.
		464
		465	This watcher type works by installing a signal handler for C<SIGCHLD>,
		466	and since it cannot be shared, nothing else should use SIGCHLD or reap
		467	random child processes (waiting for specific child processes, e.g. inside
		468	C<system>, is just fine).
267		469
268	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
269	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
270	have exited already (and no SIGCHLD will be sent anymore).	472	have exited already (and no SIGCHLD will be sent anymore).
271		473
272	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
273	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
274	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.
275		480
276	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
277	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
278	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.
279		489
280	Example: fork a process and wait for it	490	Example: fork a process and wait for it
281		491
282	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
283		493
284	my $pid = fork or exit 5;	494	my $pid = fork or exit 5;
285		495
286	my $w = AnyEvent->child (	496	my $w = AnyEvent->child (
287	pid => $pid,	497	pid => $pid,
288	cb => sub {	498	cb => sub {
289	my ($pid, $status) = @_;	499	my ($pid, $status) = @_;
290	warn "pid $pid exited with status $status";	500	warn "pid $pid exited with status $status";
291	$done->send;	501	$done->send;
292	},	502	},
293	);	503	);
294		504
295	# do something else, then wait for process exit	505	# do something else, then wait for process exit
296	$done->recv;	506	$done->recv;
		507
		508	=head2 IDLE WATCHERS
		509
		510	$w = AnyEvent->idle (cb => <callback>);
		511
		512	This will repeatedly invoke the callback after the process becomes idle,
		513	until either the watcher is destroyed or new events have been detected.
		514
		515	Idle watchers are useful when there is a need to do something, but it
		516	is not so important (or wise) to do it instantly. The callback will be
		517	invoked only when there is "nothing better to do", which is usually
		518	defined as "all outstanding events have been handled and no new events
		519	have been detected". That means that idle watchers ideally get invoked
		520	when the event loop has just polled for new events but none have been
		521	detected. Instead of blocking to wait for more events, the idle watchers
		522	will be invoked.
		523
		524	Unfortunately, most event loops do not really support idle watchers (only
		525	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		526	will simply call the callback "from time to time".
		527
		528	Example: read lines from STDIN, but only process them when the
		529	program is otherwise idle:
		530
		531	my @lines; # read data
		532	my $idle_w;
		533	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		534	push @lines, scalar <STDIN>;
		535
		536	# start an idle watcher, if not already done
		537	$idle_w ||= AnyEvent->idle (cb => sub {
		538	# handle only one line, when there are lines left
		539	if (my $line = shift @lines) {
		540	print "handled when idle: $line";
		541	} else {
		542	# otherwise disable the idle watcher again
		543	undef $idle_w;
		544	}
		545	});
		546	});
297		547
298	=head2 CONDITION VARIABLES	548	=head2 CONDITION VARIABLES
		549
		550	$cv = AnyEvent->condvar;
		551
		552	$cv->send (<list>);
		553	my @res = $cv->recv;
299		554
300	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
301	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
302	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
303		558
304	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
305	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).
306		561
307	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
308	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.
309		566
310	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
311	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
312	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
313	becomes true.	570	becomes true, with the condition variable as the first argument (but not
		571	the results).
314		572
315	After creation, the conditon variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
316	by calling the C<send> method.	574	by calling the C<send> method (or calling the condition variable as if it
		575	were a callback, read about the caveats in the description for the C<<
		576	->send >> method).
317		577
318	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
319	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:
320	in time where multiple outstandign events have been processed. And yet	580
321	another way to call them is transations - each condition variable can be	581	=over 4
322	used to represent a transaction, which finishes at some point and delivers	582
323	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
324		601
325	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
326	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,
327	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
328	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
…		…
332	you can block your main program until an event occurs - for example, you	609	you can block your main program until an event occurs - for example, you
333	could C<< ->recv >> in your main program until the user clicks the Quit	610	could C<< ->recv >> in your main program until the user clicks the Quit
334	button of your app, which would C<< ->send >> the "quit" event.	611	button of your app, which would C<< ->send >> the "quit" event.
335		612
336	Note that condition variables recurse into the event loop - if you have	613	Note that condition variables recurse into the event loop - if you have
337	two pieces of code that call C<< ->recv >> in a round-robbin fashion, you	614	two pieces of code that call C<< ->recv >> in a round-robin fashion, you
338	lose. Therefore, condition variables are good to export to your caller, but	615	lose. Therefore, condition variables are good to export to your caller, but
339	you should avoid making a blocking wait yourself, at least in callbacks,	616	you should avoid making a blocking wait yourself, at least in callbacks,
340	as this asks for trouble.	617	as this asks for trouble.
341		618
342	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
343	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
344	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
345	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
346	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
347		624
348	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
349	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
350	for the send to occur.	627	for the send to occur.
351		628
352	Example:	629	Example: wait for a timer.
353		630
354	# wait till the result is ready	631	# condition: "wait till the timer is fired"
355	my $result_ready = AnyEvent->condvar;	632	my $timer_fired = AnyEvent->condvar;
356		633
357	# do something such as adding a timer	634	# create the timer - we could wait for, say
358	# or socket watcher the calls $result_ready->send	635	# a handle becomign ready, or even an
359	# when the "result" is ready.	636	# AnyEvent::HTTP request to finish, but
360	# in this case, we simply use a timer:	637	# in this case, we simply use a timer:
361	my $w = AnyEvent->timer (	638	my $w = AnyEvent->timer (
362	after => 1,	639	after => 1,
363	cb => sub { $result_ready->send },	640	cb => sub { $timer_fired->send },
364	);	641	);
365		642
366	# this "blocks" (while handling events) till the callback	643	# this "blocks" (while handling events) till the callback
367	# calls send	644	# calls ->send
368	$result_ready->recv;	645	$timer_fired->recv;
		646
		647	Example: wait for a timer, but take advantage of the fact that condition
		648	variables are also callable directly.
		649
		650	my $done = AnyEvent->condvar;
		651	my $delay = AnyEvent->timer (after => 5, cb => $done);
		652	$done->recv;
		653
		654	Example: Imagine an API that returns a condvar and doesn't support
		655	callbacks. This is how you make a synchronous call, for example from
		656	the main program:
		657
		658	use AnyEvent::CouchDB;
		659
		660	...
		661
		662	my @info = $couchdb->info->recv;
		663
		664	And this is how you would just set a callback to be called whenever the
		665	results are available:
		666
		667	$couchdb->info->cb (sub {
		668	my @info = $_[0]->recv;
		669	});
369		670
370	=head3 METHODS FOR PRODUCERS	671	=head3 METHODS FOR PRODUCERS
371		672
372	These methods should only be used by the producing side, i.e. the	673	These methods should only be used by the producing side, i.e. the
373	code/module that eventually sends the signal. Note that it is also	674	code/module that eventually sends the signal. Note that it is also
…		…
386	immediately from within send.	687	immediately from within send.
387		688
388	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
389	future C<< ->recv >> calls.	690	future C<< ->recv >> calls.
390		691
		692	Condition variables are overloaded so one can call them directly (as if
		693	they were a code reference). Calling them directly is the same as calling
		694	C<send>.
		695
391	=item $cv->croak ($error)	696	=item $cv->croak ($error)
392		697
393	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
394	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
395		700
396	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
397	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.
398		707
399	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
400		709
401	=item $cv->end	710	=item $cv->end
402
403	These two methods are EXPERIMENTAL and MIGHT CHANGE.
404		711
405	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
406	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
407	to use a condition variable for the whole process.	714	to use a condition variable for the whole process.
408		715
409	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
410	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
411	>>, 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
412	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
413	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.
414		722
415	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:
416		730
417	my $cv = AnyEvent->condvar;	731	my $cv = AnyEvent->condvar;
418		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
419	my %result;	757	my %result;
420	$cv->begin (sub { $cv->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
421		759
422	for my $host (@list_of_hosts) {	760	for my $host (@list_of_hosts) {
423	$cv->begin;	761	$cv->begin;
424	ping_host_then_call_callback $host, sub {	762	ping_host_then_call_callback $host, sub {
425	$result{$host} = ...;	763	$result{$host} = ...;
…		…
440	loop, which serves two important purposes: first, it sets the callback	778	loop, which serves two important purposes: first, it sets the callback
441	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
442	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
443	doesn't execute once).	781	doesn't execute once).
444		782
445	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
446	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
447	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
448	C<begin> and for eahc subrequest you finish, call C<end>.	786	subrequest you start, call C<begin> and for each subrequest you finish,
		787	call C<end>.
449		788
450	=back	789	=back
451		790
452	=head3 METHODS FOR CONSUMERS	791	=head3 METHODS FOR CONSUMERS
453		792
…		…
457	=over 4	796	=over 4
458		797
459	=item $cv->recv	798	=item $cv->recv
460		799
461	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	800	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
462	>> methods have been called on c<$cv>, while servicing other watchers	801	>> methods have been called on C<$cv>, while servicing other watchers
463	normally.	802	normally.
464		803
465	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
466	will return immediately.	805	will return immediately.
467		806
…		…
469	function will call C<croak>.	808	function will call C<croak>.
470		809
471	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,
472	in scalar context only the first one will be returned.	811	in scalar context only the first one will be returned.
473		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
474	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
475	(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
476	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
477	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
478	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
479	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,
480	while still suppporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
481		827
482	Another reason I<never> to C<< ->recv >> in a module is that you cannot
483	sensibly have two C<< ->recv >>'s in parallel, as that would require
484	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
485	can supply.
486
487	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
488	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
489	versions and also integrates coroutines into AnyEvent, making blocking
490	C<< ->recv >> calls perfectly safe as long as they are done from another
491	coroutine (one that doesn't run the event loop).
492
493	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
494	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
495	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
496	waits otherwise.	831	waits otherwise.
497		832
498	=item $bool = $cv->ready	833	=item $bool = $cv->ready
499		834
500	Returns true when the condition is "true", i.e. whether C<send> or	835	Returns true when the condition is "true", i.e. whether C<send> or
501	C<croak> have been called.	836	C<croak> have been called.
502		837
503	=item $cb = $cv->cb ([new callback])	838	=item $cb = $cv->cb ($cb->($cv))
504		839
505	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
506	replaces it before doing so.	841	replaces it before doing so.
507		842
508	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
509	C<send> or C<croak> are called. Calling C<recv> inside the callback	844	C<send> or C<croak> are called, with the only argument being the
		845	condition variable itself. If the condition is already true, the
		846	callback is called immediately when it is set. Calling C<recv> inside
510	or at any later time is guaranteed not to block.	847	the callback or at any later time is guaranteed not to block.
511		848
512	=back	849	=back
513		850
		851	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		852
		853	The available backend classes are (every class has its own manpage):
		854
		855	=over 4
		856
		857	=item Backends that are autoprobed when no other event loop can be found.
		858
		859	EV is the preferred backend when no other event loop seems to be in
		860	use. If EV is not installed, then AnyEvent will fall back to its own
		861	pure-perl implementation, which is available everywhere as it comes with
		862	AnyEvent itself.
		863
		864	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		865	AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
		866
		867	=item Backends that are transparently being picked up when they are used.
		868
		869	These will be used if they are already loaded when the first watcher
		870	is created, in which case it is assumed that the application is using
		871	them. This means that AnyEvent will automatically pick the right backend
		872	when the main program loads an event module before anything starts to
		873	create watchers. Nothing special needs to be done by the main program.
		874
		875	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		877	AnyEvent::Impl::Tk based on Tk, very broken.
		878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		880	AnyEvent::Impl::Irssi used when running within irssi.
		881	AnyEvent::Impl::IOAsync based on IO::Async.
		882	AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
		883	AnyEvent::Impl::FLTK based on FLTK.
		884
		885	=item Backends with special needs.
		886
		887	Qt requires the Qt::Application to be instantiated first, but will
		888	otherwise be picked up automatically. As long as the main program
		889	instantiates the application before any AnyEvent watchers are created,
		890	everything should just work.
		891
		892	AnyEvent::Impl::Qt based on Qt.
		893
		894	=item Event loops that are indirectly supported via other backends.
		895
		896	Some event loops can be supported via other modules:
		897
		898	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		899
		900	B<WxWidgets> has no support for watching file handles. However, you can
		901	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		902	polls 20 times per second, which was considered to be too horrible to even
		903	consider for AnyEvent.
		904
		905	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		906	backend, so it can be supported through POE.
		907
		908	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		909	load L<POE> when detecting them, in the hope that POE will pick them up,
		910	in which case everything will be automatic.
		911
		912	=back
		913
514	=head1 GLOBAL VARIABLES AND FUNCTIONS	914	=head1 GLOBAL VARIABLES AND FUNCTIONS
515		915
		916	These are not normally required to use AnyEvent, but can be useful to
		917	write AnyEvent extension modules.
		918
516	=over 4	919	=over 4
517		920
518	=item $AnyEvent::MODEL	921	=item $AnyEvent::MODEL
519		922
520	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
521	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
522	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
523	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
524	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
525		930	will be C<urxvt::anyevent>).
526	The known classes so far are:
527
528	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
529	AnyEvent::Impl::Event based on Event, second best choice.
530	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
531	AnyEvent::Impl::Glib based on Glib, third-best choice.
532	AnyEvent::Impl::Tk based on Tk, very bad choice.
533	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
534	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
535	AnyEvent::Impl::POE based on POE, not generic enough for full support.
536
537	There is no support for WxWidgets, as WxWidgets has no support for
538	watching file handles. However, you can use WxWidgets through the
539	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
540	second, which was considered to be too horrible to even consider for
541	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
542	it's adaptor.
543
544	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
545	autodetecting them.
546		931
547	=item AnyEvent::detect	932	=item AnyEvent::detect
548		933
549	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	934	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
550	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
551	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
552	runtime.	937	runtime, and not e.g. during initialisation of your module.
		938
		939	If you need to do some initialisation before AnyEvent watchers are
		940	created, use C<post_detect>.
553		941
554	=item $guard = AnyEvent::post_detect { BLOCK }	942	=item $guard = AnyEvent::post_detect { BLOCK }
555		943
556	Arranges for the code block to be executed as soon as the event model is	944	Arranges for the code block to be executed as soon as the event model is
557	autodetected (or immediately if this has already happened).	945	autodetected (or immediately if that has already happened).
		946
		947	The block will be executed I<after> the actual backend has been detected
		948	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		949	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		950	other initialisations - see the sources of L<AnyEvent::Strict> or
		951	L<AnyEvent::AIO> to see how this is used.
		952
		953	The most common usage is to create some global watchers, without forcing
		954	event module detection too early, for example, L<AnyEvent::AIO> creates
		955	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		956	avoid autodetecting the event module at load time.
558		957
559	If called in scalar or list context, then it creates and returns an object	958	If called in scalar or list context, then it creates and returns an object
560	that automatically removes the callback again when it is destroyed. See	959	that automatically removes the callback again when it is destroyed (or
		960	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
561	L<Coro::BDB> for a case where this is useful.	961	a case where this is useful.
		962
		963	Example: Create a watcher for the IO::AIO module and store it in
		964	C<$WATCHER>, but do so only do so after the event loop is initialised.
		965
		966	our WATCHER;
		967
		968	my $guard = AnyEvent::post_detect {
		969	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		970	};
		971
		972	# the ||= is important in case post_detect immediately runs the block,
		973	# as to not clobber the newly-created watcher. assigning both watcher and
		974	# post_detect guard to the same variable has the advantage of users being
		975	# able to just C<undef $WATCHER> if the watcher causes them grief.
		976
		977	$WATCHER ||= $guard;
562		978
563	=item @AnyEvent::post_detect	979	=item @AnyEvent::post_detect
564		980
565	If there are any code references in this array (you can C<push> to it	981	If there are any code references in this array (you can C<push> to it
566	before or after loading AnyEvent), then they will called directly after	982	before or after loading AnyEvent), then they will be called directly
567	the event loop has been chosen.	983	after the event loop has been chosen.
568		984
569	You should check C<$AnyEvent::MODEL> before adding to this array, though:	985	You should check C<$AnyEvent::MODEL> before adding to this array, though:
570	if it contains a true value then the event loop has already been detected,	986	if it is defined then the event loop has already been detected, and the
571	and the array will be ignored.	987	array will be ignored.
572		988
573	Best use C<AnyEvent::post_detect { BLOCK }> instead.	989	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		990	it, as it takes care of these details.
		991
		992	This variable is mainly useful for modules that can do something useful
		993	when AnyEvent is used and thus want to know when it is initialised, but do
		994	not need to even load it by default. This array provides the means to hook
		995	into AnyEvent passively, without loading it.
		996
		997	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		998	together, you could put this into Coro (this is the actual code used by
		999	Coro to accomplish this):
		1000
		1001	if (defined $AnyEvent::MODEL) {
		1002	# AnyEvent already initialised, so load Coro::AnyEvent
		1003	require Coro::AnyEvent;
		1004	} else {
		1005	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1006	# as soon as it is
		1007	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1008	}
		1009
		1010	=item AnyEvent::postpone { BLOCK }
		1011
		1012	Arranges for the block to be executed as soon as possible, but not before
		1013	the call itself returns. In practise, the block will be executed just
		1014	before the event loop polls for new events, or shortly afterwards.
		1015
		1016	This function never returns anything (to make the C<return postpone { ...
		1017	}> idiom more useful.
		1018
		1019	To understand the usefulness of this function, consider a function that
		1020	asynchronously does something for you and returns some transaction
		1021	object or guard to let you cancel the operation. For example,
		1022	C<AnyEvent::Socket::tcp_connect>:
		1023
		1024	# start a conenction attempt unless one is active
		1025	$self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
		1026	delete $self->{connect_guard};
		1027	...
		1028	};
		1029
		1030	Imagine that this function could instantly call the callback, for
		1031	example, because it detects an obvious error such as a negative port
		1032	number. Invoking the callback before the function returns causes problems
		1033	however: the callback will be called and will try to delete the guard
		1034	object. But since the function hasn't returned yet, there is nothing to
		1035	delete. When the function eventually returns it will assign the guard
		1036	object to C<< $self->{connect_guard} >>, where it will likely never be
		1037	deleted, so the program thinks it is still trying to connect.
		1038
		1039	This is where C<AnyEvent::postpone> should be used. Instead of calling the
		1040	callback directly on error:
		1041
		1042	$cb->(undef), return # signal error to callback, BAD!
		1043	if $some_error_condition;
		1044
		1045	It should use C<postpone>:
		1046
		1047	AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
		1048	if $some_error_condition;
574		1049
575	=back	1050	=back
576		1051
577	=head1 WHAT TO DO IN A MODULE	1052	=head1 WHAT TO DO IN A MODULE
578		1053
…		…
589	because it will stall the whole program, and the whole point of using	1064	because it will stall the whole program, and the whole point of using
590	events is to stay interactive.	1065	events is to stay interactive.
591		1066
592	It is fine, however, to call C<< ->recv >> when the user of your module	1067	It is fine, however, to call C<< ->recv >> when the user of your module
593	requests it (i.e. if you create a http request object ad have a method	1068	requests it (i.e. if you create a http request object ad have a method
594	called C<results> that returns the results, it should call C<< ->recv >>	1069	called C<results> that returns the results, it may call C<< ->recv >>
595	freely, as the user of your module knows what she is doing. always).	1070	freely, as the user of your module knows what she is doing. Always).
596		1071
597	=head1 WHAT TO DO IN THE MAIN PROGRAM	1072	=head1 WHAT TO DO IN THE MAIN PROGRAM
598		1073
599	There will always be a single main program - the only place that should	1074	There will always be a single main program - the only place that should
600	dictate which event model to use.	1075	dictate which event model to use.
601		1076
602	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1077	If the program is not event-based, it need not do anything special, even
603	do anything special (it does not need to be event-based) and let AnyEvent	1078	when it depends on a module that uses an AnyEvent. If the program itself
604	decide which implementation to chose if some module relies on it.	1079	uses AnyEvent, but does not care which event loop is used, all it needs
		1080	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1081	available loop implementation.
605		1082
606	If the main program relies on a specific event model. For example, in	1083	If the main program relies on a specific event model - for example, in
607	Gtk2 programs you have to rely on the Glib module. You should load the	1084	Gtk2 programs you have to rely on the Glib module - you should load the
608	event module before loading AnyEvent or any module that uses it: generally	1085	event module before loading AnyEvent or any module that uses it: generally
609	speaking, you should load it as early as possible. The reason is that	1086	speaking, you should load it as early as possible. The reason is that
610	modules might create watchers when they are loaded, and AnyEvent will	1087	modules might create watchers when they are loaded, and AnyEvent will
611	decide on the event model to use as soon as it creates watchers, and it	1088	decide on the event model to use as soon as it creates watchers, and it
612	might chose the wrong one unless you load the correct one yourself.	1089	might choose the wrong one unless you load the correct one yourself.
613		1090
614	You can chose to use a rather inefficient pure-perl implementation by	1091	You can chose to use a pure-perl implementation by loading the
615	loading the C<AnyEvent::Impl::Perl> module, which gives you similar	1092	C<AnyEvent::Loop> module, which gives you similar behaviour
616	behaviour everywhere, but letting AnyEvent chose is generally better.	1093	everywhere, but letting AnyEvent chose the model is generally better.
		1094
		1095	=head2 MAINLOOP EMULATION
		1096
		1097	Sometimes (often for short test scripts, or even standalone programs who
		1098	only want to use AnyEvent), you do not want to run a specific event loop.
		1099
		1100	In that case, you can use a condition variable like this:
		1101
		1102	AnyEvent->condvar->recv;
		1103
		1104	This has the effect of entering the event loop and looping forever.
		1105
		1106	Note that usually your program has some exit condition, in which case
		1107	it is better to use the "traditional" approach of storing a condition
		1108	variable somewhere, waiting for it, and sending it when the program should
		1109	exit cleanly.
		1110
617		1111
618	=head1 OTHER MODULES	1112	=head1 OTHER MODULES
619		1113
620	The following is a non-exhaustive list of additional modules that use	1114	The following is a non-exhaustive list of additional modules that use
621	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1115	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
622	in the same program. Some of the modules come with AnyEvent, some are	1116	modules and other event loops in the same program. Some of the modules
623	available via CPAN.	1117	come as part of AnyEvent, the others are available via CPAN.
624		1118
625	=over 4	1119	=over 4
626		1120
627	=item L<AnyEvent::Util>	1121	=item L<AnyEvent::Util>
628		1122
629	Contains various utility functions that replace often-used but blocking	1123	Contains various utility functions that replace often-used blocking
630	functions such as C<inet_aton> by event-/callback-based versions.	1124	functions such as C<inet_aton> with event/callback-based versions.
631
632	=item L<AnyEvent::Handle>
633
634	Provide read and write buffers and manages watchers for reads and writes.
635		1125
636	=item L<AnyEvent::Socket>	1126	=item L<AnyEvent::Socket>
637		1127
638	Provides various utility functions for (internet protocol) sockets,	1128	Provides various utility functions for (internet protocol) sockets,
639	addresses and name resolution. Also functions to create non-blocking tcp	1129	addresses and name resolution. Also functions to create non-blocking tcp
640	connections or tcp servers, with IPv6 and SRV record support and more.	1130	connections or tcp servers, with IPv6 and SRV record support and more.
641		1131
		1132	=item L<AnyEvent::Handle>
		1133
		1134	Provide read and write buffers, manages watchers for reads and writes,
		1135	supports raw and formatted I/O, I/O queued and fully transparent and
		1136	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
		1137
		1138	=item L<AnyEvent::DNS>
		1139
		1140	Provides rich asynchronous DNS resolver capabilities.
		1141
		1142	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1143
		1144	Implement event-based interfaces to the protocols of the same name (for
		1145	the curious, IGS is the International Go Server and FCP is the Freenet
		1146	Client Protocol).
		1147
		1148	=item L<AnyEvent::Handle::UDP>
		1149
		1150	Here be danger!
		1151
		1152	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1153	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1154	its use of a stream-based API with a protocol that isn't streamable, that
		1155	the only way to improve it is to delete it.
		1156
		1157	It features data corruption (but typically only under load) and general
		1158	confusion. On top, the author is not only clueless about UDP but also
		1159	fact-resistant - some gems of his understanding: "connect doesn't work
		1160	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1161	packets", "I don't need to implement proper error checking as UDP doesn't
		1162	support error checking" and so on - he doesn't even understand what's
		1163	wrong with his module when it is explained to him.
		1164
		1165	=item L<AnyEvent::DBI>
		1166
		1167	Executes L<DBI> requests asynchronously in a proxy process for you,
		1168	notifying you in an event-based way when the operation is finished.
		1169
		1170	=item L<AnyEvent::AIO>
		1171
		1172	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1173	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1174	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1175	file I/O, and much more.
		1176
642	=item L<AnyEvent::HTTPD>	1177	=item L<AnyEvent::HTTPD>
643		1178
644	Provides a simple web application server framework.	1179	A simple embedded webserver.
645
646	=item L<AnyEvent::DNS>
647
648	Provides rich asynchronous DNS resolver capabilities.
649		1180
650	=item L<AnyEvent::FastPing>	1181	=item L<AnyEvent::FastPing>
651		1182
652	The fastest ping in the west.	1183	The fastest ping in the west.
653		1184
654	=item L<Net::IRC3>
655
656	AnyEvent based IRC client module family.
657
658	=item L<Net::XMPP2>
659
660	AnyEvent based XMPP (Jabber protocol) module family.
661
662	=item L<Net::FCP>
663
664	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
665	of AnyEvent.
666
667	=item L<Event::ExecFlow>
668
669	High level API for event-based execution flow control.
670
671	=item L<Coro>	1185	=item L<Coro>
672		1186
673	Has special support for AnyEvent via L<Coro::AnyEvent>.	1187	Has special support for AnyEvent via L<Coro::AnyEvent>.
674		1188
675	=item L<AnyEvent::AIO>, L<IO::AIO>
676
677	Truly asynchronous I/O, should be in the toolbox of every event
678	programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
679	together.
680
681	=item L<AnyEvent::BDB>, L<BDB>
682
683	Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
684	IO::AIO and AnyEvent together.
685
686	=item L<IO::Lambda>
687
688	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
689
690	=back	1189	=back
691		1190
692	=cut	1191	=cut
693		1192
694	package AnyEvent;	1193	package AnyEvent;
695		1194
696	no warnings;	1195	# basically a tuned-down version of common::sense
697	use strict;	1196	sub common_sense {
		1197	# from common:.sense 3.4
		1198	${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
		1199	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
		1200	$^H |= 0x00000600;
		1201	}
698		1202
		1203	BEGIN { AnyEvent::common_sense }
		1204
699	use Carp;	1205	use Carp ();
700		1206
701	our $VERSION = '3.6';	1207	our $VERSION = '5.34';
702	our $MODEL;	1208	our $MODEL;
703		1209
704	our $AUTOLOAD;	1210	our $AUTOLOAD;
705	our @ISA;	1211	our @ISA;
706		1212
707	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
708
709	our @REGISTRY;	1213	our @REGISTRY;
710		1214
711	our %PROTOCOL; # (ipv4|ipv6) => (1|2)	1215	our $VERBOSE;
		1216
		1217	BEGIN {
		1218	require "AnyEvent/constants.pl";
		1219
		1220	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
		1221
		1222	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1223	if ${^TAINT};
		1224
		1225	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1226
		1227	}
		1228
		1229	our $MAX_SIGNAL_LATENCY = 10;
		1230
		1231	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
712		1232
713	{	1233	{
714	my $idx;	1234	my $idx;
715	$PROTOCOL{$_} = ++$idx	1235	$PROTOCOL{$_} = ++$idx
		1236	for reverse split /\s*,\s*/,
716	for split /\s*,\s*/, $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1237	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
717	}	1238	}
718		1239
		1240	our @post_detect;
		1241
		1242	sub post_detect(&) {
		1243	my ($cb) = @_;
		1244
		1245	push @post_detect, $cb;
		1246
		1247	defined wantarray
		1248	? bless \$cb, "AnyEvent::Util::postdetect"
		1249	: ()
		1250	}
		1251
		1252	sub AnyEvent::Util::postdetect::DESTROY {
		1253	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1254	}
		1255
		1256	our $POSTPONE_W;
		1257	our @POSTPONE;
		1258
		1259	sub _postpone_exec {
		1260	undef $POSTPONE_W;
		1261
		1262	&{ shift @POSTPONE }
		1263	while @POSTPONE;
		1264	}
		1265
		1266	sub postpone(&) {
		1267	push @POSTPONE, shift;
		1268
		1269	$POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
		1270
		1271	()
		1272	}
		1273
719	my @models = (	1274	our @models = (
720	[EV:: => AnyEvent::Impl::EV::],	1275	[EV:: => AnyEvent::Impl::EV:: , 1],
		1276	[AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
		1277	# everything below here will not (normally) be autoprobed
		1278	# as the pure perl backend should work everywhere
		1279	# and is usually faster
721	[Event:: => AnyEvent::Impl::Event::],	1280	[Event:: => AnyEvent::Impl::Event::, 1],
		1281	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1282	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1283	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
722	[Tk:: => AnyEvent::Impl::Tk::],	1284	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		1285	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
		1286	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
723	[Wx:: => AnyEvent::Impl::POE::],	1287	[Wx:: => AnyEvent::Impl::POE::],
724	[Prima:: => AnyEvent::Impl::POE::],	1288	[Prima:: => AnyEvent::Impl::POE::],
725	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1289	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
726	# everything below here will not be autoprobed as the pureperl backend should work everywhere	1290	[Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
727	[Glib:: => AnyEvent::Impl::Glib::],	1291	[FLTK:: => AnyEvent::Impl::FLTK::],
728	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
729	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
730	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
731	);	1292	);
732		1293
733	our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);	1294	our %method = map +($_ => 1),
		1295	qw(io timer time now now_update signal child idle condvar DESTROY);
734		1296
735	our @post_detect;
736
737	sub post_detect(&) {	1297	sub detect() {
738	my ($cb) = @_;	1298	# free some memory
		1299	*detect = sub () { $MODEL };
739		1300
740	if ($MODEL) {	1301	local $!; # for good measure
741	$cb->();	1302	local $SIG{__DIE__};
742		1303
743	1	1304	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
		1305	my $model = $1;
		1306	$model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
		1307	if (eval "require $model") {
		1308	$MODEL = $model;
		1309	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
744	} else {	1310	} else {
745	push @post_detect, $cb;	1311	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
746		1312	}
747	defined wantarray
748	? bless \$cb, "AnyEvent::Util::PostDetect"
749	: ()
750	}	1313	}
751	}
752		1314
753	sub AnyEvent::Util::PostDetect::DESTROY {	1315	# check for already loaded models
754	@post_detect = grep $_ != ${$_[0]}, @post_detect;
755	}
756
757	sub detect() {
758	unless ($MODEL) {	1316	unless ($MODEL) {
759	no strict 'refs';	1317	for (@REGISTRY, @models) {
760		1318	my ($package, $model) = @$_;
761	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1319	if (${"$package\::VERSION"} > 0) {
762	my $model = "AnyEvent::Impl::$1";
763	if (eval "require $model") {	1320	if (eval "require $model") {
764	$MODEL = $model;	1321	$MODEL = $model;
765	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1322	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
766	} else {	1323	last;
767	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1324	}
768	}	1325	}
769	}	1326	}
770		1327
771	# check for already loaded models
772	unless ($MODEL) {	1328	unless ($MODEL) {
		1329	# try to autoload a model
773	for (@REGISTRY, @models) {	1330	for (@REGISTRY, @models) {
774	my ($package, $model) = @$_;	1331	my ($package, $model, $autoload) = @$_;
		1332	if (
		1333	$autoload
		1334	and eval "require $package"
775	if (${"$package\::VERSION"} > 0) {	1335	and ${"$package\::VERSION"} > 0
776	if (eval "require $model") {	1336	and eval "require $model"
		1337	) {
777	$MODEL = $model;	1338	$MODEL = $model;
778	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1339	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
779	last;	1340	last;
780	}
781	}	1341	}
782	}	1342	}
783		1343
784	unless ($MODEL) {
785	# try to load a model
786
787	for (@REGISTRY, @models) {
788	my ($package, $model) = @$_;
789	if (eval "require $package"
790	and ${"$package\::VERSION"} > 0
791	and eval "require $model") {
792	$MODEL = $model;
793	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
794	last;
795	}
796	}
797
798	$MODEL	1344	$MODEL
799	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1345	or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
800	}
801	}	1346	}
802
803	unshift @ISA, $MODEL;
804	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
805
806	(shift @post_detect)->() while @post_detect;
807	}	1347	}
808		1348
		1349	# free memory only needed for probing
		1350	undef @models;
		1351	undef @REGISTRY;
		1352
		1353	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1354	unshift @ISA, $MODEL;
		1355
		1356	# now nuke some methods that are overridden by the backend.
		1357	# SUPER usage is not allowed in these.
		1358	for (qw(time signal child idle)) {
		1359	undef &{"AnyEvent::Base::$_"}
		1360	if defined &{"$MODEL\::$_"};
		1361	}
		1362
		1363	if ($ENV{PERL_ANYEVENT_STRICT}) {
		1364	eval { require AnyEvent::Strict };
		1365	warn "AnyEvent: cannot load AnyEvent::Strict: $@"
		1366	if $@ && $VERBOSE;
		1367	}
		1368
		1369	(shift @post_detect)->() while @post_detect;
		1370	undef @post_detect;
		1371
		1372	*post_detect = sub(&) {
		1373	shift->();
		1374
		1375	undef
		1376	};
		1377
		1378	# recover a few more bytes
		1379	postpone {
		1380	undef &AUTOLOAD;
		1381	};
		1382
809	$MODEL	1383	$MODEL
810	}	1384	}
		1385
		1386	our %method = map +($_ => 1),
		1387	qw(io timer time now now_update signal child idle condvar DESTROY);
811		1388
812	sub AUTOLOAD {	1389	sub AUTOLOAD {
813	(my $func = $AUTOLOAD) =~ s/.*://;	1390	(my $func = $AUTOLOAD) =~ s/.*://;
814		1391
815	$method{$func}	1392	$method{$func}
816	or croak "$func: not a valid method for AnyEvent objects";	1393	or Carp::croak "$func: not a valid AnyEvent class method";
817		1394
818	detect unless $MODEL;	1395	# free some memory
		1396	undef %method;
		1397
		1398	detect;
819		1399
820	my $class = shift;	1400	my $class = shift;
821	$class->$func (@_);	1401	$class->$func (@_);
822	}	1402	}
823		1403
		1404	# utility function to dup a filehandle. this is used by many backends
		1405	# to support binding more than one watcher per filehandle (they usually
		1406	# allow only one watcher per fd, so we dup it to get a different one).
		1407	sub _dupfh($$;$$) {
		1408	my ($poll, $fh, $r, $w) = @_;
		1409
		1410	# cygwin requires the fh mode to be matching, unix doesn't
		1411	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
		1412
		1413	open my $fh2, $mode, $fh
		1414	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
		1415
		1416	# we assume CLOEXEC is already set by perl in all important cases
		1417
		1418	($fh2, $rw)
		1419	}
		1420
		1421	=head1 SIMPLIFIED AE API
		1422
		1423	Starting with version 5.0, AnyEvent officially supports a second, much
		1424	simpler, API that is designed to reduce the calling, typing and memory
		1425	overhead by using function call syntax and a fixed number of parameters.
		1426
		1427	See the L<AE> manpage for details.
		1428
		1429	=cut
		1430
		1431	package AE;
		1432
		1433	our $VERSION = $AnyEvent::VERSION;
		1434
		1435
		1436	sub _reset() {
		1437	eval q{
		1438	# fall back to the main API by default - backends and AnyEvent::Base
		1439	# implementations can overwrite these.
		1440
		1441	sub io($$$) {
		1442	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1443	}
		1444
		1445	sub timer($$$) {
		1446	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1447	}
		1448
		1449	sub signal($$) {
		1450	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1451	}
		1452
		1453	sub child($$) {
		1454	AnyEvent->child (pid => $_[0], cb => $_[1])
		1455	}
		1456
		1457	sub idle($) {
		1458	AnyEvent->idle (cb => $_[0])
		1459	}
		1460
		1461	sub cv(;&) {
		1462	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1463	}
		1464
		1465	sub now() {
		1466	AnyEvent->now
		1467	}
		1468
		1469	sub now_update() {
		1470	AnyEvent->now_update
		1471	}
		1472
		1473	sub time() {
		1474	AnyEvent->time
		1475	}
		1476
		1477	*postpone = \&AnyEvent::postpone;
		1478	};
		1479	die if $@;
		1480	}
		1481
		1482	BEGIN { _reset }
		1483
824	package AnyEvent::Base;	1484	package AnyEvent::Base;
825		1485
		1486	# default implementations for many methods
		1487
		1488	sub time {
		1489	eval q{ # poor man's autoloading {}
		1490	# probe for availability of Time::HiRes
		1491	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1492	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
		1493	*AE::time = \&Time::HiRes::time;
		1494	# if (eval "use POSIX (); (POSIX::times())...
		1495	} else {
		1496	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
		1497	*AE::time = sub (){ time }; # epic fail
		1498	}
		1499
		1500	*time = sub { AE::time }; # different prototypes
		1501	};
		1502	die if $@;
		1503
		1504	&time
		1505	}
		1506
		1507	*now = \&time;
		1508
		1509	sub now_update { }
		1510
		1511	sub _poll {
		1512	Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
		1513	}
		1514
826	# default implementation for ->condvar	1515	# default implementation for ->condvar
		1516	# in fact, the default should not be overwritten
827		1517
828	sub condvar {	1518	sub condvar {
		1519	eval q{ # poor man's autoloading {}
		1520	*condvar = sub {
829	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1521	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1522	};
		1523
		1524	*AE::cv = sub (;&) {
		1525	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1526	};
		1527	};
		1528	die if $@;
		1529
		1530	&condvar
830	}	1531	}
831		1532
832	# default implementation for ->signal	1533	# default implementation for ->signal
833		1534
834	our %SIG_CB;	1535	our $HAVE_ASYNC_INTERRUPT;
		1536
		1537	sub _have_async_interrupt() {
		1538	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1539	&& eval "use Async::Interrupt 1.02 (); 1")
		1540	unless defined $HAVE_ASYNC_INTERRUPT;
		1541
		1542	$HAVE_ASYNC_INTERRUPT
		1543	}
		1544
		1545	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1546	our (%SIG_ASY, %SIG_ASY_W);
		1547	our ($SIG_COUNT, $SIG_TW);
		1548
		1549	# install a dummy wakeup watcher to reduce signal catching latency
		1550	# used by Impls
		1551	sub _sig_add() {
		1552	unless ($SIG_COUNT++) {
		1553	# try to align timer on a full-second boundary, if possible
		1554	my $NOW = AE::now;
		1555
		1556	$SIG_TW = AE::timer
		1557	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1558	$MAX_SIGNAL_LATENCY,
		1559	sub { } # just for the PERL_ASYNC_CHECK
		1560	;
		1561	}
		1562	}
		1563
		1564	sub _sig_del {
		1565	undef $SIG_TW
		1566	unless --$SIG_COUNT;
		1567	}
		1568
		1569	our $_sig_name_init; $_sig_name_init = sub {
		1570	eval q{ # poor man's autoloading {}
		1571	undef $_sig_name_init;
		1572
		1573	if (_have_async_interrupt) {
		1574	*sig2num = \&Async::Interrupt::sig2num;
		1575	*sig2name = \&Async::Interrupt::sig2name;
		1576	} else {
		1577	require Config;
		1578
		1579	my %signame2num;
		1580	@signame2num{ split ' ', $Config::Config{sig_name} }
		1581	= split ' ', $Config::Config{sig_num};
		1582
		1583	my @signum2name;
		1584	@signum2name[values %signame2num] = keys %signame2num;
		1585
		1586	*sig2num = sub($) {
		1587	$_[0] > 0 ? shift : $signame2num{+shift}
		1588	};
		1589	*sig2name = sub ($) {
		1590	$_[0] > 0 ? $signum2name[+shift] : shift
		1591	};
		1592	}
		1593	};
		1594	die if $@;
		1595	};
		1596
		1597	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1598	sub sig2name($) { &$_sig_name_init; &sig2name }
835		1599
836	sub signal {	1600	sub signal {
		1601	eval q{ # poor man's autoloading {}
		1602	# probe for availability of Async::Interrupt
		1603	if (_have_async_interrupt) {
		1604	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1605
		1606	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1607	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1608
		1609	} else {
		1610	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1611
		1612	if (AnyEvent::WIN32) {
		1613	require AnyEvent::Util;
		1614
		1615	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1616	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1617	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1618	} else {
		1619	pipe $SIGPIPE_R, $SIGPIPE_W;
		1620	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
		1621	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
		1622
		1623	# not strictly required, as $^F is normally 2, but let's make sure...
		1624	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1625	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1626	}
		1627
		1628	$SIGPIPE_R
		1629	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1630
		1631	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1632	}
		1633
		1634	*signal = $HAVE_ASYNC_INTERRUPT
		1635	? sub {
837	my (undef, %arg) = @_;	1636	my (undef, %arg) = @_;
838		1637
		1638	# async::interrupt
839	my $signal = uc $arg{signal}	1639	my $signal = sig2num $arg{signal};
840	or Carp::croak "required option 'signal' is missing";
841
842	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1640	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1641
		1642	$SIG_ASY{$signal} ||= new Async::Interrupt
		1643	cb => sub { undef $SIG_EV{$signal} },
		1644	signal => $signal,
		1645	pipe => [$SIGPIPE_R->filenos],
		1646	pipe_autodrain => 0,
		1647	;
		1648
		1649	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1650	}
		1651	: sub {
		1652	my (undef, %arg) = @_;
		1653
		1654	# pure perl
		1655	my $signal = sig2name $arg{signal};
		1656	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1657
843	$SIG{$signal} ||= sub {	1658	$SIG{$signal} ||= sub {
		1659	local $!;
		1660	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1661	undef $SIG_EV{$signal};
		1662	};
		1663
		1664	# can't do signal processing without introducing races in pure perl,
		1665	# so limit the signal latency.
		1666	_sig_add;
		1667
		1668	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1669	}
		1670	;
		1671
		1672	*AnyEvent::Base::signal::DESTROY = sub {
		1673	my ($signal, $cb) = @{$_[0]};
		1674
		1675	_sig_del;
		1676
		1677	delete $SIG_CB{$signal}{$cb};
		1678
		1679	$HAVE_ASYNC_INTERRUPT
		1680	? delete $SIG_ASY{$signal}
		1681	: # delete doesn't work with older perls - they then
		1682	# print weird messages, or just unconditionally exit
		1683	# instead of getting the default action.
		1684	undef $SIG{$signal}
		1685	unless keys %{ $SIG_CB{$signal} };
		1686	};
		1687
		1688	*_signal_exec = sub {
		1689	$HAVE_ASYNC_INTERRUPT
		1690	? $SIGPIPE_R->drain
		1691	: sysread $SIGPIPE_R, (my $dummy), 9;
		1692
		1693	while (%SIG_EV) {
		1694	for (keys %SIG_EV) {
		1695	delete $SIG_EV{$_};
844	$_->() for values %{ $SIG_CB{$signal} || {} };	1696	&$_ for values %{ $SIG_CB{$_} || {} };
		1697	}
		1698	}
		1699	};
845	};	1700	};
		1701	die if $@;
846		1702
847	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1703	&signal
848	}
849
850	sub AnyEvent::Base::Signal::DESTROY {
851	my ($signal, $cb) = @{$_[0]};
852
853	delete $SIG_CB{$signal}{$cb};
854
855	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };
856	}	1704	}
857		1705
858	# default implementation for ->child	1706	# default implementation for ->child
859		1707
860	our %PID_CB;	1708	our %PID_CB;
861	our $CHLD_W;	1709	our $CHLD_W;
862	our $CHLD_DELAY_W;	1710	our $CHLD_DELAY_W;
863	our $PID_IDLE;
864	our $WNOHANG;
865		1711
866	sub _child_wait {	1712	# used by many Impl's
867	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1713	sub _emit_childstatus($$) {
		1714	my (undef, $rpid, $rstatus) = @_;
		1715
		1716	$_->($rpid, $rstatus)
868	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1717	for values %{ $PID_CB{$rpid} || {} },
869	(values %{ $PID_CB{0} || {} });	1718	values %{ $PID_CB{0} || {} };
870	}
871
872	undef $PID_IDLE;
873	}
874
875	sub _sigchld {
876	# make sure we deliver these changes "synchronous" with the event loop.
877	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
878	undef $CHLD_DELAY_W;
879	&_child_wait;
880	});
881	}	1719	}
882		1720
883	sub child {	1721	sub child {
		1722	eval q{ # poor man's autoloading {}
		1723	*_sigchld = sub {
		1724	my $pid;
		1725
		1726	AnyEvent->_emit_childstatus ($pid, $?)
		1727	while ($pid = waitpid -1, WNOHANG) > 0;
		1728	};
		1729
		1730	*child = sub {
884	my (undef, %arg) = @_;	1731	my (undef, %arg) = @_;
885		1732
886	defined (my $pid = $arg{pid} + 0)	1733	my $pid = $arg{pid};
887	or Carp::croak "required option 'pid' is missing";	1734	my $cb = $arg{cb};
888		1735
889	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1736	$PID_CB{$pid}{$cb+0} = $cb;
890		1737
891	unless ($WNOHANG) {
892	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1;
893	}
894
895	unless ($CHLD_W) {	1738	unless ($CHLD_W) {
896	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1739	$CHLD_W = AE::signal CHLD => \&_sigchld;
897	# child could be a zombie already, so make at least one round	1740	# child could be a zombie already, so make at least one round
898	&_sigchld;	1741	&_sigchld;
899	}	1742	}
900		1743
901	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1744	bless [$pid, $cb+0], "AnyEvent::Base::child"
902	}	1745	};
903		1746
904	sub AnyEvent::Base::Child::DESTROY {	1747	*AnyEvent::Base::child::DESTROY = sub {
905	my ($pid, $cb) = @{$_[0]};	1748	my ($pid, $icb) = @{$_[0]};
906		1749
907	delete $PID_CB{$pid}{$cb};	1750	delete $PID_CB{$pid}{$icb};
908	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1751	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
909		1752
910	undef $CHLD_W unless keys %PID_CB;	1753	undef $CHLD_W unless keys %PID_CB;
		1754	};
		1755	};
		1756	die if $@;
		1757
		1758	&child
		1759	}
		1760
		1761	# idle emulation is done by simply using a timer, regardless
		1762	# of whether the process is idle or not, and not letting
		1763	# the callback use more than 50% of the time.
		1764	sub idle {
		1765	eval q{ # poor man's autoloading {}
		1766	*idle = sub {
		1767	my (undef, %arg) = @_;
		1768
		1769	my ($cb, $w, $rcb) = $arg{cb};
		1770
		1771	$rcb = sub {
		1772	if ($cb) {
		1773	$w = _time;
		1774	&$cb;
		1775	$w = _time - $w;
		1776
		1777	# never use more then 50% of the time for the idle watcher,
		1778	# within some limits
		1779	$w = 0.0001 if $w < 0.0001;
		1780	$w = 5 if $w > 5;
		1781
		1782	$w = AE::timer $w, 0, $rcb;
		1783	} else {
		1784	# clean up...
		1785	undef $w;
		1786	undef $rcb;
		1787	}
		1788	};
		1789
		1790	$w = AE::timer 0.05, 0, $rcb;
		1791
		1792	bless \\$cb, "AnyEvent::Base::idle"
		1793	};
		1794
		1795	*AnyEvent::Base::idle::DESTROY = sub {
		1796	undef $${$_[0]};
		1797	};
		1798	};
		1799	die if $@;
		1800
		1801	&idle
911	}	1802	}
912		1803
913	package AnyEvent::CondVar;	1804	package AnyEvent::CondVar;
914		1805
915	our @ISA = AnyEvent::CondVar::Base::;	1806	our @ISA = AnyEvent::CondVar::Base::;
916		1807
		1808	# only to be used for subclassing
		1809	sub new {
		1810	my $class = shift;
		1811	bless AnyEvent->condvar (@_), $class
		1812	}
		1813
917	package AnyEvent::CondVar::Base;	1814	package AnyEvent::CondVar::Base;
		1815
		1816	#use overload
		1817	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
		1818	# fallback => 1;
		1819
		1820	# save 300+ kilobytes by dirtily hardcoding overloading
		1821	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1822	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1823	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1824	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1825
		1826	our $WAITING;
918		1827
919	sub _send {	1828	sub _send {
920	# nop	1829	# nop
		1830	}
		1831
		1832	sub _wait {
		1833	AnyEvent->_poll until $_[0]{_ae_sent};
921	}	1834	}
922		1835
923	sub send {	1836	sub send {
924	my $cv = shift;	1837	my $cv = shift;
925	$cv->{_ae_sent} = [@_];	1838	$cv->{_ae_sent} = [@_];
…		…
934		1847
935	sub ready {	1848	sub ready {
936	$_[0]{_ae_sent}	1849	$_[0]{_ae_sent}
937	}	1850	}
938		1851
939	sub _wait {
940	AnyEvent->one_event while !$_[0]{_ae_sent};
941	}
942
943	sub recv {	1852	sub recv {
		1853	unless ($_[0]{_ae_sent}) {
		1854	$WAITING
		1855	and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
		1856
		1857	local $WAITING = 1;
944	$_[0]->_wait;	1858	$_[0]->_wait;
		1859	}
945		1860
946	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1861	$_[0]{_ae_croak}
947	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1862	and Carp::croak $_[0]{_ae_croak};
		1863
		1864	wantarray
		1865	? @{ $_[0]{_ae_sent} }
		1866	: $_[0]{_ae_sent}[0]
948	}	1867	}
949		1868
950	sub cb {	1869	sub cb {
951	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1870	my $cv = shift;
		1871
		1872	@_
		1873	and $cv->{_ae_cb} = shift
		1874	and $cv->{_ae_sent}
		1875	and (delete $cv->{_ae_cb})->($cv);
		1876
952	$_[0]{_ae_cb}	1877	$cv->{_ae_cb}
953	}	1878	}
954		1879
955	sub begin {	1880	sub begin {
956	++$_[0]{_ae_counter};	1881	++$_[0]{_ae_counter};
957	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1882	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
962	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };	1887	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
963	}	1888	}
964		1889
965	# undocumented/compatibility with pre-3.4	1890	# undocumented/compatibility with pre-3.4
966	*broadcast = \&send;	1891	*broadcast = \&send;
967	*wait = \&_wait;	1892	*wait = \&recv;
		1893
		1894	=head1 ERROR AND EXCEPTION HANDLING
		1895
		1896	In general, AnyEvent does not do any error handling - it relies on the
		1897	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1898	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1899	checking of all AnyEvent methods, however, which is highly useful during
		1900	development.
		1901
		1902	As for exception handling (i.e. runtime errors and exceptions thrown while
		1903	executing a callback), this is not only highly event-loop specific, but
		1904	also not in any way wrapped by this module, as this is the job of the main
		1905	program.
		1906
		1907	The pure perl event loop simply re-throws the exception (usually
		1908	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1909	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1910	so on.
		1911
		1912	=head1 ENVIRONMENT VARIABLES
		1913
		1914	The following environment variables are used by this module or its
		1915	submodules.
		1916
		1917	Note that AnyEvent will remove I<all> environment variables starting with
		1918	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1919	enabled.
		1920
		1921	=over 4
		1922
		1923	=item C<PERL_ANYEVENT_VERBOSE>
		1924
		1925	By default, AnyEvent will be completely silent except in fatal
		1926	conditions. You can set this environment variable to make AnyEvent more
		1927	talkative.
		1928
		1929	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1930	conditions, such as not being able to load the event model specified by
		1931	C<PERL_ANYEVENT_MODEL>.
		1932
		1933	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1934	model it chooses.
		1935
		1936	When set to C<8> or higher, then AnyEvent will report extra information on
		1937	which optional modules it loads and how it implements certain features.
		1938
		1939	=item C<PERL_ANYEVENT_STRICT>
		1940
		1941	AnyEvent does not do much argument checking by default, as thorough
		1942	argument checking is very costly. Setting this variable to a true value
		1943	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1944	check the arguments passed to most method calls. If it finds any problems,
		1945	it will croak.
		1946
		1947	In other words, enables "strict" mode.
		1948
		1949	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
		1950	>>, it is definitely recommended to keep it off in production. Keeping
		1951	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1952	can be very useful, however.
		1953
		1954	=item C<PERL_ANYEVENT_MODEL>
		1955
		1956	This can be used to specify the event model to be used by AnyEvent, before
		1957	auto detection and -probing kicks in.
		1958
		1959	It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
		1960	or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
		1961	resulting module name is loaded and - if the load was successful - used as
		1962	event model backend. If it fails to load then AnyEvent will proceed with
		1963	auto detection and -probing.
		1964
		1965	If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
		1966	nothing gets prepended and the module name is used as-is (hint: C<::> at
		1967	the end of a string designates a module name and quotes it appropriately).
		1968
		1969	For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
		1970	could start your program like this:
		1971
		1972	PERL_ANYEVENT_MODEL=Perl perl ...
		1973
		1974	=item C<PERL_ANYEVENT_PROTOCOLS>
		1975
		1976	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1977	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1978	of auto probing).
		1979
		1980	Must be set to a comma-separated list of protocols or address families,
		1981	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1982	used, and preference will be given to protocols mentioned earlier in the
		1983	list.
		1984
		1985	This variable can effectively be used for denial-of-service attacks
		1986	against local programs (e.g. when setuid), although the impact is likely
		1987	small, as the program has to handle conenction and other failures anyways.
		1988
		1989	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1990	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1991	- only support IPv4, never try to resolve or contact IPv6
		1992	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1993	IPv6, but prefer IPv6 over IPv4.
		1994
		1995	=item C<PERL_ANYEVENT_EDNS0>
		1996
		1997	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1998	for DNS. This extension is generally useful to reduce DNS traffic, but
		1999	some (broken) firewalls drop such DNS packets, which is why it is off by
		2000	default.
		2001
		2002	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		2003	EDNS0 in its DNS requests.
		2004
		2005	=item C<PERL_ANYEVENT_MAX_FORKS>
		2006
		2007	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		2008	will create in parallel.
		2009
		2010	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		2011
		2012	The default value for the C<max_outstanding> parameter for the default DNS
		2013	resolver - this is the maximum number of parallel DNS requests that are
		2014	sent to the DNS server.
		2015
		2016	=item C<PERL_ANYEVENT_RESOLV_CONF>
		2017
		2018	The file to use instead of F</etc/resolv.conf> (or OS-specific
		2019	configuration) in the default resolver. When set to the empty string, no
		2020	default config will be used.
		2021
		2022	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		2023
		2024	When neither C<ca_file> nor C<ca_path> was specified during
		2025	L<AnyEvent::TLS> context creation, and either of these environment
		2026	variables exist, they will be used to specify CA certificate locations
		2027	instead of a system-dependent default.
		2028
		2029	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		2030
		2031	When these are set to C<1>, then the respective modules are not
		2032	loaded. Mostly good for testing AnyEvent itself.
		2033
		2034	=back
968		2035
969	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	2036	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
970		2037
971	This is an advanced topic that you do not normally need to use AnyEvent in	2038	This is an advanced topic that you do not normally need to use AnyEvent in
972	a module. This section is only of use to event loop authors who want to	2039	a module. This section is only of use to event loop authors who want to
…		…
1006		2073
1007	I<rxvt-unicode> also cheats a bit by not providing blocking access to	2074	I<rxvt-unicode> also cheats a bit by not providing blocking access to
1008	condition variables: code blocking while waiting for a condition will	2075	condition variables: code blocking while waiting for a condition will
1009	C<die>. This still works with most modules/usages, and blocking calls must	2076	C<die>. This still works with most modules/usages, and blocking calls must
1010	not be done in an interactive application, so it makes sense.	2077	not be done in an interactive application, so it makes sense.
1011
1012	=head1 ENVIRONMENT VARIABLES
1013
1014	The following environment variables are used by this module:
1015
1016	=over 4
1017
1018	=item C<PERL_ANYEVENT_VERBOSE>
1019
1020	By default, AnyEvent will be completely silent except in fatal
1021	conditions. You can set this environment variable to make AnyEvent more
1022	talkative.
1023
1024	When set to C<1> or higher, causes AnyEvent to warn about unexpected
1025	conditions, such as not being able to load the event model specified by
1026	C<PERL_ANYEVENT_MODEL>.
1027
1028	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1029	model it chooses.
1030
1031	=item C<PERL_ANYEVENT_MODEL>
1032
1033	This can be used to specify the event model to be used by AnyEvent, before
1034	autodetection and -probing kicks in. It must be a string consisting
1035	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1036	and the resulting module name is loaded and if the load was successful,
1037	used as event model. If it fails to load AnyEvent will proceed with
1038	autodetection and -probing.
1039
1040	This functionality might change in future versions.
1041
1042	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1043	could start your program like this:
1044
1045	PERL_ANYEVENT_MODEL=Perl perl ...
1046
1047	=item C<PERL_ANYEVENT_PROTOCOLS>
1048
1049	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1050	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1051	of autoprobing).
1052
1053	Must be set to a comma-separated list of protocols or address families,
1054	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1055	used, and preference will be given to protocols mentioned earlier in the
1056	list.
1057
1058	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1059	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1060	- only support IPv4, never try to resolve or contact IPv6
1061	addressses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1062	IPv6, but prefer IPv6 over IPv4.
1063
1064	=back
1065		2078
1066	=head1 EXAMPLE PROGRAM	2079	=head1 EXAMPLE PROGRAM
1067		2080
1068	The following program uses an I/O watcher to read data from STDIN, a timer	2081	The following program uses an I/O watcher to read data from STDIN, a timer
1069	to display a message once per second, and a condition variable to quit the	2082	to display a message once per second, and a condition variable to quit the
…		…
1082	warn "read: $input\n"; # output what has been read	2095	warn "read: $input\n"; # output what has been read
1083	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2096	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1084	},	2097	},
1085	);	2098	);
1086		2099
1087	my $time_watcher; # can only be used once
1088
1089	sub new_timer {
1090	$timer = AnyEvent->timer (after => 1, cb => sub {	2100	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1091	warn "timeout\n"; # print 'timeout' about every second	2101	warn "timeout\n"; # print 'timeout' at most every second
1092	&new_timer; # and restart the time
1093	});	2102	});
1094	}
1095
1096	new_timer; # create first timer
1097		2103
1098	$cv->recv; # wait until user enters /^q/i	2104	$cv->recv; # wait until user enters /^q/i
1099		2105
1100	=head1 REAL-WORLD EXAMPLE	2106	=head1 REAL-WORLD EXAMPLE
1101		2107
…		…
1153	syswrite $txn->{fh}, $txn->{request}	2159	syswrite $txn->{fh}, $txn->{request}
1154	or die "connection or write error";	2160	or die "connection or write error";
1155	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });	2161	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
1156		2162
1157	Again, C<fh_ready_r> waits till all data has arrived, and then stores the	2163	Again, C<fh_ready_r> waits till all data has arrived, and then stores the
1158	result and signals any possible waiters that the request ahs finished:	2164	result and signals any possible waiters that the request has finished:
1159		2165
1160	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};	2166	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
1161		2167
1162	if (end-of-file or data complete) {	2168	if (end-of-file or data complete) {
1163	$txn->{result} = $txn->{buf};	2169	$txn->{result} = $txn->{buf};
…		…
1171		2177
1172	$txn->{finished}->recv;	2178	$txn->{finished}->recv;
1173	return $txn->{result};	2179	return $txn->{result};
1174		2180
1175	The actual code goes further and collects all errors (C<die>s, exceptions)	2181	The actual code goes further and collects all errors (C<die>s, exceptions)
1176	that occured during request processing. The C<result> method detects	2182	that occurred during request processing. The C<result> method detects
1177	whether an exception as thrown (it is stored inside the $txn object)	2183	whether an exception as thrown (it is stored inside the $txn object)
1178	and just throws the exception, which means connection errors and other	2184	and just throws the exception, which means connection errors and other
1179	problems get reported tot he code that tries to use the result, not in a	2185	problems get reported to the code that tries to use the result, not in a
1180	random callback.	2186	random callback.
1181		2187
1182	All of this enables the following usage styles:	2188	All of this enables the following usage styles:
1183		2189
1184	1. Blocking:	2190	1. Blocking:
…		…
1227	of various event loops I prepared some benchmarks.	2233	of various event loops I prepared some benchmarks.
1228		2234
1229	=head2 BENCHMARKING ANYEVENT OVERHEAD	2235	=head2 BENCHMARKING ANYEVENT OVERHEAD
1230		2236
1231	Here is a benchmark of various supported event models used natively and	2237	Here is a benchmark of various supported event models used natively and
1232	through anyevent. The benchmark creates a lot of timers (with a zero	2238	through AnyEvent. The benchmark creates a lot of timers (with a zero
1233	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2239	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1234	which it is), lets them fire exactly once and destroys them again.	2240	which it is), lets them fire exactly once and destroys them again.
1235		2241
1236	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2242	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1237	distribution.	2243	distribution. It uses the L<AE> interface, which makes a real difference
		2244	for the EV and Perl backends only.
1238		2245
1239	=head3 Explanation of the columns	2246	=head3 Explanation of the columns
1240		2247
1241	I<watcher> is the number of event watchers created/destroyed. Since	2248	I<watcher> is the number of event watchers created/destroyed. Since
1242	different event models feature vastly different performances, each event	2249	different event models feature vastly different performances, each event
…		…
1263	watcher.	2270	watcher.
1264		2271
1265	=head3 Results	2272	=head3 Results
1266		2273
1267	name watchers bytes create invoke destroy comment	2274	name watchers bytes create invoke destroy comment
1268	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	2275	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1269	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	2276	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1270	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	2277	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1271	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	2278	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1272	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	2279	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1273	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	2280	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
		2281	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
		2282	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1274	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	2283	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1275	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	2284	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1276	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	2285	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1277	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	2286	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1278		2287
1279	=head3 Discussion	2288	=head3 Discussion
1280		2289
1281	The benchmark does I<not> measure scalability of the event loop very	2290	The benchmark does I<not> measure scalability of the event loop very
1282	well. For example, a select-based event loop (such as the pure perl one)	2291	well. For example, a select-based event loop (such as the pure perl one)
…		…
1294	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2303	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1295	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2304	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1296	cycles with POE.	2305	cycles with POE.
1297		2306
1298	C<EV> is the sole leader regarding speed and memory use, which are both	2307	C<EV> is the sole leader regarding speed and memory use, which are both
1299	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2308	maximal/minimal, respectively. When using the L<AE> API there is zero
		2309	overhead (when going through the AnyEvent API create is about 5-6 times
		2310	slower, with other times being equal, so still uses far less memory than
1300	far less memory than any other event loop and is still faster than Event	2311	any other event loop and is still faster than Event natively).
1301	natively.
1302		2312
1303	The pure perl implementation is hit in a few sweet spots (both the	2313	The pure perl implementation is hit in a few sweet spots (both the
1304	constant timeout and the use of a single fd hit optimisations in the perl	2314	constant timeout and the use of a single fd hit optimisations in the perl
1305	interpreter and the backend itself). Nevertheless this shows that it	2315	interpreter and the backend itself). Nevertheless this shows that it
1306	adds very little overhead in itself. Like any select-based backend its	2316	adds very little overhead in itself. Like any select-based backend its
1307	performance becomes really bad with lots of file descriptors (and few of	2317	performance becomes really bad with lots of file descriptors (and few of
1308	them active), of course, but this was not subject of this benchmark.	2318	them active), of course, but this was not subject of this benchmark.
1309		2319
1310	The C<Event> module has a relatively high setup and callback invocation	2320	The C<Event> module has a relatively high setup and callback invocation
1311	cost, but overall scores in on the third place.	2321	cost, but overall scores in on the third place.
		2322
		2323	C<IO::Async> performs admirably well, about on par with C<Event>, even
		2324	when using its pure perl backend.
1312		2325
1313	C<Glib>'s memory usage is quite a bit higher, but it features a	2326	C<Glib>'s memory usage is quite a bit higher, but it features a
1314	faster callback invocation and overall ends up in the same class as	2327	faster callback invocation and overall ends up in the same class as
1315	C<Event>. However, Glib scales extremely badly, doubling the number of	2328	C<Event>. However, Glib scales extremely badly, doubling the number of
1316	watchers increases the processing time by more than a factor of four,	2329	watchers increases the processing time by more than a factor of four,
…		…
1360		2373
1361	=back	2374	=back
1362		2375
1363	=head2 BENCHMARKING THE LARGE SERVER CASE	2376	=head2 BENCHMARKING THE LARGE SERVER CASE
1364		2377
1365	This benchmark atcually benchmarks the event loop itself. It works by	2378	This benchmark actually benchmarks the event loop itself. It works by
1366	creating a number of "servers": each server consists of a socketpair, a	2379	creating a number of "servers": each server consists of a socket pair, a
1367	timeout watcher that gets reset on activity (but never fires), and an I/O	2380	timeout watcher that gets reset on activity (but never fires), and an I/O
1368	watcher waiting for input on one side of the socket. Each time the socket	2381	watcher waiting for input on one side of the socket. Each time the socket
1369	watcher reads a byte it will write that byte to a random other "server".	2382	watcher reads a byte it will write that byte to a random other "server".
1370		2383
1371	The effect is that there will be a lot of I/O watchers, only part of which	2384	The effect is that there will be a lot of I/O watchers, only part of which
1372	are active at any one point (so there is a constant number of active	2385	are active at any one point (so there is a constant number of active
1373	fds for each loop iterstaion, but which fds these are is random). The	2386	fds for each loop iteration, but which fds these are is random). The
1374	timeout is reset each time something is read because that reflects how	2387	timeout is reset each time something is read because that reflects how
1375	most timeouts work (and puts extra pressure on the event loops).	2388	most timeouts work (and puts extra pressure on the event loops).
1376		2389
1377	In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100	2390	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1378	(1%) are active. This mirrors the activity of large servers with many	2391	(1%) are active. This mirrors the activity of large servers with many
1379	connections, most of which are idle at any one point in time.	2392	connections, most of which are idle at any one point in time.
1380		2393
1381	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2394	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1382	distribution.	2395	distribution. It uses the L<AE> interface, which makes a real difference
		2396	for the EV and Perl backends only.
1383		2397
1384	=head3 Explanation of the columns	2398	=head3 Explanation of the columns
1385		2399
1386	I<sockets> is the number of sockets, and twice the number of "servers" (as	2400	I<sockets> is the number of sockets, and twice the number of "servers" (as
1387	each server has a read and write socket end).	2401	each server has a read and write socket end).
1388		2402
1389	I<create> is the time it takes to create a socketpair (which is	2403	I<create> is the time it takes to create a socket pair (which is
1390	nontrivial) and two watchers: an I/O watcher and a timeout watcher.	2404	nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1391		2405
1392	I<request>, the most important value, is the time it takes to handle a	2406	I<request>, the most important value, is the time it takes to handle a
1393	single "request", that is, reading the token from the pipe and forwarding	2407	single "request", that is, reading the token from the pipe and forwarding
1394	it to another server. This includes deleting the old timeout and creating	2408	it to another server. This includes deleting the old timeout and creating
1395	a new one that moves the timeout into the future.	2409	a new one that moves the timeout into the future.
1396		2410
1397	=head3 Results	2411	=head3 Results
1398		2412
1399	name sockets create request	2413	name sockets create request
1400	EV 20000 69.01 11.16	2414	EV 20000 62.66 7.99
1401	Perl 20000 73.32 35.87	2415	Perl 20000 68.32 32.64
1402	Event 20000 212.62 257.32	2416	IOAsync 20000 174.06 101.15 epoll
1403	Glib 20000 651.16 1896.30	2417	IOAsync 20000 174.67 610.84 poll
		2418	Event 20000 202.69 242.91
		2419	Glib 20000 557.01 1689.52
1404	POE 20000 349.67 12317.24 uses POE::Loop::Event	2420	POE 20000 341.54 12086.32 uses POE::Loop::Event
1405		2421
1406	=head3 Discussion	2422	=head3 Discussion
1407		2423
1408	This benchmark I<does> measure scalability and overall performance of the	2424	This benchmark I<does> measure scalability and overall performance of the
1409	particular event loop.	2425	particular event loop.
…		…
1411	EV is again fastest. Since it is using epoll on my system, the setup time	2427	EV is again fastest. Since it is using epoll on my system, the setup time
1412	is relatively high, though.	2428	is relatively high, though.
1413		2429
1414	Perl surprisingly comes second. It is much faster than the C-based event	2430	Perl surprisingly comes second. It is much faster than the C-based event
1415	loops Event and Glib.	2431	loops Event and Glib.
		2432
		2433	IO::Async performs very well when using its epoll backend, and still quite
		2434	good compared to Glib when using its pure perl backend.
1416		2435
1417	Event suffers from high setup time as well (look at its code and you will	2436	Event suffers from high setup time as well (look at its code and you will
1418	understand why). Callback invocation also has a high overhead compared to	2437	understand why). Callback invocation also has a high overhead compared to
1419	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2438	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1420	uses select or poll in basically all documented configurations.	2439	uses select or poll in basically all documented configurations.
…		…
1467	speed most when you have lots of watchers, not when you only have a few of	2486	speed most when you have lots of watchers, not when you only have a few of
1468	them).	2487	them).
1469		2488
1470	EV is again fastest.	2489	EV is again fastest.
1471		2490
1472	Perl again comes second. It is noticably faster than the C-based event	2491	Perl again comes second. It is noticeably faster than the C-based event
1473	loops Event and Glib, although the difference is too small to really	2492	loops Event and Glib, although the difference is too small to really
1474	matter.	2493	matter.
1475		2494
1476	POE also performs much better in this case, but is is still far behind the	2495	POE also performs much better in this case, but is is still far behind the
1477	others.	2496	others.
…		…
1483	=item * C-based event loops perform very well with small number of	2502	=item * C-based event loops perform very well with small number of
1484	watchers, as the management overhead dominates.	2503	watchers, as the management overhead dominates.
1485		2504
1486	=back	2505	=back
1487		2506
		2507	=head2 THE IO::Lambda BENCHMARK
		2508
		2509	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2510	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2511	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2512	shouldn't come as a surprise to anybody). As such, the benchmark is
		2513	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2514	very optimal. But how would AnyEvent compare when used without the extra
		2515	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2516
		2517	The benchmark itself creates an echo-server, and then, for 500 times,
		2518	connects to the echo server, sends a line, waits for the reply, and then
		2519	creates the next connection. This is a rather bad benchmark, as it doesn't
		2520	test the efficiency of the framework or much non-blocking I/O, but it is a
		2521	benchmark nevertheless.
		2522
		2523	name runtime
		2524	Lambda/select 0.330 sec
		2525	+ optimized 0.122 sec
		2526	Lambda/AnyEvent 0.327 sec
		2527	+ optimized 0.138 sec
		2528	Raw sockets/select 0.077 sec
		2529	POE/select, components 0.662 sec
		2530	POE/select, raw sockets 0.226 sec
		2531	POE/select, optimized 0.404 sec
		2532
		2533	AnyEvent/select/nb 0.085 sec
		2534	AnyEvent/EV/nb 0.068 sec
		2535	+state machine 0.134 sec
		2536
		2537	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2538	benchmarks actually make blocking connects and use 100% blocking I/O,
		2539	defeating the purpose of an event-based solution. All of the newly
		2540	written AnyEvent benchmarks use 100% non-blocking connects (using
		2541	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2542	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2543	generally require a lot more bookkeeping and event handling than blocking
		2544	connects (which involve a single syscall only).
		2545
		2546	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2547	offers similar expressive power as POE and IO::Lambda, using conventional
		2548	Perl syntax. This means that both the echo server and the client are 100%
		2549	non-blocking, further placing it at a disadvantage.
		2550
		2551	As you can see, the AnyEvent + EV combination even beats the
		2552	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2553	backend easily beats IO::Lambda and POE.
		2554
		2555	And even the 100% non-blocking version written using the high-level (and
		2556	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
		2557	higher level ("unoptimised") abstractions by a large margin, even though
		2558	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
		2559
		2560	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2561	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2562	part of the IO::Lambda distribution and were used without any changes.
		2563
		2564
		2565	=head1 SIGNALS
		2566
		2567	AnyEvent currently installs handlers for these signals:
		2568
		2569	=over 4
		2570
		2571	=item SIGCHLD
		2572
		2573	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		2574	emulation for event loops that do not support them natively. Also, some
		2575	event loops install a similar handler.
		2576
		2577	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2578	AnyEvent will reset it to default, to avoid losing child exit statuses.
		2579
		2580	=item SIGPIPE
		2581
		2582	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		2583	when AnyEvent gets loaded.
		2584
		2585	The rationale for this is that AnyEvent users usually do not really depend
		2586	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		2587	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		2588	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		2589	some random socket.
		2590
		2591	The rationale for installing a no-op handler as opposed to ignoring it is
		2592	that this way, the handler will be restored to defaults on exec.
		2593
		2594	Feel free to install your own handler, or reset it to defaults.
		2595
		2596	=back
		2597
		2598	=cut
		2599
		2600	undef $SIG{CHLD}
		2601	if $SIG{CHLD} eq 'IGNORE';
		2602
		2603	$SIG{PIPE} = sub { }
		2604	unless defined $SIG{PIPE};
		2605
		2606	=head1 RECOMMENDED/OPTIONAL MODULES
		2607
		2608	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2609	its built-in modules) are required to use it.
		2610
		2611	That does not mean that AnyEvent won't take advantage of some additional
		2612	modules if they are installed.
		2613
		2614	This section explains which additional modules will be used, and how they
		2615	affect AnyEvent's operation.
		2616
		2617	=over 4
		2618
		2619	=item L<Async::Interrupt>
		2620
		2621	This slightly arcane module is used to implement fast signal handling: To
		2622	my knowledge, there is no way to do completely race-free and quick
		2623	signal handling in pure perl. To ensure that signals still get
		2624	delivered, AnyEvent will start an interval timer to wake up perl (and
		2625	catch the signals) with some delay (default is 10 seconds, look for
		2626	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2627
		2628	If this module is available, then it will be used to implement signal
		2629	catching, which means that signals will not be delayed, and the event loop
		2630	will not be interrupted regularly, which is more efficient (and good for
		2631	battery life on laptops).
		2632
		2633	This affects not just the pure-perl event loop, but also other event loops
		2634	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2635
		2636	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2637	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2638	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2639	does nothing for those backends.
		2640
		2641	=item L<EV>
		2642
		2643	This module isn't really "optional", as it is simply one of the backend
		2644	event loops that AnyEvent can use. However, it is simply the best event
		2645	loop available in terms of features, speed and stability: It supports
		2646	the AnyEvent API optimally, implements all the watcher types in XS, does
		2647	automatic timer adjustments even when no monotonic clock is available,
		2648	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2649	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2650	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2651
		2652	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2653	then this module will do nothing for you.
		2654
		2655	=item L<Guard>
		2656
		2657	The guard module, when used, will be used to implement
		2658	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2659	lot less memory), but otherwise doesn't affect guard operation much. It is
		2660	purely used for performance.
		2661
		2662	=item L<JSON> and L<JSON::XS>
		2663
		2664	One of these modules is required when you want to read or write JSON data
		2665	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
		2666	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2667
		2668	=item L<Net::SSLeay>
		2669
		2670	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2671	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2672	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2673
		2674	=item L<Time::HiRes>
		2675
		2676	This module is part of perl since release 5.008. It will be used when the
		2677	chosen event library does not come with a timing source of its own. The
		2678	pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
		2679	try to use a monotonic clock for timing stability.
		2680
		2681	=back
		2682
1488		2683
1489	=head1 FORK	2684	=head1 FORK
1490		2685
1491	Most event libraries are not fork-safe. The ones who are usually are	2686	Most event libraries are not fork-safe. The ones who are usually are
1492	because they rely on inefficient but fork-safe C<select> or C<poll>	2687	because they rely on inefficient but fork-safe C<select> or C<poll> calls
1493	calls. Only L<EV> is fully fork-aware.	2688	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2689	are usually badly thought-out hacks that are incompatible with fork in
		2690	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2691	continue event-processing in both parent and child (or both, if you know
		2692	what you are doing).
		2693
		2694	This means that, in general, you cannot fork and do event processing in
		2695	the child if the event library was initialised before the fork (which
		2696	usually happens when the first AnyEvent watcher is created, or the library
		2697	is loaded).
1494		2698
1495	If you have to fork, you must either do so I<before> creating your first	2699	If you have to fork, you must either do so I<before> creating your first
1496	watcher OR you must not use AnyEvent at all in the child.	2700	watcher OR you must not use AnyEvent at all in the child OR you must do
		2701	something completely out of the scope of AnyEvent.
		2702
		2703	The problem of doing event processing in the parent I<and> the child
		2704	is much more complicated: even for backends that I<are> fork-aware or
		2705	fork-safe, their behaviour is not usually what you want: fork clones all
		2706	watchers, that means all timers, I/O watchers etc. are active in both
		2707	parent and child, which is almost never what you want. USing C<exec>
		2708	to start worker children from some kind of manage rprocess is usually
		2709	preferred, because it is much easier and cleaner, at the expense of having
		2710	to have another binary.
1497		2711
1498		2712
1499	=head1 SECURITY CONSIDERATIONS	2713	=head1 SECURITY CONSIDERATIONS
1500		2714
1501	AnyEvent can be forced to load any event model via	2715	AnyEvent can be forced to load any event model via
…		…
1506	specified in the variable.	2720	specified in the variable.
1507		2721
1508	You can make AnyEvent completely ignore this variable by deleting it	2722	You can make AnyEvent completely ignore this variable by deleting it
1509	before the first watcher gets created, e.g. with a C<BEGIN> block:	2723	before the first watcher gets created, e.g. with a C<BEGIN> block:
1510		2724
1511	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }	2725	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1512		2726
1513	use AnyEvent;	2727	use AnyEvent;
1514		2728
1515	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2729	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1516	be used to probe what backend is used and gain other information (which is	2730	be used to probe what backend is used and gain other information (which is
1517	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	2731	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		2732	$ENV{PERL_ANYEVENT_STRICT}.
		2733
		2734	Note that AnyEvent will remove I<all> environment variables starting with
		2735	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2736	enabled.
		2737
		2738
		2739	=head1 BUGS
		2740
		2741	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
		2742	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
		2743	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
		2744	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
		2745	pronounced).
1518		2746
1519		2747
1520	=head1 SEE ALSO	2748	=head1 SEE ALSO
1521		2749
		2750	Tutorial/Introduction: L<AnyEvent::Intro>.
		2751
		2752	FAQ: L<AnyEvent::FAQ>.
		2753
1522	Utility functions: L<AnyEvent::Util>.	2754	Utility functions: L<AnyEvent::Util>.
1523		2755
1524	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2756	Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
1525	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2757	L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1526		2758
1527	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2759	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1528	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2760	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1529	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2761	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1530	L<AnyEvent::Impl::POE>.	2762	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1531		2763
1532	Non-blocking file handles, sockets, TCP clients and	2764	Non-blocking file handles, sockets, TCP clients and
1533	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2765	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1534		2766
1535	Asynchronous DNS: L<AnyEvent::DNS>.	2767	Asynchronous DNS: L<AnyEvent::DNS>.
1536		2768
1537	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2769	Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
1538		2770
1539	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2771	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
		2772	L<AnyEvent::HTTP>.
1540		2773
1541		2774
1542	=head1 AUTHOR	2775	=head1 AUTHOR
1543		2776
1544	Marc Lehmann <schmorp@schmorp.de>	2777	Marc Lehmann <schmorp@schmorp.de>
1545	http://home.schmorp.de/	2778	http://home.schmorp.de/
1546		2779
1547	=cut	2780	=cut
1548		2781
1549	1	2782	1
1550		2783

Diff Legend

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