ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.112 by root, Sat May 10 01:04:42 2008 UTC vs.
Revision 1.330 by root, Tue Aug 31 00:59:55 2010 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
		6	and POE are various supported event loops/environments.
6		7
7	=head1 SYNOPSIS	8	=head1 SYNOPSIS
8		9
9	use AnyEvent;	10	use AnyEvent;
10		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
		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
		38	$w->send; # wake up current and all future recv's
20	$w->wait; # enters "main loop" till $condvar gets ->send	39	$w->recv; # enters "main loop" till $condvar gets ->send
21	$w->send; # wake up current and all future wait's	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	There is a mailinglist for discussing all things AnyEvent, and an IRC
		52	channel, too.
		53
		54	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		55	Repository>, at L<http://anyevent.schmorp.de>, for more info.
22		56
23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	57	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24		58
25	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	59	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26	nowadays. So what is different about AnyEvent?	60	nowadays. So what is different about AnyEvent?
27		61
28	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	62	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29	policy> and AnyEvent is I<small and efficient>.	63	policy> and AnyEvent is I<small and efficient>.
30		64
31	First and foremost, I<AnyEvent is not an event model> itself, it only	65	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	66	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,	67	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,	68	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	69	only one event loop can be active at the same time in a process. AnyEvent
36	helps hiding the differences between those event loops.	70	cannot change this, but it can hide the differences between those event
		71	loops.
37		72
38	The goal of AnyEvent is to offer module authors the ability to do event	73	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	74	programming (waiting for I/O or timer events) without subscribing to a
40	religion, a way of living, and most importantly: without forcing your	75	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	76	module users into the same thing by forcing them to use the same event
42	model you use.	77	model you use.
43		78
44	For modules like POE or IO::Async (which is a total misnomer as it is	79	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	80	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	81	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	82	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	83	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.	84	module are I<also> forced to use the same event loop you use.
50		85
51	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	86	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	87	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	88	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
54	your module uses one of those, every user of your module has to use it,	89	your module uses one of those, every user of your module has to use it,
55	too. But if your module uses AnyEvent, it works transparently with all	90	too. But if your module uses AnyEvent, it works transparently with all
56	event models it supports (including stuff like POE and IO::Async, as long	91	event models it supports (including stuff like IO::Async, as long as those
57	as those use one of the supported event loops. It is trivial to add new	92	use one of the supported event loops. It is easy to add new event loops
58	event loops to AnyEvent, too, so it is future-proof).	93	to AnyEvent, too, so it is future-proof).
59		94
60	In addition to being free of having to use I<the one and only true event	95	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	96	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	97	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	98	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	99	offering the functionality that is necessary, in as thin as a wrapper as
65	technically possible.	100	technically possible.
66		101
		102	Of course, AnyEvent comes with a big (and fully optional!) toolbox
		103	of useful functionality, such as an asynchronous DNS resolver, 100%
		104	non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
		105	such as Windows) and lots of real-world knowledge and workarounds for
		106	platform bugs and differences.
		107
67	Of course, if you want lots of policy (this can arguably be somewhat	108	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	109	useful) and you want to force your users to use the one and only event
69	model, you should I<not> use this module.	110	model, you should I<not> use this module.
70		111
71	=head1 DESCRIPTION	112	=head1 DESCRIPTION
72		113
73	L<AnyEvent> provides an identical interface to multiple event loops. This	114	L<AnyEvent> provides a uniform interface to various event loops. This
74	allows module authors to utilise an event loop without forcing module	115	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	116	module users to use a specific event loop implementation (since more
76	peacefully at any one time).	117	than one event loop cannot coexist peacefully).
77		118
78	The interface itself is vaguely similar, but not identical to the L<Event>	119	The interface itself is vaguely similar, but not identical to the L<Event>
79	module.	120	module.
80		121
81	During the first call of any watcher-creation method, the module tries	122	During the first call of any watcher-creation method, the module tries
…		…
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
106	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
107	explicitly.	149	explicitly and enjoy the high 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::Impl::Perl>) cache
		362	the current time for each loop iteration (see the discussion of L<<
		363	AnyEvent->now >>, 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 the latency and race problems
		488	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	AnyEvent::detect; # force event module to be initialised
285
286	my $pid = fork or exit 5;	494	my $pid = fork or exit 5;
287		495
288	my $w = AnyEvent->child (	496	my $w = AnyEvent->child (
289	pid => $pid,	497	pid => $pid,
290	cb => sub {	498	cb => sub {
291	my ($pid, $status) = @_;	499	my ($pid, $status) = @_;
292	warn "pid $pid exited with status $status";	500	warn "pid $pid exited with status $status";
293	$done->send;	501	$done->send;
294	},	502	},
295	);	503	);
296		504
297	# do something else, then wait for process exit	505	# do something else, then wait for process exit
298	$done->wait;	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	});
299		547
300	=head2 CONDITION VARIABLES	548	=head2 CONDITION VARIABLES
		549
		550	$cv = AnyEvent->condvar;
		551
		552	$cv->send (<list>);
		553	my @res = $cv->recv;
301		554
302	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
303	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
304	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
305		558
306	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
307	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).
308		561
309	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
310	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.
311		566
312	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
313	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
314	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
315	becomes true.	570	becomes true, with the condition variable as the first argument (but not
		571	the results).
316		572
317	After creation, the conditon variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
318	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).
319		577
320	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
321	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:
322	in time where multiple outstandign events have been processed. And yet	580
323	another way to call them is transations - each condition variable can be	581	=over 4
324	used to represent a transaction, which finishes at some point and delivers	582
325	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
326		601
327	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
328	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,
329	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
330	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
331	called or can synchronously C<< ->wait >> for the results.	606	called or can synchronously C<< ->recv >> for the results.
332		607
333	You can also use them to simulate traditional event loops - for example,	608	You can also use them to simulate traditional event loops - for example,
334	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
335	could C<< ->wait >> in your main program until the user clicks the Quit	610	could C<< ->recv >> in your main program until the user clicks the Quit
336	button of your app, which would C<< ->send >> the "quit" event.	611	button of your app, which would C<< ->send >> the "quit" event.
337		612
338	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
339	two pieces of code that call C<< ->wait >> in a round-robbin fashion, you	614	two pieces of code that call C<< ->recv >> in a round-robin fashion, you
340	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
341	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,
342	as this asks for trouble.	617	as this asks for trouble.
343		618
344	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
345	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
346	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
347	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
348	it's C<new> method in your own C<new> method.	623	its C<new> method in your own C<new> method.
349		624
350	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
351	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
352	for the send to occur.	627	for the send to occur.
353		628
354	Example:	629	Example: wait for a timer.
355		630
356	# wait till the result is ready	631	# condition: "wait till the timer is fired"
357	my $result_ready = AnyEvent->condvar;	632	my $timer_fired = AnyEvent->condvar;
358		633
359	# do something such as adding a timer	634	# create the timer - we could wait for, say
360	# or socket watcher the calls $result_ready->send	635	# a handle becomign ready, or even an
361	# when the "result" is ready.	636	# AnyEvent::HTTP request to finish, but
362	# in this case, we simply use a timer:	637	# in this case, we simply use a timer:
363	my $w = AnyEvent->timer (	638	my $w = AnyEvent->timer (
364	after => 1,	639	after => 1,
365	cb => sub { $result_ready->send },	640	cb => sub { $timer_fired->send },
366	);	641	);
367		642
368	# this "blocks" (while handling events) till the callback	643	# this "blocks" (while handling events) till the callback
369	# calls send	644	# calls ->send
370	$result_ready->wait;	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	});
371		670
372	=head3 METHODS FOR PRODUCERS	671	=head3 METHODS FOR PRODUCERS
373		672
374	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
375	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
…		…
378		677
379	=over 4	678	=over 4
380		679
381	=item $cv->send (...)	680	=item $cv->send (...)
382		681
383	Flag the condition as ready - a running C<< ->wait >> and all further	682	Flag the condition as ready - a running C<< ->recv >> and all further
384	calls to C<wait> will (eventually) return after this method has been	683	calls to C<recv> will (eventually) return after this method has been
385	called. If nobody is waiting the send will be remembered.	684	called. If nobody is waiting the send will be remembered.
386		685
387	If a callback has been set on the condition variable, it is called	686	If a callback has been set on the condition variable, it is called
388	immediately from within send.	687	immediately from within send.
389		688
390	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
391	future C<< ->wait >> calls.	690	future C<< ->recv >> calls.
		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>.
392		695
393	=item $cv->croak ($error)	696	=item $cv->croak ($error)
394		697
395	Similar to send, but causes all call's wait C<< ->wait >> to invoke	698	Similar to send, but causes all calls to C<< ->recv >> to invoke
396	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
397		700
398	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
399	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.
400		707
401	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
402		709
403	=item $cv->end	710	=item $cv->end
404		711
…		…
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
454	These methods should only be used by the consuming side, i.e. the	793	These methods should only be used by the consuming side, i.e. the
455	code awaits the condition.	794	code awaits the condition.
456		795
457	=over 4	796	=over 4
458		797
459	=item $cv->wait	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<< ->wait >> in a module is that you cannot
483	sensibly have two C<< ->wait >>'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<< ->wait >> 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<< -wait >> 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<< ->wait >> 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<wait> 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 implementation, fast and portable.
		866
		867	=item Backends that are transparently being picked up when they are used.
		868
		869	These will be used if they are already loaded when the first watcher
		870	is created, in which case it is assumed that the application is using
		871	them. This means that AnyEvent will automatically pick the right backend
		872	when the main program loads an event module before anything starts to
		873	create watchers. Nothing special needs to be done by the main program.
		874
		875	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		876	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		877	AnyEvent::Impl::Tk based on Tk, very broken.
		878	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		879	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		880	AnyEvent::Impl::Irssi used when running within irssi.
		881
		882	=item Backends with special needs.
		883
		884	Qt requires the Qt::Application to be instantiated first, but will
		885	otherwise be picked up automatically. As long as the main program
		886	instantiates the application before any AnyEvent watchers are created,
		887	everything should just work.
		888
		889	AnyEvent::Impl::Qt based on Qt.
		890
		891	Support for IO::Async can only be partial, as it is too broken and
		892	architecturally limited to even support the AnyEvent API. It also
		893	is the only event loop that needs the loop to be set explicitly, so
		894	it can only be used by a main program knowing about AnyEvent. See
		895	L<AnyEvent::Impl::IOAsync> for the gory details.
		896
		897	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		898
		899	=item Event loops that are indirectly supported via other backends.
		900
		901	Some event loops can be supported via other modules:
		902
		903	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		904
		905	B<WxWidgets> has no support for watching file handles. However, you can
		906	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		907	polls 20 times per second, which was considered to be too horrible to even
		908	consider for AnyEvent.
		909
		910	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		911	backend, so it can be supported through POE.
		912
		913	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		914	load L<POE> when detecting them, in the hope that POE will pick them up,
		915	in which case everything will be automatic.
		916
		917	=back
		918
