ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.126 by root, Fri May 23 23:44:55 2008 UTC vs.
Revision 1.247 by root, Sat Jul 18 22:24:17 2009 UTC

1	=head1 => NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - provide framework for multiple event loops
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops	5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported
		6	event loops.
6		7
7	=head1 SYNOPSIS	8	=head1 SYNOPSIS
8		9
9	use AnyEvent;	10	use AnyEvent;
10		11
		12	# file descriptor readable
11	my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub {	13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
		14
		15	# one-shot or repeating timers
		16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
		17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
		18
		19	print AnyEvent->now; # prints current event loop time
		20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
		21
		22	# POSIX signal
		23	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
		24
		25	# child process exit
		26	my $w = AnyEvent->child (pid => $pid, cb => sub {
		27	my ($pid, $status) = @_;
12	...	28	...
13	});	29	});
14		30
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {	31	# called when event loop idle (if applicable)
16	...	32	my $w = AnyEvent->idle (cb => sub { ... });
17	});
18		33
19	my $w = AnyEvent->condvar; # stores whether a condition was flagged	34	my $w = AnyEvent->condvar; # stores whether a condition was flagged
20	$w->send; # wake up current and all future recv's	35	$w->send; # wake up current and all future recv's
21	$w->recv; # enters "main loop" till $condvar gets ->send	36	$w->recv; # enters "main loop" till $condvar gets ->send
		37	# use a condvar in callback mode:
		38	$w->cb (sub { $_[0]->recv });
		39
		40	=head1 INTRODUCTION/TUTORIAL
		41
		42	This manpage is mainly a reference manual. If you are interested
		43	in a tutorial or some gentle introduction, have a look at the
		44	L<AnyEvent::Intro> manpage.
22		45
23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	46	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24		47
25	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	48	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26	nowadays. So what is different about AnyEvent?	49	nowadays. So what is different about AnyEvent?
27		50
28	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	51	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29	policy> and AnyEvent is I<small and efficient>.	52	policy> and AnyEvent is I<small and efficient>.
30		53
31	First and foremost, I<AnyEvent is not an event model> itself, it only	54	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	55	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,	56	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,	57	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	58	only one event loop can be active at the same time in a process. AnyEvent
36	helps hiding the differences between those event loops.	59	cannot change this, but it can hide the differences between those event
		60	loops.
37		61
38	The goal of AnyEvent is to offer module authors the ability to do event	62	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	63	programming (waiting for I/O or timer events) without subscribing to a
40	religion, a way of living, and most importantly: without forcing your	64	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	65	module users into the same thing by forcing them to use the same event
42	model you use.	66	model you use.
43		67
44	For modules like POE or IO::Async (which is a total misnomer as it is	68	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	69	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	70	like joining a cult: After you joined, you are dependent on them and you
47	cannot use anything else, as it is simply incompatible to everything that	71	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	72	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.	73	module are I<also> forced to use the same event loop you use.
50		74
51	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	75	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	76	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	77	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,	78	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	79	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	80	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	81	use one of the supported event loops. It is trivial to add new event loops
58	event loops to AnyEvent, too, so it is future-proof).	82	to AnyEvent, too, so it is future-proof).
59		83
60	In addition to being free of having to use I<the one and only true event	84	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	85	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	86	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	87	follow. AnyEvent, on the other hand, is lean and up to the point, by only
64	offering the functionality that is necessary, in as thin as a wrapper as	88	offering the functionality that is necessary, in as thin as a wrapper as
65	technically possible.	89	technically possible.
66		90
		91	Of course, AnyEvent comes with a big (and fully optional!) toolbox
		92	of useful functionality, such as an asynchronous DNS resolver, 100%
		93	non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
		94	such as Windows) and lots of real-world knowledge and workarounds for
		95	platform bugs and differences.
		96
67	Of course, if you want lots of policy (this can arguably be somewhat	97	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	98	useful) and you want to force your users to use the one and only event
69	model, you should I<not> use this module.	99	model, you should I<not> use this module.
70		100
71	=head1 DESCRIPTION	101	=head1 DESCRIPTION
72		102
…		…
102	starts using it, all bets are off. Maybe you should tell their authors to	132	starts using it, all bets are off. Maybe you should tell their authors to
103	use AnyEvent so their modules work together with others seamlessly...	133	use AnyEvent so their modules work together with others seamlessly...
104		134
105	The pure-perl implementation of AnyEvent is called	135	The pure-perl implementation of AnyEvent is called
106	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	136	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
107	explicitly.	137	explicitly and enjoy the high availability of that event loop :)
108		138
109	=head1 WATCHERS	139	=head1 WATCHERS
110		140
111	AnyEvent has the central concept of a I<watcher>, which is an object that	141	AnyEvent has the central concept of a I<watcher>, which is an object that
112	stores relevant data for each kind of event you are waiting for, such as	142	stores relevant data for each kind of event you are waiting for, such as
113	the callback to call, the filehandle to watch, etc.	143	the callback to call, the file handle to watch, etc.
114		144
115	These watchers are normal Perl objects with normal Perl lifetime. After	145	These watchers are normal Perl objects with normal Perl lifetime. After
116	creating a watcher it will immediately "watch" for events and invoke the	146	creating a watcher it will immediately "watch" for events and invoke the
117	callback when the event occurs (of course, only when the event model	147	callback when the event occurs (of course, only when the event model
118	is in control).	148	is in control).
119		149
		150	Note that B<callbacks must not permanently change global variables>
		151	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
		152	callbacks must not C<die> >>. The former is good programming practise in
		153	Perl and the latter stems from the fact that exception handling differs
		154	widely between event loops.
		155
120	To disable the watcher you have to destroy it (e.g. by setting the	156	To disable the watcher you have to destroy it (e.g. by setting the
121	variable you store it in to C<undef> or otherwise deleting all references	157	variable you store it in to C<undef> or otherwise deleting all references
122	to it).	158	to it).
123		159
124	All watchers are created by calling a method on the C<AnyEvent> class.	160	All watchers are created by calling a method on the C<AnyEvent> class.
…		…
126	Many watchers either are used with "recursion" (repeating timers for	162	Many watchers either are used with "recursion" (repeating timers for
127	example), or need to refer to their watcher object in other ways.	163	example), or need to refer to their watcher object in other ways.
128		164
129	An any way to achieve that is this pattern:	165	An any way to achieve that is this pattern:
130		166
131	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	167	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
132	# you can use $w here, for example to undef it	168	# you can use $w here, for example to undef it
133	undef $w;	169	undef $w;
134	});	170	});
135		171
136	Note that C<my $w; $w => combination. This is necessary because in Perl,	172	Note that C<my $w; $w => combination. This is necessary because in Perl,
137	my variables are only visible after the statement in which they are	173	my variables are only visible after the statement in which they are
138	declared.	174	declared.
139		175
140	=head2 I/O WATCHERS	176	=head2 I/O WATCHERS
141		177
142	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
143	with the following mandatory key-value pairs as arguments:	179	with the following mandatory key-value pairs as arguments:
144		180
145	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch	181	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
		182	for events (AnyEvent might or might not keep a reference to this file
		183	handle). Note that only file handles pointing to things for which
		184	non-blocking operation makes sense are allowed. This includes sockets,
		185	most character devices, pipes, fifos and so on, but not for example files
		186	or block devices.
		187
146	for events. C<poll> must be a string that is either C<r> or C<w>,	188	C<poll> must be a string that is either C<r> or C<w>, which creates a
147	which creates a watcher waiting for "r"eadable or "w"ritable events,	189	watcher waiting for "r"eadable or "w"ritable events, respectively.
		190
148	respectively. C<cb> is the callback to invoke each time the file handle	191	C<cb> is the callback to invoke each time the file handle becomes ready.
149	becomes ready.
150		192
151	Although the callback might get passed parameters, their value and	193	Although the callback might get passed parameters, their value and
152	presence is undefined and you cannot rely on them. Portable AnyEvent	194	presence is undefined and you cannot rely on them. Portable AnyEvent
153	callbacks cannot use arguments passed to I/O watcher callbacks.	195	callbacks cannot use arguments passed to I/O watcher callbacks.
154		196
…		…
158		200
159	Some event loops issue spurious readyness notifications, so you should	201	Some event loops issue spurious readyness notifications, so you should
160	always use non-blocking calls when reading/writing from/to your file	202	always use non-blocking calls when reading/writing from/to your file
161	handles.	203	handles.
162		204
163	Example:
164
165	# wait for readability of STDIN, then read a line and disable the watcher	205	Example: wait for readability of STDIN, then read a line and disable the
		206	watcher.
		207
166	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	208	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
167	chomp (my $input = <STDIN>);	209	chomp (my $input = <STDIN>);
168	warn "read: $input\n";	210	warn "read: $input\n";
169	undef $w;	211	undef $w;
170	});	212	});
…		…
180		222
181	Although the callback might get passed parameters, their value and	223	Although the callback might get passed parameters, their value and
182	presence is undefined and you cannot rely on them. Portable AnyEvent	224	presence is undefined and you cannot rely on them. Portable AnyEvent
183	callbacks cannot use arguments passed to time watcher callbacks.	225	callbacks cannot use arguments passed to time watcher callbacks.
184		226
185	The timer callback will be invoked at most once: if you want a repeating	227	The callback will normally be invoked once only. If you specify another
186	timer you have to create a new watcher (this is a limitation by both Tk	228	parameter, C<interval>, as a strictly positive number (> 0), then the
187	and Glib).	229	callback will be invoked regularly at that interval (in fractional
		230	seconds) after the first invocation. If C<interval> is specified with a
		231	false value, then it is treated as if it were missing.
188		232
189	Example:	233	The callback will be rescheduled before invoking the callback, but no
		234	attempt is done to avoid timer drift in most backends, so the interval is
		235	only approximate.
190		236
191	# fire an event after 7.7 seconds	237	Example: fire an event after 7.7 seconds.
		238
