ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

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

Diff Legend

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