ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.198 by root, Thu Mar 26 20:17:44 2009 UTC vs.
Revision 1.277 by root, Sun Aug 9 13:27:23 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?
…		…
165	my variables are only visible after the statement in which they are	181	my variables are only visible after the statement in which they are
166	declared.	182	declared.
167		183
168	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
169		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
170	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	192	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
171	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
172		194
173	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events	195	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
174	(AnyEvent might or might not keep a reference to this file handle). C<poll>	196	for events (AnyEvent might or might not keep a reference to this file
		197	handle). Note that only file handles pointing to things for which
		198	non-blocking operation makes sense are allowed. This includes sockets,
		199	most character devices, pipes, fifos and so on, but not for example files
		200	or block devices.
		201
175	must be a string that is either C<r> or C<w>, which creates a watcher	202	C<poll> must be a string that is either C<r> or C<w>, which creates a
176	waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the	203	watcher waiting for "r"eadable or "w"ritable events, respectively.
		204
177	callback to invoke each time the file handle becomes ready.	205	C<cb> is the callback to invoke each time the file handle becomes ready.
178		206
179	Although the callback might get passed parameters, their value and	207	Although the callback might get passed parameters, their value and
180	presence is undefined and you cannot rely on them. Portable AnyEvent	208	presence is undefined and you cannot rely on them. Portable AnyEvent
181	callbacks cannot use arguments passed to I/O watcher callbacks.	209	callbacks cannot use arguments passed to I/O watcher callbacks.
182		210
…		…
197	undef $w;	225	undef $w;
198	});	226	});
199		227
200	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
201		229
		230	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		231
		232	$w = AnyEvent->timer (
		233	after => <fractional_seconds>,
		234	interval => <fractional_seconds>,
		235	cb => <callback>,
		236	);
		237
202	You can create a time watcher by calling the C<< AnyEvent->timer >>	238	You can create a time watcher by calling the C<< AnyEvent->timer >>
203	method with the following mandatory arguments:	239	method with the following mandatory arguments:
204		240
205	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
206	supported) the callback should be invoked. C<cb> is the callback to invoke	242	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
314	In either case, if you care (and in most cases, you don't), then you	350	In either case, if you care (and in most cases, you don't), then you
315	can get whatever behaviour you want with any event loop, by taking the	351	can get whatever behaviour you want with any event loop, by taking the
316	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	352	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
317	account.	353	account.
318		354
		355	=item AnyEvent->now_update
		356
		357	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
		358	the current time for each loop iteration (see the discussion of L<<
		359	AnyEvent->now >>, above).
		360
		361	When a callback runs for a long time (or when the process sleeps), then
		362	this "current" time will differ substantially from the real time, which
		363	might affect timers and time-outs.
		364
		365	When this is the case, you can call this method, which will update the
		366	event loop's idea of "current time".
		367
		368	Note that updating the time I<might> cause some events to be handled.
		369
319	=back	370	=back
320		371
321	=head2 SIGNAL WATCHERS	372	=head2 SIGNAL WATCHERS
		373
		374	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
322		375
323	You can watch for signals using a signal watcher, C<signal> is the signal	376	You can watch for signals using a signal watcher, C<signal> is the signal
324	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	377	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
325	callback to be invoked whenever a signal occurs.	378	callback to be invoked whenever a signal occurs.
326		379
…		…
332	invocation, and callback invocation will be synchronous. Synchronous means	385	invocation, and callback invocation will be synchronous. Synchronous means
333	that it might take a while until the signal gets handled by the process,	386	that it might take a while until the signal gets handled by the process,
334	but it is guaranteed not to interrupt any other callbacks.	387	but it is guaranteed not to interrupt any other callbacks.
335		388
336	The main advantage of using these watchers is that you can share a signal	389	The main advantage of using these watchers is that you can share a signal
337	between multiple watchers.	390	between multiple watchers, and AnyEvent will ensure that signals will not
		391	interrupt your program at bad times.
338		392
339	This watcher might use C<%SIG>, so programs overwriting those signals	393	This watcher might use C<%SIG> (depending on the event loop used),
340	directly will likely not work correctly.	394	so programs overwriting those signals directly will likely not work
		395	correctly.
341		396
342	Example: exit on SIGINT	397	Example: exit on SIGINT
343		398
344	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
345		400
		401	=head3 Signal Races, Delays and Workarounds
		402
		403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		404	callbacks to signals in a generic way, which is a pity, as you cannot
		405	do race-free signal handling in perl, requiring C libraries for
		406	this. AnyEvent will try to do it's best, which means in some cases,
		407	signals will be delayed. The maximum time a signal might be delayed is
		408	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
		409	variable can be changed only before the first signal watcher is created,
		410	and should be left alone otherwise. This variable determines how often
		411	AnyEvent polls for signals (in case a wake-up was missed). Higher values
		412	will cause fewer spurious wake-ups, which is better for power and CPU
		413	saving.
		414
		415	All these problems can be avoided by installing the optional
		416	L<Async::Interrupt> module, which works with most event loops. It will not
		417	work with inherently broken event loops such as L<Event> or L<Event::Lib>
		418	(and not with L<POE> currently, as POE does it's own workaround with
		419	one-second latency). For those, you just have to suffer the delays.
		420
346	=head2 CHILD PROCESS WATCHERS	421	=head2 CHILD PROCESS WATCHERS
347		422
		423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		424
348	You can also watch on a child process exit and catch its exit status.	425	You can also watch on a child process exit and catch its exit status.
349		426
350	The child process is specified by the C<pid> argument (if set to C<0>, it	427	The child process is specified by the C<pid> argument (one some backends,
351	watches for any child process exit). The watcher will triggered only when	428	using C<0> watches for any child process exit, on others this will
352	the child process has finished and an exit status is available, not on	429	croak). The watcher will be triggered only when the child process has
353	any trace events (stopped/continued).	430	finished and an exit status is available, not on any trace events
		431	(stopped/continued).
354		432
355	The callback will be called with the pid and exit status (as returned by	433	The callback will be called with the pid and exit status (as returned by
356	waitpid), so unlike other watcher types, you I<can> rely on child watcher	434	waitpid), so unlike other watcher types, you I<can> rely on child watcher
357	callback arguments.	435	callback arguments.
358		436
…		…
363		441
364	There is a slight catch to child watchers, however: you usually start them	442	There is a slight catch to child watchers, however: you usually start them
365	I<after> the child process was created, and this means the process could	443	I<after> the child process was created, and this means the process could
366	have exited already (and no SIGCHLD will be sent anymore).	444	have exited already (and no SIGCHLD will be sent anymore).
367		445
368	Not all event models handle this correctly (POE doesn't), but even for	446	Not all event models handle this correctly (neither POE nor IO::Async do,
		447	see their AnyEvent::Impl manpages for details), but even for event models
369	event models that I<do> handle this correctly, they usually need to be	448	that I<do> handle this correctly, they usually need to be loaded before
370	loaded before the process exits (i.e. before you fork in the first place).	449	the process exits (i.e. before you fork in the first place). AnyEvent's
		450	pure perl event loop handles all cases correctly regardless of when you
		451	start the watcher.
371		452
372	This means you cannot create a child watcher as the very first thing in an	453	This means you cannot create a child watcher as the very first
373	AnyEvent program, you I<have> to create at least one watcher before you	454	thing in an AnyEvent program, you I<have> to create at least one
374	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	455	watcher before you C<fork> the child (alternatively, you can call
		456	C<AnyEvent::detect>).
		457
		458	As most event loops do not support waiting for child events, they will be
		459	emulated by AnyEvent in most cases, in which the latency and race problems
		460	mentioned in the description of signal watchers apply.
375		461
376	Example: fork a process and wait for it	462	Example: fork a process and wait for it
377		463
378	my $done = AnyEvent->condvar;	464	my $done = AnyEvent->condvar;
379		465
…		…
389	);	475	);
390		476
391	# do something else, then wait for process exit	477	# do something else, then wait for process exit
392	$done->recv;	478	$done->recv;
393		479
		480	=head2 IDLE WATCHERS
		481
		482	$w = AnyEvent->idle (cb => <callback>);
		483
		484	Sometimes there is a need to do something, but it is not so important
		485	to do it instantly, but only when there is nothing better to do. This
		486	"nothing better to do" is usually defined to be "no other events need
		487	attention by the event loop".
		488
		489	Idle watchers ideally get invoked when the event loop has nothing
		490	better to do, just before it would block the process to wait for new
		491	events. Instead of blocking, the idle watcher is invoked.
		492
		493	Most event loops unfortunately do not really support idle watchers (only
		494	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		495	will simply call the callback "from time to time".
		496
		497	Example: read lines from STDIN, but only process them when the
		498	program is otherwise idle:
		499
		500	my @lines; # read data
		501	my $idle_w;
		502	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		503	push @lines, scalar <STDIN>;
		504
		505	# start an idle watcher, if not already done
		506	$idle_w ||= AnyEvent->idle (cb => sub {
		507	# handle only one line, when there are lines left
		508	if (my $line = shift @lines) {
		509	print "handled when idle: $line";
		510	} else {
		511	# otherwise disable the idle watcher again
		512	undef $idle_w;
		513	}
		514	});
		515	});
		516