192	my $w = AnyEvent->timer (after => 7.7, cb => sub {	239	my $w = AnyEvent->timer (after => 7.7, cb => sub {
193	warn "timeout\n";	240	warn "timeout\n";
194	});	241	});
195		242
196	# to cancel the timer:	243	# to cancel the timer:
197	undef $w;	244	undef $w;
198		245
199	Example 2:
200
201	# fire an event after 0.5 seconds, then roughly every second	246	Example 2: fire an event after 0.5 seconds, then roughly every second.
202	my $w;
203		247
204	my $cb = sub {
205	# cancel the old timer while creating a new one
206	$w = AnyEvent->timer (after => 1, cb => $cb);	248	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
		249	warn "timeout\n";
207	};	250	};
208
209	# start the "loop" by creating the first watcher
210	$w = AnyEvent->timer (after => 0.5, cb => $cb);
211		251
212	=head3 TIMING ISSUES	252	=head3 TIMING ISSUES
213		253
214	There are two ways to handle timers: based on real time (relative, "fire	254	There are two ways to handle timers: based on real time (relative, "fire
215	in 10 seconds") and based on wallclock time (absolute, "fire at 12	255	in 10 seconds") and based on wallclock time (absolute, "fire at 12
…		…
227	timers.	267	timers.
228		268
229	AnyEvent always prefers relative timers, if available, matching the	269	AnyEvent always prefers relative timers, if available, matching the
230	AnyEvent API.	270	AnyEvent API.
231		271
		272	AnyEvent has two additional methods that return the "current time":
		273
		274	=over 4
		275
		276	=item AnyEvent->time
		277
		278	This returns the "current wallclock time" as a fractional number of
		279	seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
		280	return, and the result is guaranteed to be compatible with those).
		281
		282	It progresses independently of any event loop processing, i.e. each call
		283	will check the system clock, which usually gets updated frequently.
		284
		285	=item AnyEvent->now
		286
		287	This also returns the "current wallclock time", but unlike C<time>, above,
		288	this value might change only once per event loop iteration, depending on
		289	the event loop (most return the same time as C<time>, above). This is the
		290	time that AnyEvent's timers get scheduled against.
		291
		292	I<In almost all cases (in all cases if you don't care), this is the
		293	function to call when you want to know the current time.>
		294
		295	This function is also often faster then C<< AnyEvent->time >>, and
		296	thus the preferred method if you want some timestamp (for example,
		297	L<AnyEvent::Handle> uses this to update it's activity timeouts).
		298
		299	The rest of this section is only of relevance if you try to be very exact
		300	with your timing, you can skip it without bad conscience.
		301
		302	For a practical example of when these times differ, consider L<Event::Lib>
		303	and L<EV> and the following set-up:
		304
		305	The event loop is running and has just invoked one of your callback at
		306	time=500 (assume no other callbacks delay processing). In your callback,
		307	you wait a second by executing C<sleep 1> (blocking the process for a
		308	second) and then (at time=501) you create a relative timer that fires
		309	after three seconds.
		310
		311	With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
		312	both return C<501>, because that is the current time, and the timer will
		313	be scheduled to fire at time=504 (C<501> + C<3>).
		314
		315	With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
		316	time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
		317	last event processing phase started. With L<EV>, your timer gets scheduled
		318	to run at time=503 (C<500> + C<3>).
		319
		320	In one sense, L<Event::Lib> is more exact, as it uses the current time
		321	regardless of any delays introduced by event processing. However, most
		322	callbacks do not expect large delays in processing, so this causes a
		323	higher drift (and a lot more system calls to get the current time).
		324
		325	In another sense, L<EV> is more exact, as your timer will be scheduled at
		326	the same time, regardless of how long event processing actually took.
		327
		328	In either case, if you care (and in most cases, you don't), then you
		329	can get whatever behaviour you want with any event loop, by taking the
		330	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
		331	account.
		332
		333	=item AnyEvent->now_update
		334
		335	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
		336	the current time for each loop iteration (see the discussion of L<<
		337	AnyEvent->now >>, above).
		338
		339	When a callback runs for a long time (or when the process sleeps), then
		340	this "current" time will differ substantially from the real time, which
		341	might affect timers and time-outs.
		342
		343	When this is the case, you can call this method, which will update the
		344	event loop's idea of "current time".
		345
		346	Note that updating the time I<might> cause some events to be handled.
		347
		348	=back
		349
232	=head2 SIGNAL WATCHERS	350	=head2 SIGNAL WATCHERS
233		351
234	You can watch for signals using a signal watcher, C<signal> is the signal	352	You can watch for signals using a signal watcher, C<signal> is the signal
235	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to	353	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
236	be invoked whenever a signal occurs.	354	callback to be invoked whenever a signal occurs.
237		355
238	Although the callback might get passed parameters, their value and	356	Although the callback might get passed parameters, their value and
239	presence is undefined and you cannot rely on them. Portable AnyEvent	357	presence is undefined and you cannot rely on them. Portable AnyEvent
240	callbacks cannot use arguments passed to signal watcher callbacks.	358	callbacks cannot use arguments passed to signal watcher callbacks.
241		359
242	Multiple signal occurances can be clumped together into one callback	360	Multiple signal occurrences can be clumped together into one callback
243	invocation, and callback invocation will be synchronous. synchronous means	361	invocation, and callback invocation will be synchronous. Synchronous means
244	that it might take a while until the signal gets handled by the process,	362	that it might take a while until the signal gets handled by the process,
245	but it is guarenteed not to interrupt any other callbacks.	363	but it is guaranteed not to interrupt any other callbacks.
246		364
247	The main advantage of using these watchers is that you can share a signal	365	The main advantage of using these watchers is that you can share a signal
248	between multiple watchers.	366	between multiple watchers, and AnyEvent will ensure that signals will not
		367	interrupt your program at bad times.
249		368
250	This watcher might use C<%SIG>, so programs overwriting those signals	369	This watcher might use C<%SIG> (depending on the event loop used),
251	directly will likely not work correctly.	370	so programs overwriting those signals directly will likely not work
		371	correctly.
252		372
253	Example: exit on SIGINT	373	Example: exit on SIGINT
254		374
255	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	375	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
256		376
		377	=head3 Signal Races, Delays and Workarounds
		378
		379	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		380	callbacks to signals in a generic way, which is a pity, as you cannot do
		381	race-free signal handling in perl. AnyEvent will try to do it's best, but
		382	in some cases, signals will be delayed. The maximum time a signal might
		383	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
		384	seconds). This variable can be changed only before the first signal
		385	watcher is created, and should be left alone otherwise. Higher values
		386	will cause fewer spurious wake-ups, which is better for power and CPU
		387	saving. All these problems can be avoided by installing the optional
		388	L<Async::Interrupt> module. This will not work with inherently broken
		389	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
		390	currently, as POE does it's own workaround with one-second latency). With
		391	those, you just have to suffer the delays.
		392
257	=head2 CHILD PROCESS WATCHERS	393	=head2 CHILD PROCESS WATCHERS
258		394
259	You can also watch on a child process exit and catch its exit status.	395	You can also watch on a child process exit and catch its exit status.
260		396
261	The child process is specified by the C<pid> argument (if set to C<0>, it	397	The child process is specified by the C<pid> argument (if set to C<0>, it
262	watches for any child process exit). The watcher will trigger as often	398	watches for any child process exit). The watcher will triggered only when
263	as status change for the child are received. This works by installing a	399	the child process has finished and an exit status is available, not on
264	signal handler for C<SIGCHLD>. The callback will be called with the pid	400	any trace events (stopped/continued).
265	and exit status (as returned by waitpid), so unlike other watcher types,	401
266	you I<can> rely on child watcher callback arguments.	402	The callback will be called with the pid and exit status (as returned by
		403	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		404	callback arguments.
		405
		406	This watcher type works by installing a signal handler for C<SIGCHLD>,
		407	and since it cannot be shared, nothing else should use SIGCHLD or reap
		408	random child processes (waiting for specific child processes, e.g. inside
		409	C<system>, is just fine).
267		410
268	There is a slight catch to child watchers, however: you usually start them	411	There is a slight catch to child watchers, however: you usually start them
269	I<after> the child process was created, and this means the process could	412	I<after> the child process was created, and this means the process could
270	have exited already (and no SIGCHLD will be sent anymore).	413	have exited already (and no SIGCHLD will be sent anymore).
271		414
272	Not all event models handle this correctly (POE doesn't), but even for	415	Not all event models handle this correctly (neither POE nor IO::Async do,
		416	see their AnyEvent::Impl manpages for details), but even for event models
273	event models that I<do> handle this correctly, they usually need to be	417	that I<do> handle this correctly, they usually need to be loaded before
274	loaded before the process exits (i.e. before you fork in the first place).	418	the process exits (i.e. before you fork in the first place). AnyEvent's
		419	pure perl event loop handles all cases correctly regardless of when you
		420	start the watcher.
275		421
276	This means you cannot create a child watcher as the very first thing in an	422	This means you cannot create a child watcher as the very first
277	AnyEvent program, you I<have> to create at least one watcher before you	423	thing in an AnyEvent program, you I<have> to create at least one
278	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	424	watcher before you C<fork> the child (alternatively, you can call
		425	C<AnyEvent::detect>).
		426
		427	As most event loops do not support waiting for child events, they will be
		428	emulated by AnyEvent in most cases, in which the latency and race problems
		429	mentioned in the description of signal watchers apply.
279		430
280	Example: fork a process and wait for it	431	Example: fork a process and wait for it
281		432
282	my $done = AnyEvent->condvar;	433	my $done = AnyEvent->condvar;
283		434
284	my $pid = fork or exit 5;	435	my $pid = fork or exit 5;
285		436
286	my $w = AnyEvent->child (	437	my $w = AnyEvent->child (
287	pid => $pid,	438	pid => $pid,
288	cb => sub {	439	cb => sub {
289	my ($pid, $status) = @_;	440	my ($pid, $status) = @_;
290	warn "pid $pid exited with status $status";	441	warn "pid $pid exited with status $status";
291	$done->send;	442	$done->send;
292	},	443	},
293	);	444	);
294		445
295	# do something else, then wait for process exit	446	# do something else, then wait for process exit
296	$done->recv;	447	$done->recv;
		448
		449	=head2 IDLE WATCHERS
		450
		451	Sometimes there is a need to do something, but it is not so important
		452	to do it instantly, but only when there is nothing better to do. This
		453	"nothing better to do" is usually defined to be "no other events need
		454	attention by the event loop".
		455
		456	Idle watchers ideally get invoked when the event loop has nothing
		457	better to do, just before it would block the process to wait for new
		458	events. Instead of blocking, the idle watcher is invoked.
		459
		460	Most event loops unfortunately do not really support idle watchers (only
		461	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		462	will simply call the callback "from time to time".
		463
		464	Example: read lines from STDIN, but only process them when the
		465	program is otherwise idle:
		466
		467	my @lines; # read data
		468	my $idle_w;
		469	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		470	push @lines, scalar <STDIN>;
		471
		472	# start an idle watcher, if not already done
		473	$idle_w ||= AnyEvent->idle (cb => sub {
		474	# handle only one line, when there are lines left
		475	if (my $line = shift @lines) {
		476	print "handled when idle: $line";
		477	} else {
		478	# otherwise disable the idle watcher again
		479	undef $idle_w;
		480	}
		481	});
		482	});
297		483
298	=head2 CONDITION VARIABLES	484	=head2 CONDITION VARIABLES
299		485
300	If you are familiar with some event loops you will know that all of them	486	If you are familiar with some event loops you will know that all of them
301	require you to run some blocking "loop", "run" or similar function that	487	require you to run some blocking "loop", "run" or similar function that
302	will actively watch for new events and call your callbacks.	488	will actively watch for new events and call your callbacks.
303		489
304	AnyEvent is different, it expects somebody else to run the event loop and	490	AnyEvent is slightly different: it expects somebody else to run the event
305	will only block when necessary (usually when told by the user).	491	loop and will only block when necessary (usually when told by the user).
306		492
307	The instrument to do that is called a "condition variable", so called	493	The instrument to do that is called a "condition variable", so called
308	because they represent a condition that must become true.	494	because they represent a condition that must become true.
		495
		496	Now is probably a good time to look at the examples further below.
309		497
310	Condition variables can be created by calling the C<< AnyEvent->condvar	498	Condition variables can be created by calling the C<< AnyEvent->condvar
311	>> method, usually without arguments. The only argument pair allowed is	499	>> method, usually without arguments. The only argument pair allowed is
312	C<cb>, which specifies a callback to be called when the condition variable	500	C<cb>, which specifies a callback to be called when the condition variable
313	becomes true.	501	becomes true, with the condition variable as the first argument (but not
		502	the results).
314		503
315	After creation, the conditon variable is "false" until it becomes "true"	504	After creation, the condition variable is "false" until it becomes "true"
316	by calling the C<send> method.	505	by calling the C<send> method (or calling the condition variable as if it
		506	were a callback, read about the caveats in the description for the C<<
		507	->send >> method).
317		508
318	Condition variables are similar to callbacks, except that you can	509	Condition variables are similar to callbacks, except that you can
319	optionally wait for them. They can also be called merge points - points	510	optionally wait for them. They can also be called merge points - points
320	in time where multiple outstandign events have been processed. And yet	511	in time where multiple outstanding events have been processed. And yet
321	another way to call them is transations - each condition variable can be	512	another way to call them is transactions - each condition variable can be
322	used to represent a transaction, which finishes at some point and delivers	513	used to represent a transaction, which finishes at some point and delivers
323	a result.	514	a result.
324		515
325	Condition variables are very useful to signal that something has finished,	516	Condition variables are very useful to signal that something has finished,
326	for example, if you write a module that does asynchronous http requests,	517	for example, if you write a module that does asynchronous http requests,
…		…
332	you can block your main program until an event occurs - for example, you	523	you can block your main program until an event occurs - for example, you
333	could C<< ->recv >> in your main program until the user clicks the Quit	524	could C<< ->recv >> in your main program until the user clicks the Quit
334	button of your app, which would C<< ->send >> the "quit" event.	525	button of your app, which would C<< ->send >> the "quit" event.
335		526
336	Note that condition variables recurse into the event loop - if you have	527	Note that condition variables recurse into the event loop - if you have
337	two pieces of code that call C<< ->recv >> in a round-robbin fashion, you	528	two pieces of code that call C<< ->recv >> in a round-robin fashion, you
338	lose. Therefore, condition variables are good to export to your caller, but	529	lose. Therefore, condition variables are good to export to your caller, but
339	you should avoid making a blocking wait yourself, at least in callbacks,	530	you should avoid making a blocking wait yourself, at least in callbacks,
340	as this asks for trouble.	531	as this asks for trouble.
341		532
342	Condition variables are represented by hash refs in perl, and the keys	533	Condition variables are represented by hash refs in perl, and the keys
…		…
347		538
348	There are two "sides" to a condition variable - the "producer side" which	539	There are two "sides" to a condition variable - the "producer side" which
349	eventually calls C<< -> send >>, and the "consumer side", which waits	540	eventually calls C<< -> send >>, and the "consumer side", which waits
350	for the send to occur.	541	for the send to occur.
351		542
352	Example:	543	Example: wait for a timer.
353		544
354	# wait till the result is ready	545	# wait till the result is ready
355	my $result_ready = AnyEvent->condvar;	546	my $result_ready = AnyEvent->condvar;
356		547
357	# do something such as adding a timer	548	# do something such as adding a timer
…		…
362	after => 1,	553	after => 1,
363	cb => sub { $result_ready->send },	554	cb => sub { $result_ready->send },
364	);	555	);
365		556
366	# this "blocks" (while handling events) till the callback	557	# this "blocks" (while handling events) till the callback
367	# calls send	558	# calls -<send
368	$result_ready->recv;	559	$result_ready->recv;
		560
		561	Example: wait for a timer, but take advantage of the fact that condition
		562	variables are also callable directly.
		563
		564	my $done = AnyEvent->condvar;
		565	my $delay = AnyEvent->timer (after => 5, cb => $done);
		566	$done->recv;
		567
		568	Example: Imagine an API that returns a condvar and doesn't support
		569	callbacks. This is how you make a synchronous call, for example from
		570	the main program:
		571
		572	use AnyEvent::CouchDB;
		573
		574	...
		575
		576	my @info = $couchdb->info->recv;
		577
		578	And this is how you would just set a callback to be called whenever the
		579	results are available:
		580
		581	$couchdb->info->cb (sub {
		582	my @info = $_[0]->recv;
		583	});