514	=head1 GLOBAL VARIABLES AND FUNCTIONS	919	=head1 GLOBAL VARIABLES AND FUNCTIONS
515		920
		921	These are not normally required to use AnyEvent, but can be useful to
		922	write AnyEvent extension modules.
		923
516	=over 4	924	=over 4
517		925
518	=item $AnyEvent::MODEL	926	=item $AnyEvent::MODEL
519		927
520	Contains C<undef> until the first watcher is being created. Then it	928	Contains C<undef> until the first watcher is being created, before the
		929	backend has been autodetected.
		930
521	contains the event model that is being used, which is the name of the	931	Afterwards it contains the event model that is being used, which is the
522	Perl class implementing the model. This class is usually one of the	932	name of the Perl class implementing the model. This class is usually one
523	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	933	of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
524	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	934	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
525		935	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		936
547	=item AnyEvent::detect	937	=item AnyEvent::detect
548		938
549	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	939	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
550	if necessary. You should only call this function right before you would	940	if necessary. You should only call this function right before you would
551	have created an AnyEvent watcher anyway, that is, as late as possible at	941	have created an AnyEvent watcher anyway, that is, as late as possible at
552	runtime.	942	runtime, and not e.g. during initialisation of your module.
		943
		944	If you need to do some initialisation before AnyEvent watchers are
		945	created, use C<post_detect>.
553		946
554	=item $guard = AnyEvent::post_detect { BLOCK }	947	=item $guard = AnyEvent::post_detect { BLOCK }
555		948
556	Arranges for the code block to be executed as soon as the event model is	949	Arranges for the code block to be executed as soon as the event model is
557	autodetected (or immediately if this has already happened).	950	autodetected (or immediately if that has already happened).
		951
		952	The block will be executed I<after> the actual backend has been detected
		953	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		954	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		955	other initialisations - see the sources of L<AnyEvent::Strict> or
		956	L<AnyEvent::AIO> to see how this is used.
		957
		958	The most common usage is to create some global watchers, without forcing
		959	event module detection too early, for example, L<AnyEvent::AIO> creates
		960	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		961	avoid autodetecting the event module at load time.
558		962
559	If called in scalar or list context, then it creates and returns an object	963	If called in scalar or list context, then it creates and returns an object
560	that automatically removes the callback again when it is destroyed. See	964	that automatically removes the callback again when it is destroyed (or
		965	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
561	L<Coro::BDB> for a case where this is useful.	966	a case where this is useful.
		967
		968	Example: Create a watcher for the IO::AIO module and store it in
		969	C<$WATCHER>, but do so only do so after the event loop is initialised.
		970
		971	our WATCHER;
		972
		973	my $guard = AnyEvent::post_detect {
		974	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		975	};
		976
		977	# the ||= is important in case post_detect immediately runs the block,
		978	# as to not clobber the newly-created watcher. assigning both watcher and
		979	# post_detect guard to the same variable has the advantage of users being
		980	# able to just C<undef $WATCHER> if the watcher causes them grief.
		981
		982	$WATCHER ||= $guard;
562		983
563	=item @AnyEvent::post_detect	984	=item @AnyEvent::post_detect
564		985
565	If there are any code references in this array (you can C<push> to it	986	If there are any code references in this array (you can C<push> to it
566	before or after loading AnyEvent), then they will called directly after	987	before or after loading AnyEvent), then they will be called directly
567	the event loop has been chosen.	988	after the event loop has been chosen.
568		989
569	You should check C<$AnyEvent::MODEL> before adding to this array, though:	990	You should check C<$AnyEvent::MODEL> before adding to this array, though:
570	if it contains a true value then the event loop has already been detected,	991	if it is defined then the event loop has already been detected, and the
571	and the array will be ignored.	992	array will be ignored.
572		993
573	Best use C<AnyEvent::post_detect { BLOCK }> instead.	994	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		995	it, as it takes care of these details.
		996
		997	This variable is mainly useful for modules that can do something useful
		998	when AnyEvent is used and thus want to know when it is initialised, but do
		999	not need to even load it by default. This array provides the means to hook
		1000	into AnyEvent passively, without loading it.
		1001
		1002	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1003	together, you could put this into Coro (this is the actual code used by
		1004	Coro to accomplish this):
		1005
		1006	if (defined $AnyEvent::MODEL) {
		1007	# AnyEvent already initialised, so load Coro::AnyEvent
		1008	require Coro::AnyEvent;
		1009	} else {
		1010	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1011	# as soon as it is
		1012	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1013	}
574		1014
575	=back	1015	=back
576		1016
577	=head1 WHAT TO DO IN A MODULE	1017	=head1 WHAT TO DO IN A MODULE
578		1018
…		…
582	Be careful when you create watchers in the module body - AnyEvent will	1022	Be careful when you create watchers in the module body - AnyEvent will
583	decide which event module to use as soon as the first method is called, so	1023	decide which event module to use as soon as the first method is called, so
584	by calling AnyEvent in your module body you force the user of your module	1024	by calling AnyEvent in your module body you force the user of your module
585	to load the event module first.	1025	to load the event module first.
586		1026
587	Never call C<< ->wait >> on a condition variable unless you I<know> that	1027	Never call C<< ->recv >> on a condition variable unless you I<know> that
588	the C<< ->send >> method has been called on it already. This is	1028	the C<< ->send >> method has been called on it already. This is
589	because it will stall the whole program, and the whole point of using	1029	because it will stall the whole program, and the whole point of using
590	events is to stay interactive.	1030	events is to stay interactive.
591		1031
592	It is fine, however, to call C<< ->wait >> when the user of your module	1032	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	1033	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<< ->wait >>	1034	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).	1035	freely, as the user of your module knows what she is doing. Always).
596		1036
597	=head1 WHAT TO DO IN THE MAIN PROGRAM	1037	=head1 WHAT TO DO IN THE MAIN PROGRAM
598		1038
599	There will always be a single main program - the only place that should	1039	There will always be a single main program - the only place that should
600	dictate which event model to use.	1040	dictate which event model to use.
601		1041
602	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	1042	If the program is not event-based, it need not do anything special, even
603	do anything special (it does not need to be event-based) and let AnyEvent	1043	when it depends on a module that uses an AnyEvent. If the program itself
604	decide which implementation to chose if some module relies on it.	1044	uses AnyEvent, but does not care which event loop is used, all it needs
		1045	to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
		1046	available loop implementation.
605		1047
606	If the main program relies on a specific event model. For example, in	1048	If the main program relies on a specific event model - for example, in
607	Gtk2 programs you have to rely on the Glib module. You should load the	1049	Gtk2 programs you have to rely on the Glib module - you should load the
608	event module before loading AnyEvent or any module that uses it: generally	1050	event module before loading AnyEvent or any module that uses it: generally
609	speaking, you should load it as early as possible. The reason is that	1051	speaking, you should load it as early as possible. The reason is that
610	modules might create watchers when they are loaded, and AnyEvent will	1052	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	1053	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.	1054	might choose the wrong one unless you load the correct one yourself.
613		1055
614	You can chose to use a rather inefficient pure-perl implementation by	1056	You can chose to use a pure-perl implementation by loading the
615	loading the C<AnyEvent::Impl::Perl> module, which gives you similar	1057	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
616	behaviour everywhere, but letting AnyEvent chose is generally better.	1058	everywhere, but letting AnyEvent chose the model is generally better.
		1059
		1060	=head2 MAINLOOP EMULATION
		1061
		1062	Sometimes (often for short test scripts, or even standalone programs who
		1063	only want to use AnyEvent), you do not want to run a specific event loop.
		1064
		1065	In that case, you can use a condition variable like this:
		1066
		1067	AnyEvent->condvar->recv;
		1068
		1069	This has the effect of entering the event loop and looping forever.
		1070
		1071	Note that usually your program has some exit condition, in which case
		1072	it is better to use the "traditional" approach of storing a condition
		1073	variable somewhere, waiting for it, and sending it when the program should
		1074	exit cleanly.
		1075