394	=head2 CONDITION VARIABLES	517	=head2 CONDITION VARIABLES
		518
		519	$cv = AnyEvent->condvar;
		520
		521	$cv->send (<list>);
		522	my @res = $cv->recv;
395		523
396	If you are familiar with some event loops you will know that all of them	524	If you are familiar with some event loops you will know that all of them
397	require you to run some blocking "loop", "run" or similar function that	525	require you to run some blocking "loop", "run" or similar function that
398	will actively watch for new events and call your callbacks.	526	will actively watch for new events and call your callbacks.
399		527
400	AnyEvent is different, it expects somebody else to run the event loop and	528	AnyEvent is slightly different: it expects somebody else to run the event
401	will only block when necessary (usually when told by the user).	529	loop and will only block when necessary (usually when told by the user).
402		530
403	The instrument to do that is called a "condition variable", so called	531	The instrument to do that is called a "condition variable", so called
404	because they represent a condition that must become true.	532	because they represent a condition that must become true.
405		533
		534	Now is probably a good time to look at the examples further below.
		535
406	Condition variables can be created by calling the C<< AnyEvent->condvar	536	Condition variables can be created by calling the C<< AnyEvent->condvar
407	>> method, usually without arguments. The only argument pair allowed is	537	>> method, usually without arguments. The only argument pair allowed is
408
409	C<cb>, which specifies a callback to be called when the condition variable	538	C<cb>, which specifies a callback to be called when the condition variable
410	becomes true, with the condition variable as the first argument (but not	539	becomes true, with the condition variable as the first argument (but not
411	the results).	540	the results).
412		541
413	After creation, the condition variable is "false" until it becomes "true"	542	After creation, the condition variable is "false" until it becomes "true"
…		…
418	Condition variables are similar to callbacks, except that you can	547	Condition variables are similar to callbacks, except that you can
419	optionally wait for them. They can also be called merge points - points	548	optionally wait for them. They can also be called merge points - points
420	in time where multiple outstanding events have been processed. And yet	549	in time where multiple outstanding events have been processed. And yet
421	another way to call them is transactions - each condition variable can be	550	another way to call them is transactions - each condition variable can be
422	used to represent a transaction, which finishes at some point and delivers	551	used to represent a transaction, which finishes at some point and delivers
423	a result.	552	a result. And yet some people know them as "futures" - a promise to
		553	compute/deliver something that you can wait for.
424		554
425	Condition variables are very useful to signal that something has finished,	555	Condition variables are very useful to signal that something has finished,
426	for example, if you write a module that does asynchronous http requests,	556	for example, if you write a module that does asynchronous http requests,
427	then a condition variable would be the ideal candidate to signal the	557	then a condition variable would be the ideal candidate to signal the
428	availability of results. The user can either act when the callback is	558	availability of results. The user can either act when the callback is
…		…
462	after => 1,	592	after => 1,
463	cb => sub { $result_ready->send },	593	cb => sub { $result_ready->send },
464	);	594	);
465		595
466	# this "blocks" (while handling events) till the callback	596	# this "blocks" (while handling events) till the callback
467	# calls send	597	# calls -<send
468	$result_ready->recv;	598	$result_ready->recv;
469		599
470	Example: wait for a timer, but take advantage of the fact that	600	Example: wait for a timer, but take advantage of the fact that condition
471	condition variables are also code references.	601	variables are also callable directly.
472		602
473	my $done = AnyEvent->condvar;	603	my $done = AnyEvent->condvar;
474	my $delay = AnyEvent->timer (after => 5, cb => $done);	604	my $delay = AnyEvent->timer (after => 5, cb => $done);
475	$done->recv;	605	$done->recv;
476		606
…		…
482		612
483	...	613	...
484		614
485	my @info = $couchdb->info->recv;	615	my @info = $couchdb->info->recv;
486		616
487	And this is how you would just ste a callback to be called whenever the	617	And this is how you would just set a callback to be called whenever the
488	results are available:	618	results are available:
489		619
490	$couchdb->info->cb (sub {	620	$couchdb->info->cb (sub {
491	my @info = $_[0]->recv;	621	my @info = $_[0]->recv;
492	});	622	});
…		…
510	immediately from within send.	640	immediately from within send.
511		641
512	Any arguments passed to the C<send> call will be returned by all	642	Any arguments passed to the C<send> call will be returned by all
513	future C<< ->recv >> calls.	643	future C<< ->recv >> calls.
514		644
515	Condition variables are overloaded so one can call them directly	645	Condition variables are overloaded so one can call them directly (as if
516	(as a code reference). Calling them directly is the same as calling	646	they were a code reference). Calling them directly is the same as calling
517	C<send>. Note, however, that many C-based event loops do not handle	647	C<send>.
518	overloading, so as tempting as it may be, passing a condition variable
519	instead of a callback does not work. Both the pure perl and EV loops
520	support overloading, however, as well as all functions that use perl to
521	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
522	example).
523		648
524	=item $cv->croak ($error)	649	=item $cv->croak ($error)
525		650
526	Similar to send, but causes all call's to C<< ->recv >> to invoke	651	Similar to send, but causes all call's to C<< ->recv >> to invoke
527	C<Carp::croak> with the given error message/object/scalar.	652	C<Carp::croak> with the given error message/object/scalar.
528		653
529	This can be used to signal any errors to the condition variable	654	This can be used to signal any errors to the condition variable
530	user/consumer.	655	user/consumer. Doing it this way instead of calling C<croak> directly
		656	delays the error detetcion, but has the overwhelmign advantage that it
		657	diagnoses the error at the place where the result is expected, and not
		658	deep in some event clalback without connection to the actual code causing
		659	the problem.
531		660
532	=item $cv->begin ([group callback])	661	=item $cv->begin ([group callback])
533		662
534	=item $cv->end	663	=item $cv->end
535
536	These two methods are EXPERIMENTAL and MIGHT CHANGE.
537		664
538	These two methods can be used to combine many transactions/events into	665	These two methods can be used to combine many transactions/events into
539	one. For example, a function that pings many hosts in parallel might want	666	one. For example, a function that pings many hosts in parallel might want
540	to use a condition variable for the whole process.	667	to use a condition variable for the whole process.
541		668
…		…
543	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	670	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
544	>>, the (last) callback passed to C<begin> will be executed. That callback	671	>>, the (last) callback passed to C<begin> will be executed. That callback
545	is I<supposed> to call C<< ->send >>, but that is not required. If no	672	is I<supposed> to call C<< ->send >>, but that is not required. If no
546	callback was set, C<send> will be called without any arguments.	673	callback was set, C<send> will be called without any arguments.
547		674
548	Let's clarify this with the ping example:	675	You can think of C<< $cv->send >> giving you an OR condition (one call
		676	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
		677	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
		678
		679	Let's start with a simple example: you have two I/O watchers (for example,
		680	STDOUT and STDERR for a program), and you want to wait for both streams to
		681	close before activating a condvar:
		682
		683	my $cv = AnyEvent->condvar;
		684
		685	$cv->begin; # first watcher
		686	my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
		687	defined sysread $fh1, my $buf, 4096
		688	or $cv->end;
		689	});
		690
		691	$cv->begin; # second watcher
		692	my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
		693	defined sysread $fh2, my $buf, 4096
		694	or $cv->end;
		695	});
		696
		697	$cv->recv;
		698
		699	This works because for every event source (EOF on file handle), there is
		700	one call to C<begin>, so the condvar waits for all calls to C<end> before
		701	sending.
		702
		703	The ping example mentioned above is slightly more complicated, as the
		704	there are results to be passwd back, and the number of tasks that are
		705	begung can potentially be zero:
549		706
550	my $cv = AnyEvent->condvar;	707	my $cv = AnyEvent->condvar;
551		708
552	my %result;	709	my %result;
553	$cv->begin (sub { $cv->send (\%result) });	710	$cv->begin (sub { $cv->send (\%result) });
…		…
573	loop, which serves two important purposes: first, it sets the callback	730	loop, which serves two important purposes: first, it sets the callback
574	to be called once the counter reaches C<0>, and second, it ensures that	731	to be called once the counter reaches C<0>, and second, it ensures that
575	C<send> is called even when C<no> hosts are being pinged (the loop	732	C<send> is called even when C<no> hosts are being pinged (the loop
576	doesn't execute once).	733	doesn't execute once).
577		734
578	This is the general pattern when you "fan out" into multiple subrequests:	735	This is the general pattern when you "fan out" into multiple (but
579	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	736	potentially none) subrequests: use an outer C<begin>/C<end> pair to set
580	is called at least once, and then, for each subrequest you start, call	737	the callback and ensure C<end> is called at least once, and then, for each
581	C<begin> and for each subrequest you finish, call C<end>.	738	subrequest you start, call C<begin> and for each subrequest you finish,
		739	call C<end>.
582		740
583	=back	741	=back
584		742
585	=head3 METHODS FOR CONSUMERS	743	=head3 METHODS FOR CONSUMERS
586		744
…		…
602	function will call C<croak>.	760	function will call C<croak>.
603		761
604	In list context, all parameters passed to C<send> will be returned,	762	In list context, all parameters passed to C<send> will be returned,
605	in scalar context only the first one will be returned.	763	in scalar context only the first one will be returned.
606		764
		765	Note that doing a blocking wait in a callback is not supported by any
		766	event loop, that is, recursive invocation of a blocking C<< ->recv
		767	>> is not allowed, and the C<recv> call will C<croak> if such a
		768	condition is detected. This condition can be slightly loosened by using
		769	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		770	any thread that doesn't run the event loop itself.
		771
607	Not all event models support a blocking wait - some die in that case	772	Not all event models support a blocking wait - some die in that case
608	(programs might want to do that to stay interactive), so I<if you are	773	(programs might want to do that to stay interactive), so I<if you are
609	using this from a module, never require a blocking wait>, but let the	774	using this from a module, never require a blocking wait>. Instead, let the
610	caller decide whether the call will block or not (for example, by coupling	775	caller decide whether the call will block or not (for example, by coupling
611	condition variables with some kind of request results and supporting	776	condition variables with some kind of request results and supporting
612	callbacks so the caller knows that getting the result will not block,	777	callbacks so the caller knows that getting the result will not block,
613	while still supporting blocking waits if the caller so desires).	778	while still supporting blocking waits if the caller so desires).
614		779
615	Another reason I<never> to C<< ->recv >> in a module is that you cannot
616	sensibly have two C<< ->recv >>'s in parallel, as that would require
617	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
618	can supply.
619
620	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
621	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
622	versions and also integrates coroutines into AnyEvent, making blocking
623	C<< ->recv >> calls perfectly safe as long as they are done from another
624	coroutine (one that doesn't run the event loop).
625
626	You can ensure that C<< -recv >> never blocks by setting a callback and	780	You can ensure that C<< -recv >> never blocks by setting a callback and
627	only calling C<< ->recv >> from within that callback (or at a later	781	only calling C<< ->recv >> from within that callback (or at a later
628	time). This will work even when the event loop does not support blocking	782	time). This will work even when the event loop does not support blocking
629	waits otherwise.	783	waits otherwise.
630		784
…		…
636	=item $cb = $cv->cb ($cb->($cv))	790	=item $cb = $cv->cb ($cb->($cv))
637		791
638	This is a mutator function that returns the callback set and optionally	792	This is a mutator function that returns the callback set and optionally
639	replaces it before doing so.	793	replaces it before doing so.
640		794
641	The callback will be called when the condition becomes "true", i.e. when	795	The callback will be called when the condition becomes (or already was)
642	C<send> or C<croak> are called, with the only argument being the condition	796	"true", i.e. when C<send> or C<croak> are called (or were called), with
643	variable itself. Calling C<recv> inside the callback or at any later time	797	the only argument being the condition variable itself. Calling C<recv>
644	is guaranteed not to block.	798	inside the callback or at any later time is guaranteed not to block.
645		799
646	=back	800	=back
647		801
		802	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		803
		804	The available backend classes are (every class has its own manpage):
		805
		806	=over 4
		807
		808	=item Backends that are autoprobed when no other event loop can be found.
		809
		810	EV is the preferred backend when no other event loop seems to be in
		811	use. If EV is not installed, then AnyEvent will fall back to its own
		812	pure-perl implementation, which is available everywhere as it comes with
		813	AnyEvent itself.
		814
		815	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		816	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		817
		818	=item Backends that are transparently being picked up when they are used.
		819
		820	These will be used when they are currently loaded when the first watcher
		821	is created, in which case it is assumed that the application is using
		822	them. This means that AnyEvent will automatically pick the right backend
		823	when the main program loads an event module before anything starts to
		824	create watchers. Nothing special needs to be done by the main program.
		825
		826	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		827	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		828	AnyEvent::Impl::Tk based on Tk, very broken.
		829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		830	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		831	AnyEvent::Impl::Irssi used when running within irssi.
		832
		833	=item Backends with special needs.
		834
		835	Qt requires the Qt::Application to be instantiated first, but will
		836	otherwise be picked up automatically. As long as the main program
		837	instantiates the application before any AnyEvent watchers are created,
		838	everything should just work.
		839
		840	AnyEvent::Impl::Qt based on Qt.
		841
		842	Support for IO::Async can only be partial, as it is too broken and
		843	architecturally limited to even support the AnyEvent API. It also
		844	is the only event loop that needs the loop to be set explicitly, so
		845	it can only be used by a main program knowing about AnyEvent. See
		846	L<AnyEvent::Impl::Async> for the gory details.
		847
		848	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		849
		850	=item Event loops that are indirectly supported via other backends.
		851
		852	Some event loops can be supported via other modules:
		853
		854	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		855
		856	B<WxWidgets> has no support for watching file handles. However, you can
		857	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		858	polls 20 times per second, which was considered to be too horrible to even
		859	consider for AnyEvent.
		860
		861	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		862	backend, so it can be supported through POE.
		863
		864	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		865	load L<POE> when detecting them, in the hope that POE will pick them up,
		866	in which case everything will be automatic.
		867
		868	=back
		869
648	=head1 GLOBAL VARIABLES AND FUNCTIONS	870	=head1 GLOBAL VARIABLES AND FUNCTIONS
649		871
		872	These are not normally required to use AnyEvent, but can be useful to
		873	write AnyEvent extension modules.
		874
650	=over 4	875	=over 4
651		876
652	=item $AnyEvent::MODEL	877	=item $AnyEvent::MODEL
653		878
654	Contains C<undef> until the first watcher is being created. Then it	879	Contains C<undef> until the first watcher is being created, before the
		880	backend has been autodetected.
		881
655	contains the event model that is being used, which is the name of the	882	Afterwards it contains the event model that is being used, which is the
656	Perl class implementing the model. This class is usually one of the	883	name of the Perl class implementing the model. This class is usually one
657	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	884	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
658	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	885	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
659		886	will be C<urxvt::anyevent>).
660	The known classes so far are:
661
662	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
663	AnyEvent::Impl::Event based on Event, second best choice.
664	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
665	AnyEvent::Impl::Glib based on Glib, third-best choice.
666	AnyEvent::Impl::Tk based on Tk, very bad choice.
667	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
668	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
669	AnyEvent::Impl::POE based on POE, not generic enough for full support.
670
671	There is no support for WxWidgets, as WxWidgets has no support for
672	watching file handles. However, you can use WxWidgets through the
673	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
674	second, which was considered to be too horrible to even consider for
675	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
676	it's adaptor.
677
678	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
679	autodetecting them.
680		887
681	=item AnyEvent::detect	888	=item AnyEvent::detect
682		889
683	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	890	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
684	if necessary. You should only call this function right before you would	891	if necessary. You should only call this function right before you would
685	have created an AnyEvent watcher anyway, that is, as late as possible at	892	have created an AnyEvent watcher anyway, that is, as late as possible at
686	runtime.	893	runtime, and not e.g. while initialising of your module.
		894
		895	If you need to do some initialisation before AnyEvent watchers are
		896	created, use C<post_detect>.
687		897
688	=item $guard = AnyEvent::post_detect { BLOCK }	898	=item $guard = AnyEvent::post_detect { BLOCK }
689		899
690	Arranges for the code block to be executed as soon as the event model is	900	Arranges for the code block to be executed as soon as the event model is
691	autodetected (or immediately if this has already happened).	901	autodetected (or immediately if this has already happened).
692		902
		903	The block will be executed I<after> the actual backend has been detected
		904	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		905	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		906	other initialisations - see the sources of L<AnyEvent::Strict> or
		907	L<AnyEvent::AIO> to see how this is used.
		908
		909	The most common usage is to create some global watchers, without forcing
		910	event module detection too early, for example, L<AnyEvent::AIO> creates
		911	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		912	avoid autodetecting the event module at load time.
		913
693	If called in scalar or list context, then it creates and returns an object	914	If called in scalar or list context, then it creates and returns an object
694	that automatically removes the callback again when it is destroyed. See	915	that automatically removes the callback again when it is destroyed (or
		916	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
695	L<Coro::BDB> for a case where this is useful.	917	a case where this is useful.
		918
		919	Example: Create a watcher for the IO::AIO module and store it in
		920	C<$WATCHER>. Only do so after the event loop is initialised, though.
		921
		922	our WATCHER;
		923
		924	my $guard = AnyEvent::post_detect {
		925	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		926	};
		927
		928	# the ||= is important in case post_detect immediately runs the block,
		929	# as to not clobber the newly-created watcher. assigning both watcher and
		930	# post_detect guard to the same variable has the advantage of users being
		931	# able to just C<undef $WATCHER> if the watcher causes them grief.
		932
		933	$WATCHER ||= $guard;
696		934
697	=item @AnyEvent::post_detect	935	=item @AnyEvent::post_detect
698		936
699	If there are any code references in this array (you can C<push> to it	937	If there are any code references in this array (you can C<push> to it
700	before or after loading AnyEvent), then they will called directly after	938	before or after loading AnyEvent), then they will called directly after
701	the event loop has been chosen.	939	the event loop has been chosen.
702		940
703	You should check C<$AnyEvent::MODEL> before adding to this array, though:	941	You should check C<$AnyEvent::MODEL> before adding to this array, though:
704	if it contains a true value then the event loop has already been detected,	942	if it is defined then the event loop has already been detected, and the
705	and the array will be ignored.	943	array will be ignored.
706		944
707	Best use C<AnyEvent::post_detect { BLOCK }> instead.	945	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		946	it,as it takes care of these details.
		947
		948	This variable is mainly useful for modules that can do something useful
		949	when AnyEvent is used and thus want to know when it is initialised, but do
		950	not need to even load it by default. This array provides the means to hook
		951	into AnyEvent passively, without loading it.
708		952
709	=back	953	=back
710		954
711	=head1 WHAT TO DO IN A MODULE	955	=head1 WHAT TO DO IN A MODULE
712		956
…		…
767		1011
768		1012
769	=head1 OTHER MODULES	1013	=head1 OTHER MODULES
770		1014
771	The following is a non-exhaustive list of additional modules that use	1015	The following is a non-exhaustive list of additional modules that use
772	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1016	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
773	in the same program. Some of the modules come with AnyEvent, some are	1017	modules and other event loops in the same program. Some of the modules
774	available via CPAN.	1018	come with AnyEvent, most are available via CPAN.
775		1019
776	=over 4	1020	=over 4
777		1021
778	=item L<AnyEvent::Util>	1022	=item L<AnyEvent::Util>
779		1023
…		…
788		1032
789	=item L<AnyEvent::Handle>	1033	=item L<AnyEvent::Handle>
790		1034
791	Provide read and write buffers, manages watchers for reads and writes,	1035	Provide read and write buffers, manages watchers for reads and writes,
792	supports raw and formatted I/O, I/O queued and fully transparent and	1036	supports raw and formatted I/O, I/O queued and fully transparent and
793	non-blocking SSL/TLS.	1037	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
794		1038
795	=item L<AnyEvent::DNS>	1039	=item L<AnyEvent::DNS>
796		1040
797	Provides rich asynchronous DNS resolver capabilities.	1041	Provides rich asynchronous DNS resolver capabilities.
798		1042
…		…
826		1070
827	=item L<AnyEvent::GPSD>	1071	=item L<AnyEvent::GPSD>
828		1072
829	A non-blocking interface to gpsd, a daemon delivering GPS information.	1073	A non-blocking interface to gpsd, a daemon delivering GPS information.
830		1074
		1075	=item L<AnyEvent::IRC>
		1076
		1077	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		1078
		1079	=item L<AnyEvent::XMPP>
		1080
		1081	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1082	Net::XMPP2>.
		1083
831	=item L<AnyEvent::IGS>	1084	=item L<AnyEvent::IGS>
832		1085
833	A non-blocking interface to the Internet Go Server protocol (used by	1086	A non-blocking interface to the Internet Go Server protocol (used by
834	L<App::IGS>).	1087	L<App::IGS>).
835		1088
836	=item L<AnyEvent::IRC>
837
838	AnyEvent based IRC client module family (replacing the older Net::IRC3).
839
840	=item L<Net::XMPP2>
841
842	AnyEvent based XMPP (Jabber protocol) module family.
843
844	=item L<Net::FCP>	1089	=item L<Net::FCP>
845		1090
846	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1091	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
847	of AnyEvent.	1092	of AnyEvent.
848		1093
…		…
852		1097
853	=item L<Coro>	1098	=item L<Coro>
854		1099
855	Has special support for AnyEvent via L<Coro::AnyEvent>.	1100	Has special support for AnyEvent via L<Coro::AnyEvent>.
856		1101
857	=item L<IO::Lambda>
858
859	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
860
861	=back	1102	=back
862		1103
863	=cut	1104	=cut
864		1105
865	package AnyEvent;	1106	package AnyEvent;
866		1107
		1108	# basically a tuned-down version of common::sense
		1109	sub common_sense {
867	no warnings;	1110	# no warnings
		1111	${^WARNING_BITS} ^= ${^WARNING_BITS};
868	use strict qw(vars subs);	1112	# use strict vars subs
		1113	$^H |= 0x00000600;
		1114	}
869		1115
		1116	BEGIN { AnyEvent::common_sense }
		1117
870	use Carp;	1118	use Carp ();
871		1119
872	our $VERSION = 4.341;	1120	our $VERSION = 4.92;
873	our $MODEL;	1121	our $MODEL;
874		1122
875	our $AUTOLOAD;	1123	our $AUTOLOAD;
876	our @ISA;	1124	our @ISA;
877		1125
878	our @REGISTRY;	1126	our @REGISTRY;
879		1127
880	our $WIN32;	1128	our $WIN32;
881		1129
		1130	our $VERBOSE;
		1131
882	BEGIN {	1132	BEGIN {
883	my $win32 = ! ! ($^O =~ /mswin32/i);	1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
884	eval "sub WIN32(){ $win32 }";	1134	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
885	}
886		1135
		1136	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1137	if ${^TAINT};
		1138
887	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1139	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1140
		1141	}
		1142
		1143	our $MAX_SIGNAL_LATENCY = 10;
888		1144
889	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1145	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
890		1146
891	{	1147	{
892	my $idx;	1148	my $idx;
…		…
894	for reverse split /\s*,\s*/,	1150	for reverse split /\s*,\s*/,
895	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1151	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
896	}	1152	}
897		1153
898	my @models = (	1154	my @models = (
899	[EV:: => AnyEvent::Impl::EV::],	1155	[EV:: => AnyEvent::Impl::EV:: , 1],
900	[Event:: => AnyEvent::Impl::Event::],
901	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1156	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
902	# everything below here will not be autoprobed	1157	# everything below here will not (normally) be autoprobed
903	# as the pureperl backend should work everywhere	1158	# as the pureperl backend should work everywhere
904	# and is usually faster	1159	# and is usually faster
		1160	[Event:: => AnyEvent::Impl::Event::, 1],
		1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
905	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
906	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
907	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
908	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
909	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1166	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
910	[Wx:: => AnyEvent::Impl::POE::],	1167	[Wx:: => AnyEvent::Impl::POE::],
911	[Prima:: => AnyEvent::Impl::POE::],	1168	[Prima:: => AnyEvent::Impl::POE::],
		1169	# IO::Async is just too broken - we would need workarounds for its
		1170	# byzantine signal and broken child handling, among others.
		1171	# IO::Async is rather hard to detect, as it doesn't have any
		1172	# obvious default class.
		1173	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1174	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1175	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1176	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
912	);	1177	);
913		1178
914	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);	1179	our %method = map +($_ => 1),
		1180	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
915		1181
916	our @post_detect;	1182	our @post_detect;
917		1183
918	sub post_detect(&) {	1184	sub post_detect(&) {
919	my ($cb) = @_;	1185	my ($cb) = @_;
920		1186
921	if ($MODEL) {	1187	if ($MODEL) {
922	$cb->();	1188	$cb->();
923		1189
924	1	1190	undef
925	} else {	1191	} else {
926	push @post_detect, $cb;	1192	push @post_detect, $cb;
927		1193
928	defined wantarray	1194	defined wantarray
929	? bless \$cb, "AnyEvent::Util::PostDetect"	1195	? bless \$cb, "AnyEvent::Util::postdetect"
930	: ()	1196	: ()
931	}	1197	}
932	}	1198	}
933		1199
934	sub AnyEvent::Util::PostDetect::DESTROY {	1200	sub AnyEvent::Util::postdetect::DESTROY {
935	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1201	@post_detect = grep $_ != ${$_[0]}, @post_detect;
936	}	1202	}
937		1203
938	sub detect() {	1204	sub detect() {
939	unless ($MODEL) {	1205	unless ($MODEL) {
940	no strict 'refs';
941	local $SIG{__DIE__};	1206	local $SIG{__DIE__};
942		1207
943	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1208	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
944	my $model = "AnyEvent::Impl::$1";	1209	my $model = "AnyEvent::Impl::$1";
945	if (eval "require $model") {	1210	if (eval "require $model") {
946	$MODEL = $model;	1211	$MODEL = $model;
947	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1212	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
948	} else {	1213	} else {
949	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1214	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
950	}	1215	}
951	}	1216	}
952		1217
953	# check for already loaded models	1218	# check for already loaded models
954	unless ($MODEL) {	1219	unless ($MODEL) {
955	for (@REGISTRY, @models) {	1220	for (@REGISTRY, @models) {
956	my ($package, $model) = @$_;	1221	my ($package, $model) = @$_;
957	if (${"$package\::VERSION"} > 0) {	1222	if (${"$package\::VERSION"} > 0) {
958	if (eval "require $model") {	1223	if (eval "require $model") {
959	$MODEL = $model;	1224	$MODEL = $model;
960	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1225	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
961	last;	1226	last;
962	}	1227	}
963	}	1228	}
964	}	1229	}
965		1230
966	unless ($MODEL) {	1231	unless ($MODEL) {
967	# try to load a model	1232	# try to autoload a model
968
969	for (@REGISTRY, @models) {	1233	for (@REGISTRY, @models) {
970	my ($package, $model) = @$_;	1234	my ($package, $model, $autoload) = @$_;
		1235	if (
		1236	$autoload
971	if (eval "require $package"	1237	and eval "require $package"
972	and ${"$package\::VERSION"} > 0	1238	and ${"$package\::VERSION"} > 0
973	and eval "require $model") {	1239	and eval "require $model"
		1240	) {
974	$MODEL = $model;	1241	$MODEL = $model;
975	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1242	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
976	last;	1243	last;
977	}	1244	}
978	}	1245	}
979		1246
980	$MODEL	1247	$MODEL
981	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1248	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
982	}	1249	}
983	}	1250	}
984		1251
985	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1252	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
986		1253
…		…
996		1263
997	sub AUTOLOAD {	1264	sub AUTOLOAD {
998	(my $func = $AUTOLOAD) =~ s/.*://;	1265	(my $func = $AUTOLOAD) =~ s/.*://;
999		1266
1000	$method{$func}	1267	$method{$func}
1001	or croak "$func: not a valid method for AnyEvent objects";	1268	or Carp::croak "$func: not a valid method for AnyEvent objects";
1002		1269
1003	detect unless $MODEL;	1270	detect unless $MODEL;
1004		1271
1005	my $class = shift;	1272	my $class = shift;
1006	$class->$func (@_);	1273	$class->$func (@_);
1007	}	1274	}
1008		1275
1009	# utility function to dup a filehandle. this is used by many backends	1276	# utility function to dup a filehandle. this is used by many backends
1010	# to support binding more than one watcher per filehandle (they usually	1277	# to support binding more than one watcher per filehandle (they usually
1011	# allow only one watcher per fd, so we dup it to get a different one).	1278	# allow only one watcher per fd, so we dup it to get a different one).
1012	sub _dupfh($$$$) {	1279	sub _dupfh($$;$$) {
1013	my ($poll, $fh, $r, $w) = @_;	1280	my ($poll, $fh, $r, $w) = @_;
1014		1281
1015	# cygwin requires the fh mode to be matching, unix doesn't	1282	# cygwin requires the fh mode to be matching, unix doesn't
1016	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1283	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1017	: $poll eq "w" ? ($w, ">")
1018	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1019		1284
1020	open my $fh2, "$mode&" . fileno $fh	1285	open my $fh2, $mode, $fh
1021	or die "cannot dup() filehandle: $!";	1286	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1022		1287
1023	# we assume CLOEXEC is already set by perl in all important cases	1288	# we assume CLOEXEC is already set by perl in all important cases
1024		1289
1025	($fh2, $rw)	1290	($fh2, $rw)
1026	}	1291	}
1027		1292
		1293	#############################################################################
		1294	# "new" API, currently only emulation of it
		1295	#############################################################################
		1296
		1297	package AE;
		1298
		1299	our $VERSION = $AnyEvent::VERSION;
		1300
		1301	sub io($$$) {
		1302	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1303	}
		1304
		1305	sub timer($$$) {
		1306	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1307	}
		1308
		1309	sub signal($$) {
		1310	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1311	}
		1312
		1313	sub child($$) {
		1314	AnyEvent->child (pid => $_[0], cb => $_[1])
		1315	}
		1316
		1317	sub idle($) {
		1318	AnyEvent->idle (cb => $_[0])
		1319	}
		1320
		1321	sub cv(;&) {
		1322	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1323	}
		1324
		1325	sub now() {
		1326	AnyEvent->now
		1327	}
		1328
		1329	sub now_update() {
		1330	AnyEvent->now_update
		1331	}
		1332
		1333	sub time() {
		1334	AnyEvent->time
		1335	}
		1336
1028	package AnyEvent::Base;	1337	package AnyEvent::Base;
1029		1338
1030	# default implementation for now and time	1339	# default implementations for many methods
1031		1340
1032	BEGIN {	1341	sub _time {
		1342	# probe for availability of Time::HiRes
1033	if (eval "use Time::HiRes (); time (); 1") {	1343	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1344	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1034	*_time = \&Time::HiRes::time;	1345	*_time = \&Time::HiRes::time;
1035	# if (eval "use POSIX (); (POSIX::times())...	1346	# if (eval "use POSIX (); (POSIX::times())...
1036	} else {	1347	} else {
		1348	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1037	*_time = sub { time }; # epic fail	1349	*_time = sub { time }; # epic fail
1038	}	1350	}
		1351
		1352	&_time
1039	}	1353	}
1040		1354
1041	sub time { _time }	1355	sub time { _time }
1042	sub now { _time }	1356	sub now { _time }
		1357	sub now_update { }
1043		1358
1044	# default implementation for ->condvar	1359	# default implementation for ->condvar
1045		1360
1046	sub condvar {	1361	sub condvar {
1047	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1362	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1048	}	1363	}
1049		1364
1050	# default implementation for ->signal	1365	# default implementation for ->signal
1051		1366
		1367	our $HAVE_ASYNC_INTERRUPT;
		1368
		1369	sub _have_async_interrupt() {
		1370	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1371	&& eval "use Async::Interrupt 1.0 (); 1")
		1372	unless defined $HAVE_ASYNC_INTERRUPT;
		1373
		1374	$HAVE_ASYNC_INTERRUPT
		1375	}
		1376
1052	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1377	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1378	our (%SIG_ASY, %SIG_ASY_W);
		1379	our ($SIG_COUNT, $SIG_TW);
1053		1380
1054	sub _signal_exec {	1381	sub _signal_exec {
		1382	$HAVE_ASYNC_INTERRUPT
		1383	? $SIGPIPE_R->drain
1055	sysread $SIGPIPE_R, my $dummy, 4;	1384	: sysread $SIGPIPE_R, my $dummy, 9;
1056		1385
1057	while (%SIG_EV) {	1386	while (%SIG_EV) {
1058	for (keys %SIG_EV) {	1387	for (keys %SIG_EV) {
1059	delete $SIG_EV{$_};	1388	delete $SIG_EV{$_};
1060	$_->() for values %{ $SIG_CB{$_} || {} };	1389	$_->() for values %{ $SIG_CB{$_} || {} };
1061	}	1390	}
1062	}	1391	}
1063	}	1392	}
1064		1393
		1394	# install a dummy wakeup watcher to reduce signal catching latency
		1395	sub _sig_add() {
		1396	unless ($SIG_COUNT++) {
		1397	# try to align timer on a full-second boundary, if possible
		1398	my $NOW = AE::now;
		1399
		1400	$SIG_TW = AE::timer
		1401	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1402	$MAX_SIGNAL_LATENCY,
		1403	sub { } # just for the PERL_ASYNC_CHECK
		1404	;
		1405	}
		1406	}
		1407
		1408	sub _sig_del {
		1409	undef $SIG_TW
		1410	unless --$SIG_COUNT;
		1411	}
		1412
		1413	our $_sig_name_init; $_sig_name_init = sub {
		1414	eval q{ # poor man's autoloading
		1415	undef $_sig_name_init;
		1416
		1417	if (_have_async_interrupt) {
		1418	*sig2num = \&Async::Interrupt::sig2num;
		1419	*sig2name = \&Async::Interrupt::sig2name;
		1420	} else {
		1421	require Config;
		1422
		1423	my %signame2num;
		1424	@signame2num{ split ' ', $Config::Config{sig_name} }
		1425	= split ' ', $Config::Config{sig_num};
		1426
		1427	my @signum2name;
		1428	@signum2name[values %signame2num] = keys %signame2num;
		1429
		1430	*sig2num = sub($) {
		1431	$_[0] > 0 ? shift : $signame2num{+shift}
		1432	};
		1433	*sig2name = sub ($) {
		1434	$_[0] > 0 ? $signum2name[+shift] : shift
		1435	};
		1436	}
		1437	};
		1438	die if $@;
		1439	};
		1440
		1441	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1442	sub sig2name($) { &$_sig_name_init; &sig2name }
		1443
1065	sub signal {	1444	sub signal {
1066	my (undef, %arg) = @_;	1445	eval q{ # poor man's autoloading {}
		1446	# probe for availability of Async::Interrupt
		1447	if (_have_async_interrupt) {
		1448	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1067		1449
1068	unless ($SIGPIPE_R) {	1450	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1069	if (AnyEvent::WIN32) {	1451	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1070	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1452
1071	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1072	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1073	} else {	1453	} else {
1074	pipe $SIGPIPE_R, $SIGPIPE_W;	1454	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1455
1075	require Fcntl;	1456	require Fcntl;
		1457
		1458	if (AnyEvent::WIN32) {
		1459	require AnyEvent::Util;
		1460
		1461	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1462	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1463	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1464	} else {
		1465	pipe $SIGPIPE_R, $SIGPIPE_W;
1076	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1466	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1077	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1467	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1468
		1469	# not strictly required, as $^F is normally 2, but let's make sure...
		1470	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1471	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1472	}
		1473
		1474	$SIGPIPE_R
		1475	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1476
		1477	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1078	}	1478	}
1079		1479
1080	$SIGPIPE_R	1480	*signal = sub {
1081	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1481	my (undef, %arg) = @_;
1082		1482
1083	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1084	}
1085
1086	my $signal = uc $arg{signal}	1483	my $signal = uc $arg{signal}
1087	or Carp::croak "required option 'signal' is missing";	1484	or Carp::croak "required option 'signal' is missing";
1088		1485
		1486	if ($HAVE_ASYNC_INTERRUPT) {
		1487	# async::interrupt
		1488
		1489	$signal = sig2num $signal;
1089	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1490	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1491
		1492	$SIG_ASY{$signal} ||= new Async::Interrupt
		1493	cb => sub { undef $SIG_EV{$signal} },
		1494	signal => $signal,
		1495	pipe => [$SIGPIPE_R->filenos],
		1496	pipe_autodrain => 0,
		1497	;
		1498
		1499	} else {
		1500	# pure perl
		1501
		1502	# AE::Util has been loaded in signal
		1503	$signal = sig2name $signal;
		1504	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1505
1090	$SIG{$signal} ||= sub {	1506	$SIG{$signal} ||= sub {
		1507	local $!;
1091	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1508	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1092	undef $SIG_EV{$signal};	1509	undef $SIG_EV{$signal};
		1510	};
		1511
		1512	# can't do signal processing without introducing races in pure perl,
		1513	# so limit the signal latency.
		1514	_sig_add;
		1515	}
		1516
		1517	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1518	};
		1519
		1520	*AnyEvent::Base::signal::DESTROY = sub {
		1521	my ($signal, $cb) = @{$_[0]};
		1522
		1523	_sig_del;
		1524
		1525	delete $SIG_CB{$signal}{$cb};
		1526
		1527	$HAVE_ASYNC_INTERRUPT
		1528	? delete $SIG_ASY{$signal}
		1529	: # delete doesn't work with older perls - they then
		1530	# print weird messages, or just unconditionally exit
		1531	# instead of getting the default action.
		1532	undef $SIG{$signal}
		1533	unless keys %{ $SIG_CB{$signal} };
		1534	};
1093	};	1535	};
1094		1536	die if $@;
1095	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1537	&signal
1096	}
1097
1098	sub AnyEvent::Base::Signal::DESTROY {
1099	my ($signal, $cb) = @{$_[0]};
1100
1101	delete $SIG_CB{$signal}{$cb};
1102
1103	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1104	}	1538	}
1105		1539
1106	# default implementation for ->child	1540	# default implementation for ->child
1107		1541
1108	our %PID_CB;	1542	our %PID_CB;
1109	our $CHLD_W;	1543	our $CHLD_W;
1110	our $CHLD_DELAY_W;	1544	our $CHLD_DELAY_W;
1111	our $PID_IDLE;
1112	our $WNOHANG;	1545	our $WNOHANG;
1113		1546
1114	sub _child_wait {	1547	sub _emit_childstatus($$) {
1115	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1548	my (undef, $rpid, $rstatus) = @_;
		1549
		1550	$_->($rpid, $rstatus)
1116	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1551	for values %{ $PID_CB{$rpid} || {} },
1117	(values %{ $PID_CB{0} || {} });	1552	values %{ $PID_CB{0} || {} };
1118	}
1119
1120	undef $PID_IDLE;
1121	}	1553	}
1122		1554
1123	sub _sigchld {	1555	sub _sigchld {
1124	# make sure we deliver these changes "synchronous" with the event loop.	1556	my $pid;
1125	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {	1557
1126	undef $CHLD_DELAY_W;	1558	AnyEvent->_emit_childstatus ($pid, $?)
1127	&_child_wait;	1559	while ($pid = waitpid -1, $WNOHANG) > 0;
1128	});
1129	}	1560	}
1130		1561
1131	sub child {	1562	sub child {
1132	my (undef, %arg) = @_;	1563	my (undef, %arg) = @_;
1133		1564
1134	defined (my $pid = $arg{pid} + 0)	1565	defined (my $pid = $arg{pid} + 0)
1135	or Carp::croak "required option 'pid' is missing";	1566	or Carp::croak "required option 'pid' is missing";
1136		1567
1137	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1568	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1138		1569
1139	unless ($WNOHANG) {	1570	# WNOHANG is almost cetrainly 1 everywhere
		1571	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
		1572	? 1
1140	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1573	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1141	}
1142		1574
1143	unless ($CHLD_W) {	1575	unless ($CHLD_W) {
1144	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1576	$CHLD_W = AE::signal CHLD => \&_sigchld;
1145	# child could be a zombie already, so make at least one round	1577	# child could be a zombie already, so make at least one round
1146	&_sigchld;	1578	&_sigchld;
1147	}	1579	}
1148		1580
1149	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1581	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1150	}	1582	}
1151		1583
1152	sub AnyEvent::Base::Child::DESTROY {	1584	sub AnyEvent::Base::child::DESTROY {
1153	my ($pid, $cb) = @{$_[0]};	1585	my ($pid, $cb) = @{$_[0]};
1154		1586
1155	delete $PID_CB{$pid}{$cb};	1587	delete $PID_CB{$pid}{$cb};
1156	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1588	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1157		1589
1158	undef $CHLD_W unless keys %PID_CB;	1590	undef $CHLD_W unless keys %PID_CB;
1159	}	1591	}
1160		1592
		1593	# idle emulation is done by simply using a timer, regardless
		1594	# of whether the process is idle or not, and not letting
		1595	# the callback use more than 50% of the time.
		1596	sub idle {
		1597	my (undef, %arg) = @_;
		1598
		1599	my ($cb, $w, $rcb) = $arg{cb};
		1600
		1601	$rcb = sub {
		1602	if ($cb) {
		1603	$w = _time;
		1604	&$cb;
		1605	$w = _time - $w;
		1606
		1607	# never use more then 50% of the time for the idle watcher,
		1608	# within some limits
		1609	$w = 0.0001 if $w < 0.0001;
		1610	$w = 5 if $w > 5;
		1611
		1612	$w = AE::timer $w, 0, $rcb;
		1613	} else {
		1614	# clean up...
		1615	undef $w;
		1616	undef $rcb;
		1617	}
		1618	};
		1619
		1620	$w = AE::timer 0.05, 0, $rcb;
		1621
		1622	bless \\$cb, "AnyEvent::Base::idle"
		1623	}
		1624
		1625	sub AnyEvent::Base::idle::DESTROY {
		1626	undef $${$_[0]};
		1627	}
		1628