369		584
370	=head3 METHODS FOR PRODUCERS	585	=head3 METHODS FOR PRODUCERS
371		586
372	These methods should only be used by the producing side, i.e. the	587	These methods should only be used by the producing side, i.e. the
373	code/module that eventually sends the signal. Note that it is also	588	code/module that eventually sends the signal. Note that it is also
…		…
386	immediately from within send.	601	immediately from within send.
387		602
388	Any arguments passed to the C<send> call will be returned by all	603	Any arguments passed to the C<send> call will be returned by all
389	future C<< ->recv >> calls.	604	future C<< ->recv >> calls.
390		605
		606	Condition variables are overloaded so one can call them directly (as if
		607	they were a code reference). Calling them directly is the same as calling
		608	C<send>.
		609
391	=item $cv->croak ($error)	610	=item $cv->croak ($error)
392		611
393	Similar to send, but causes all call's to C<< ->recv >> to invoke	612	Similar to send, but causes all call's to C<< ->recv >> to invoke
394	C<Carp::croak> with the given error message/object/scalar.	613	C<Carp::croak> with the given error message/object/scalar.
395		614
396	This can be used to signal any errors to the condition variable	615	This can be used to signal any errors to the condition variable
397	user/consumer.	616	user/consumer. Doing it this way instead of calling C<croak> directly
		617	delays the error detetcion, but has the overwhelmign advantage that it
		618	diagnoses the error at the place where the result is expected, and not
		619	deep in some event clalback without connection to the actual code causing
		620	the problem.
398		621
399	=item $cv->begin ([group callback])	622	=item $cv->begin ([group callback])
400		623
401	=item $cv->end	624	=item $cv->end
402
403	These two methods are EXPERIMENTAL and MIGHT CHANGE.
404		625
405	These two methods can be used to combine many transactions/events into	626	These two methods can be used to combine many transactions/events into
406	one. For example, a function that pings many hosts in parallel might want	627	one. For example, a function that pings many hosts in parallel might want
407	to use a condition variable for the whole process.	628	to use a condition variable for the whole process.
408		629
…		…
410	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	631	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
411	>>, the (last) callback passed to C<begin> will be executed. That callback	632	>>, the (last) callback passed to C<begin> will be executed. That callback
412	is I<supposed> to call C<< ->send >>, but that is not required. If no	633	is I<supposed> to call C<< ->send >>, but that is not required. If no
413	callback was set, C<send> will be called without any arguments.	634	callback was set, C<send> will be called without any arguments.
414		635
415	Let's clarify this with the ping example:	636	You can think of C<< $cv->send >> giving you an OR condition (one call
		637	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
		638	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
		639
		640	Let's start with a simple example: you have two I/O watchers (for example,
		641	STDOUT and STDERR for a program), and you want to wait for both streams to
		642	close before activating a condvar:
		643
		644	my $cv = AnyEvent->condvar;
		645
		646	$cv->begin; # first watcher
		647	my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
		648	defined sysread $fh1, my $buf, 4096
		649	or $cv->end;
		650	});
		651
		652	$cv->begin; # second watcher
		653	my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
		654	defined sysread $fh2, my $buf, 4096
		655	or $cv->end;
		656	});
		657
		658	$cv->recv;
		659
		660	This works because for every event source (EOF on file handle), there is
		661	one call to C<begin>, so the condvar waits for all calls to C<end> before
		662	sending.
		663
		664	The ping example mentioned above is slightly more complicated, as the
		665	there are results to be passwd back, and the number of tasks that are
		666	begung can potentially be zero:
416		667
417	my $cv = AnyEvent->condvar;	668	my $cv = AnyEvent->condvar;
418		669
419	my %result;	670	my %result;
420	$cv->begin (sub { $cv->send (\%result) });	671	$cv->begin (sub { $cv->send (\%result) });
…		…
440	loop, which serves two important purposes: first, it sets the callback	691	loop, which serves two important purposes: first, it sets the callback
441	to be called once the counter reaches C<0>, and second, it ensures that	692	to be called once the counter reaches C<0>, and second, it ensures that
442	C<send> is called even when C<no> hosts are being pinged (the loop	693	C<send> is called even when C<no> hosts are being pinged (the loop
443	doesn't execute once).	694	doesn't execute once).
444		695
445	This is the general pattern when you "fan out" into multiple subrequests:	696	This is the general pattern when you "fan out" into multiple (but
446	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	697	potentially none) subrequests: use an outer C<begin>/C<end> pair to set
447	is called at least once, and then, for each subrequest you start, call	698	the callback and ensure C<end> is called at least once, and then, for each
448	C<begin> and for eahc subrequest you finish, call C<end>.	699	subrequest you start, call C<begin> and for each subrequest you finish,
		700	call C<end>.
449		701
450	=back	702	=back
451		703
452	=head3 METHODS FOR CONSUMERS	704	=head3 METHODS FOR CONSUMERS
453		705
…		…
469	function will call C<croak>.	721	function will call C<croak>.
470		722
471	In list context, all parameters passed to C<send> will be returned,	723	In list context, all parameters passed to C<send> will be returned,
472	in scalar context only the first one will be returned.	724	in scalar context only the first one will be returned.
473		725
		726	Note that doing a blocking wait in a callback is not supported by any
		727	event loop, that is, recursive invocation of a blocking C<< ->recv
		728	>> is not allowed, and the C<recv> call will C<croak> if such a
		729	condition is detected. This condition can be slightly loosened by using
		730	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		731	any thread that doesn't run the event loop itself.
		732
474	Not all event models support a blocking wait - some die in that case	733	Not all event models support a blocking wait - some die in that case
475	(programs might want to do that to stay interactive), so I<if you are	734	(programs might want to do that to stay interactive), so I<if you are
476	using this from a module, never require a blocking wait>, but let the	735	using this from a module, never require a blocking wait>. Instead, let the
477	caller decide whether the call will block or not (for example, by coupling	736	caller decide whether the call will block or not (for example, by coupling
478	condition variables with some kind of request results and supporting	737	condition variables with some kind of request results and supporting
479	callbacks so the caller knows that getting the result will not block,	738	callbacks so the caller knows that getting the result will not block,
480	while still suppporting blocking waits if the caller so desires).	739	while still supporting blocking waits if the caller so desires).
481
482	Another reason I<never> to C<< ->recv >> in a module is that you cannot
483	sensibly have two C<< ->recv >>'s in parallel, as that would require
484	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
485	can supply.
486
487	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
488	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
489	versions and also integrates coroutines into AnyEvent, making blocking
490	C<< ->recv >> calls perfectly safe as long as they are done from another
491	coroutine (one that doesn't run the event loop).
492		740
493	You can ensure that C<< -recv >> never blocks by setting a callback and	741	You can ensure that C<< -recv >> never blocks by setting a callback and
494	only calling C<< ->recv >> from within that callback (or at a later	742	only calling C<< ->recv >> from within that callback (or at a later
495	time). This will work even when the event loop does not support blocking	743	time). This will work even when the event loop does not support blocking
496	waits otherwise.	744	waits otherwise.
…		…
498	=item $bool = $cv->ready	746	=item $bool = $cv->ready
499		747
500	Returns true when the condition is "true", i.e. whether C<send> or	748	Returns true when the condition is "true", i.e. whether C<send> or
501	C<croak> have been called.	749	C<croak> have been called.
502		750
503	=item $cb = $cv->cb ([new callback])	751	=item $cb = $cv->cb ($cb->($cv))
504		752
505	This is a mutator function that returns the callback set and optionally	753	This is a mutator function that returns the callback set and optionally
506	replaces it before doing so.	754	replaces it before doing so.
507		755
508	The callback will be called when the condition becomes "true", i.e. when	756	The callback will be called when the condition becomes "true", i.e. when
509	C<send> or C<croak> are called. Calling C<recv> inside the callback	757	C<send> or C<croak> are called, with the only argument being the condition
510	or at any later time is guaranteed not to block.	758	variable itself. Calling C<recv> inside the callback or at any later time
		759	is guaranteed not to block.
511		760
512	=back	761	=back
513		762
		763	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		764
		765	The available backend classes are (every class has its own manpage):
		766
		767	=over 4
		768
		769	=item Backends that are autoprobed when no other event loop can be found.
		770
		771	EV is the preferred backend when no other event loop seems to be in
		772	use. If EV is not installed, then AnyEvent will try Event, and, failing
		773	that, will fall back to its own pure-perl implementation, which is
		774	available everywhere as it comes with AnyEvent itself.
		775
		776	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		777	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		778	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		779
		780	=item Backends that are transparently being picked up when they are used.
		781
		782	These will be used when they are currently loaded when the first watcher
		783	is created, in which case it is assumed that the application is using
		784	them. This means that AnyEvent will automatically pick the right backend
		785	when the main program loads an event module before anything starts to
		786	create watchers. Nothing special needs to be done by the main program.
		787
		788	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		789	AnyEvent::Impl::Tk based on Tk, very broken.
		790	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		791	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		792
		793	=item Backends with special needs.
		794
		795	Qt requires the Qt::Application to be instantiated first, but will
		796	otherwise be picked up automatically. As long as the main program
		797	instantiates the application before any AnyEvent watchers are created,
		798	everything should just work.
		799
		800	AnyEvent::Impl::Qt based on Qt.
		801
		802	Support for IO::Async can only be partial, as it is too broken and
		803	architecturally limited to even support the AnyEvent API. It also
		804	is the only event loop that needs the loop to be set explicitly, so
		805	it can only be used by a main program knowing about AnyEvent. See
		806	L<AnyEvent::Impl::Async> for the gory details.
		807
		808	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		809
		810	=item Event loops that are indirectly supported via other backends.
		811
		812	Some event loops can be supported via other modules:
		813
		814	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		815
		816	B<WxWidgets> has no support for watching file handles. However, you can
		817	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		818	polls 20 times per second, which was considered to be too horrible to even
		819	consider for AnyEvent.
		820
		821	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		822	backend, so it can be supported through POE.
		823
		824	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		825	load L<POE> when detecting them, in the hope that POE will pick them up,
		826	in which case everything will be automatic.
		827
		828	=back
		829
514	=head1 GLOBAL VARIABLES AND FUNCTIONS	830	=head1 GLOBAL VARIABLES AND FUNCTIONS
515		831
		832	These are not normally required to use AnyEvent, but can be useful to
		833	write AnyEvent extension modules.
		834
516	=over 4	835	=over 4
517		836
518	=item $AnyEvent::MODEL	837	=item $AnyEvent::MODEL
519		838
520	Contains C<undef> until the first watcher is being created. Then it	839	Contains C<undef> until the first watcher is being created, before the
		840	backend has been autodetected.
		841
521	contains the event model that is being used, which is the name of the	842	Afterwards it contains the event model that is being used, which is the
522	Perl class implementing the model. This class is usually one of the	843	name of the Perl class implementing the model. This class is usually one
523	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	844	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
524	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	845	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
525		846	will be C<urxvt::anyevent>).
526	The known classes so far are:
527
528	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
529	AnyEvent::Impl::Event based on Event, second best choice.
530	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
531	AnyEvent::Impl::Glib based on Glib, third-best choice.
532	AnyEvent::Impl::Tk based on Tk, very bad choice.
533	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
534	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
535	AnyEvent::Impl::POE based on POE, not generic enough for full support.
536
537	There is no support for WxWidgets, as WxWidgets has no support for
538	watching file handles. However, you can use WxWidgets through the
539	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
540	second, which was considered to be too horrible to even consider for
541	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
542	it's adaptor.
543
544	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
545	autodetecting them.
546		847
547	=item AnyEvent::detect	848	=item AnyEvent::detect
548		849
549	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	850	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
550	if necessary. You should only call this function right before you would	851	if necessary. You should only call this function right before you would
551	have created an AnyEvent watcher anyway, that is, as late as possible at	852	have created an AnyEvent watcher anyway, that is, as late as possible at
552	runtime.	853	runtime, and not e.g. while initialising of your module.
		854
		855	If you need to do some initialisation before AnyEvent watchers are
		856	created, use C<post_detect>.
553		857
554	=item $guard = AnyEvent::post_detect { BLOCK }	858	=item $guard = AnyEvent::post_detect { BLOCK }
555		859
556	Arranges for the code block to be executed as soon as the event model is	860	Arranges for the code block to be executed as soon as the event model is
557	autodetected (or immediately if this has already happened).	861	autodetected (or immediately if this has already happened).
		862
		863	The block will be executed I<after> the actual backend has been detected
		864	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		865	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		866	other initialisations - see the sources of L<AnyEvent::Strict> or
		867	L<AnyEvent::AIO> to see how this is used.
		868
		869	The most common usage is to create some global watchers, without forcing
		870	event module detection too early, for example, L<AnyEvent::AIO> creates
		871	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		872	avoid autodetecting the event module at load time.
558		873
559	If called in scalar or list context, then it creates and returns an object	874	If called in scalar or list context, then it creates and returns an object
560	that automatically removes the callback again when it is destroyed. See	875	that automatically removes the callback again when it is destroyed. See
561	L<Coro::BDB> for a case where this is useful.	876	L<Coro::BDB> for a case where this is useful.
562		877
…		…
565	If there are any code references in this array (you can C<push> to it	880	If there are any code references in this array (you can C<push> to it
566	before or after loading AnyEvent), then they will called directly after	881	before or after loading AnyEvent), then they will called directly after
567	the event loop has been chosen.	882	the event loop has been chosen.
568		883
569	You should check C<$AnyEvent::MODEL> before adding to this array, though:	884	You should check C<$AnyEvent::MODEL> before adding to this array, though:
570	if it contains a true value then the event loop has already been detected,	885	if it is defined then the event loop has already been detected, and the
571	and the array will be ignored.	886	array will be ignored.
572		887
573	Best use C<AnyEvent::post_detect { BLOCK }> instead.	888	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		889	it,as it takes care of these details.
		890
		891	This variable is mainly useful for modules that can do something useful
		892	when AnyEvent is used and thus want to know when it is initialised, but do
		893	not need to even load it by default. This array provides the means to hook
		894	into AnyEvent passively, without loading it.
574		895
575	=back	896	=back
576		897
577	=head1 WHAT TO DO IN A MODULE	898	=head1 WHAT TO DO IN A MODULE
578		899
…		…
601		922
602	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	923	If it doesn't care, it can just "use AnyEvent" and use it itself, or not
603	do anything special (it does not need to be event-based) and let AnyEvent	924	do anything special (it does not need to be event-based) and let AnyEvent
604	decide which implementation to chose if some module relies on it.	925	decide which implementation to chose if some module relies on it.
605		926
606	If the main program relies on a specific event model. For example, in	927	If the main program relies on a specific event model - for example, in
607	Gtk2 programs you have to rely on the Glib module. You should load the	928	Gtk2 programs you have to rely on the Glib module - you should load the
608	event module before loading AnyEvent or any module that uses it: generally	929	event module before loading AnyEvent or any module that uses it: generally
609	speaking, you should load it as early as possible. The reason is that	930	speaking, you should load it as early as possible. The reason is that
610	modules might create watchers when they are loaded, and AnyEvent will	931	modules might create watchers when they are loaded, and AnyEvent will
611	decide on the event model to use as soon as it creates watchers, and it	932	decide on the event model to use as soon as it creates watchers, and it
612	might chose the wrong one unless you load the correct one yourself.	933	might chose the wrong one unless you load the correct one yourself.
613		934
614	You can chose to use a rather inefficient pure-perl implementation by	935	You can chose to use a pure-perl implementation by loading the
615	loading the C<AnyEvent::Impl::Perl> module, which gives you similar	936	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
616	behaviour everywhere, but letting AnyEvent chose is generally better.	937	everywhere, but letting AnyEvent chose the model is generally better.
		938
		939	=head2 MAINLOOP EMULATION
		940
		941	Sometimes (often for short test scripts, or even standalone programs who
		942	only want to use AnyEvent), you do not want to run a specific event loop.
		943
		944	In that case, you can use a condition variable like this:
		945
		946	AnyEvent->condvar->recv;
		947
		948	This has the effect of entering the event loop and looping forever.
		949
		950	Note that usually your program has some exit condition, in which case
		951	it is better to use the "traditional" approach of storing a condition
		952	variable somewhere, waiting for it, and sending it when the program should
		953	exit cleanly.
		954
617		955
618	=head1 OTHER MODULES	956	=head1 OTHER MODULES
619		957
620	The following is a non-exhaustive list of additional modules that use	958	The following is a non-exhaustive list of additional modules that use
621	AnyEvent and can therefore be mixed easily with other AnyEvent modules	959	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
622	in the same program. Some of the modules come with AnyEvent, some are	960	modules and other event loops in the same program. Some of the modules
623	available via CPAN.	961	come with AnyEvent, most are available via CPAN.
624		962
625	=over 4	963	=over 4
626		964
627	=item L<AnyEvent::Util>	965	=item L<AnyEvent::Util>
628		966
629	Contains various utility functions that replace often-used but blocking	967	Contains various utility functions that replace often-used but blocking
630	functions such as C<inet_aton> by event-/callback-based versions.	968	functions such as C<inet_aton> by event-/callback-based versions.
631
632	=item L<AnyEvent::Handle>
633
634	Provide read and write buffers and manages watchers for reads and writes.
635		969
636	=item L<AnyEvent::Socket>	970	=item L<AnyEvent::Socket>
637		971
638	Provides various utility functions for (internet protocol) sockets,	972	Provides various utility functions for (internet protocol) sockets,
639	addresses and name resolution. Also functions to create non-blocking tcp	973	addresses and name resolution. Also functions to create non-blocking tcp
640	connections or tcp servers, with IPv6 and SRV record support and more.	974	connections or tcp servers, with IPv6 and SRV record support and more.
641		975
		976	=item L<AnyEvent::Handle>
		977
		978	Provide read and write buffers, manages watchers for reads and writes,
		979	supports raw and formatted I/O, I/O queued and fully transparent and
		980	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
		981
		982	=item L<AnyEvent::DNS>
		983
		984	Provides rich asynchronous DNS resolver capabilities.
		985
		986	=item L<AnyEvent::HTTP>
		987
		988	A simple-to-use HTTP library that is capable of making a lot of concurrent
		989	HTTP requests.
		990
642	=item L<AnyEvent::HTTPD>	991	=item L<AnyEvent::HTTPD>
643		992
644	Provides a simple web application server framework.	993	Provides a simple web application server framework.
645		994
646	=item L<AnyEvent::DNS>
647
648	Provides rich asynchronous DNS resolver capabilities.
649
650	=item L<AnyEvent::FastPing>	995	=item L<AnyEvent::FastPing>
651		996
652	The fastest ping in the west.	997	The fastest ping in the west.
653		998
		999	=item L<AnyEvent::DBI>
		1000
		1001	Executes L<DBI> requests asynchronously in a proxy process.
		1002
		1003	=item L<AnyEvent::AIO>
		1004
		1005	Truly asynchronous I/O, should be in the toolbox of every event
		1006	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
		1007	together.
		1008
		1009	=item L<AnyEvent::BDB>
		1010
		1011	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
		1012	L<BDB> and AnyEvent together.
		1013
		1014	=item L<AnyEvent::GPSD>
		1015
		1016	A non-blocking interface to gpsd, a daemon delivering GPS information.
		1017
654	=item L<Net::IRC3>	1018	=item L<AnyEvent::IRC>
655		1019
656	AnyEvent based IRC client module family.	1020	AnyEvent based IRC client module family (replacing the older Net::IRC3).
657		1021
658	=item L<Net::XMPP2>	1022	=item L<AnyEvent::XMPP>
659		1023
660	AnyEvent based XMPP (Jabber protocol) module family.	1024	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1025	Net::XMPP2>.
		1026
		1027	=item L<AnyEvent::IGS>
		1028
		1029	A non-blocking interface to the Internet Go Server protocol (used by
		1030	L<App::IGS>).
661		1031
662	=item L<Net::FCP>	1032	=item L<Net::FCP>
663		1033
664	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1034	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
665	of AnyEvent.	1035	of AnyEvent.
…		…
670		1040
671	=item L<Coro>	1041	=item L<Coro>
672		1042
673	Has special support for AnyEvent via L<Coro::AnyEvent>.	1043	Has special support for AnyEvent via L<Coro::AnyEvent>.
674		1044
675	=item L<AnyEvent::AIO>, L<IO::AIO>
676
677	Truly asynchronous I/O, should be in the toolbox of every event
678	programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
679	together.
680
681	=item L<AnyEvent::BDB>, L<BDB>
682
683	Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
684	IO::AIO and AnyEvent together.
685
686	=item L<IO::Lambda>
687
688	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
689
690	=back	1045	=back
691		1046
692	=cut	1047	=cut
693		1048
694	package AnyEvent;	1049	package AnyEvent;
695		1050
		1051	# basically a tuned-down version of common::sense
		1052	sub common_sense {
696	no warnings;	1053	# no warnings
697	use strict;	1054	${^WARNING_BITS} ^= ${^WARNING_BITS};
		1055	# use strict vars subs
		1056	$^H |= 0x00000600;
		1057	}
698		1058
		1059	BEGIN { AnyEvent::common_sense }
		1060
699	use Carp;	1061	use Carp ();
700		1062
701	our $VERSION = '3.6';	1063	our $VERSION = 4.85;
702	our $MODEL;	1064	our $MODEL;
703		1065
704	our $AUTOLOAD;	1066	our $AUTOLOAD;
705	our @ISA;	1067	our @ISA;
706		1068
707	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
708
709	our @REGISTRY;	1069	our @REGISTRY;
710		1070
711	our %PROTOCOL; # (ipv4|ipv6) => (1|2)	1071	our $WIN32;
		1072
		1073	our $VERBOSE;
		1074
		1075	BEGIN {
		1076	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
		1077	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
		1078
		1079	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1080	if ${^TAINT};
		1081
		1082	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1083
		1084	}
		1085
		1086	our $MAX_SIGNAL_LATENCY = 10;
		1087
		1088	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
712		1089
713	{	1090	{
714	my $idx;	1091	my $idx;
715	$PROTOCOL{$_} = ++$idx	1092	$PROTOCOL{$_} = ++$idx
		1093	for reverse split /\s*,\s*/,
716	for split /\s*,\s*/, $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1094	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
717	}	1095	}
718		1096
719	my @models = (	1097	my @models = (
720	[EV:: => AnyEvent::Impl::EV::],	1098	[EV:: => AnyEvent::Impl::EV::],
721	[Event:: => AnyEvent::Impl::Event::],	1099	[Event:: => AnyEvent::Impl::Event::],
		1100	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
		1101	# everything below here will not be autoprobed
		1102	# as the pureperl backend should work everywhere
		1103	# and is usually faster
		1104	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
		1105	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
722	[Tk:: => AnyEvent::Impl::Tk::],	1106	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		1107	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
		1108	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
723	[Wx:: => AnyEvent::Impl::POE::],	1109	[Wx:: => AnyEvent::Impl::POE::],
724	[Prima:: => AnyEvent::Impl::POE::],	1110	[Prima:: => AnyEvent::Impl::POE::],
725	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1111	# IO::Async is just too broken - we would need workarounds for its
726	# everything below here will not be autoprobed as the pureperl backend should work everywhere	1112	# byzantine signal and broken child handling, among others.
727	[Glib:: => AnyEvent::Impl::Glib::],	1113	# IO::Async is rather hard to detect, as it doesn't have any
728	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1114	# obvious default class.
729	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1115	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
730	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1116	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1117	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
731	);	1118	);
732		1119
733	our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);	1120	our %method = map +($_ => 1),
		1121	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