617		1076
618	=head1 OTHER MODULES	1077	=head1 OTHER MODULES
619		1078
620	The following is a non-exhaustive list of additional modules that use	1079	The following is a non-exhaustive list of additional modules that use
621	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1080	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
622	in the same program. Some of the modules come with AnyEvent, some are	1081	modules and other event loops in the same program. Some of the modules
623	available via CPAN.	1082	come as part of AnyEvent, the others are available via CPAN.
624		1083
625	=over 4	1084	=over 4
626		1085
627	=item L<AnyEvent::Util>	1086	=item L<AnyEvent::Util>
628		1087
629	Contains various utility functions that replace often-used but blocking	1088	Contains various utility functions that replace often-used blocking
630	functions such as C<inet_aton> by event-/callback-based versions.	1089	functions such as C<inet_aton> with event/callback-based versions.
		1090
		1091	=item L<AnyEvent::Socket>
		1092
		1093	Provides various utility functions for (internet protocol) sockets,
		1094	addresses and name resolution. Also functions to create non-blocking tcp
		1095	connections or tcp servers, with IPv6 and SRV record support and more.
631		1096
632	=item L<AnyEvent::Handle>	1097	=item L<AnyEvent::Handle>
633		1098
634	Provide read and write buffers and manages watchers for reads and writes.	1099	Provide read and write buffers, manages watchers for reads and writes,
		1100	supports raw and formatted I/O, I/O queued and fully transparent and
		1101	non-blocking SSL/TLS (via L<AnyEvent::TLS>).
635		1102
636	=item L<AnyEvent::Socket>	1103	=item L<AnyEvent::DNS>
637		1104
638	Provides a means to do non-blocking connects, accepts etc.	1105	Provides rich asynchronous DNS resolver capabilities.
		1106
		1107	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1108
		1109	Implement event-based interfaces to the protocols of the same name (for
		1110	the curious, IGS is the International Go Server and FCP is the Freenet
		1111	Client Protocol).
		1112
		1113	=item L<AnyEvent::Handle::UDP>
		1114
		1115	Here be danger!
		1116
		1117	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1118	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1119	its use of a stream-based API with a protocol that isn't streamable, that
		1120	the only way to improve it is to delete it.
		1121
		1122	It features data corruption (but typically only under load) and general
		1123	confusion. On top, the author is not only clueless about UDP but also
		1124	fact-resistant - some gems of his understanding: "connect doesn't work
		1125	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1126	packets", "I don't need to implement proper error checking as UDP doesn't
		1127	support error checking" and so on - he doesn't even understand what's
		1128	wrong with his module when it is explained to him.
		1129
		1130	=item L<AnyEvent::DBI>
		1131
		1132	Executes L<DBI> requests asynchronously in a proxy process for you,
		1133	notifying you in an event-based way when the operation is finished.
		1134
		1135	=item L<AnyEvent::AIO>
		1136
		1137	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1138	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1139	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1140	file I/O, and much more.
639		1141
640	=item L<AnyEvent::HTTPD>	1142	=item L<AnyEvent::HTTPD>
641		1143
642	Provides a simple web application server framework.	1144	A simple embedded webserver.
643
644	=item L<AnyEvent::DNS>
645
646	Provides asynchronous DNS resolver capabilities, beyond what
647	L<AnyEvent::Util> offers.
648		1145
649	=item L<AnyEvent::FastPing>	1146	=item L<AnyEvent::FastPing>
650		1147
651	The fastest ping in the west.	1148	The fastest ping in the west.
652		1149
653	=item L<Net::IRC3>
654
655	AnyEvent based IRC client module family.
656
657	=item L<Net::XMPP2>
658
659	AnyEvent based XMPP (Jabber protocol) module family.
660
661	=item L<Net::FCP>
662
663	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
664	of AnyEvent.
665
666	=item L<Event::ExecFlow>
667
668	High level API for event-based execution flow control.
669
670	=item L<Coro>	1150	=item L<Coro>
671		1151
672	Has special support for AnyEvent via L<Coro::AnyEvent>.	1152	Has special support for AnyEvent via L<Coro::AnyEvent>.
673		1153
674	=item L<IO::Lambda>
675
676	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
677
678	=item L<IO::AIO>
679
680	Truly asynchronous I/O, should be in the toolbox of every event
681	programmer. Can be trivially made to use AnyEvent.
682
683	=item L<BDB>
684
685	Truly asynchronous Berkeley DB access. Can be trivially made to use
686	AnyEvent.
687
688	=back	1154	=back
689		1155
690	=cut	1156	=cut
691		1157
692	package AnyEvent;	1158	package AnyEvent;
693		1159
694	no warnings;	1160	# basically a tuned-down version of common::sense
695	use strict;	1161	sub common_sense {
		1162	# from common:.sense 1.0
		1163	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
		1164	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
		1165	$^H |= 0x00000600;
		1166	}
696		1167
		1168	BEGIN { AnyEvent::common_sense }
		1169
697	use Carp;	1170	use Carp ();
698		1171
699	our $VERSION = '3.4';	1172	our $VERSION = '5.271';
700	our $MODEL;	1173	our $MODEL;
701		1174
702	our $AUTOLOAD;	1175	our $AUTOLOAD;
703	our @ISA;	1176	our @ISA;
704		1177
705	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
706
707	our @REGISTRY;	1178	our @REGISTRY;
708		1179
		1180	our $VERBOSE;
		1181
		1182	BEGIN {
		1183	require "AnyEvent/constants.pl";
		1184
		1185	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
		1186
		1187	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1188	if ${^TAINT};
		1189
		1190	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1191
		1192	}
		1193
		1194	our $MAX_SIGNAL_LATENCY = 10;
		1195
		1196	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
		1197
		1198	{
		1199	my $idx;
		1200	$PROTOCOL{$_} = ++$idx
		1201	for reverse split /\s*,\s*/,
		1202	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
		1203	}
		1204
709	my @models = (	1205	my @models = (
710	[EV:: => AnyEvent::Impl::EV::],	1206	[EV:: => AnyEvent::Impl::EV:: , 1],
		1207	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
		1208	# everything below here will not (normally) be autoprobed
		1209	# as the pureperl backend should work everywhere
		1210	# and is usually faster
711	[Event:: => AnyEvent::Impl::Event::],	1211	[Event:: => AnyEvent::Impl::Event::, 1],
		1212	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1213	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1214	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
712	[Tk:: => AnyEvent::Impl::Tk::],	1215	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		1216	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
		1217	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
713	[Wx:: => AnyEvent::Impl::POE::],	1218	[Wx:: => AnyEvent::Impl::POE::],
714	[Prima:: => AnyEvent::Impl::POE::],	1219	[Prima:: => AnyEvent::Impl::POE::],
715	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1220	# IO::Async is just too broken - we would need workarounds for its
716	# everything below here will not be autoprobed as the pureperl backend should work everywhere	1221	# byzantine signal and broken child handling, among others.
717	[Glib:: => AnyEvent::Impl::Glib::],	1222	# IO::Async is rather hard to detect, as it doesn't have any
718	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1223	# obvious default class.
719	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1224	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
720	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1225	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1226	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1227	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
721	);	1228	);
722		1229
723	our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);	1230	our %method = map +($_ => 1),
		1231	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
724		1232
725	our @post_detect;	1233	our @post_detect;
726		1234
727	sub post_detect(&) {	1235	sub post_detect(&) {
728	my ($cb) = @_;	1236	my ($cb) = @_;
729		1237
730	if ($MODEL) {
731	$cb->();
732
733	1
734	} else {
735	push @post_detect, $cb;	1238	push @post_detect, $cb;
736		1239
737	defined wantarray	1240	defined wantarray
738	? bless \$cb, "AnyEvent::Util::Guard"	1241	? bless \$cb, "AnyEvent::Util::postdetect"
739	: ()	1242	: ()
		1243	}
		1244
		1245	sub AnyEvent::Util::postdetect::DESTROY {
		1246	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1247	}
		1248
		1249	sub detect() {
		1250	# free some memory
		1251	*detect = sub () { $MODEL };
		1252
		1253	local $!; # for good measure
		1254	local $SIG{__DIE__};
		1255
		1256	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1257	my $model = "AnyEvent::Impl::$1";
		1258	if (eval "require $model") {
		1259	$MODEL = $model;
		1260	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1261	} else {
		1262	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1263	}
740	}	1264	}
741	}
742		1265
743	sub AnyEvent::Util::Guard::DESTROY {	1266	# check for already loaded models
744	@post_detect = grep $_ != ${$_[0]}, @post_detect;
745	}
746
747	sub detect() {
748	unless ($MODEL) {	1267	unless ($MODEL) {
749	no strict 'refs';	1268	for (@REGISTRY, @models) {
750		1269	my ($package, $model) = @$_;
751	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1270	if (${"$package\::VERSION"} > 0) {
752	my $model = "AnyEvent::Impl::$1";
753	if (eval "require $model") {	1271	if (eval "require $model") {
754	$MODEL = $model;	1272	$MODEL = $model;
755	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1273	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
756	} else {	1274	last;
757	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1275	}
758	}	1276	}
759	}	1277	}
760		1278
761	# check for already loaded models
762	unless ($MODEL) {	1279	unless ($MODEL) {
		1280	# try to autoload a model
763	for (@REGISTRY, @models) {	1281	for (@REGISTRY, @models) {
764	my ($package, $model) = @$_;	1282	my ($package, $model, $autoload) = @$_;
		1283	if (
		1284	$autoload
		1285	and eval "require $package"
765	if (${"$package\::VERSION"} > 0) {	1286	and ${"$package\::VERSION"} > 0
766	if (eval "require $model") {	1287	and eval "require $model"
		1288	) {
767	$MODEL = $model;	1289	$MODEL = $model;
768	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1290	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
769	last;	1291	last;
770	}
771	}	1292	}
772	}	1293	}
773		1294
774	unless ($MODEL) {
775	# try to load a model
776
777	for (@REGISTRY, @models) {
778	my ($package, $model) = @$_;
779	if (eval "require $package"
780	and ${"$package\::VERSION"} > 0
781	and eval "require $model") {
782	$MODEL = $model;
783	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
784	last;
785	}
786	}
787
788	$MODEL	1295	$MODEL
789	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1296	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
790	}
791	}	1297	}
792
793	unshift @ISA, $MODEL;
794	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
795
796	(shift @post_detect)->() while @post_detect;
797	}	1298	}
		1299
		1300	@models = (); # free probe data
		1301
		1302	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1303	unshift @ISA, $MODEL;
		1304
		1305	# now nuke some methods that are overriden by the backend.
		1306	# SUPER is not allowed.
		1307	for (qw(time signal child idle)) {
		1308	undef &{"AnyEvent::Base::$_"}
		1309	if defined &{"$MODEL\::$_"};
		1310	}
		1311
		1312	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1313
		1314	(shift @post_detect)->() while @post_detect;
		1315
		1316	*post_detect = sub(&) {
		1317	shift->();
		1318
		1319	undef
		1320	};
