ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.165 by root, Tue Jul 8 23:07:26 2008 UTC vs.
Revision 1.246 by root, Sat Jul 18 15:51:52 2009 UTC

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

Diff Legend

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