734		1122
735	our @post_detect;	1123	our @post_detect;
736		1124
737	sub post_detect(&) {	1125	sub post_detect(&) {
738	my ($cb) = @_;	1126	my ($cb) = @_;
…		…
743	1	1131	1
744	} else {	1132	} else {
745	push @post_detect, $cb;	1133	push @post_detect, $cb;
746		1134
747	defined wantarray	1135	defined wantarray
748	? bless \$cb, "AnyEvent::Util::PostDetect"	1136	? bless \$cb, "AnyEvent::Util::postdetect"
749	: ()	1137	: ()
750	}	1138	}
751	}	1139	}
752		1140
753	sub AnyEvent::Util::PostDetect::DESTROY {	1141	sub AnyEvent::Util::postdetect::DESTROY {
754	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1142	@post_detect = grep $_ != ${$_[0]}, @post_detect;
755	}	1143	}
756		1144
757	sub detect() {	1145	sub detect() {
758	unless ($MODEL) {	1146	unless ($MODEL) {
759	no strict 'refs';	1147	local $SIG{__DIE__};
760		1148
761	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1149	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
762	my $model = "AnyEvent::Impl::$1";	1150	my $model = "AnyEvent::Impl::$1";
763	if (eval "require $model") {	1151	if (eval "require $model") {
764	$MODEL = $model;	1152	$MODEL = $model;
765	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1153	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
766	} else {	1154	} else {
767	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1155	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
768	}	1156	}
769	}	1157	}
770		1158
771	# check for already loaded models	1159	# check for already loaded models
772	unless ($MODEL) {	1160	unless ($MODEL) {
773	for (@REGISTRY, @models) {	1161	for (@REGISTRY, @models) {
774	my ($package, $model) = @$_;	1162	my ($package, $model) = @$_;
775	if (${"$package\::VERSION"} > 0) {	1163	if (${"$package\::VERSION"} > 0) {
776	if (eval "require $model") {	1164	if (eval "require $model") {
777	$MODEL = $model;	1165	$MODEL = $model;
778	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1166	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
779	last;	1167	last;
780	}	1168	}
781	}	1169	}
782	}	1170	}
783		1171
…		…
788	my ($package, $model) = @$_;	1176	my ($package, $model) = @$_;
789	if (eval "require $package"	1177	if (eval "require $package"
790	and ${"$package\::VERSION"} > 0	1178	and ${"$package\::VERSION"} > 0
791	and eval "require $model") {	1179	and eval "require $model") {
792	$MODEL = $model;	1180	$MODEL = $model;
793	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1181	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
794	last;	1182	last;
795	}	1183	}
796	}	1184	}
797		1185
798	$MODEL	1186	$MODEL
799	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1187	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
800	}	1188	}
801	}	1189	}
802		1190
		1191	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1192
803	unshift @ISA, $MODEL;	1193	unshift @ISA, $MODEL;
804	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1194
		1195	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
805		1196
806	(shift @post_detect)->() while @post_detect;	1197	(shift @post_detect)->() while @post_detect;
807	}	1198	}
808		1199
809	$MODEL	1200	$MODEL
…		…
811		1202
812	sub AUTOLOAD {	1203	sub AUTOLOAD {
813	(my $func = $AUTOLOAD) =~ s/.*://;	1204	(my $func = $AUTOLOAD) =~ s/.*://;
814		1205
815	$method{$func}	1206	$method{$func}
816	or croak "$func: not a valid method for AnyEvent objects";	1207	or Carp::croak "$func: not a valid method for AnyEvent objects";
817		1208
818	detect unless $MODEL;	1209	detect unless $MODEL;
819		1210
820	my $class = shift;	1211	my $class = shift;
821	$class->$func (@_);	1212	$class->$func (@_);
822	}	1213	}
823		1214
		1215	# utility function to dup a filehandle. this is used by many backends
		1216	# to support binding more than one watcher per filehandle (they usually
		1217	# allow only one watcher per fd, so we dup it to get a different one).
		1218	sub _dupfh($$;$$) {
		1219	my ($poll, $fh, $r, $w) = @_;
		1220
		1221	# cygwin requires the fh mode to be matching, unix doesn't
		1222	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
		1223
		1224	open my $fh2, $mode, $fh
		1225	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
		1226
		1227	# we assume CLOEXEC is already set by perl in all important cases
		1228
		1229	($fh2, $rw)
		1230	}
		1231
824	package AnyEvent::Base;	1232	package AnyEvent::Base;
825		1233
		1234	# default implementations for many methods
		1235
		1236	sub _time {
		1237	# probe for availability of Time::HiRes
		1238	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1239	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
		1240	*_time = \&Time::HiRes::time;
		1241	# if (eval "use POSIX (); (POSIX::times())...
		1242	} else {
		1243	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
		1244	*_time = sub { time }; # epic fail
		1245	}
		1246
		1247	&_time
		1248	}
		1249
		1250	sub time { _time }
		1251	sub now { _time }
		1252	sub now_update { }
		1253
826	# default implementation for ->condvar	1254	# default implementation for ->condvar
827		1255
828	sub condvar {	1256	sub condvar {
829	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1257	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
830	}	1258	}
831		1259
832	# default implementation for ->signal	1260	# default implementation for ->signal
833		1261
834	our %SIG_CB;	1262	our $HAVE_ASYNC_INTERRUPT;
		1263	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1264	our (%SIG_ASY, %SIG_ASY_W);
		1265	our ($SIG_COUNT, $SIG_TW);
835		1266
		1267	sub _signal_exec {
		1268	$HAVE_ASYNC_INTERRUPT
		1269	? $SIGPIPE_R->drain
		1270	: sysread $SIGPIPE_R, my $dummy, 9;
		1271
		1272	while (%SIG_EV) {
		1273	for (keys %SIG_EV) {
		1274	delete $SIG_EV{$_};
		1275	$_->() for values %{ $SIG_CB{$_} || {} };
		1276	}
		1277	}
		1278	}
		1279
		1280	# install a dumym wakeupw atcher to reduce signal catching latency
		1281	sub _sig_add() {
		1282	unless ($SIG_COUNT++) {
		1283	# try to align timer on a full-second boundary, if possible
		1284	my $NOW = AnyEvent->now;
		1285
		1286	$SIG_TW = AnyEvent->timer (
		1287	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1288	interval => $MAX_SIGNAL_LATENCY,
		1289	cb => sub { }, # just for the PERL_ASYNC_CHECK
		1290	);
		1291	}
		1292	}
		1293
		1294	sub _sig_del {
		1295	undef $SIG_TW
		1296	unless --$SIG_COUNT;
		1297	}
		1298