798		1321
799	$MODEL	1322	$MODEL
800	}	1323	}
801		1324
802	sub AUTOLOAD {	1325	sub AUTOLOAD {
803	(my $func = $AUTOLOAD) =~ s/.*://;	1326	(my $func = $AUTOLOAD) =~ s/.*://;
804		1327
805	$method{$func}	1328	$method{$func}
806	or croak "$func: not a valid method for AnyEvent objects";	1329	or Carp::croak "$func: not a valid AnyEvent class method";
807		1330
808	detect unless $MODEL;	1331	detect;
809		1332
810	my $class = shift;	1333	my $class = shift;
811	$class->$func (@_);	1334	$class->$func (@_);
812	}	1335	}
813		1336
		1337	# utility function to dup a filehandle. this is used by many backends
		1338	# to support binding more than one watcher per filehandle (they usually
		1339	# allow only one watcher per fd, so we dup it to get a different one).
		1340	sub _dupfh($$;$$) {
		1341	my ($poll, $fh, $r, $w) = @_;
		1342
		1343	# cygwin requires the fh mode to be matching, unix doesn't
		1344	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
		1345
		1346	open my $fh2, $mode, $fh
		1347	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
		1348
		1349	# we assume CLOEXEC is already set by perl in all important cases
		1350
		1351	($fh2, $rw)
		1352	}
		1353
		1354	=head1 SIMPLIFIED AE API
		1355
		1356	Starting with version 5.0, AnyEvent officially supports a second, much
		1357	simpler, API that is designed to reduce the calling, typing and memory
		1358	overhead by using function call syntax and a fixed number of parameters.
		1359
		1360	See the L<AE> manpage for details.
		1361
		1362	=cut
		1363
		1364	package AE;
		1365
		1366	our $VERSION = $AnyEvent::VERSION;
		1367
		1368	# fall back to the main API by default - backends and AnyEvent::Base
		1369	# implementations can overwrite these.
		1370
		1371	sub io($$$) {
		1372	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1373	}
		1374
		1375	sub timer($$$) {
		1376	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1377	}
		1378
		1379	sub signal($$) {
		1380	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1381	}
		1382
		1383	sub child($$) {
		1384	AnyEvent->child (pid => $_[0], cb => $_[1])
		1385	}
		1386
		1387	sub idle($) {
		1388	AnyEvent->idle (cb => $_[0])
		1389	}
		1390
		1391	sub cv(;&) {
		1392	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1393	}
		1394
		1395	sub now() {
		1396	AnyEvent->now
		1397	}
		1398
		1399	sub now_update() {
		1400	AnyEvent->now_update
		1401	}
		1402
		1403	sub time() {
		1404	AnyEvent->time
		1405	}
		1406
814	package AnyEvent::Base;	1407	package AnyEvent::Base;
815		1408
		1409	# default implementations for many methods
		1410
		1411	sub time {
		1412	eval q{ # poor man's autoloading {}
		1413	# probe for availability of Time::HiRes
		1414	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1415	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
		1416	*AE::time = \&Time::HiRes::time;
		1417	# if (eval "use POSIX (); (POSIX::times())...
		1418	} else {
		1419	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
		1420	*AE::time = sub (){ time }; # epic fail
		1421	}
		1422
		1423	*time = sub { AE::time }; # different prototypes
		1424	};
		1425	die if $@;
		1426
		1427	&time
		1428	}
		1429
		1430	*now = \&time;
		1431
		1432	sub now_update { }
		1433
816	# default implementation for ->condvar, ->wait, ->broadcast	1434	# default implementation for ->condvar
817		1435
818	sub condvar {	1436	sub condvar {
819	bless \my $flag, "AnyEvent::Base::CondVar"	1437	eval q{ # poor man's autoloading {}
820	}	1438	*condvar = sub {
		1439	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1440	};
821		1441
822	sub AnyEvent::Base::CondVar::broadcast {	1442	*AE::cv = sub (;&) {
823	${$_[0]}++;	1443	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
824	}	1444	};
		1445	};
		1446	die if $@;
825		1447
826	sub AnyEvent::Base::CondVar::wait {	1448	&condvar
827	AnyEvent->one_event while !${$_[0]};
828	}	1449	}
829		1450
830	# default implementation for ->signal	1451	# default implementation for ->signal
831		1452
832	our %SIG_CB;	1453	our $HAVE_ASYNC_INTERRUPT;
		1454
		1455	sub _have_async_interrupt() {
		1456	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1457	&& eval "use Async::Interrupt 1.02 (); 1")
		1458	unless defined $HAVE_ASYNC_INTERRUPT;
		1459
		1460	$HAVE_ASYNC_INTERRUPT
		1461	}
		1462
		1463	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1464	our (%SIG_ASY, %SIG_ASY_W);
		1465	our ($SIG_COUNT, $SIG_TW);
		1466
		1467	# install a dummy wakeup watcher to reduce signal catching latency
		1468	# used by Impls
		1469	sub _sig_add() {
		1470	unless ($SIG_COUNT++) {
		1471	# try to align timer on a full-second boundary, if possible
		1472	my $NOW = AE::now;
		1473
		1474	$SIG_TW = AE::timer
		1475	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1476	$MAX_SIGNAL_LATENCY,
		1477	sub { } # just for the PERL_ASYNC_CHECK
		1478	;
		1479	}
		1480	}
		1481
		1482	sub _sig_del {
		1483	undef $SIG_TW
		1484	unless --$SIG_COUNT;
		1485	}
		1486
		1487	our $_sig_name_init; $_sig_name_init = sub {
		1488	eval q{ # poor man's autoloading {}
		1489	undef $_sig_name_init;
		1490
		1491	if (_have_async_interrupt) {
		1492	*sig2num = \&Async::Interrupt::sig2num;
		1493	*sig2name = \&Async::Interrupt::sig2name;
		1494	} else {
		1495	require Config;
		1496
		1497	my %signame2num;
		1498	@signame2num{ split ' ', $Config::Config{sig_name} }
		1499	= split ' ', $Config::Config{sig_num};
		1500
		1501	my @signum2name;
		1502	@signum2name[values %signame2num] = keys %signame2num;
		1503
		1504	*sig2num = sub($) {
		1505	$_[0] > 0 ? shift : $signame2num{+shift}
		1506	};
		1507	*sig2name = sub ($) {
		1508	$_[0] > 0 ? $signum2name[+shift] : shift
		1509	};
		1510	}
		1511	};
		1512	die if $@;
		1513	};
		1514
		1515	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1516	sub sig2name($) { &$_sig_name_init; &sig2name }