1161	package AnyEvent::CondVar;	1629	package AnyEvent::CondVar;
1162		1630
1163	our @ISA = AnyEvent::CondVar::Base::;	1631	our @ISA = AnyEvent::CondVar::Base::;
1164		1632
1165	package AnyEvent::CondVar::Base;	1633	package AnyEvent::CondVar::Base;
1166		1634
1167	use overload	1635	#use overload
1168	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1636	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1169	fallback => 1;	1637	# fallback => 1;
		1638
		1639	# save 300+ kilobytes by dirtily hardcoding overloading
		1640	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1641	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1642	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1643	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1644
		1645	our $WAITING;
1170		1646
1171	sub _send {	1647	sub _send {
1172	# nop	1648	# nop
1173	}	1649	}
1174		1650
…		…
1187	sub ready {	1663	sub ready {
1188	$_[0]{_ae_sent}	1664	$_[0]{_ae_sent}
1189	}	1665	}
1190		1666
1191	sub _wait {	1667	sub _wait {
		1668	$WAITING
		1669	and !$_[0]{_ae_sent}
		1670	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1671
		1672	local $WAITING = 1;
1192	AnyEvent->one_event while !$_[0]{_ae_sent};	1673	AnyEvent->one_event while !$_[0]{_ae_sent};
1193	}	1674	}
1194		1675
1195	sub recv {	1676	sub recv {
1196	$_[0]->_wait;	1677	$_[0]->_wait;
…		…
1198	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1679	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1199	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1680	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1200	}	1681	}
1201		1682
1202	sub cb {	1683	sub cb {
1203	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1684	my $cv = shift;
		1685
		1686	@_
		1687	and $cv->{_ae_cb} = shift
		1688	and $cv->{_ae_sent}
		1689	and (delete $cv->{_ae_cb})->($cv);
		1690
1204	$_[0]{_ae_cb}	1691	$cv->{_ae_cb}
1205	}	1692	}
1206		1693
1207	sub begin {	1694	sub begin {
1208	++$_[0]{_ae_counter};	1695	++$_[0]{_ae_counter};
1209	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1696	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1237	so on.	1724	so on.
1238		1725
1239	=head1 ENVIRONMENT VARIABLES	1726	=head1 ENVIRONMENT VARIABLES
1240		1727
1241	The following environment variables are used by this module or its	1728	The following environment variables are used by this module or its
1242	submodules:	1729	submodules.
		1730
		1731	Note that AnyEvent will remove I<all> environment variables starting with
		1732	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1733	enabled.
1243		1734
1244	=over 4	1735	=over 4
1245		1736
1246	=item C<PERL_ANYEVENT_VERBOSE>	1737	=item C<PERL_ANYEVENT_VERBOSE>
1247		1738
…		…
1254	C<PERL_ANYEVENT_MODEL>.	1745	C<PERL_ANYEVENT_MODEL>.
1255		1746
1256	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1747	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1257	model it chooses.	1748	model it chooses.
1258		1749
		1750	When set to C<8> or higher, then AnyEvent will report extra information on
		1751	which optional modules it loads and how it implements certain features.
		1752
1259	=item C<PERL_ANYEVENT_STRICT>	1753	=item C<PERL_ANYEVENT_STRICT>
1260		1754
1261	AnyEvent does not do much argument checking by default, as thorough	1755	AnyEvent does not do much argument checking by default, as thorough
1262	argument checking is very costly. Setting this variable to a true value	1756	argument checking is very costly. Setting this variable to a true value
1263	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1757	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1264	check the arguments passed to most method calls. If it finds any problems	1758	check the arguments passed to most method calls. If it finds any problems,
1265	it will croak.	1759	it will croak.
1266		1760
1267	In other words, enables "strict" mode.	1761	In other words, enables "strict" mode.
1268		1762
1269	Unlike C<use strict>, it is definitely recommended ot keep it off in	1763	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1270	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1764	>>, it is definitely recommended to keep it off in production. Keeping
1271	developing programs can be very useful, however.	1765	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1766	can be very useful, however.
1272		1767
1273	=item C<PERL_ANYEVENT_MODEL>	1768	=item C<PERL_ANYEVENT_MODEL>
1274		1769
1275	This can be used to specify the event model to be used by AnyEvent, before	1770	This can be used to specify the event model to be used by AnyEvent, before
1276	auto detection and -probing kicks in. It must be a string consisting	1771	auto detection and -probing kicks in. It must be a string consisting
…		…
1319		1814
1320	=item C<PERL_ANYEVENT_MAX_FORKS>	1815	=item C<PERL_ANYEVENT_MAX_FORKS>
1321		1816
1322	The maximum number of child processes that C<AnyEvent::Util::fork_call>	1817	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1323	will create in parallel.	1818	will create in parallel.
		1819
		1820	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1821
		1822	The default value for the C<max_outstanding> parameter for the default DNS
		1823	resolver - this is the maximum number of parallel DNS requests that are
		1824	sent to the DNS server.
		1825
		1826	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1827
		1828	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1829	configuration) in the default resolver. When set to the empty string, no
		1830	default config will be used.
		1831
		1832	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1833
		1834	When neither C<ca_file> nor C<ca_path> was specified during
		1835	L<AnyEvent::TLS> context creation, and either of these environment
		1836	variables exist, they will be used to specify CA certificate locations
		1837	instead of a system-dependent default.
		1838
		1839	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1840
		1841	When these are set to C<1>, then the respective modules are not
		1842	loaded. Mostly good for testing AnyEvent itself.
1324		1843
1325	=back	1844	=back
1326		1845
1327	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1846	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1328		1847
…		…
1573	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2092	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1574	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2093	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1575	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2094	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1576	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2095	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1577	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2096	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
		2097	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
		2098	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1578	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2099	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1579	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2100	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1580	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2101	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1581	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2102	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1582		2103
…		…
1611	performance becomes really bad with lots of file descriptors (and few of	2132	performance becomes really bad with lots of file descriptors (and few of
1612	them active), of course, but this was not subject of this benchmark.	2133	them active), of course, but this was not subject of this benchmark.
1613		2134
1614	The C<Event> module has a relatively high setup and callback invocation	2135	The C<Event> module has a relatively high setup and callback invocation
1615	cost, but overall scores in on the third place.	2136	cost, but overall scores in on the third place.
		2137
		2138	C<IO::Async> performs admirably well, about on par with C<Event>, even
		2139	when using its pure perl backend.
1616		2140
1617	C<Glib>'s memory usage is quite a bit higher, but it features a	2141	C<Glib>'s memory usage is quite a bit higher, but it features a
1618	faster callback invocation and overall ends up in the same class as	2142	faster callback invocation and overall ends up in the same class as
1619	C<Event>. However, Glib scales extremely badly, doubling the number of	2143	C<Event>. However, Glib scales extremely badly, doubling the number of
1620	watchers increases the processing time by more than a factor of four,	2144	watchers increases the processing time by more than a factor of four,
…		…
1698	it to another server. This includes deleting the old timeout and creating	2222	it to another server. This includes deleting the old timeout and creating
1699	a new one that moves the timeout into the future.	2223	a new one that moves the timeout into the future.
1700		2224
1701	=head3 Results	2225	=head3 Results
1702		2226
1703	name sockets create request	2227	name sockets create request
1704	EV 20000 69.01 11.16	2228	EV 20000 69.01 11.16
1705	Perl 20000 73.32 35.87	2229	Perl 20000 73.32 35.87
		2230	IOAsync 20000 157.00 98.14 epoll
		2231	IOAsync 20000 159.31 616.06 poll
1706	Event 20000 212.62 257.32	2232	Event 20000 212.62 257.32
1707	Glib 20000 651.16 1896.30	2233	Glib 20000 651.16 1896.30
1708	POE 20000 349.67 12317.24 uses POE::Loop::Event	2234	POE 20000 349.67 12317.24 uses POE::Loop::Event
1709		2235
1710	=head3 Discussion	2236	=head3 Discussion
1711		2237
1712	This benchmark I<does> measure scalability and overall performance of the	2238	This benchmark I<does> measure scalability and overall performance of the
1713	particular event loop.	2239	particular event loop.
…		…
1715	EV is again fastest. Since it is using epoll on my system, the setup time	2241	EV is again fastest. Since it is using epoll on my system, the setup time
1716	is relatively high, though.	2242	is relatively high, though.
1717		2243
1718	Perl surprisingly comes second. It is much faster than the C-based event	2244	Perl surprisingly comes second. It is much faster than the C-based event
1719	loops Event and Glib.	2245	loops Event and Glib.
		2246
		2247	IO::Async performs very well when using its epoll backend, and still quite
		2248	good compared to Glib when using its pure perl backend.
1720		2249
1721	Event suffers from high setup time as well (look at its code and you will	2250	Event suffers from high setup time as well (look at its code and you will
1722	understand why). Callback invocation also has a high overhead compared to	2251	understand why). Callback invocation also has a high overhead compared to
1723	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2252	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1724	uses select or poll in basically all documented configurations.	2253	uses select or poll in basically all documented configurations.
…		…
1787	=item * C-based event loops perform very well with small number of	2316	=item * C-based event loops perform very well with small number of
1788	watchers, as the management overhead dominates.	2317	watchers, as the management overhead dominates.
1789		2318
1790	=back	2319	=back
1791		2320
		2321	=head2 THE IO::Lambda BENCHMARK
		2322
		2323	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2324	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2325	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2326	shouldn't come as a surprise to anybody). As such, the benchmark is
		2327	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2328	very optimal. But how would AnyEvent compare when used without the extra
		2329	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2330
		2331	The benchmark itself creates an echo-server, and then, for 500 times,
		2332	connects to the echo server, sends a line, waits for the reply, and then
		2333	creates the next connection. This is a rather bad benchmark, as it doesn't
		2334	test the efficiency of the framework or much non-blocking I/O, but it is a
		2335	benchmark nevertheless.
		2336
		2337	name runtime
		2338	Lambda/select 0.330 sec
		2339	+ optimized 0.122 sec
		2340	Lambda/AnyEvent 0.327 sec
		2341	+ optimized 0.138 sec
		2342	Raw sockets/select 0.077 sec
		2343	POE/select, components 0.662 sec
		2344	POE/select, raw sockets 0.226 sec
		2345	POE/select, optimized 0.404 sec
		2346
		2347	AnyEvent/select/nb 0.085 sec
		2348	AnyEvent/EV/nb 0.068 sec
		2349	+state machine 0.134 sec
		2350
		2351	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2352	benchmarks actually make blocking connects and use 100% blocking I/O,
		2353	defeating the purpose of an event-based solution. All of the newly
		2354	written AnyEvent benchmarks use 100% non-blocking connects (using
		2355	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2356	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2357	generally require a lot more bookkeeping and event handling than blocking
		2358	connects (which involve a single syscall only).
		2359
		2360	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2361	offers similar expressive power as POE and IO::Lambda, using conventional
		2362	Perl syntax. This means that both the echo server and the client are 100%
		2363	non-blocking, further placing it at a disadvantage.
		2364
		2365	As you can see, the AnyEvent + EV combination even beats the
		2366	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2367	backend easily beats IO::Lambda and POE.
		2368
		2369	And even the 100% non-blocking version written using the high-level (and
		2370	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
		2371	large margin, even though it does all of DNS, tcp-connect and socket I/O
		2372	in a non-blocking way.
		2373
		2374	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2375	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2376	part of the IO::lambda distribution and were used without any changes.
		2377
1792		2378
1793	=head1 SIGNALS	2379	=head1 SIGNALS
1794		2380
1795	AnyEvent currently installs handlers for these signals:	2381	AnyEvent currently installs handlers for these signals:
1796		2382
…		…
1799	=item SIGCHLD	2385	=item SIGCHLD
1800		2386
1801	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2387	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1802	emulation for event loops that do not support them natively. Also, some	2388	emulation for event loops that do not support them natively. Also, some
1803	event loops install a similar handler.	2389	event loops install a similar handler.
		2390
		2391	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2392	AnyEvent will reset it to default, to avoid losing child exit statuses.
1804		2393
1805	=item SIGPIPE	2394	=item SIGPIPE
1806		2395
1807	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2396	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1808	when AnyEvent gets loaded.	2397	when AnyEvent gets loaded.
…		…
1820		2409
1821	=back	2410	=back
1822		2411
1823	=cut	2412	=cut
1824		2413
		2414	undef $SIG{CHLD}
		2415	if $SIG{CHLD} eq 'IGNORE';
		2416
1825	$SIG{PIPE} = sub { }	2417	$SIG{PIPE} = sub { }
1826	unless defined $SIG{PIPE};	2418	unless defined $SIG{PIPE};
		2419
		2420	=head1 RECOMMENDED/OPTIONAL MODULES
		2421
		2422	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2423	it's built-in modules) are required to use it.
		2424
		2425	That does not mean that AnyEvent won't take advantage of some additional
		2426	modules if they are installed.
		2427
		2428	This section epxlains which additional modules will be used, and how they
		2429	affect AnyEvent's operetion.
		2430
		2431	=over 4
		2432
		2433	=item L<Async::Interrupt>
		2434
		2435	This slightly arcane module is used to implement fast signal handling: To
		2436	my knowledge, there is no way to do completely race-free and quick
		2437	signal handling in pure perl. To ensure that signals still get
		2438	delivered, AnyEvent will start an interval timer to wake up perl (and
		2439	catch the signals) with some delay (default is 10 seconds, look for
		2440	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2441
		2442	If this module is available, then it will be used to implement signal
		2443	catching, which means that signals will not be delayed, and the event loop
		2444	will not be interrupted regularly, which is more efficient (And good for
		2445	battery life on laptops).
		2446
		2447	This affects not just the pure-perl event loop, but also other event loops
		2448	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2449
		2450	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2451	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2452	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2453	does nothing for those backends.
		2454
		2455	=item L<EV>
		2456
		2457	This module isn't really "optional", as it is simply one of the backend
		2458	event loops that AnyEvent can use. However, it is simply the best event
		2459	loop available in terms of features, speed and stability: It supports
		2460	the AnyEvent API optimally, implements all the watcher types in XS, does
		2461	automatic timer adjustments even when no monotonic clock is available,
		2462	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2463	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2464	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2465
		2466	=item L<Guard>
		2467
		2468	The guard module, when used, will be used to implement
		2469	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2470	lot less memory), but otherwise doesn't affect guard operation much. It is
		2471	purely used for performance.
		2472
		2473	=item L<JSON> and L<JSON::XS>
		2474
		2475	This module is required when you want to read or write JSON data via
		2476	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2477	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2478
		2479	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2480	installed.
		2481
		2482	=item L<Net::SSLeay>
		2483
		2484	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2485	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2486	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2487
		2488	=item L<Time::HiRes>
		2489
		2490	This module is part of perl since release 5.008. It will be used when the
		2491	chosen event library does not come with a timing source on it's own. The
		2492	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2493	try to use a monotonic clock for timing stability.
		2494
		2495	=back
1827		2496
1828		2497
1829	=head1 FORK	2498	=head1 FORK
1830		2499
1831	Most event libraries are not fork-safe. The ones who are usually are	2500	Most event libraries are not fork-safe. The ones who are usually are
1832	because they rely on inefficient but fork-safe C<select> or C<poll>	2501	because they rely on inefficient but fork-safe C<select> or C<poll>
1833	calls. Only L<EV> is fully fork-aware.	2502	calls. Only L<EV> is fully fork-aware.
1834		2503
1835	If you have to fork, you must either do so I<before> creating your first	2504	If you have to fork, you must either do so I<before> creating your first
1836	watcher OR you must not use AnyEvent at all in the child.	2505	watcher OR you must not use AnyEvent at all in the child OR you must do
		2506	something completely out of the scope of AnyEvent.
1837		2507
1838		2508
1839	=head1 SECURITY CONSIDERATIONS	2509	=head1 SECURITY CONSIDERATIONS
1840		2510
1841	AnyEvent can be forced to load any event model via	2511	AnyEvent can be forced to load any event model via
…		…
1853	use AnyEvent;	2523	use AnyEvent;
1854		2524
1855	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2525	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1856	be used to probe what backend is used and gain other information (which is	2526	be used to probe what backend is used and gain other information (which is
1857	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and	2527	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1858	$ENV{PERL_ANYEGENT_STRICT}.	2528	$ENV{PERL_ANYEVENT_STRICT}.
		2529
		2530	Note that AnyEvent will remove I<all> environment variables starting with
		2531	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2532	enabled.
1859		2533
1860		2534
1861	=head1 BUGS	2535	=head1 BUGS
1862		2536
1863	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	2537	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
…		…
1875	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2549	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1876		2550
1877	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2551	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1878	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2552	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1879	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2553	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1880	L<AnyEvent::Impl::POE>.	2554	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1881		2555
1882	Non-blocking file handles, sockets, TCP clients and	2556	Non-blocking file handles, sockets, TCP clients and
1883	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2557	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1884		2558
1885	Asynchronous DNS: L<AnyEvent::DNS>.	2559	Asynchronous DNS: L<AnyEvent::DNS>.
1886		2560
1887	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2561	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2562	L<Coro::Event>,
1888		2563
1889	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2564	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2565	L<AnyEvent::HTTP>.
1890		2566
1891		2567
1892	=head1 AUTHOR	2568	=head1 AUTHOR
1893		2569
1894	Marc Lehmann <schmorp@schmorp.de>	2570	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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