836	sub signal {	1299	sub _signal {
837	my (undef, %arg) = @_;	1300	my (undef, %arg) = @_;
838		1301
839	my $signal = uc $arg{signal}	1302	my $signal = uc $arg{signal}
840	or Carp::croak "required option 'signal' is missing";	1303	or Carp::croak "required option 'signal' is missing";
841		1304
842	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1305	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1306
		1307	if ($HAVE_ASYNC_INTERRUPT) {
		1308	# async::interrupt
		1309
		1310	$SIG_ASY{$signal} ||= do {
		1311	my $asy = new Async::Interrupt
		1312	cb => sub { undef $SIG_EV{$signal} },
		1313	signal => $signal,
		1314	pipe => [$SIGPIPE_R->filenos],
		1315	;
		1316	$asy->pipe_autodrain (0);
		1317
		1318	$asy
		1319	};
		1320
		1321	} else {
		1322	# pure perl
		1323
843	$SIG{$signal} ||= sub {	1324	$SIG{$signal} ||= sub {
844	$_->() for values %{ $SIG_CB{$signal} || {} };	1325	local $!;
		1326	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1327	undef $SIG_EV{$signal};
		1328	};
		1329
		1330	# can't do signal processing without introducing races in pure perl,
		1331	# so limit the signal latency.
		1332	_sig_add;
845	};	1333	}
846		1334
847	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1335	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
848	}	1336	}
849		1337
		1338	sub signal {
		1339	# probe for availability of Async::Interrupt
		1340	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
		1341	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1342
		1343	$HAVE_ASYNC_INTERRUPT = 1;
		1344	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1345	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
		1346
		1347	} else {
		1348	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1349
		1350	require Fcntl;
		1351
		1352	if (AnyEvent::WIN32) {
		1353	require AnyEvent::Util;
		1354
		1355	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1356	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
		1357	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
		1358	} else {
		1359	pipe $SIGPIPE_R, $SIGPIPE_W;
		1360	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1361	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1362
		1363	# not strictly required, as $^F is normally 2, but let's make sure...
		1364	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1365	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1366	}
		1367
		1368	$SIGPIPE_R
		1369	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1370
		1371	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1372	}
		1373
		1374	*signal = \&_signal;
		1375	&signal
		1376	}
		1377
850	sub AnyEvent::Base::Signal::DESTROY {	1378	sub AnyEvent::Base::signal::DESTROY {
851	my ($signal, $cb) = @{$_[0]};	1379	my ($signal, $cb) = @{$_[0]};
852		1380
		1381	_sig_del;
		1382
853	delete $SIG_CB{$signal}{$cb};	1383	delete $SIG_CB{$signal}{$cb};
854		1384
855	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };	1385	$HAVE_ASYNC_INTERRUPT
		1386	? delete $SIG_ASY{$signal}
		1387	: # delete doesn't work with older perls - they then
		1388	# print weird messages, or just unconditionally exit
		1389	# instead of getting the default action.
		1390	undef $SIG{$signal}
		1391	unless keys %{ $SIG_CB{$signal} };
856	}	1392	}
857		1393
858	# default implementation for ->child	1394	# default implementation for ->child
859		1395
860	our %PID_CB;	1396	our %PID_CB;
861	our $CHLD_W;	1397	our $CHLD_W;
862	our $CHLD_DELAY_W;	1398	our $CHLD_DELAY_W;
863	our $PID_IDLE;
864	our $WNOHANG;	1399	our $WNOHANG;
865		1400
866	sub _child_wait {	1401	sub _sigchld {
867	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1402	while (0 < (my $pid = waitpid -1, $WNOHANG)) {
		1403	$_->($pid, $?)
868	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1404	for values %{ $PID_CB{$pid} || {} },
869	(values %{ $PID_CB{0} || {} });	1405	values %{ $PID_CB{0} || {} };
870	}	1406	}
871
872	undef $PID_IDLE;
873	}
874
875	sub _sigchld {
876	# make sure we deliver these changes "synchronous" with the event loop.
877	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
878	undef $CHLD_DELAY_W;
879	&_child_wait;
880	});
881	}	1407	}
882		1408
883	sub child {	1409	sub child {
884	my (undef, %arg) = @_;	1410	my (undef, %arg) = @_;
885		1411
886	defined (my $pid = $arg{pid} + 0)	1412	defined (my $pid = $arg{pid} + 0)
887	or Carp::croak "required option 'pid' is missing";	1413	or Carp::croak "required option 'pid' is missing";
888		1414
889	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1415	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
890		1416
891	unless ($WNOHANG) {	1417	# WNOHANG is almost cetrainly 1 everywhere
892	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1;	1418	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
893	}	1419	? 1
		1420	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
894		1421
895	unless ($CHLD_W) {	1422	unless ($CHLD_W) {
896	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1423	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
897	# child could be a zombie already, so make at least one round	1424	# child could be a zombie already, so make at least one round
898	&_sigchld;	1425	&_sigchld;
899	}	1426	}
900		1427
901	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1428	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
902	}	1429	}
903		1430
904	sub AnyEvent::Base::Child::DESTROY {	1431	sub AnyEvent::Base::child::DESTROY {
905	my ($pid, $cb) = @{$_[0]};	1432	my ($pid, $cb) = @{$_[0]};
906		1433
907	delete $PID_CB{$pid}{$cb};	1434	delete $PID_CB{$pid}{$cb};
908	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1435	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
909		1436
910	undef $CHLD_W unless keys %PID_CB;	1437	undef $CHLD_W unless keys %PID_CB;
911	}	1438	}
912		1439
		1440	# idle emulation is done by simply using a timer, regardless
		1441	# of whether the process is idle or not, and not letting
		1442	# the callback use more than 50% of the time.
		1443	sub idle {
		1444	my (undef, %arg) = @_;
		1445
		1446	my ($cb, $w, $rcb) = $arg{cb};
		1447
		1448	$rcb = sub {
		1449	if ($cb) {
		1450	$w = _time;
		1451	&$cb;
		1452	$w = _time - $w;
		1453
		1454	# never use more then 50% of the time for the idle watcher,
		1455	# within some limits
		1456	$w = 0.0001 if $w < 0.0001;
		1457	$w = 5 if $w > 5;
		1458
		1459	$w = AnyEvent->timer (after => $w, cb => $rcb);
		1460	} else {
		1461	# clean up...
		1462	undef $w;
		1463	undef $rcb;
		1464	}
		1465	};
		1466
		1467	$w = AnyEvent->timer (after => 0.05, cb => $rcb);
		1468
		1469	bless \\$cb, "AnyEvent::Base::idle"
		1470	}
		1471
		1472	sub AnyEvent::Base::idle::DESTROY {
		1473	undef $${$_[0]};
		1474	}
		1475
913	package AnyEvent::CondVar;	1476	package AnyEvent::CondVar;
914		1477
915	our @ISA = AnyEvent::CondVar::Base::;	1478	our @ISA = AnyEvent::CondVar::Base::;
916		1479
917	package AnyEvent::CondVar::Base;	1480	package AnyEvent::CondVar::Base;
		1481
		1482	#use overload
		1483	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
		1484	# fallback => 1;
		1485
		1486	# save 300+ kilobytes by dirtily hardcoding overloading
		1487	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1488	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1489	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1490	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1491
		1492	our $WAITING;
918		1493
919	sub _send {	1494	sub _send {
920	# nop	1495	# nop
921	}	1496	}
922		1497
…		…
935	sub ready {	1510	sub ready {
936	$_[0]{_ae_sent}	1511	$_[0]{_ae_sent}
937	}	1512	}
938		1513
939	sub _wait {	1514	sub _wait {
		1515	$WAITING
		1516	and !$_[0]{_ae_sent}
		1517	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1518
		1519	local $WAITING = 1;
940	AnyEvent->one_event while !$_[0]{_ae_sent};	1520	AnyEvent->one_event while !$_[0]{_ae_sent};
941	}	1521	}
942		1522
943	sub recv {	1523	sub recv {
944	$_[0]->_wait;	1524	$_[0]->_wait;
…		…
963	}	1543	}
964		1544
965	# undocumented/compatibility with pre-3.4	1545	# undocumented/compatibility with pre-3.4
966	*broadcast = \&send;	1546	*broadcast = \&send;
967	*wait = \&_wait;	1547	*wait = \&_wait;
		1548
		1549	=head1 ERROR AND EXCEPTION HANDLING
		1550
		1551	In general, AnyEvent does not do any error handling - it relies on the
		1552	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1553	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1554	checking of all AnyEvent methods, however, which is highly useful during
		1555	development.
		1556
		1557	As for exception handling (i.e. runtime errors and exceptions thrown while
		1558	executing a callback), this is not only highly event-loop specific, but
		1559	also not in any way wrapped by this module, as this is the job of the main
		1560	program.
		1561
		1562	The pure perl event loop simply re-throws the exception (usually
		1563	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1564	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1565	so on.
		1566
		1567	=head1 ENVIRONMENT VARIABLES
		1568
		1569	The following environment variables are used by this module or its
		1570	submodules.
		1571
		1572	Note that AnyEvent will remove I<all> environment variables starting with
		1573	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1574	enabled.
		1575
		1576	=over 4
		1577
		1578	=item C<PERL_ANYEVENT_VERBOSE>
		1579
		1580	By default, AnyEvent will be completely silent except in fatal
		1581	conditions. You can set this environment variable to make AnyEvent more
		1582	talkative.
		1583
		1584	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1585	conditions, such as not being able to load the event model specified by
		1586	C<PERL_ANYEVENT_MODEL>.
		1587
		1588	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1589	model it chooses.
		1590
		1591	When set to C<8> or higher, then AnyEvent will report extra information on
		1592	which optional modules it loads and how it implements certain features.
		1593
		1594	=item C<PERL_ANYEVENT_STRICT>
		1595
		1596	AnyEvent does not do much argument checking by default, as thorough
		1597	argument checking is very costly. Setting this variable to a true value
		1598	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1599	check the arguments passed to most method calls. If it finds any problems,
		1600	it will croak.
		1601
		1602	In other words, enables "strict" mode.
		1603
		1604	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
		1605	>>, it is definitely recommended to keep it off in production. Keeping
		1606	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1607	can be very useful, however.
		1608
		1609	=item C<PERL_ANYEVENT_MODEL>
		1610
		1611	This can be used to specify the event model to be used by AnyEvent, before
		1612	auto detection and -probing kicks in. It must be a string consisting
		1613	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		1614	and the resulting module name is loaded and if the load was successful,
		1615	used as event model. If it fails to load AnyEvent will proceed with
		1616	auto detection and -probing.
		1617
		1618	This functionality might change in future versions.
		1619
		1620	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		1621	could start your program like this:
		1622
		1623	PERL_ANYEVENT_MODEL=Perl perl ...
		1624
		1625	=item C<PERL_ANYEVENT_PROTOCOLS>
		1626
		1627	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1628	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1629	of auto probing).
		1630
		1631	Must be set to a comma-separated list of protocols or address families,
		1632	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1633	used, and preference will be given to protocols mentioned earlier in the
		1634	list.
		1635
		1636	This variable can effectively be used for denial-of-service attacks
		1637	against local programs (e.g. when setuid), although the impact is likely
		1638	small, as the program has to handle conenction and other failures anyways.
		1639
		1640	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1641	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1642	- only support IPv4, never try to resolve or contact IPv6
		1643	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1644	IPv6, but prefer IPv6 over IPv4.
		1645
		1646	=item C<PERL_ANYEVENT_EDNS0>
		1647
		1648	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1649	for DNS. This extension is generally useful to reduce DNS traffic, but
		1650	some (broken) firewalls drop such DNS packets, which is why it is off by
		1651	default.
		1652
		1653	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1654	EDNS0 in its DNS requests.
		1655
		1656	=item C<PERL_ANYEVENT_MAX_FORKS>
		1657
		1658	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1659	will create in parallel.
		1660
		1661	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1662
		1663	The default value for the C<max_outstanding> parameter for the default DNS
		1664	resolver - this is the maximum number of parallel DNS requests that are
		1665	sent to the DNS server.
		1666
		1667	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1668
		1669	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1670	configuration) in the default resolver. When set to the empty string, no
		1671	default config will be used.
		1672
		1673	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1674
		1675	When neither C<ca_file> nor C<ca_path> was specified during
		1676	L<AnyEvent::TLS> context creation, and either of these environment
		1677	variables exist, they will be used to specify CA certificate locations
		1678	instead of a system-dependent default.
		1679
		1680	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1681
		1682	When these are set to C<1>, then the respective modules are not
		1683	loaded. Mostly good for testing AnyEvent itself.
		1684
		1685	=back