833		1517
834	sub signal {	1518	sub signal {
		1519	eval q{ # poor man's autoloading {}
		1520	# probe for availability of Async::Interrupt
		1521	if (_have_async_interrupt) {
		1522	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1523
		1524	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1525	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1526
		1527	} else {
		1528	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1529
		1530	if (AnyEvent::WIN32) {
		1531	require AnyEvent::Util;
		1532
		1533	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1534	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1535	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1536	} else {
		1537	pipe $SIGPIPE_R, $SIGPIPE_W;
		1538	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
		1539	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
		1540
		1541	# not strictly required, as $^F is normally 2, but let's make sure...
		1542	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1543	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1544	}
		1545
		1546	$SIGPIPE_R
		1547	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1548
		1549	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1550	}
		1551
		1552	*signal = $HAVE_ASYNC_INTERRUPT
		1553	? sub {
835	my (undef, %arg) = @_;	1554	my (undef, %arg) = @_;
836		1555
		1556	# async::interrupt
837	my $signal = uc $arg{signal}	1557	my $signal = sig2num $arg{signal};
838	or Carp::croak "required option 'signal' is missing";
839
840	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1558	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1559
		1560	$SIG_ASY{$signal} ||= new Async::Interrupt
		1561	cb => sub { undef $SIG_EV{$signal} },
		1562	signal => $signal,
		1563	pipe => [$SIGPIPE_R->filenos],
		1564	pipe_autodrain => 0,
		1565	;
		1566
		1567	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1568	}
		1569	: sub {
		1570	my (undef, %arg) = @_;
		1571
		1572	# pure perl
		1573	my $signal = sig2name $arg{signal};
		1574	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1575
841	$SIG{$signal} ||= sub {	1576	$SIG{$signal} ||= sub {
		1577	local $!;
		1578	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1579	undef $SIG_EV{$signal};
		1580	};
		1581
		1582	# can't do signal processing without introducing races in pure perl,
		1583	# so limit the signal latency.
		1584	_sig_add;
		1585
		1586	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1587	}
		1588	;
		1589
		1590	*AnyEvent::Base::signal::DESTROY = sub {
		1591	my ($signal, $cb) = @{$_[0]};
		1592
		1593	_sig_del;
		1594
		1595	delete $SIG_CB{$signal}{$cb};
		1596
		1597	$HAVE_ASYNC_INTERRUPT
		1598	? delete $SIG_ASY{$signal}
		1599	: # delete doesn't work with older perls - they then
		1600	# print weird messages, or just unconditionally exit
		1601	# instead of getting the default action.
		1602	undef $SIG{$signal}
		1603	unless keys %{ $SIG_CB{$signal} };
		1604	};
		1605
		1606	*_signal_exec = sub {
		1607	$HAVE_ASYNC_INTERRUPT
		1608	? $SIGPIPE_R->drain
		1609	: sysread $SIGPIPE_R, (my $dummy), 9;
		1610
		1611	while (%SIG_EV) {
		1612	for (keys %SIG_EV) {
		1613	delete $SIG_EV{$_};
842	$_->() for values %{ $SIG_CB{$signal} || {} };	1614	$_->() for values %{ $SIG_CB{$_} || {} };
		1615	}
		1616	}
		1617	};
843	};	1618	};
		1619	die if $@;
844		1620
845	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1621	&signal
846	}
847
848	sub AnyEvent::Base::Signal::DESTROY {
849	my ($signal, $cb) = @{$_[0]};
850
851	delete $SIG_CB{$signal}{$cb};
852
853	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };
854	}	1622	}
855		1623
856	# default implementation for ->child	1624	# default implementation for ->child
857		1625
858	our %PID_CB;	1626	our %PID_CB;
859	our $CHLD_W;	1627	our $CHLD_W;
860	our $CHLD_DELAY_W;	1628	our $CHLD_DELAY_W;
861	our $PID_IDLE;
862	our $WNOHANG;	1629	our $WNOHANG;
863		1630
864	sub _child_wait {	1631	# used by many Impl's
865	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1632	sub _emit_childstatus($$) {
		1633	my (undef, $rpid, $rstatus) = @_;
		1634
		1635	$_->($rpid, $rstatus)
866	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1636	for values %{ $PID_CB{$rpid} || {} },
867	(values %{ $PID_CB{0} || {} });	1637	values %{ $PID_CB{0} || {} };
868	}
869
870	undef $PID_IDLE;
871	}
872
873	sub _sigchld {
874	# make sure we deliver these changes "synchronous" with the event loop.
875	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
876	undef $CHLD_DELAY_W;
877	&_child_wait;
878	});
879	}	1638	}
880		1639
881	sub child {	1640	sub child {
		1641	eval q{ # poor man's autoloading {}
		1642	*_sigchld = sub {
		1643	my $pid;
		1644
		1645	AnyEvent->_emit_childstatus ($pid, $?)
		1646	while ($pid = waitpid -1, $WNOHANG) > 0;
		1647	};
		1648
		1649	*child = sub {
882	my (undef, %arg) = @_;	1650	my (undef, %arg) = @_;
883		1651
884	defined (my $pid = $arg{pid} + 0)	1652	defined (my $pid = $arg{pid} + 0)
885	or Carp::croak "required option 'pid' is missing";	1653	or Carp::croak "required option 'pid' is missing";
886		1654
887	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1655	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
888		1656
889	unless ($WNOHANG) {	1657	# WNOHANG is almost cetrainly 1 everywhere
890	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1;	1658	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
891	}	1659	? 1
		1660	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
892		1661
893	unless ($CHLD_W) {	1662	unless ($CHLD_W) {
894	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1663	$CHLD_W = AE::signal CHLD => \&_sigchld;
895	# child could be a zombie already, so make at least one round	1664	# child could be a zombie already, so make at least one round
896	&_sigchld;	1665	&_sigchld;
897	}	1666	}
898		1667
899	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1668	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
900	}	1669	};
901		1670
902	sub AnyEvent::Base::Child::DESTROY {	1671	*AnyEvent::Base::child::DESTROY = sub {
903	my ($pid, $cb) = @{$_[0]};	1672	my ($pid, $cb) = @{$_[0]};
904		1673
905	delete $PID_CB{$pid}{$cb};	1674	delete $PID_CB{$pid}{$cb};
906	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1675	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
907		1676
908	undef $CHLD_W unless keys %PID_CB;	1677	undef $CHLD_W unless keys %PID_CB;
		1678	};
		1679	};
		1680	die if $@;
		1681
		1682	&child
909	}	1683	}
		1684
		1685	# idle emulation is done by simply using a timer, regardless
		1686	# of whether the process is idle or not, and not letting
		1687	# the callback use more than 50% of the time.
		1688	sub idle {
		1689	eval q{ # poor man's autoloading {}
		1690	*idle = sub {
		1691	my (undef, %arg) = @_;
		1692
		1693	my ($cb, $w, $rcb) = $arg{cb};
		1694
		1695	$rcb = sub {
		1696	if ($cb) {
		1697	$w = _time;
		1698	&$cb;
		1699	$w = _time - $w;
		1700
		1701	# never use more then 50% of the time for the idle watcher,
		1702	# within some limits
		1703	$w = 0.0001 if $w < 0.0001;
		1704	$w = 5 if $w > 5;
		1705
		1706	$w = AE::timer $w, 0, $rcb;
		1707	} else {
		1708	# clean up...
		1709	undef $w;
		1710	undef $rcb;
		1711	}
		1712	};
		1713
		1714	$w = AE::timer 0.05, 0, $rcb;
		1715
		1716	bless \\$cb, "AnyEvent::Base::idle"
		1717	};
		1718
		1719	*AnyEvent::Base::idle::DESTROY = sub {
		1720	undef $${$_[0]};
		1721	};
		1722	};
		1723	die if $@;
		1724
		1725	&idle
		1726	}
		1727
		1728	package AnyEvent::CondVar;
		1729
		1730	our @ISA = AnyEvent::CondVar::Base::;
		1731
		1732	package AnyEvent::CondVar::Base;
		1733
		1734	#use overload
		1735	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
		1736	# fallback => 1;
		1737
		1738	# save 300+ kilobytes by dirtily hardcoding overloading
		1739	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1740	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1741	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1742	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1743
		1744	our $WAITING;
		1745
		1746	sub _send {
		1747	# nop
		1748	}
		1749
		1750	sub send {
		1751	my $cv = shift;
		1752	$cv->{_ae_sent} = [@_];
		1753	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
		1754	$cv->_send;
		1755	}
		1756
		1757	sub croak {
		1758	$_[0]{_ae_croak} = $_[1];
		1759	$_[0]->send;
		1760	}
		1761
		1762	sub ready {
		1763	$_[0]{_ae_sent}
		1764	}
		1765
		1766	sub _wait {
		1767	$WAITING
		1768	and !$_[0]{_ae_sent}
		1769	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1770
		1771	local $WAITING = 1;
		1772	AnyEvent->one_event while !$_[0]{_ae_sent};
		1773	}
		1774
		1775	sub recv {
		1776	$_[0]->_wait;
		1777
		1778	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
		1779	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
		1780	}
		1781
		1782	sub cb {
		1783	my $cv = shift;
		1784
		1785	@_
		1786	and $cv->{_ae_cb} = shift
		1787	and $cv->{_ae_sent}
		1788	and (delete $cv->{_ae_cb})->($cv);
		1789
		1790	$cv->{_ae_cb}
		1791	}
		1792
		1793	sub begin {
		1794	++$_[0]{_ae_counter};
		1795	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
		1796	}
		1797
		1798	sub end {
		1799	return if --$_[0]{_ae_counter};
		1800	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
		1801	}
		1802
		1803	# undocumented/compatibility with pre-3.4
		1804	*broadcast = \&send;
		1805	*wait = \&_wait;
		1806
		1807	=head1 ERROR AND EXCEPTION HANDLING
		1808
		1809	In general, AnyEvent does not do any error handling - it relies on the
		1810	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1811	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1812	checking of all AnyEvent methods, however, which is highly useful during
		1813	development.
		1814
		1815	As for exception handling (i.e. runtime errors and exceptions thrown while
		1816	executing a callback), this is not only highly event-loop specific, but
		1817	also not in any way wrapped by this module, as this is the job of the main
		1818	program.
		1819
		1820	The pure perl event loop simply re-throws the exception (usually
		1821	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1822	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1823	so on.
		1824
		1825	=head1 ENVIRONMENT VARIABLES
		1826
		1827	The following environment variables are used by this module or its
		1828	submodules.
		1829
		1830	Note that AnyEvent will remove I<all> environment variables starting with
		1831	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1832	enabled.
		1833
		1834	=over 4
		1835
		1836	=item C<PERL_ANYEVENT_VERBOSE>
		1837
		1838	By default, AnyEvent will be completely silent except in fatal
		1839	conditions. You can set this environment variable to make AnyEvent more
		1840	talkative.
		1841
		1842	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1843	conditions, such as not being able to load the event model specified by
		1844	C<PERL_ANYEVENT_MODEL>.
		1845
		1846	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1847	model it chooses.
		1848
		1849	When set to C<8> or higher, then AnyEvent will report extra information on
		1850	which optional modules it loads and how it implements certain features.
		1851
		1852	=item C<PERL_ANYEVENT_STRICT>
		1853
		1854	AnyEvent does not do much argument checking by default, as thorough
		1855	argument checking is very costly. Setting this variable to a true value
		1856	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1857	check the arguments passed to most method calls. If it finds any problems,
		1858	it will croak.
		1859
		1860	In other words, enables "strict" mode.
		1861
		1862	Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
		1863	>>, it is definitely recommended to keep it off in production. Keeping
		1864	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1865	can be very useful, however.
		1866
		1867	=item C<PERL_ANYEVENT_MODEL>
		1868
		1869	This can be used to specify the event model to be used by AnyEvent, before
		1870	auto detection and -probing kicks in. It must be a string consisting
		1871	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		1872	and the resulting module name is loaded and if the load was successful,
		1873	used as event model. If it fails to load AnyEvent will proceed with
		1874	auto detection and -probing.
		1875
		1876	This functionality might change in future versions.
		1877
		1878	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		1879	could start your program like this:
		1880
		1881	PERL_ANYEVENT_MODEL=Perl perl ...
		1882
		1883	=item C<PERL_ANYEVENT_PROTOCOLS>
		1884
		1885	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1886	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1887	of auto probing).
		1888
		1889	Must be set to a comma-separated list of protocols or address families,
		1890	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1891	used, and preference will be given to protocols mentioned earlier in the
		1892	list.
		1893
		1894	This variable can effectively be used for denial-of-service attacks
		1895	against local programs (e.g. when setuid), although the impact is likely
		1896	small, as the program has to handle conenction and other failures anyways.
		1897
		1898	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1899	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1900	- only support IPv4, never try to resolve or contact IPv6
		1901	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1902	IPv6, but prefer IPv6 over IPv4.
		1903
		1904	=item C<PERL_ANYEVENT_EDNS0>
		1905
		1906	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1907	for DNS. This extension is generally useful to reduce DNS traffic, but
		1908	some (broken) firewalls drop such DNS packets, which is why it is off by
		1909	default.
		1910
		1911	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1912	EDNS0 in its DNS requests.
		1913
		1914	=item C<PERL_ANYEVENT_MAX_FORKS>
		1915
		1916	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1917	will create in parallel.
		1918
		1919	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1920
		1921	The default value for the C<max_outstanding> parameter for the default DNS
		1922	resolver - this is the maximum number of parallel DNS requests that are
		1923	sent to the DNS server.
		1924
		1925	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1926
		1927	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1928	configuration) in the default resolver. When set to the empty string, no
		1929	default config will be used.
		1930
		1931	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1932
		1933	When neither C<ca_file> nor C<ca_path> was specified during
		1934	L<AnyEvent::TLS> context creation, and either of these environment
		1935	variables exist, they will be used to specify CA certificate locations
		1936	instead of a system-dependent default.
		1937
		1938	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1939
		1940	When these are set to C<1>, then the respective modules are not
		1941	loaded. Mostly good for testing AnyEvent itself.
		1942
		1943	=back
