ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

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

Diff Legend

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