968		1686
969	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1687	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
970		1688
971	This is an advanced topic that you do not normally need to use AnyEvent in	1689	This is an advanced topic that you do not normally need to use AnyEvent in
972	a module. This section is only of use to event loop authors who want to	1690	a module. This section is only of use to event loop authors who want to
…		…
1006		1724
1007	I<rxvt-unicode> also cheats a bit by not providing blocking access to	1725	I<rxvt-unicode> also cheats a bit by not providing blocking access to
1008	condition variables: code blocking while waiting for a condition will	1726	condition variables: code blocking while waiting for a condition will
1009	C<die>. This still works with most modules/usages, and blocking calls must	1727	C<die>. This still works with most modules/usages, and blocking calls must
1010	not be done in an interactive application, so it makes sense.	1728	not be done in an interactive application, so it makes sense.
1011
1012	=head1 ENVIRONMENT VARIABLES
1013
1014	The following environment variables are used by this module:
1015
1016	=over 4
1017
1018	=item C<PERL_ANYEVENT_VERBOSE>
1019
1020	By default, AnyEvent will be completely silent except in fatal
1021	conditions. You can set this environment variable to make AnyEvent more
1022	talkative.
1023
1024	When set to C<1> or higher, causes AnyEvent to warn about unexpected
1025	conditions, such as not being able to load the event model specified by
1026	C<PERL_ANYEVENT_MODEL>.
1027
1028	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1029	model it chooses.
1030
1031	=item C<PERL_ANYEVENT_MODEL>
1032
1033	This can be used to specify the event model to be used by AnyEvent, before
1034	autodetection and -probing kicks in. It must be a string consisting
1035	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1036	and the resulting module name is loaded and if the load was successful,
1037	used as event model. If it fails to load AnyEvent will proceed with
1038	autodetection and -probing.
1039
1040	This functionality might change in future versions.
1041
1042	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1043	could start your program like this:
1044
1045	PERL_ANYEVENT_MODEL=Perl perl ...
1046
1047	=item C<PERL_ANYEVENT_PROTOCOLS>
1048
1049	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1050	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1051	of autoprobing).
1052
1053	Must be set to a comma-separated list of protocols or address families,
1054	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1055	used, and preference will be given to protocols mentioned earlier in the
1056	list.
1057
1058	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1059	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1060	- only support IPv4, never try to resolve or contact IPv6
1061	addressses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1062	IPv6, but prefer IPv6 over IPv4.
1063
1064	=back
1065		1729
1066	=head1 EXAMPLE PROGRAM	1730	=head1 EXAMPLE PROGRAM
1067		1731
1068	The following program uses an I/O watcher to read data from STDIN, a timer	1732	The following program uses an I/O watcher to read data from STDIN, a timer
1069	to display a message once per second, and a condition variable to quit the	1733	to display a message once per second, and a condition variable to quit the
…		…
1153	syswrite $txn->{fh}, $txn->{request}	1817	syswrite $txn->{fh}, $txn->{request}
1154	or die "connection or write error";	1818	or die "connection or write error";
1155	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });	1819	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
1156		1820
1157	Again, C<fh_ready_r> waits till all data has arrived, and then stores the	1821	Again, C<fh_ready_r> waits till all data has arrived, and then stores the
1158	result and signals any possible waiters that the request ahs finished:	1822	result and signals any possible waiters that the request has finished:
1159		1823
1160	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};	1824	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
1161		1825
1162	if (end-of-file or data complete) {	1826	if (end-of-file or data complete) {
1163	$txn->{result} = $txn->{buf};	1827	$txn->{result} = $txn->{buf};
…		…
1171		1835
1172	$txn->{finished}->recv;	1836	$txn->{finished}->recv;
1173	return $txn->{result};	1837	return $txn->{result};
1174		1838
1175	The actual code goes further and collects all errors (C<die>s, exceptions)	1839	The actual code goes further and collects all errors (C<die>s, exceptions)
1176	that occured during request processing. The C<result> method detects	1840	that occurred during request processing. The C<result> method detects
1177	whether an exception as thrown (it is stored inside the $txn object)	1841	whether an exception as thrown (it is stored inside the $txn object)
1178	and just throws the exception, which means connection errors and other	1842	and just throws the exception, which means connection errors and other
1179	problems get reported tot he code that tries to use the result, not in a	1843	problems get reported tot he code that tries to use the result, not in a
1180	random callback.	1844	random callback.
1181		1845
…		…
1227	of various event loops I prepared some benchmarks.	1891	of various event loops I prepared some benchmarks.
1228		1892
1229	=head2 BENCHMARKING ANYEVENT OVERHEAD	1893	=head2 BENCHMARKING ANYEVENT OVERHEAD
1230		1894
1231	Here is a benchmark of various supported event models used natively and	1895	Here is a benchmark of various supported event models used natively and
1232	through anyevent. The benchmark creates a lot of timers (with a zero	1896	through AnyEvent. The benchmark creates a lot of timers (with a zero
1233	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	1897	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1234	which it is), lets them fire exactly once and destroys them again.	1898	which it is), lets them fire exactly once and destroys them again.
1235		1899
1236	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	1900	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1237	distribution.	1901	distribution.
…		…
1263	watcher.	1927	watcher.
1264		1928
1265	=head3 Results	1929	=head3 Results
1266		1930
1267	name watchers bytes create invoke destroy comment	1931	name watchers bytes create invoke destroy comment
1268	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	1932	EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1269	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	1933	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1270	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	1934	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1271	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	1935	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1272	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	1936	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1273	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	1937	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
		1938	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
		1939	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1274	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	1940	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1275	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	1941	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1276	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	1942	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1277	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	1943	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1278		1944
1279	=head3 Discussion	1945	=head3 Discussion
1280		1946
1281	The benchmark does I<not> measure scalability of the event loop very	1947	The benchmark does I<not> measure scalability of the event loop very
1282	well. For example, a select-based event loop (such as the pure perl one)	1948	well. For example, a select-based event loop (such as the pure perl one)
…		…
1307	performance becomes really bad with lots of file descriptors (and few of	1973	performance becomes really bad with lots of file descriptors (and few of
1308	them active), of course, but this was not subject of this benchmark.	1974	them active), of course, but this was not subject of this benchmark.
1309		1975
1310	The C<Event> module has a relatively high setup and callback invocation	1976	The C<Event> module has a relatively high setup and callback invocation
1311	cost, but overall scores in on the third place.	1977	cost, but overall scores in on the third place.
		1978
		1979	C<IO::Async> performs admirably well, about on par with C<Event>, even
		1980	when using its pure perl backend.
1312		1981
1313	C<Glib>'s memory usage is quite a bit higher, but it features a	1982	C<Glib>'s memory usage is quite a bit higher, but it features a
1314	faster callback invocation and overall ends up in the same class as	1983	faster callback invocation and overall ends up in the same class as
1315	C<Event>. However, Glib scales extremely badly, doubling the number of	1984	C<Event>. However, Glib scales extremely badly, doubling the number of
1316	watchers increases the processing time by more than a factor of four,	1985	watchers increases the processing time by more than a factor of four,
…		…
1360		2029
1361	=back	2030	=back
1362		2031
1363	=head2 BENCHMARKING THE LARGE SERVER CASE	2032	=head2 BENCHMARKING THE LARGE SERVER CASE
1364		2033
1365	This benchmark atcually benchmarks the event loop itself. It works by	2034	This benchmark actually benchmarks the event loop itself. It works by
1366	creating a number of "servers": each server consists of a socketpair, a	2035	creating a number of "servers": each server consists of a socket pair, a
1367	timeout watcher that gets reset on activity (but never fires), and an I/O	2036	timeout watcher that gets reset on activity (but never fires), and an I/O
1368	watcher waiting for input on one side of the socket. Each time the socket	2037	watcher waiting for input on one side of the socket. Each time the socket
1369	watcher reads a byte it will write that byte to a random other "server".	2038	watcher reads a byte it will write that byte to a random other "server".
1370		2039
1371	The effect is that there will be a lot of I/O watchers, only part of which	2040	The effect is that there will be a lot of I/O watchers, only part of which
1372	are active at any one point (so there is a constant number of active	2041	are active at any one point (so there is a constant number of active
1373	fds for each loop iterstaion, but which fds these are is random). The	2042	fds for each loop iteration, but which fds these are is random). The
1374	timeout is reset each time something is read because that reflects how	2043	timeout is reset each time something is read because that reflects how
1375	most timeouts work (and puts extra pressure on the event loops).	2044	most timeouts work (and puts extra pressure on the event loops).
1376		2045
1377	In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100	2046	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1378	(1%) are active. This mirrors the activity of large servers with many	2047	(1%) are active. This mirrors the activity of large servers with many
1379	connections, most of which are idle at any one point in time.	2048	connections, most of which are idle at any one point in time.
1380		2049
1381	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2050	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1382	distribution.	2051	distribution.
…		…
1384	=head3 Explanation of the columns	2053	=head3 Explanation of the columns
1385		2054
1386	I<sockets> is the number of sockets, and twice the number of "servers" (as	2055	I<sockets> is the number of sockets, and twice the number of "servers" (as
1387	each server has a read and write socket end).	2056	each server has a read and write socket end).
1388		2057
1389	I<create> is the time it takes to create a socketpair (which is	2058	I<create> is the time it takes to create a socket pair (which is
1390	nontrivial) and two watchers: an I/O watcher and a timeout watcher.	2059	nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1391		2060
1392	I<request>, the most important value, is the time it takes to handle a	2061	I<request>, the most important value, is the time it takes to handle a
1393	single "request", that is, reading the token from the pipe and forwarding	2062	single "request", that is, reading the token from the pipe and forwarding
1394	it to another server. This includes deleting the old timeout and creating	2063	it to another server. This includes deleting the old timeout and creating
1395	a new one that moves the timeout into the future.	2064	a new one that moves the timeout into the future.
1396		2065
1397	=head3 Results	2066	=head3 Results
1398		2067
1399	name sockets create request	2068	name sockets create request
1400	EV 20000 69.01 11.16	2069	EV 20000 69.01 11.16
1401	Perl 20000 73.32 35.87	2070	Perl 20000 73.32 35.87
		2071	IOAsync 20000 157.00 98.14 epoll
		2072	IOAsync 20000 159.31 616.06 poll
1402	Event 20000 212.62 257.32	2073	Event 20000 212.62 257.32
1403	Glib 20000 651.16 1896.30	2074	Glib 20000 651.16 1896.30
1404	POE 20000 349.67 12317.24 uses POE::Loop::Event	2075	POE 20000 349.67 12317.24 uses POE::Loop::Event
1405		2076
1406	=head3 Discussion	2077	=head3 Discussion
1407		2078
1408	This benchmark I<does> measure scalability and overall performance of the	2079	This benchmark I<does> measure scalability and overall performance of the
1409	particular event loop.	2080	particular event loop.
…		…
1411	EV is again fastest. Since it is using epoll on my system, the setup time	2082	EV is again fastest. Since it is using epoll on my system, the setup time
1412	is relatively high, though.	2083	is relatively high, though.
1413		2084
1414	Perl surprisingly comes second. It is much faster than the C-based event	2085	Perl surprisingly comes second. It is much faster than the C-based event
1415	loops Event and Glib.	2086	loops Event and Glib.
		2087
		2088	IO::Async performs very well when using its epoll backend, and still quite
		2089	good compared to Glib when using its pure perl backend.
1416		2090
1417	Event suffers from high setup time as well (look at its code and you will	2091	Event suffers from high setup time as well (look at its code and you will
1418	understand why). Callback invocation also has a high overhead compared to	2092	understand why). Callback invocation also has a high overhead compared to
1419	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2093	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1420	uses select or poll in basically all documented configurations.	2094	uses select or poll in basically all documented configurations.
…		…
1467	speed most when you have lots of watchers, not when you only have a few of	2141	speed most when you have lots of watchers, not when you only have a few of
1468	them).	2142	them).
1469		2143
1470	EV is again fastest.	2144	EV is again fastest.
1471		2145
1472	Perl again comes second. It is noticably faster than the C-based event	2146	Perl again comes second. It is noticeably faster than the C-based event
1473	loops Event and Glib, although the difference is too small to really	2147	loops Event and Glib, although the difference is too small to really
1474	matter.	2148	matter.
1475		2149
1476	POE also performs much better in this case, but is is still far behind the	2150	POE also performs much better in this case, but is is still far behind the
1477	others.	2151	others.
…		…
1480		2154
1481	=over 4	2155	=over 4
1482		2156
1483	=item * C-based event loops perform very well with small number of	2157	=item * C-based event loops perform very well with small number of
1484	watchers, as the management overhead dominates.	2158	watchers, as the management overhead dominates.
		2159
		2160	=back
		2161
		2162	=head2 THE IO::Lambda BENCHMARK
		2163
		2164	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2165	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2166	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2167	shouldn't come as a surprise to anybody). As such, the benchmark is
		2168	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2169	very optimal. But how would AnyEvent compare when used without the extra
		2170	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2171
		2172	The benchmark itself creates an echo-server, and then, for 500 times,
		2173	connects to the echo server, sends a line, waits for the reply, and then
		2174	creates the next connection. This is a rather bad benchmark, as it doesn't
		2175	test the efficiency of the framework or much non-blocking I/O, but it is a
		2176	benchmark nevertheless.
		2177
		2178	name runtime
		2179	Lambda/select 0.330 sec
		2180	+ optimized 0.122 sec
		2181	Lambda/AnyEvent 0.327 sec
		2182	+ optimized 0.138 sec
		2183	Raw sockets/select 0.077 sec
		2184	POE/select, components 0.662 sec
		2185	POE/select, raw sockets 0.226 sec
		2186	POE/select, optimized 0.404 sec
		2187
		2188	AnyEvent/select/nb 0.085 sec
		2189	AnyEvent/EV/nb 0.068 sec
		2190	+state machine 0.134 sec
		2191
		2192	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2193	benchmarks actually make blocking connects and use 100% blocking I/O,
		2194	defeating the purpose of an event-based solution. All of the newly
		2195	written AnyEvent benchmarks use 100% non-blocking connects (using
		2196	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2197	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2198	generally require a lot more bookkeeping and event handling than blocking
		2199	connects (which involve a single syscall only).
		2200
		2201	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2202	offers similar expressive power as POE and IO::Lambda, using conventional
		2203	Perl syntax. This means that both the echo server and the client are 100%
		2204	non-blocking, further placing it at a disadvantage.
		2205
		2206	As you can see, the AnyEvent + EV combination even beats the
		2207	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2208	backend easily beats IO::Lambda and POE.
		2209
		2210	And even the 100% non-blocking version written using the high-level (and
		2211	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
		2212	large margin, even though it does all of DNS, tcp-connect and socket I/O
		2213	in a non-blocking way.
		2214
		2215	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2216	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2217	part of the IO::lambda distribution and were used without any changes.
		2218
		2219
		2220	=head1 SIGNALS
		2221
		2222	AnyEvent currently installs handlers for these signals:
		2223
		2224	=over 4
		2225
		2226	=item SIGCHLD
		2227
		2228	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		2229	emulation for event loops that do not support them natively. Also, some
		2230	event loops install a similar handler.
		2231
		2232	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2233	AnyEvent will reset it to default, to avoid losing child exit statuses.
		2234
		2235	=item SIGPIPE
		2236
		2237	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		2238	when AnyEvent gets loaded.
		2239
		2240	The rationale for this is that AnyEvent users usually do not really depend
		2241	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		2242	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		2243	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		2244	some random socket.
		2245
		2246	The rationale for installing a no-op handler as opposed to ignoring it is
		2247	that this way, the handler will be restored to defaults on exec.
		2248
		2249	Feel free to install your own handler, or reset it to defaults.
		2250
		2251	=back
		2252
		2253	=cut
		2254
		2255	undef $SIG{CHLD}
		2256	if $SIG{CHLD} eq 'IGNORE';
		2257
		2258	$SIG{PIPE} = sub { }
		2259	unless defined $SIG{PIPE};
		2260
		2261	=head1 RECOMMENDED/OPTIONAL MODULES
		2262
		2263	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2264	it's built-in modules) are required to use it.
		2265
		2266	That does not mean that AnyEvent won't take advantage of some additional
		2267	modules if they are installed.
		2268
		2269	This section epxlains which additional modules will be used, and how they
		2270	affect AnyEvent's operetion.
		2271
		2272	=over 4
		2273
		2274	=item L<Async::Interrupt>
		2275
		2276	This slightly arcane module is used to implement fast signal handling: To
		2277	my knowledge, there is no way to do completely race-free and quick
		2278	signal handling in pure perl. To ensure that signals still get
		2279	delivered, AnyEvent will start an interval timer to wake up perl (and
		2280	catch the signals) with some delay (default is 10 seconds, look for
		2281	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2282
		2283	If this module is available, then it will be used to implement signal
		2284	catching, which means that signals will not be delayed, and the event loop
		2285	will not be interrupted regularly, which is more efficient (And good for
		2286	battery life on laptops).
		2287
		2288	This affects not just the pure-perl event loop, but also other event loops
		2289	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2290
		2291	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2292	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2293	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2294	does nothing for those backends.
		2295
		2296	=item L<EV>
		2297
		2298	This module isn't really "optional", as it is simply one of the backend
		2299	event loops that AnyEvent can use. However, it is simply the best event
		2300	loop available in terms of features, speed and stability: It supports
		2301	the AnyEvent API optimally, implements all the watcher types in XS, does
		2302	automatic timer adjustments even when no monotonic clock is available,
		2303	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2304	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2305	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2306
		2307	=item L<Guard>
		2308
		2309	The guard module, when used, will be used to implement
		2310	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2311	lot less memory), but otherwise doesn't affect guard operation much. It is
		2312	purely used for performance.
		2313
		2314	=item L<JSON> and L<JSON::XS>
		2315
		2316	This module is required when you want to read or write JSON data via
		2317	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2318	advantage of the ulta-high-speed L<JSON::XS> module when it is installed.
		2319
		2320	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2321	installed.
		2322
		2323	=item L<Net::SSLeay>
		2324
		2325	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2326	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2327	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2328
		2329	=item L<Time::HiRes>
		2330
		2331	This module is part of perl since release 5.008. It will be used when the
		2332	chosen event library does not come with a timing source on it's own. The
		2333	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2334	try to use a monotonic clock for timing stability.
1485		2335
1486	=back	2336	=back
1487		2337
1488		2338
1489	=head1 FORK	2339	=head1 FORK
…		…
1491	Most event libraries are not fork-safe. The ones who are usually are	2341	Most event libraries are not fork-safe. The ones who are usually are
1492	because they rely on inefficient but fork-safe C<select> or C<poll>	2342	because they rely on inefficient but fork-safe C<select> or C<poll>
1493	calls. Only L<EV> is fully fork-aware.	2343	calls. Only L<EV> is fully fork-aware.
1494		2344
1495	If you have to fork, you must either do so I<before> creating your first	2345	If you have to fork, you must either do so I<before> creating your first
1496	watcher OR you must not use AnyEvent at all in the child.	2346	watcher OR you must not use AnyEvent at all in the child OR you must do
		2347	something completely out of the scope of AnyEvent.
1497		2348
1498		2349
1499	=head1 SECURITY CONSIDERATIONS	2350	=head1 SECURITY CONSIDERATIONS
1500		2351
1501	AnyEvent can be forced to load any event model via	2352	AnyEvent can be forced to load any event model via
…		…
1506	specified in the variable.	2357	specified in the variable.
1507		2358
1508	You can make AnyEvent completely ignore this variable by deleting it	2359	You can make AnyEvent completely ignore this variable by deleting it
1509	before the first watcher gets created, e.g. with a C<BEGIN> block:	2360	before the first watcher gets created, e.g. with a C<BEGIN> block:
1510		2361
1511	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }	2362	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1512		2363
1513	use AnyEvent;	2364	use AnyEvent;
1514		2365
1515	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2366	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1516	be used to probe what backend is used and gain other information (which is	2367	be used to probe what backend is used and gain other information (which is
1517	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	2368	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		2369	$ENV{PERL_ANYEVENT_STRICT}.
		2370
		2371	Note that AnyEvent will remove I<all> environment variables starting with
		2372	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2373	enabled.
		2374
		2375
		2376	=head1 BUGS
		2377
		2378	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
		2379	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
		2380	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
		2381	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
		2382	pronounced).
1518		2383
1519		2384
1520	=head1 SEE ALSO	2385	=head1 SEE ALSO
1521		2386
1522	Utility functions: L<AnyEvent::Util>.	2387	Utility functions: L<AnyEvent::Util>.
…		…
1525	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2390	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1526		2391
1527	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2392	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1528	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2393	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1529	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2394	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1530	L<AnyEvent::Impl::POE>.	2395	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
1531		2396
1532	Non-blocking file handles, sockets, TCP clients and	2397	Non-blocking file handles, sockets, TCP clients and
1533	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2398	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1534		2399
1535	Asynchronous DNS: L<AnyEvent::DNS>.	2400	Asynchronous DNS: L<AnyEvent::DNS>.
1536		2401
1537	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2402	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2403	L<Coro::Event>,
1538		2404
1539	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2405	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2406	L<AnyEvent::HTTP>.
1540		2407
1541		2408
1542	=head1 AUTHOR	2409	=head1 AUTHOR
1543		2410
1544	Marc Lehmann <schmorp@schmorp.de>	2411	Marc Lehmann <schmorp@schmorp.de>
1545	http://home.schmorp.de/	2412	http://home.schmorp.de/
1546		2413
1547	=cut	2414	=cut
1548		2415
1549	1	2416	1
1550		2417

Diff Legend

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