ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.147 by root, Fri May 30 21:43:26 2008 UTC vs.
Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC

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

Diff Legend

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