ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

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

Diff Legend

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