910		1944
911	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1945	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
912		1946
913	This is an advanced topic that you do not normally need to use AnyEvent in	1947	This is an advanced topic that you do not normally need to use AnyEvent in
914	a module. This section is only of use to event loop authors who want to	1948	a module. This section is only of use to event loop authors who want to
…		…
948		1982
949	I<rxvt-unicode> also cheats a bit by not providing blocking access to	1983	I<rxvt-unicode> also cheats a bit by not providing blocking access to
950	condition variables: code blocking while waiting for a condition will	1984	condition variables: code blocking while waiting for a condition will
951	C<die>. This still works with most modules/usages, and blocking calls must	1985	C<die>. This still works with most modules/usages, and blocking calls must
952	not be done in an interactive application, so it makes sense.	1986	not be done in an interactive application, so it makes sense.
953
954	=head1 ENVIRONMENT VARIABLES
955
956	The following environment variables are used by this module:
957
958	=over 4
959
960	=item C<PERL_ANYEVENT_VERBOSE>
961
962	By default, AnyEvent will be completely silent except in fatal
963	conditions. You can set this environment variable to make AnyEvent more
964	talkative.
965
966	When set to C<1> or higher, causes AnyEvent to warn about unexpected
967	conditions, such as not being able to load the event model specified by
968	C<PERL_ANYEVENT_MODEL>.
969
970	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
971	model it chooses.
972
973	=item C<PERL_ANYEVENT_MODEL>
974
975	This can be used to specify the event model to be used by AnyEvent, before
976	autodetection and -probing kicks in. It must be a string consisting
977	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
978	and the resulting module name is loaded and if the load was successful,
979	used as event model. If it fails to load AnyEvent will proceed with
980	autodetection and -probing.
981
982	This functionality might change in future versions.
983
984	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
985	could start your program like this:
986
987	PERL_ANYEVENT_MODEL=Perl perl ...
988
989	=back
990		1987
991	=head1 EXAMPLE PROGRAM	1988	=head1 EXAMPLE PROGRAM
992		1989
993	The following program uses an I/O watcher to read data from STDIN, a timer	1990	The following program uses an I/O watcher to read data from STDIN, a timer
994	to display a message once per second, and a condition variable to quit the	1991	to display a message once per second, and a condition variable to quit the
…		…
1003	poll => 'r',	2000	poll => 'r',
1004	cb => sub {	2001	cb => sub {
1005	warn "io event <$_[0]>\n"; # will always output <r>	2002	warn "io event <$_[0]>\n"; # will always output <r>
1006	chomp (my $input = <STDIN>); # read a line	2003	chomp (my $input = <STDIN>); # read a line
1007	warn "read: $input\n"; # output what has been read	2004	warn "read: $input\n"; # output what has been read
1008	$cv->broadcast if $input =~ /^q/i; # quit program if /^q/i	2005	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1009	},	2006	},
1010	);	2007	);
1011		2008
1012	my $time_watcher; # can only be used once
1013
1014	sub new_timer {
1015	$timer = AnyEvent->timer (after => 1, cb => sub {	2009	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1016	warn "timeout\n"; # print 'timeout' about every second	2010	warn "timeout\n"; # print 'timeout' at most every second
1017	&new_timer; # and restart the time
1018	});	2011	});
1019	}
1020		2012
1021	new_timer; # create first timer
1022
1023	$cv->wait; # wait until user enters /^q/i	2013	$cv->recv; # wait until user enters /^q/i
1024		2014
1025	=head1 REAL-WORLD EXAMPLE	2015	=head1 REAL-WORLD EXAMPLE
1026		2016
1027	Consider the L<Net::FCP> module. It features (among others) the following	2017	Consider the L<Net::FCP> module. It features (among others) the following
1028	API calls, which are to freenet what HTTP GET requests are to http:	2018	API calls, which are to freenet what HTTP GET requests are to http:
…		…
1078	syswrite $txn->{fh}, $txn->{request}	2068	syswrite $txn->{fh}, $txn->{request}
1079	or die "connection or write error";	2069	or die "connection or write error";
1080	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });	2070	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
1081		2071
1082	Again, C<fh_ready_r> waits till all data has arrived, and then stores the	2072	Again, C<fh_ready_r> waits till all data has arrived, and then stores the
1083	result and signals any possible waiters that the request ahs finished:	2073	result and signals any possible waiters that the request has finished:
1084		2074
1085	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};	2075	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
1086		2076
1087	if (end-of-file or data complete) {	2077	if (end-of-file or data complete) {
1088	$txn->{result} = $txn->{buf};	2078	$txn->{result} = $txn->{buf};
1089	$txn->{finished}->broadcast;	2079	$txn->{finished}->send;
1090	$txb->{cb}->($txn) of $txn->{cb}; # also call callback	2080	$txb->{cb}->($txn) of $txn->{cb}; # also call callback
1091	}	2081	}
1092		2082
1093	The C<result> method, finally, just waits for the finished signal (if the	2083	The C<result> method, finally, just waits for the finished signal (if the
1094	request was already finished, it doesn't wait, of course, and returns the	2084	request was already finished, it doesn't wait, of course, and returns the
1095	data:	2085	data:
1096		2086
1097	$txn->{finished}->wait;	2087	$txn->{finished}->recv;
1098	return $txn->{result};	2088	return $txn->{result};
1099		2089
1100	The actual code goes further and collects all errors (C<die>s, exceptions)	2090	The actual code goes further and collects all errors (C<die>s, exceptions)
1101	that occured during request processing. The C<result> method detects	2091	that occurred during request processing. The C<result> method detects
1102	whether an exception as thrown (it is stored inside the $txn object)	2092	whether an exception as thrown (it is stored inside the $txn object)
1103	and just throws the exception, which means connection errors and other	2093	and just throws the exception, which means connection errors and other
1104	problems get reported tot he code that tries to use the result, not in a	2094	problems get reported to the code that tries to use the result, not in a
1105	random callback.	2095	random callback.
1106		2096
1107	All of this enables the following usage styles:	2097	All of this enables the following usage styles:
1108		2098
1109	1. Blocking:	2099	1. Blocking:
…		…
1137		2127
1138	my $quit = AnyEvent->condvar;	2128	my $quit = AnyEvent->condvar;
1139		2129
1140	$fcp->txn_client_get ($url)->cb (sub {	2130	$fcp->txn_client_get ($url)->cb (sub {
1141	...	2131	...
1142	$quit->broadcast;	2132	$quit->send;
1143	});	2133	});
1144		2134
1145	$quit->wait;	2135	$quit->recv;
1146		2136
1147		2137
1148	=head1 BENCHMARKS	2138	=head1 BENCHMARKS
1149		2139
1150	To give you an idea of the performance and overheads that AnyEvent adds	2140	To give you an idea of the performance and overheads that AnyEvent adds
…		…
1152	of various event loops I prepared some benchmarks.	2142	of various event loops I prepared some benchmarks.
1153		2143
1154	=head2 BENCHMARKING ANYEVENT OVERHEAD	2144	=head2 BENCHMARKING ANYEVENT OVERHEAD
1155		2145
1156	Here is a benchmark of various supported event models used natively and	2146	Here is a benchmark of various supported event models used natively and
1157	through anyevent. The benchmark creates a lot of timers (with a zero	2147	through AnyEvent. The benchmark creates a lot of timers (with a zero
1158	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2148	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1159	which it is), lets them fire exactly once and destroys them again.	2149	which it is), lets them fire exactly once and destroys them again.
1160		2150
1161	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2151	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1162	distribution.	2152	distribution. It uses the L<AE> interface, which makes a real difference
		2153	for the EV and Perl backends only.
1163		2154
1164	=head3 Explanation of the columns	2155	=head3 Explanation of the columns
1165		2156
1166	I<watcher> is the number of event watchers created/destroyed. Since	2157	I<watcher> is the number of event watchers created/destroyed. Since
1167	different event models feature vastly different performances, each event	2158	different event models feature vastly different performances, each event
…		…
1179	all watchers, to avoid adding memory overhead. That means closure creation	2170	all watchers, to avoid adding memory overhead. That means closure creation
1180	and memory usage is not included in the figures.	2171	and memory usage is not included in the figures.
1181		2172
1182	I<invoke> is the time, in microseconds, used to invoke a simple	2173	I<invoke> is the time, in microseconds, used to invoke a simple
1183	callback. The callback simply counts down a Perl variable and after it was	2174	callback. The callback simply counts down a Perl variable and after it was
1184	invoked "watcher" times, it would C<< ->broadcast >> a condvar once to	2175	invoked "watcher" times, it would C<< ->send >> a condvar once to
1185	signal the end of this phase.	2176	signal the end of this phase.
1186		2177
1187	I<destroy> is the time, in microseconds, that it takes to destroy a single	2178	I<destroy> is the time, in microseconds, that it takes to destroy a single
1188	watcher.	2179	watcher.
1189		2180
1190	=head3 Results	2181	=head3 Results
1191		2182
1192	name watchers bytes create invoke destroy comment	2183	name watchers bytes create invoke destroy comment
1193	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	2184	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1194	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	2185	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1195	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	2186	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1196	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	2187	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1197	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	2188	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1198	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	2189	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
		2190	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
		2191	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1199	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	2192	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1200	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	2193	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1201	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	2194	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1202	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	2195	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1203		2196
1204	=head3 Discussion	2197	=head3 Discussion
1205		2198
1206	The benchmark does I<not> measure scalability of the event loop very	2199	The benchmark does I<not> measure scalability of the event loop very
1207	well. For example, a select-based event loop (such as the pure perl one)	2200	well. For example, a select-based event loop (such as the pure perl one)
…		…
1219	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2212	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1220	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2213	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1221	cycles with POE.	2214	cycles with POE.
1222		2215
1223	C<EV> is the sole leader regarding speed and memory use, which are both	2216	C<EV> is the sole leader regarding speed and memory use, which are both
1224	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2217	maximal/minimal, respectively. When using the L<AE> API there is zero
		2218	overhead (when going through the AnyEvent API create is about 5-6 times
		2219	slower, with other times being equal, so still uses far less memory than
1225	far less memory than any other event loop and is still faster than Event	2220	any other event loop and is still faster than Event natively).
1226	natively.
1227		2221
1228	The pure perl implementation is hit in a few sweet spots (both the	2222	The pure perl implementation is hit in a few sweet spots (both the
1229	constant timeout and the use of a single fd hit optimisations in the perl	2223	constant timeout and the use of a single fd hit optimisations in the perl
1230	interpreter and the backend itself). Nevertheless this shows that it	2224	interpreter and the backend itself). Nevertheless this shows that it
1231	adds very little overhead in itself. Like any select-based backend its	2225	adds very little overhead in itself. Like any select-based backend its
1232	performance becomes really bad with lots of file descriptors (and few of	2226	performance becomes really bad with lots of file descriptors (and few of
1233	them active), of course, but this was not subject of this benchmark.	2227	them active), of course, but this was not subject of this benchmark.
1234		2228
1235	The C<Event> module has a relatively high setup and callback invocation	2229	The C<Event> module has a relatively high setup and callback invocation
1236	cost, but overall scores in on the third place.	2230	cost, but overall scores in on the third place.
		2231
		2232	C<IO::Async> performs admirably well, about on par with C<Event>, even
		2233	when using its pure perl backend.
1237		2234
1238	C<Glib>'s memory usage is quite a bit higher, but it features a	2235	C<Glib>'s memory usage is quite a bit higher, but it features a
1239	faster callback invocation and overall ends up in the same class as	2236	faster callback invocation and overall ends up in the same class as
1240	C<Event>. However, Glib scales extremely badly, doubling the number of	2237	C<Event>. However, Glib scales extremely badly, doubling the number of
1241	watchers increases the processing time by more than a factor of four,	2238	watchers increases the processing time by more than a factor of four,
…		…
1285		2282
1286	=back	2283	=back
1287		2284
1288	=head2 BENCHMARKING THE LARGE SERVER CASE	2285	=head2 BENCHMARKING THE LARGE SERVER CASE
1289		2286
1290	This benchmark atcually benchmarks the event loop itself. It works by	2287	This benchmark actually benchmarks the event loop itself. It works by
1291	creating a number of "servers": each server consists of a socketpair, a	2288	creating a number of "servers": each server consists of a socket pair, a
1292	timeout watcher that gets reset on activity (but never fires), and an I/O	2289	timeout watcher that gets reset on activity (but never fires), and an I/O
1293	watcher waiting for input on one side of the socket. Each time the socket	2290	watcher waiting for input on one side of the socket. Each time the socket
1294	watcher reads a byte it will write that byte to a random other "server".	2291	watcher reads a byte it will write that byte to a random other "server".
1295		2292
1296	The effect is that there will be a lot of I/O watchers, only part of which	2293	The effect is that there will be a lot of I/O watchers, only part of which
1297	are active at any one point (so there is a constant number of active	2294	are active at any one point (so there is a constant number of active
1298	fds for each loop iterstaion, but which fds these are is random). The	2295	fds for each loop iteration, but which fds these are is random). The
1299	timeout is reset each time something is read because that reflects how	2296	timeout is reset each time something is read because that reflects how
1300	most timeouts work (and puts extra pressure on the event loops).	2297	most timeouts work (and puts extra pressure on the event loops).
1301		2298
1302	In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100	2299	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1303	(1%) are active. This mirrors the activity of large servers with many	2300	(1%) are active. This mirrors the activity of large servers with many
1304	connections, most of which are idle at any one point in time.	2301	connections, most of which are idle at any one point in time.
1305		2302
1306	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2303	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1307	distribution.	2304	distribution. It uses the L<AE> interface, which makes a real difference
		2305	for the EV and Perl backends only.
1308		2306
1309	=head3 Explanation of the columns	2307	=head3 Explanation of the columns
1310		2308
1311	I<sockets> is the number of sockets, and twice the number of "servers" (as	2309	I<sockets> is the number of sockets, and twice the number of "servers" (as
1312	each server has a read and write socket end).	2310	each server has a read and write socket end).
1313		2311
1314	I<create> is the time it takes to create a socketpair (which is	2312	I<create> is the time it takes to create a socket pair (which is
1315	nontrivial) and two watchers: an I/O watcher and a timeout watcher.	2313	nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1316		2314
1317	I<request>, the most important value, is the time it takes to handle a	2315	I<request>, the most important value, is the time it takes to handle a
1318	single "request", that is, reading the token from the pipe and forwarding	2316	single "request", that is, reading the token from the pipe and forwarding
1319	it to another server. This includes deleting the old timeout and creating	2317	it to another server. This includes deleting the old timeout and creating
1320	a new one that moves the timeout into the future.	2318	a new one that moves the timeout into the future.
1321		2319
1322	=head3 Results	2320	=head3 Results
1323		2321
1324	name sockets create request	2322	name sockets create request
1325	EV 20000 69.01 11.16	2323	EV 20000 62.66 7.99
1326	Perl 20000 73.32 35.87	2324	Perl 20000 68.32 32.64
1327	Event 20000 212.62 257.32	2325	IOAsync 20000 174.06 101.15 epoll
1328	Glib 20000 651.16 1896.30	2326	IOAsync 20000 174.67 610.84 poll
		2327	Event 20000 202.69 242.91
		2328	Glib 20000 557.01 1689.52
1329	POE 20000 349.67 12317.24 uses POE::Loop::Event	2329	POE 20000 341.54 12086.32 uses POE::Loop::Event
1330		2330
1331	=head3 Discussion	2331	=head3 Discussion
1332		2332
1333	This benchmark I<does> measure scalability and overall performance of the	2333	This benchmark I<does> measure scalability and overall performance of the
1334	particular event loop.	2334	particular event loop.
…		…
1336	EV is again fastest. Since it is using epoll on my system, the setup time	2336	EV is again fastest. Since it is using epoll on my system, the setup time
1337	is relatively high, though.	2337	is relatively high, though.
1338		2338
1339	Perl surprisingly comes second. It is much faster than the C-based event	2339	Perl surprisingly comes second. It is much faster than the C-based event
1340	loops Event and Glib.	2340	loops Event and Glib.
		2341
		2342	IO::Async performs very well when using its epoll backend, and still quite
		2343	good compared to Glib when using its pure perl backend.
1341		2344
1342	Event suffers from high setup time as well (look at its code and you will	2345	Event suffers from high setup time as well (look at its code and you will
1343	understand why). Callback invocation also has a high overhead compared to	2346	understand why). Callback invocation also has a high overhead compared to
1344	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2347	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1345	uses select or poll in basically all documented configurations.	2348	uses select or poll in basically all documented configurations.
…		…
1392	speed most when you have lots of watchers, not when you only have a few of	2395	speed most when you have lots of watchers, not when you only have a few of
1393	them).	2396	them).
1394		2397
1395	EV is again fastest.	2398	EV is again fastest.
1396		2399
1397	Perl again comes second. It is noticably faster than the C-based event	2400	Perl again comes second. It is noticeably faster than the C-based event
1398	loops Event and Glib, although the difference is too small to really	2401	loops Event and Glib, although the difference is too small to really
1399	matter.	2402	matter.
1400		2403
1401	POE also performs much better in this case, but is is still far behind the	2404	POE also performs much better in this case, but is is still far behind the
1402	others.	2405	others.
…		…
1408	=item * C-based event loops perform very well with small number of	2411	=item * C-based event loops perform very well with small number of
1409	watchers, as the management overhead dominates.	2412	watchers, as the management overhead dominates.
1410		2413
1411	=back	2414	=back
1412		2415
		2416	=head2 THE IO::Lambda BENCHMARK
		2417
		2418	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2419	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2420	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2421	shouldn't come as a surprise to anybody). As such, the benchmark is
		2422	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2423	very optimal. But how would AnyEvent compare when used without the extra
		2424	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2425
		2426	The benchmark itself creates an echo-server, and then, for 500 times,
		2427	connects to the echo server, sends a line, waits for the reply, and then
		2428	creates the next connection. This is a rather bad benchmark, as it doesn't
		2429	test the efficiency of the framework or much non-blocking I/O, but it is a
		2430	benchmark nevertheless.
		2431
		2432	name runtime
		2433	Lambda/select 0.330 sec
		2434	+ optimized 0.122 sec
		2435	Lambda/AnyEvent 0.327 sec
		2436	+ optimized 0.138 sec
		2437	Raw sockets/select 0.077 sec
		2438	POE/select, components 0.662 sec
		2439	POE/select, raw sockets 0.226 sec
		2440	POE/select, optimized 0.404 sec
		2441
		2442	AnyEvent/select/nb 0.085 sec
		2443	AnyEvent/EV/nb 0.068 sec
		2444	+state machine 0.134 sec
		2445
		2446	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2447	benchmarks actually make blocking connects and use 100% blocking I/O,
		2448	defeating the purpose of an event-based solution. All of the newly
		2449	written AnyEvent benchmarks use 100% non-blocking connects (using
		2450	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2451	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2452	generally require a lot more bookkeeping and event handling than blocking
		2453	connects (which involve a single syscall only).
		2454
		2455	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2456	offers similar expressive power as POE and IO::Lambda, using conventional
		2457	Perl syntax. This means that both the echo server and the client are 100%
		2458	non-blocking, further placing it at a disadvantage.
		2459
		2460	As you can see, the AnyEvent + EV combination even beats the
		2461	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2462	backend easily beats IO::Lambda and POE.
		2463
		2464	And even the 100% non-blocking version written using the high-level (and
		2465	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
		2466	higher level ("unoptimised") abstractions by a large margin, even though
		2467	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
		2468
		2469	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2470	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2471	part of the IO::Lambda distribution and were used without any changes.
		2472
		2473
		2474	=head1 SIGNALS
		2475
		2476	AnyEvent currently installs handlers for these signals:
		2477
		2478	=over 4
		2479
		2480	=item SIGCHLD
		2481
		2482	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		2483	emulation for event loops that do not support them natively. Also, some
		2484	event loops install a similar handler.
		2485
		2486	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2487	AnyEvent will reset it to default, to avoid losing child exit statuses.
		2488
		2489	=item SIGPIPE
		2490
		2491	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		2492	when AnyEvent gets loaded.
		2493
		2494	The rationale for this is that AnyEvent users usually do not really depend
		2495	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		2496	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		2497	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		2498	some random socket.
		2499
		2500	The rationale for installing a no-op handler as opposed to ignoring it is
		2501	that this way, the handler will be restored to defaults on exec.
		2502
		2503	Feel free to install your own handler, or reset it to defaults.
		2504
		2505	=back
		2506
		2507	=cut
		2508
		2509	undef $SIG{CHLD}
		2510	if $SIG{CHLD} eq 'IGNORE';
		2511
		2512	$SIG{PIPE} = sub { }
		2513	unless defined $SIG{PIPE};
		2514
		2515	=head1 RECOMMENDED/OPTIONAL MODULES
		2516
		2517	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2518	its built-in modules) are required to use it.
		2519
		2520	That does not mean that AnyEvent won't take advantage of some additional
		2521	modules if they are installed.
		2522
		2523	This section explains which additional modules will be used, and how they
		2524	affect AnyEvent's operation.
		2525
		2526	=over 4
		2527
		2528	=item L<Async::Interrupt>
		2529
		2530	This slightly arcane module is used to implement fast signal handling: To
		2531	my knowledge, there is no way to do completely race-free and quick
		2532	signal handling in pure perl. To ensure that signals still get
		2533	delivered, AnyEvent will start an interval timer to wake up perl (and
		2534	catch the signals) with some delay (default is 10 seconds, look for
		2535	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2536
		2537	If this module is available, then it will be used to implement signal
		2538	catching, which means that signals will not be delayed, and the event loop
		2539	will not be interrupted regularly, which is more efficient (and good for
		2540	battery life on laptops).
		2541
		2542	This affects not just the pure-perl event loop, but also other event loops
		2543	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2544
		2545	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2546	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2547	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2548	does nothing for those backends.
		2549
		2550	=item L<EV>
		2551
		2552	This module isn't really "optional", as it is simply one of the backend
		2553	event loops that AnyEvent can use. However, it is simply the best event
		2554	loop available in terms of features, speed and stability: It supports
		2555	the AnyEvent API optimally, implements all the watcher types in XS, does
		2556	automatic timer adjustments even when no monotonic clock is available,
		2557	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2558	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2559	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2560
		2561	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2562	then this module will do nothing for you.
		2563
		2564	=item L<Guard>
		2565
		2566	The guard module, when used, will be used to implement
		2567	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2568	lot less memory), but otherwise doesn't affect guard operation much. It is
		2569	purely used for performance.
		2570
		2571	=item L<JSON> and L<JSON::XS>
		2572
		2573	One of these modules is required when you want to read or write JSON data
		2574	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
		2575	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2576
		2577	=item L<Net::SSLeay>
		2578
		2579	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2580	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2581	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2582
		2583	=item L<Time::HiRes>
		2584
		2585	This module is part of perl since release 5.008. It will be used when the
		2586	chosen event library does not come with a timing source of its own. The
		2587	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2588	try to use a monotonic clock for timing stability.
		2589
		2590	=back
		2591
1413		2592
1414	=head1 FORK	2593	=head1 FORK
1415		2594
1416	Most event libraries are not fork-safe. The ones who are usually are	2595	Most event libraries are not fork-safe. The ones who are usually are
1417	because they rely on inefficient but fork-safe C<select> or C<poll>	2596	because they rely on inefficient but fork-safe C<select> or C<poll> calls
1418	calls. Only L<EV> is fully fork-aware.	2597	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2598	are usually badly thought-out hacks that are incompatible with fork in
		2599	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2600	continue event-processing in both parent and child (or both, if you know
		2601	what you are doing).
		2602
		2603	This means that, in general, you cannot fork and do event processing in
		2604	the child if the event library was initialised before the fork (which
		2605	usually happens when the first AnyEvent watcher is created, or the library
		2606	is loaded).
1419		2607
1420	If you have to fork, you must either do so I<before> creating your first	2608	If you have to fork, you must either do so I<before> creating your first
1421	watcher OR you must not use AnyEvent at all in the child.	2609	watcher OR you must not use AnyEvent at all in the child OR you must do
		2610	something completely out of the scope of AnyEvent.
		2611
		2612	The problem of doing event processing in the parent I<and> the child
		2613	is much more complicated: even for backends that I<are> fork-aware or
		2614	fork-safe, their behaviour is not usually what you want: fork clones all
		2615	watchers, that means all timers, I/O watchers etc. are active in both
		2616	parent and child, which is almost never what you want. USing C<exec>
		2617	to start worker children from some kind of manage rprocess is usually
		2618	preferred, because it is much easier and cleaner, at the expense of having
		2619	to have another binary.
1422		2620
1423		2621
1424	=head1 SECURITY CONSIDERATIONS	2622	=head1 SECURITY CONSIDERATIONS
1425		2623
1426	AnyEvent can be forced to load any event model via	2624	AnyEvent can be forced to load any event model via
…		…
1431	specified in the variable.	2629	specified in the variable.
1432		2630
1433	You can make AnyEvent completely ignore this variable by deleting it	2631	You can make AnyEvent completely ignore this variable by deleting it
1434	before the first watcher gets created, e.g. with a C<BEGIN> block:	2632	before the first watcher gets created, e.g. with a C<BEGIN> block:
1435		2633
1436	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }	2634	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1437		2635
1438	use AnyEvent;	2636	use AnyEvent;
1439		2637
1440	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2638	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1441	be used to probe what backend is used and gain other information (which is	2639	be used to probe what backend is used and gain other information (which is
1442	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	2640	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		2641	$ENV{PERL_ANYEVENT_STRICT}.
		2642
		2643	Note that AnyEvent will remove I<all> environment variables starting with
		2644	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2645	enabled.
		2646
		2647
		2648	=head1 BUGS
		2649
		2650	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
		2651	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
		2652	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
		2653	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
		2654	pronounced).
1443		2655
1444		2656
1445	=head1 SEE ALSO	2657	=head1 SEE ALSO
		2658
		2659	Utility functions: L<AnyEvent::Util>.
1446		2660
1447	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	2661	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1448	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2662	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1449		2663
1450	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2664	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1451	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2665	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1452	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2666	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1453	L<AnyEvent::Impl::POE>.	2667	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1454		2668
		2669	Non-blocking file handles, sockets, TCP clients and
		2670	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
		2671
		2672	Asynchronous DNS: L<AnyEvent::DNS>.
		2673
1455	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2674	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2675	L<Coro::Event>,
1456		2676
1457	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.	2677	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2678	L<AnyEvent::HTTP>.
1458		2679
1459		2680
1460	=head1 AUTHOR	2681	=head1 AUTHOR
1461		2682
1462	Marc Lehmann <schmorp@schmorp.de>	2683	Marc Lehmann <schmorp@schmorp.de>
1463	http://home.schmorp.de/	2684	http://home.schmorp.de/
1464		2685
1465	=cut	2686	=cut
1466		2687
1467	1	2688	1
1468		2689

Diff Legend

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