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.326 by root, Sun Jun 6 10:11:56 2010 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	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
		15	# file handle or descriptor readable
11	my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
12		17
		18	# one-shot or repeating timers
13	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
14	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
15		21
16	print AnyEvent->now; # prints current event loop time	22	print AnyEvent->now; # prints current event loop time
17	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.	23	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
18		24
		25	# POSIX signal
19	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });	26	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
20		27
		28	# child process exit
21	my $w = AnyEvent->child (pid => $pid, cb => sub {	29	my $w = AnyEvent->child (pid => $pid, cb => sub {
22	my ($pid, $status) = @_;	30	my ($pid, $status) = @_;
23	...	31	...
24	});	32	});
		33
		34	# called when event loop idle (if applicable)
		35	my $w = AnyEvent->idle (cb => sub { ... });
25		36
26	my $w = AnyEvent->condvar; # stores whether a condition was flagged	37	my $w = AnyEvent->condvar; # stores whether a condition was flagged
27	$w->send; # wake up current and all future recv's	38	$w->send; # wake up current and all future recv's
28	$w->recv; # enters "main loop" till $condvar gets ->send	39	$w->recv; # enters "main loop" till $condvar gets ->send
29	# use a condvar in callback mode:	40	# use a condvar in callback mode:
…		…
32	=head1 INTRODUCTION/TUTORIAL	43	=head1 INTRODUCTION/TUTORIAL
33		44
34	This manpage is mainly a reference manual. If you are interested	45	This manpage is mainly a reference manual. If you are interested
35	in a tutorial or some gentle introduction, have a look at the	46	in a tutorial or some gentle introduction, have a look at the
36	L<AnyEvent::Intro> manpage.	47	L<AnyEvent::Intro> manpage.
		48
		49	=head1 SUPPORT
		50
		51	There is a mailinglist for discussing all things AnyEvent, and an IRC
		52	channel, too.
		53
		54	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		55	Repository>, at L<http://anyevent.schmorp.de>, for more info.
37		56
38	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	57	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
39		58
40	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	59	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
41	nowadays. So what is different about AnyEvent?	60	nowadays. So what is different about AnyEvent?
…		…
165	my variables are only visible after the statement in which they are	184	my variables are only visible after the statement in which they are
166	declared.	185	declared.
167		186
168	=head2 I/O WATCHERS	187	=head2 I/O WATCHERS
169		188
		189	$w = AnyEvent->io (
		190	fh => <filehandle_or_fileno>,
		191	poll => <"r" or "w">,
		192	cb => <callback>,
		193	);
		194
170	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	195	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
171	with the following mandatory key-value pairs as arguments:	196	with the following mandatory key-value pairs as arguments:
172		197
173	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events	198	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>	199	for events (AnyEvent might or might not keep a reference to this file
		200	handle). Note that only file handles pointing to things for which
		201	non-blocking operation makes sense are allowed. This includes sockets,
		202	most character devices, pipes, fifos and so on, but not for example files
		203	or block devices.
		204
175	must be a string that is either C<r> or C<w>, which creates a watcher	205	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	206	watcher waiting for "r"eadable or "w"ritable events, respectively.
		207
177	callback to invoke each time the file handle becomes ready.	208	C<cb> is the callback to invoke each time the file handle becomes ready.
178		209
179	Although the callback might get passed parameters, their value and	210	Although the callback might get passed parameters, their value and
180	presence is undefined and you cannot rely on them. Portable AnyEvent	211	presence is undefined and you cannot rely on them. Portable AnyEvent
181	callbacks cannot use arguments passed to I/O watcher callbacks.	212	callbacks cannot use arguments passed to I/O watcher callbacks.
182		213
…		…
197	undef $w;	228	undef $w;
198	});	229	});
199		230
200	=head2 TIME WATCHERS	231	=head2 TIME WATCHERS
201		232
		233	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		234
		235	$w = AnyEvent->timer (
		236	after => <fractional_seconds>,
		237	interval => <fractional_seconds>,
		238	cb => <callback>,
		239	);
		240
202	You can create a time watcher by calling the C<< AnyEvent->timer >>	241	You can create a time watcher by calling the C<< AnyEvent->timer >>
203	method with the following mandatory arguments:	242	method with the following mandatory arguments:
204		243
205	C<after> specifies after how many seconds (fractional values are	244	C<after> specifies after how many seconds (fractional values are
206	supported) the callback should be invoked. C<cb> is the callback to invoke	245	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	353	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	354	can get whatever behaviour you want with any event loop, by taking the
316	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	355	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
317	account.	356	account.
318		357
		358	=item AnyEvent->now_update
		359
		360	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
		361	the current time for each loop iteration (see the discussion of L<<
		362	AnyEvent->now >>, above).
		363
		364	When a callback runs for a long time (or when the process sleeps), then
		365	this "current" time will differ substantially from the real time, which
		366	might affect timers and time-outs.
		367
		368	When this is the case, you can call this method, which will update the
		369	event loop's idea of "current time".
		370
		371	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		372	when mod_perl executes the script, then the event loop will have the wrong
		373	idea about the "current time" (being potentially far in the past, when the
		374	script ran the last time). In that case you should arrange a call to C<<
		375	AnyEvent->now_update >> each time the web server process wakes up again
		376	(e.g. at the start of your script, or in a handler).
		377
		378	Note that updating the time I<might> cause some events to be handled.
		379
319	=back	380	=back
320		381
321	=head2 SIGNAL WATCHERS	382	=head2 SIGNAL WATCHERS
		383
		384	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
322		385
323	You can watch for signals using a signal watcher, C<signal> is the signal	386	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	387	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
325	callback to be invoked whenever a signal occurs.	388	callback to be invoked whenever a signal occurs.
326		389
…		…
332	invocation, and callback invocation will be synchronous. Synchronous means	395	invocation, and callback invocation will be synchronous. Synchronous means
333	that it might take a while until the signal gets handled by the process,	396	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.	397	but it is guaranteed not to interrupt any other callbacks.
335		398
336	The main advantage of using these watchers is that you can share a signal	399	The main advantage of using these watchers is that you can share a signal
337	between multiple watchers.	400	between multiple watchers, and AnyEvent will ensure that signals will not
		401	interrupt your program at bad times.
338		402
339	This watcher might use C<%SIG>, so programs overwriting those signals	403	This watcher might use C<%SIG> (depending on the event loop used),
340	directly will likely not work correctly.	404	so programs overwriting those signals directly will likely not work
		405	correctly.
341		406
342	Example: exit on SIGINT	407	Example: exit on SIGINT
343		408
344	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	409	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
345		410
		411	=head3 Restart Behaviour
		412
		413	While restart behaviour is up to the event loop implementation, most will
		414	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		415	pure perl implementation).
		416
		417	=head3 Safe/Unsafe Signals
		418
		419	Perl signals can be either "safe" (synchronous to opcode handling) or
		420	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		421	latter might corrupt your memory.
		422
		423	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		424	i.e. they will not interrupt your running perl program but will only be
		425	called as part of the normal event handling (just like timer, I/O etc.
		426	callbacks, too).
		427
		428	=head3 Signal Races, Delays and Workarounds
		429
		430	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		431	callbacks to signals in a generic way, which is a pity, as you cannot
		432	do race-free signal handling in perl, requiring C libraries for
		433	this. AnyEvent will try to do it's best, which means in some cases,
		434	signals will be delayed. The maximum time a signal might be delayed is
		435	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
		436	variable can be changed only before the first signal watcher is created,
		437	and should be left alone otherwise. This variable determines how often
		438	AnyEvent polls for signals (in case a wake-up was missed). Higher values
		439	will cause fewer spurious wake-ups, which is better for power and CPU
		440	saving.
		441
		442	All these problems can be avoided by installing the optional
		443	L<Async::Interrupt> module, which works with most event loops. It will not
		444	work with inherently broken event loops such as L<Event> or L<Event::Lib>
		445	(and not with L<POE> currently, as POE does it's own workaround with
		446	one-second latency). For those, you just have to suffer the delays.
		447
346	=head2 CHILD PROCESS WATCHERS	448	=head2 CHILD PROCESS WATCHERS
347		449
		450	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		451
348	You can also watch on a child process exit and catch its exit status.	452	You can also watch on a child process exit and catch its exit status.
349		453
350	The child process is specified by the C<pid> argument (if set to C<0>, it	454	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	455	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	456	croak). The watcher will be triggered only when the child process has
353	any trace events (stopped/continued).	457	finished and an exit status is available, not on any trace events
		458	(stopped/continued).
354		459
355	The callback will be called with the pid and exit status (as returned by	460	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	461	waitpid), so unlike other watcher types, you I<can> rely on child watcher
357	callback arguments.	462	callback arguments.
358		463
…		…
363		468
364	There is a slight catch to child watchers, however: you usually start them	469	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	470	I<after> the child process was created, and this means the process could
366	have exited already (and no SIGCHLD will be sent anymore).	471	have exited already (and no SIGCHLD will be sent anymore).
367		472
368	Not all event models handle this correctly (POE doesn't), but even for	473	Not all event models handle this correctly (neither POE nor IO::Async do,
		474	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	475	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).	476	the process exits (i.e. before you fork in the first place). AnyEvent's
		477	pure perl event loop handles all cases correctly regardless of when you
		478	start the watcher.
371		479
372	This means you cannot create a child watcher as the very first thing in an	480	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	481	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>).	482	watcher before you C<fork> the child (alternatively, you can call
		483	C<AnyEvent::detect>).
		484
		485	As most event loops do not support waiting for child events, they will be
		486	emulated by AnyEvent in most cases, in which the latency and race problems
		487	mentioned in the description of signal watchers apply.
375		488
376	Example: fork a process and wait for it	489	Example: fork a process and wait for it
377		490
378	my $done = AnyEvent->condvar;	491	my $done = AnyEvent->condvar;
379		492
…		…
389	);	502	);
390		503
391	# do something else, then wait for process exit	504	# do something else, then wait for process exit
392	$done->recv;	505	$done->recv;
393		506
		507	=head2 IDLE WATCHERS
		508
		509	$w = AnyEvent->idle (cb => <callback>);
		510
		511	Repeatedly invoke the callback after the process becomes idle, until
		512	either the watcher is destroyed or new events have been detected.
		513
		514	Idle watchers are useful when there is a need to do something, but it
		515	is not so important (or wise) to do it instantly. The callback will be
		516	invoked only when there is "nothing better to do", which is usually
		517	defined as "all outstanding events have been handled and no new events
		518	have been detected". That means that idle watchers ideally get invoked
		519	when the event loop has just polled for new events but none have been
		520	detected. Instead of blocking to wait for more events, the idle watchers
		521	will be invoked.
		522
		523	Unfortunately, most event loops do not really support idle watchers (only
		524	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		525	will simply call the callback "from time to time".
		526
		527	Example: read lines from STDIN, but only process them when the
		528	program is otherwise idle:
		529
		530	my @lines; # read data
		531	my $idle_w;
		532	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		533	push @lines, scalar <STDIN>;
		534
		535	# start an idle watcher, if not already done
		536	$idle_w ||= AnyEvent->idle (cb => sub {
		537	# handle only one line, when there are lines left
		538	if (my $line = shift @lines) {
		539	print "handled when idle: $line";
		540	} else {
		541	# otherwise disable the idle watcher again
		542	undef $idle_w;
		543	}
		544	});
		545	});
		546
394	=head2 CONDITION VARIABLES	547	=head2 CONDITION VARIABLES
		548
		549	$cv = AnyEvent->condvar;
		550
		551	$cv->send (<list>);
		552	my @res = $cv->recv;
395		553
396	If you are familiar with some event loops you will know that all of them	554	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	555	require you to run some blocking "loop", "run" or similar function that
398	will actively watch for new events and call your callbacks.	556	will actively watch for new events and call your callbacks.
399		557
400	AnyEvent is different, it expects somebody else to run the event loop and	558	AnyEvent is slightly different: it expects somebody else to run the event
401	will only block when necessary (usually when told by the user).	559	loop and will only block when necessary (usually when told by the user).
402		560
403	The instrument to do that is called a "condition variable", so called	561	The tool to do that is called a "condition variable", so called because
404	because they represent a condition that must become true.	562	they represent a condition that must become true.
		563
		564	Now is probably a good time to look at the examples further below.
405		565
406	Condition variables can be created by calling the C<< AnyEvent->condvar	566	Condition variables can be created by calling the C<< AnyEvent->condvar
407	>> method, usually without arguments. The only argument pair allowed is	567	>> 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	568	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	569	becomes true, with the condition variable as the first argument (but not
411	the results).	570	the results).
412		571
413	After creation, the condition variable is "false" until it becomes "true"	572	After creation, the condition variable is "false" until it becomes "true"
414	by calling the C<send> method (or calling the condition variable as if it	573	by calling the C<send> method (or calling the condition variable as if it
415	were a callback, read about the caveats in the description for the C<<	574	were a callback, read about the caveats in the description for the C<<
416	->send >> method).	575	->send >> method).
417		576
418	Condition variables are similar to callbacks, except that you can	577	Since condition variables are the most complex part of the AnyEvent API, here are
419	optionally wait for them. They can also be called merge points - points	578	some different mental models of what they are - pick the ones you can connect to:
420	in time where multiple outstanding events have been processed. And yet	579
421	another way to call them is transactions - each condition variable can be	580	=over 4
422	used to represent a transaction, which finishes at some point and delivers	581
423	a result.	582	=item * Condition variables are like callbacks - you can call them (and pass them instead
		583	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		584
		585	=item * Condition variables are signals - one side can emit or send them,
		586	the other side can wait for them, or install a handler that is called when
		587	the signal fires.
		588
		589	=item * Condition variables are like "Merge Points" - points in your program
		590	where you merge multiple independent results/control flows into one.
		591
		592	=item * Condition variables represent a transaction - function that start
		593	some kind of transaction can return them, leaving the caller the choice
		594	between waiting in a blocking fashion, or setting a callback.
		595
		596	=item * Condition variables represent future values, or promises to deliver
		597	some result, long before the result is available.
		598
		599	=back
424		600
425	Condition variables are very useful to signal that something has finished,	601	Condition variables are very useful to signal that something has finished,
426	for example, if you write a module that does asynchronous http requests,	602	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	603	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	604	availability of results. The user can either act when the callback is
…		…
449	eventually calls C<< -> send >>, and the "consumer side", which waits	625	eventually calls C<< -> send >>, and the "consumer side", which waits
450	for the send to occur.	626	for the send to occur.
451		627
452	Example: wait for a timer.	628	Example: wait for a timer.
453		629
454	# wait till the result is ready	630	# condition: "wait till the timer is fired"
455	my $result_ready = AnyEvent->condvar;	631	my $timer_fired = AnyEvent->condvar;
456		632
457	# do something such as adding a timer	633	# create the timer - we could wait for, say
458	# or socket watcher the calls $result_ready->send	634	# a handle becomign ready, or even an
459	# when the "result" is ready.	635	# AnyEvent::HTTP request to finish, but
460	# in this case, we simply use a timer:	636	# in this case, we simply use a timer:
461	my $w = AnyEvent->timer (	637	my $w = AnyEvent->timer (
462	after => 1,	638	after => 1,
463	cb => sub { $result_ready->send },	639	cb => sub { $timer_fired->send },
464	);	640	);
465		641
466	# this "blocks" (while handling events) till the callback	642	# this "blocks" (while handling events) till the callback
467	# calls send	643	# calls ->send
468	$result_ready->recv;	644	$timer_fired->recv;
469		645
470	Example: wait for a timer, but take advantage of the fact that	646	Example: wait for a timer, but take advantage of the fact that condition
471	condition variables are also code references.	647	variables are also callable directly.
472		648
473	my $done = AnyEvent->condvar;	649	my $done = AnyEvent->condvar;
474	my $delay = AnyEvent->timer (after => 5, cb => $done);	650	my $delay = AnyEvent->timer (after => 5, cb => $done);
475	$done->recv;	651	$done->recv;
476		652
…		…
482		658
483	...	659	...
484		660
485	my @info = $couchdb->info->recv;	661	my @info = $couchdb->info->recv;
486		662
487	And this is how you would just ste a callback to be called whenever the	663	And this is how you would just set a callback to be called whenever the
488	results are available:	664	results are available:
489		665
490	$couchdb->info->cb (sub {	666	$couchdb->info->cb (sub {
491	my @info = $_[0]->recv;	667	my @info = $_[0]->recv;
492	});	668	});
…		…
510	immediately from within send.	686	immediately from within send.
511		687
512	Any arguments passed to the C<send> call will be returned by all	688	Any arguments passed to the C<send> call will be returned by all
513	future C<< ->recv >> calls.	689	future C<< ->recv >> calls.
514		690
515	Condition variables are overloaded so one can call them directly	691	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	692	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	693	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		694
524	=item $cv->croak ($error)	695	=item $cv->croak ($error)
525		696
526	Similar to send, but causes all call's to C<< ->recv >> to invoke	697	Similar to send, but causes all call's to C<< ->recv >> to invoke
527	C<Carp::croak> with the given error message/object/scalar.	698	C<Carp::croak> with the given error message/object/scalar.
528		699
529	This can be used to signal any errors to the condition variable	700	This can be used to signal any errors to the condition variable
530	user/consumer.	701	user/consumer. Doing it this way instead of calling C<croak> directly
		702	delays the error detetcion, but has the overwhelmign advantage that it
		703	diagnoses the error at the place where the result is expected, and not
		704	deep in some event clalback without connection to the actual code causing
		705	the problem.
531		706
532	=item $cv->begin ([group callback])	707	=item $cv->begin ([group callback])
533		708
534	=item $cv->end	709	=item $cv->end
535
536	These two methods are EXPERIMENTAL and MIGHT CHANGE.
537		710
538	These two methods can be used to combine many transactions/events into	711	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	712	one. For example, a function that pings many hosts in parallel might want
540	to use a condition variable for the whole process.	713	to use a condition variable for the whole process.
541		714
542	Every call to C<< ->begin >> will increment a counter, and every call to	715	Every call to C<< ->begin >> will increment a counter, and every call to
543	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	716	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	717	>>, the (last) callback passed to C<begin> will be executed, passing the
545	is I<supposed> to call C<< ->send >>, but that is not required. If no	718	condvar as first argument. That callback is I<supposed> to call C<< ->send
546	callback was set, C<send> will be called without any arguments.	719	>>, but that is not required. If no group callback was set, C<send> will
		720	be called without any arguments.
547		721
548	Let's clarify this with the ping example:	722	You can think of C<< $cv->send >> giving you an OR condition (one call
		723	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
		724	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
		725
		726	Let's start with a simple example: you have two I/O watchers (for example,
		727	STDOUT and STDERR for a program), and you want to wait for both streams to
		728	close before activating a condvar:
549		729
550	my $cv = AnyEvent->condvar;	730	my $cv = AnyEvent->condvar;
551		731
		732	$cv->begin; # first watcher
		733	my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
		734	defined sysread $fh1, my $buf, 4096
		735	or $cv->end;
		736	});
		737
		738	$cv->begin; # second watcher
		739	my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
		740	defined sysread $fh2, my $buf, 4096
		741	or $cv->end;
		742	});
		743
		744	$cv->recv;
		745
		746	This works because for every event source (EOF on file handle), there is
		747	one call to C<begin>, so the condvar waits for all calls to C<end> before
		748	sending.
		749
		750	The ping example mentioned above is slightly more complicated, as the
		751	there are results to be passwd back, and the number of tasks that are
		752	begung can potentially be zero:
		753
		754	my $cv = AnyEvent->condvar;
		755
552	my %result;	756	my %result;
553	$cv->begin (sub { $cv->send (\%result) });	757	$cv->begin (sub { shift->send (\%result) });
554		758
555	for my $host (@list_of_hosts) {	759	for my $host (@list_of_hosts) {
556	$cv->begin;	760	$cv->begin;
557	ping_host_then_call_callback $host, sub {	761	ping_host_then_call_callback $host, sub {
558	$result{$host} = ...;	762	$result{$host} = ...;
…		…
573	loop, which serves two important purposes: first, it sets the callback	777	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	778	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	779	C<send> is called even when C<no> hosts are being pinged (the loop
576	doesn't execute once).	780	doesn't execute once).
577		781
578	This is the general pattern when you "fan out" into multiple subrequests:	782	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>	783	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	784	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>.	785	subrequest you start, call C<begin> and for each subrequest you finish,
		786	call C<end>.
582		787
583	=back	788	=back
584		789
585	=head3 METHODS FOR CONSUMERS	790	=head3 METHODS FOR CONSUMERS
586		791
…		…
602	function will call C<croak>.	807	function will call C<croak>.
603		808
604	In list context, all parameters passed to C<send> will be returned,	809	In list context, all parameters passed to C<send> will be returned,
605	in scalar context only the first one will be returned.	810	in scalar context only the first one will be returned.
606		811
		812	Note that doing a blocking wait in a callback is not supported by any
		813	event loop, that is, recursive invocation of a blocking C<< ->recv
		814	>> is not allowed, and the C<recv> call will C<croak> if such a
		815	condition is detected. This condition can be slightly loosened by using
		816	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		817	any thread that doesn't run the event loop itself.
		818
607	Not all event models support a blocking wait - some die in that case	819	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	820	(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	821	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	822	caller decide whether the call will block or not (for example, by coupling
611	condition variables with some kind of request results and supporting	823	condition variables with some kind of request results and supporting
612	callbacks so the caller knows that getting the result will not block,	824	callbacks so the caller knows that getting the result will not block,
613	while still supporting blocking waits if the caller so desires).	825	while still supporting blocking waits if the caller so desires).
614		826
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	827	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	828	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	829	time). This will work even when the event loop does not support blocking
629	waits otherwise.	830	waits otherwise.
630		831
…		…
636	=item $cb = $cv->cb ($cb->($cv))	837	=item $cb = $cv->cb ($cb->($cv))
637		838
638	This is a mutator function that returns the callback set and optionally	839	This is a mutator function that returns the callback set and optionally
639	replaces it before doing so.	840	replaces it before doing so.
640		841
641	The callback will be called when the condition becomes "true", i.e. when	842	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	843	"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	844	the only argument being the condition variable itself. Calling C<recv>
644	is guaranteed not to block.	845	inside the callback or at any later time is guaranteed not to block.
645		846
646	=back	847	=back
647		848
		849	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		850
		851	The available backend classes are (every class has its own manpage):
		852
		853	=over 4
		854
		855	=item Backends that are autoprobed when no other event loop can be found.
		856
		857	EV is the preferred backend when no other event loop seems to be in
		858	use. If EV is not installed, then AnyEvent will fall back to its own
		859	pure-perl implementation, which is available everywhere as it comes with
		860	AnyEvent itself.
		861
		862	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		863	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		864
		865	=item Backends that are transparently being picked up when they are used.
		866
		867	These will be used when they are currently loaded when the first watcher
		868	is created, in which case it is assumed that the application is using
		869	them. This means that AnyEvent will automatically pick the right backend
		870	when the main program loads an event module before anything starts to
		871	create watchers. Nothing special needs to be done by the main program.
		872
		873	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		874	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		875	AnyEvent::Impl::Tk based on Tk, very broken.
		876	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		877	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		878	AnyEvent::Impl::Irssi used when running within irssi.
		879
		880	=item Backends with special needs.
		881
		882	Qt requires the Qt::Application to be instantiated first, but will
		883	otherwise be picked up automatically. As long as the main program
		884	instantiates the application before any AnyEvent watchers are created,
		885	everything should just work.
		886
		887	AnyEvent::Impl::Qt based on Qt.
		888
		889	Support for IO::Async can only be partial, as it is too broken and
		890	architecturally limited to even support the AnyEvent API. It also
		891	is the only event loop that needs the loop to be set explicitly, so
		892	it can only be used by a main program knowing about AnyEvent. See
		893	L<AnyEvent::Impl::Async> for the gory details.
		894
		895	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		896
		897	=item Event loops that are indirectly supported via other backends.
		898
		899	Some event loops can be supported via other modules:
		900
		901	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		902
		903	B<WxWidgets> has no support for watching file handles. However, you can
		904	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		905	polls 20 times per second, which was considered to be too horrible to even
		906	consider for AnyEvent.
		907
		908	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		909	backend, so it can be supported through POE.
		910
		911	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		912	load L<POE> when detecting them, in the hope that POE will pick them up,
		913	in which case everything will be automatic.
		914
		915	=back
		916
648	=head1 GLOBAL VARIABLES AND FUNCTIONS	917	=head1 GLOBAL VARIABLES AND FUNCTIONS
649		918
		919	These are not normally required to use AnyEvent, but can be useful to
		920	write AnyEvent extension modules.
		921
650	=over 4	922	=over 4
651		923
652	=item $AnyEvent::MODEL	924	=item $AnyEvent::MODEL
653		925
654	Contains C<undef> until the first watcher is being created. Then it	926	Contains C<undef> until the first watcher is being created, before the
		927	backend has been autodetected.
		928
655	contains the event model that is being used, which is the name of the	929	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	930	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	931	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>).	932	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
659		933	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		934
681	=item AnyEvent::detect	935	=item AnyEvent::detect
682		936
683	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	937	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
684	if necessary. You should only call this function right before you would	938	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	939	have created an AnyEvent watcher anyway, that is, as late as possible at
686	runtime.	940	runtime, and not e.g. while initialising of your module.
		941
		942	If you need to do some initialisation before AnyEvent watchers are
		943	created, use C<post_detect>.
687		944
688	=item $guard = AnyEvent::post_detect { BLOCK }	945	=item $guard = AnyEvent::post_detect { BLOCK }
689		946
690	Arranges for the code block to be executed as soon as the event model is	947	Arranges for the code block to be executed as soon as the event model is
691	autodetected (or immediately if this has already happened).	948	autodetected (or immediately if this has already happened).
692		949
		950	The block will be executed I<after> the actual backend has been detected
		951	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		952	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		953	other initialisations - see the sources of L<AnyEvent::Strict> or
		954	L<AnyEvent::AIO> to see how this is used.
		955
		956	The most common usage is to create some global watchers, without forcing
		957	event module detection too early, for example, L<AnyEvent::AIO> creates
		958	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		959	avoid autodetecting the event module at load time.
		960
693	If called in scalar or list context, then it creates and returns an object	961	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	962	that automatically removes the callback again when it is destroyed (or
		963	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
695	L<Coro::BDB> for a case where this is useful.	964	a case where this is useful.
		965
		966	Example: Create a watcher for the IO::AIO module and store it in
		967	C<$WATCHER>. Only do so after the event loop is initialised, though.
		968
		969	our WATCHER;
		970
		971	my $guard = AnyEvent::post_detect {
		972	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		973	};
		974
		975	# the ||= is important in case post_detect immediately runs the block,
		976	# as to not clobber the newly-created watcher. assigning both watcher and
		977	# post_detect guard to the same variable has the advantage of users being
		978	# able to just C<undef $WATCHER> if the watcher causes them grief.
		979
		980	$WATCHER ||= $guard;
696		981
697	=item @AnyEvent::post_detect	982	=item @AnyEvent::post_detect
698		983
699	If there are any code references in this array (you can C<push> to it	984	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	985	before or after loading AnyEvent), then they will called directly after
701	the event loop has been chosen.	986	the event loop has been chosen.
702		987
703	You should check C<$AnyEvent::MODEL> before adding to this array, though:	988	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,	989	if it is defined then the event loop has already been detected, and the
705	and the array will be ignored.	990	array will be ignored.
706		991
707	Best use C<AnyEvent::post_detect { BLOCK }> instead.	992	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		993	it, as it takes care of these details.
		994
		995	This variable is mainly useful for modules that can do something useful
		996	when AnyEvent is used and thus want to know when it is initialised, but do
		997	not need to even load it by default. This array provides the means to hook
		998	into AnyEvent passively, without loading it.
		999
		1000	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1001	together, you could put this into Coro (this is the actual code used by
		1002	Coro to accomplish this):
		1003
		1004	if (defined $AnyEvent::MODEL) {
		1005	# AnyEvent already initialised, so load Coro::AnyEvent
		1006	require Coro::AnyEvent;
		1007	} else {
		1008	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1009	# as soon as it is
		1010	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1011	}
708		1012
709	=back	1013	=back
710		1014
711	=head1 WHAT TO DO IN A MODULE	1015	=head1 WHAT TO DO IN A MODULE
712		1016
…		…
767		1071
768		1072
769	=head1 OTHER MODULES	1073	=head1 OTHER MODULES
770		1074
771	The following is a non-exhaustive list of additional modules that use	1075	The following is a non-exhaustive list of additional modules that use
772	AnyEvent and can therefore be mixed easily with other AnyEvent modules	1076	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	1077	modules and other event loops in the same program. Some of the modules
774	available via CPAN.	1078	come as part of AnyEvent, the others are available via CPAN.
775		1079
776	=over 4	1080	=over 4
777		1081
778	=item L<AnyEvent::Util>	1082	=item L<AnyEvent::Util>
779		1083
…		…
788		1092
789	=item L<AnyEvent::Handle>	1093	=item L<AnyEvent::Handle>
790		1094
791	Provide read and write buffers, manages watchers for reads and writes,	1095	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	1096	supports raw and formatted I/O, I/O queued and fully transparent and
793	non-blocking SSL/TLS.	1097	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
794		1098
795	=item L<AnyEvent::DNS>	1099	=item L<AnyEvent::DNS>
796		1100
797	Provides rich asynchronous DNS resolver capabilities.	1101	Provides rich asynchronous DNS resolver capabilities.
798		1102
		1103	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1104
		1105	Implement event-based interfaces to the protocols of the same name (for
		1106	the curious, IGS is the International Go Server and FCP is the Freenet
		1107	Client Protocol).
		1108
		1109	=item L<AnyEvent::Handle::UDP>
		1110
		1111	Here be danger!
		1112
		1113	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1114	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1115	it's use of a stream-based API with a protocol that isn't streamable, that
		1116	the only way to improve it is to delete it.
		1117
		1118	It features data corruption (but typically only under load) and general
		1119	confusion. On top, the author is not only clueless about UDP but also
		1120	fact-resistant - some gems of his understanding: "connect doesn't work
		1121	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1122	packets", "I don't need to implement proper error checking as UDP doesn't
		1123	support error checking" and so on - he doesn't even understand what's
		1124	wrong with his module when it is explained to him.
		1125
799	=item L<AnyEvent::HTTP>	1126	=item L<AnyEvent::DBI>
800		1127
801	A simple-to-use HTTP library that is capable of making a lot of concurrent	1128	Executes L<DBI> requests asynchronously in a proxy process for you,
802	HTTP requests.	1129	notifying you in an event-bnased way when the operation is finished.
		1130
		1131	=item L<AnyEvent::AIO>
		1132
		1133	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1134	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1135	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1136	file I/O, and much more.
803		1137
804	=item L<AnyEvent::HTTPD>	1138	=item L<AnyEvent::HTTPD>
805		1139
806	Provides a simple web application server framework.	1140	A simple embedded webserver.
807		1141
808	=item L<AnyEvent::FastPing>	1142	=item L<AnyEvent::FastPing>
809		1143
810	The fastest ping in the west.	1144	The fastest ping in the west.
811		1145
812	=item L<AnyEvent::DBI>
813
814	Executes L<DBI> requests asynchronously in a proxy process.
815
816	=item L<AnyEvent::AIO>
817
818	Truly asynchronous I/O, should be in the toolbox of every event
819	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
820	together.
821
822	=item L<AnyEvent::BDB>
823
824	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
825	L<BDB> and AnyEvent together.
826
827	=item L<AnyEvent::GPSD>
828
829	A non-blocking interface to gpsd, a daemon delivering GPS information.
830
831	=item L<AnyEvent::IGS>
832
833	A non-blocking interface to the Internet Go Server protocol (used by
834	L<App::IGS>).
835
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>
845
846	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
847	of AnyEvent.
848
849	=item L<Event::ExecFlow>
850
851	High level API for event-based execution flow control.
852
853	=item L<Coro>	1146	=item L<Coro>
854		1147
855	Has special support for AnyEvent via L<Coro::AnyEvent>.	1148	Has special support for AnyEvent via L<Coro::AnyEvent>.
856		1149
857	=item L<IO::Lambda>
858
859	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
860
861	=back	1150	=back
862		1151
863	=cut	1152	=cut
864		1153
865	package AnyEvent;	1154	package AnyEvent;
866		1155
867	no warnings;	1156	# basically a tuned-down version of common::sense
868	use strict qw(vars subs);	1157	sub common_sense {
		1158	# from common:.sense 1.0
		1159	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
		1160	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
		1161	$^H |= 0x00000600;
		1162	}
869		1163
		1164	BEGIN { AnyEvent::common_sense }
		1165
870	use Carp;	1166	use Carp ();
871		1167
872	our $VERSION = 4.341;	1168	our $VERSION = '5.261';
873	our $MODEL;	1169	our $MODEL;
874		1170
875	our $AUTOLOAD;	1171	our $AUTOLOAD;
876	our @ISA;	1172	our @ISA;
877		1173
878	our @REGISTRY;	1174	our @REGISTRY;
879		1175
880	our $WIN32;	1176	our $VERBOSE;
881		1177
882	BEGIN {	1178	BEGIN {
883	my $win32 = ! ! ($^O =~ /mswin32/i);	1179	require "AnyEvent/constants.pl";
884	eval "sub WIN32(){ $win32 }";
885	}
886		1180
		1181	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
		1182
		1183	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1184	if ${^TAINT};
		1185
887	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1186	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1187
		1188	}
		1189
		1190	our $MAX_SIGNAL_LATENCY = 10;
888		1191
889	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1192	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
890		1193
891	{	1194	{
892	my $idx;	1195	my $idx;
…		…
894	for reverse split /\s*,\s*/,	1197	for reverse split /\s*,\s*/,
895	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1198	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
896	}	1199	}
897		1200
898	my @models = (	1201	my @models = (
899	[EV:: => AnyEvent::Impl::EV::],	1202	[EV:: => AnyEvent::Impl::EV:: , 1],
900	[Event:: => AnyEvent::Impl::Event::],
901	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1203	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
902	# everything below here will not be autoprobed	1204	# everything below here will not (normally) be autoprobed
903	# as the pureperl backend should work everywhere	1205	# as the pureperl backend should work everywhere
904	# and is usually faster	1206	# and is usually faster
		1207	[Event:: => AnyEvent::Impl::Event::, 1],
		1208	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
		1209	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1210	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
905	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1211	[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	1212	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
909	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1213	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
910	[Wx:: => AnyEvent::Impl::POE::],	1214	[Wx:: => AnyEvent::Impl::POE::],
911	[Prima:: => AnyEvent::Impl::POE::],	1215	[Prima:: => AnyEvent::Impl::POE::],
		1216	# IO::Async is just too broken - we would need workarounds for its
		1217	# byzantine signal and broken child handling, among others.
		1218	# IO::Async is rather hard to detect, as it doesn't have any
		1219	# obvious default class.
		1220	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1221	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1222	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1223	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
912	);	1224	);
913		1225
914	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);	1226	our %method = map +($_ => 1),
		1227	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
915		1228
916	our @post_detect;	1229	our @post_detect;
917		1230
918	sub post_detect(&) {	1231	sub post_detect(&) {
919	my ($cb) = @_;	1232	my ($cb) = @_;
920		1233
921	if ($MODEL) {
922	$cb->();
923
924	1
925	} else {
926	push @post_detect, $cb;	1234	push @post_detect, $cb;
927		1235
928	defined wantarray	1236	defined wantarray
929	? bless \$cb, "AnyEvent::Util::PostDetect"	1237	? bless \$cb, "AnyEvent::Util::postdetect"
930	: ()	1238	: ()
		1239	}
		1240
		1241	sub AnyEvent::Util::postdetect::DESTROY {
		1242	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		1243	}
		1244
		1245	sub detect() {
		1246	# free some memory
		1247	*detect = sub () { $MODEL };
		1248
		1249	local $!; # for good measure
		1250	local $SIG{__DIE__};
		1251
		1252	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1253	my $model = "AnyEvent::Impl::$1";
		1254	if (eval "require $model") {
		1255	$MODEL = $model;
		1256	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1257	} else {
		1258	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1259	}
931	}	1260	}
932	}
933		1261
934	sub AnyEvent::Util::PostDetect::DESTROY {	1262	# check for already loaded models
935	@post_detect = grep $_ != ${$_[0]}, @post_detect;
936	}
937
938	sub detect() {
939	unless ($MODEL) {	1263	unless ($MODEL) {
940	no strict 'refs';	1264	for (@REGISTRY, @models) {
941	local $SIG{__DIE__};	1265	my ($package, $model) = @$_;
942		1266	if (${"$package\::VERSION"} > 0) {
943	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
944	my $model = "AnyEvent::Impl::$1";
945	if (eval "require $model") {	1267	if (eval "require $model") {
946	$MODEL = $model;	1268	$MODEL = $model;
947	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1269	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
948	} else {	1270	last;
949	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1271	}
950	}	1272	}
951	}	1273	}
952		1274
953	# check for already loaded models
954	unless ($MODEL) {	1275	unless ($MODEL) {
		1276	# try to autoload a model
955	for (@REGISTRY, @models) {	1277	for (@REGISTRY, @models) {
956	my ($package, $model) = @$_;	1278	my ($package, $model, $autoload) = @$_;
		1279	if (
		1280	$autoload
		1281	and eval "require $package"
957	if (${"$package\::VERSION"} > 0) {	1282	and ${"$package\::VERSION"} > 0
958	if (eval "require $model") {	1283	and eval "require $model"
		1284	) {
959	$MODEL = $model;	1285	$MODEL = $model;
960	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1286	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
961	last;	1287	last;
962	}
963	}	1288	}
964	}	1289	}
965		1290
966	unless ($MODEL) {
967	# try to load a model
968
969	for (@REGISTRY, @models) {
970	my ($package, $model) = @$_;
971	if (eval "require $package"
972	and ${"$package\::VERSION"} > 0
973	and eval "require $model") {
974	$MODEL = $model;
975	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
976	last;
977	}
978	}
979
980	$MODEL	1291	$MODEL
981	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1292	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
982	}
983	}	1293	}
984
985	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
986
987	unshift @ISA, $MODEL;
988
989	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
990
991	(shift @post_detect)->() while @post_detect;
992	}	1294	}
		1295
		1296	@models = (); # free probe data
		1297
		1298	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1299	unshift @ISA, $MODEL;
		1300
		1301	# now nuke some methods that are overriden by the backend.
		1302	# SUPER is not allowed.
		1303	for (qw(time signal child idle)) {
		1304	undef &{"AnyEvent::Base::$_"}
		1305	if defined &{"$MODEL\::$_"};
		1306	}
		1307
		1308	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1309
		1310	(shift @post_detect)->() while @post_detect;
		1311
		1312	*post_detect = sub(&) {
		1313	shift->();
		1314
		1315	undef
		1316	};
993		1317
994	$MODEL	1318	$MODEL
995	}	1319	}
996		1320
997	sub AUTOLOAD {	1321	sub AUTOLOAD {
998	(my $func = $AUTOLOAD) =~ s/.*://;	1322	(my $func = $AUTOLOAD) =~ s/.*://;
999		1323
1000	$method{$func}	1324	$method{$func}
1001	or croak "$func: not a valid method for AnyEvent objects";	1325	or Carp::croak "$func: not a valid AnyEvent class method";
1002		1326
1003	detect unless $MODEL;	1327	detect;
1004		1328
1005	my $class = shift;	1329	my $class = shift;
1006	$class->$func (@_);	1330	$class->$func (@_);
1007	}	1331	}
1008		1332
1009	# utility function to dup a filehandle. this is used by many backends	1333	# utility function to dup a filehandle. this is used by many backends
1010	# to support binding more than one watcher per filehandle (they usually	1334	# 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).	1335	# allow only one watcher per fd, so we dup it to get a different one).
1012	sub _dupfh($$$$) {	1336	sub _dupfh($$;$$) {
1013	my ($poll, $fh, $r, $w) = @_;	1337	my ($poll, $fh, $r, $w) = @_;
1014		1338
1015	# cygwin requires the fh mode to be matching, unix doesn't	1339	# cygwin requires the fh mode to be matching, unix doesn't
1016	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1340	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		1341
1020	open my $fh2, "$mode&" . fileno $fh	1342	open my $fh2, $mode, $fh
1021	or die "cannot dup() filehandle: $!";	1343	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1022		1344
1023	# we assume CLOEXEC is already set by perl in all important cases	1345	# we assume CLOEXEC is already set by perl in all important cases
1024		1346
1025	($fh2, $rw)	1347	($fh2, $rw)
1026	}	1348	}
1027		1349
		1350	=head1 SIMPLIFIED AE API
		1351
		1352	Starting with version 5.0, AnyEvent officially supports a second, much
		1353	simpler, API that is designed to reduce the calling, typing and memory
		1354	overhead by using function call syntax and a fixed number of parameters.
		1355
		1356	See the L<AE> manpage for details.
		1357
		1358	=cut
		1359
		1360	package AE;
		1361
		1362	our $VERSION = $AnyEvent::VERSION;
		1363
		1364	# fall back to the main API by default - backends and AnyEvent::Base
		1365	# implementations can overwrite these.
		1366
		1367	sub io($$$) {
		1368	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1369	}
		1370
		1371	sub timer($$$) {
		1372	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1373	}
		1374
		1375	sub signal($$) {
		1376	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1377	}
		1378
		1379	sub child($$) {
		1380	AnyEvent->child (pid => $_[0], cb => $_[1])
		1381	}
		1382
		1383	sub idle($) {
		1384	AnyEvent->idle (cb => $_[0])
		1385	}
		1386
		1387	sub cv(;&) {
		1388	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1389	}
		1390
		1391	sub now() {
		1392	AnyEvent->now
		1393	}
		1394
		1395	sub now_update() {
		1396	AnyEvent->now_update
		1397	}
		1398
		1399	sub time() {
		1400	AnyEvent->time
		1401	}
		1402
1028	package AnyEvent::Base;	1403	package AnyEvent::Base;
1029		1404
1030	# default implementation for now and time	1405	# default implementations for many methods
1031		1406
1032	BEGIN {	1407	sub time {
		1408	eval q{ # poor man's autoloading {}
		1409	# probe for availability of Time::HiRes
1033	if (eval "use Time::HiRes (); time (); 1") {	1410	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1411	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1034	*_time = \&Time::HiRes::time;	1412	*AE::time = \&Time::HiRes::time;
1035	# if (eval "use POSIX (); (POSIX::times())...	1413	# if (eval "use POSIX (); (POSIX::times())...
1036	} else {	1414	} else {
		1415	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1037	*_time = sub { time }; # epic fail	1416	*AE::time = sub (){ time }; # epic fail
		1417	}
		1418
		1419	*time = sub { AE::time }; # different prototypes
		1420	};
		1421	die if $@;
		1422
		1423	&time
		1424	}
		1425
		1426	*now = \&time;
		1427
		1428	sub now_update { }
		1429
		1430	# default implementation for ->condvar
		1431
		1432	sub condvar {
		1433	eval q{ # poor man's autoloading {}
		1434	*condvar = sub {
		1435	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1436	};
		1437
		1438	*AE::cv = sub (;&) {
		1439	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1440	};
		1441	};
		1442	die if $@;
		1443
		1444	&condvar
		1445	}
		1446
		1447	# default implementation for ->signal
		1448
		1449	our $HAVE_ASYNC_INTERRUPT;
		1450
		1451	sub _have_async_interrupt() {
		1452	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1453	&& eval "use Async::Interrupt 1.02 (); 1")
		1454	unless defined $HAVE_ASYNC_INTERRUPT;
		1455
		1456	$HAVE_ASYNC_INTERRUPT
		1457	}
		1458
		1459	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1460	our (%SIG_ASY, %SIG_ASY_W);
		1461	our ($SIG_COUNT, $SIG_TW);
		1462
		1463	# install a dummy wakeup watcher to reduce signal catching latency
		1464	# used by Impls
		1465	sub _sig_add() {
		1466	unless ($SIG_COUNT++) {
		1467	# try to align timer on a full-second boundary, if possible
		1468	my $NOW = AE::now;
		1469
		1470	$SIG_TW = AE::timer
		1471	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1472	$MAX_SIGNAL_LATENCY,
		1473	sub { } # just for the PERL_ASYNC_CHECK
		1474	;
1038	}	1475	}
1039	}	1476	}
1040		1477
1041	sub time { _time }	1478	sub _sig_del {
1042	sub now { _time }	1479	undef $SIG_TW
1043		1480	unless --$SIG_COUNT;
1044	# default implementation for ->condvar
1045
1046	sub condvar {
1047	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
1048	}	1481	}
1049		1482
1050	# default implementation for ->signal	1483	our $_sig_name_init; $_sig_name_init = sub {
		1484	eval q{ # poor man's autoloading {}
		1485	undef $_sig_name_init;
1051		1486
1052	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1487	if (_have_async_interrupt) {
		1488	*sig2num = \&Async::Interrupt::sig2num;
		1489	*sig2name = \&Async::Interrupt::sig2name;
		1490	} else {
		1491	require Config;
1053		1492
1054	sub _signal_exec {	1493	my %signame2num;
1055	sysread $SIGPIPE_R, my $dummy, 4;	1494	@signame2num{ split ' ', $Config::Config{sig_name} }
		1495	= split ' ', $Config::Config{sig_num};
1056		1496
1057	while (%SIG_EV) {	1497	my @signum2name;
1058	for (keys %SIG_EV) {	1498	@signum2name[values %signame2num] = keys %signame2num;
1059	delete $SIG_EV{$_};	1499
1060	$_->() for values %{ $SIG_CB{$_} || {} };	1500	*sig2num = sub($) {
		1501	$_[0] > 0 ? shift : $signame2num{+shift}
		1502	};
		1503	*sig2name = sub ($) {
		1504	$_[0] > 0 ? $signum2name[+shift] : shift
		1505	};
1061	}	1506	}
1062	}	1507	};
1063	}	1508	die if $@;
		1509	};
		1510
		1511	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1512	sub sig2name($) { &$_sig_name_init; &sig2name }
1064		1513
1065	sub signal {	1514	sub signal {
1066	my (undef, %arg) = @_;	1515	eval q{ # poor man's autoloading {}
		1516	# probe for availability of Async::Interrupt
		1517	if (_have_async_interrupt) {
		1518	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1067		1519
1068	unless ($SIGPIPE_R) {	1520	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1069	if (AnyEvent::WIN32) {	1521	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1070	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1522
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 {	1523	} else {
		1524	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1525
		1526	if (AnyEvent::WIN32) {
		1527	require AnyEvent::Util;
		1528
		1529	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1530	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1531	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1532	} else {
1074	pipe $SIGPIPE_R, $SIGPIPE_W;	1533	pipe $SIGPIPE_R, $SIGPIPE_W;
1075	require Fcntl;
1076	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1534	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1077	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1535	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
		1536
		1537	# not strictly required, as $^F is normally 2, but let's make sure...
		1538	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1539	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1540	}
		1541
		1542	$SIGPIPE_R
		1543	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1544
		1545	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1078	}	1546	}
1079		1547
1080	$SIGPIPE_R	1548	*signal = $HAVE_ASYNC_INTERRUPT
1081	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1549	? sub {
		1550	my (undef, %arg) = @_;
1082		1551
1083	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1552	# async::interrupt
1084	}
1085
1086	my $signal = uc $arg{signal}	1553	my $signal = sig2num $arg{signal};
1087	or Carp::croak "required option 'signal' is missing";
1088
1089	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1554	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1555
		1556	$SIG_ASY{$signal} ||= new Async::Interrupt
		1557	cb => sub { undef $SIG_EV{$signal} },
		1558	signal => $signal,
		1559	pipe => [$SIGPIPE_R->filenos],
		1560	pipe_autodrain => 0,
		1561	;
		1562
		1563	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1564	}
		1565	: sub {
		1566	my (undef, %arg) = @_;
		1567
		1568	# pure perl
		1569	my $signal = sig2name $arg{signal};
		1570	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1571
1090	$SIG{$signal} ||= sub {	1572	$SIG{$signal} ||= sub {
		1573	local $!;
1091	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1574	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1092	undef $SIG_EV{$signal};	1575	undef $SIG_EV{$signal};
		1576	};
		1577
		1578	# can't do signal processing without introducing races in pure perl,
		1579	# so limit the signal latency.
		1580	_sig_add;
		1581
		1582	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1583	}
		1584	;
		1585
		1586	*AnyEvent::Base::signal::DESTROY = sub {
		1587	my ($signal, $cb) = @{$_[0]};
		1588
		1589	_sig_del;
		1590
		1591	delete $SIG_CB{$signal}{$cb};
		1592
		1593	$HAVE_ASYNC_INTERRUPT
		1594	? delete $SIG_ASY{$signal}
		1595	: # delete doesn't work with older perls - they then
		1596	# print weird messages, or just unconditionally exit
		1597	# instead of getting the default action.
		1598	undef $SIG{$signal}
		1599	unless keys %{ $SIG_CB{$signal} };
		1600	};
		1601
		1602	*_signal_exec = sub {
		1603	$HAVE_ASYNC_INTERRUPT
		1604	? $SIGPIPE_R->drain
		1605	: sysread $SIGPIPE_R, (my $dummy), 9;
		1606
		1607	while (%SIG_EV) {
		1608	for (keys %SIG_EV) {
		1609	delete $SIG_EV{$_};
		1610	$_->() for values %{ $SIG_CB{$_} || {} };
		1611	}
		1612	}
		1613	};
1093	};	1614	};
		1615	die if $@;
1094		1616
1095	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1617	&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	}	1618	}
1105		1619
1106	# default implementation for ->child	1620	# default implementation for ->child
1107		1621
1108	our %PID_CB;	1622	our %PID_CB;
1109	our $CHLD_W;	1623	our $CHLD_W;
1110	our $CHLD_DELAY_W;	1624	our $CHLD_DELAY_W;
1111	our $PID_IDLE;
1112	our $WNOHANG;	1625	our $WNOHANG;
1113		1626
1114	sub _child_wait {	1627	# used by many Impl's
1115	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1628	sub _emit_childstatus($$) {
		1629	my (undef, $rpid, $rstatus) = @_;
		1630
		1631	$_->($rpid, $rstatus)
1116	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1632	for values %{ $PID_CB{$rpid} || {} },
1117	(values %{ $PID_CB{0} || {} });	1633	values %{ $PID_CB{0} || {} };
1118	}
1119
1120	undef $PID_IDLE;
1121	}
1122
1123	sub _sigchld {
1124	# make sure we deliver these changes "synchronous" with the event loop.
1125	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1126	undef $CHLD_DELAY_W;
1127	&_child_wait;
1128	});
1129	}	1634	}
1130		1635
1131	sub child {	1636	sub child {
		1637	eval q{ # poor man's autoloading {}
		1638	*_sigchld = sub {
		1639	my $pid;
		1640
		1641	AnyEvent->_emit_childstatus ($pid, $?)
		1642	while ($pid = waitpid -1, $WNOHANG) > 0;
		1643	};
		1644
		1645	*child = sub {
1132	my (undef, %arg) = @_;	1646	my (undef, %arg) = @_;
1133		1647
1134	defined (my $pid = $arg{pid} + 0)	1648	defined (my $pid = $arg{pid} + 0)
1135	or Carp::croak "required option 'pid' is missing";	1649	or Carp::croak "required option 'pid' is missing";
1136		1650
1137	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1651	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1138		1652
1139	unless ($WNOHANG) {	1653	# WNOHANG is almost cetrainly 1 everywhere
		1654	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
		1655	? 1
1140	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1656	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1141	}
1142		1657
1143	unless ($CHLD_W) {	1658	unless ($CHLD_W) {
1144	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1659	$CHLD_W = AE::signal CHLD => \&_sigchld;
1145	# child could be a zombie already, so make at least one round	1660	# child could be a zombie already, so make at least one round
1146	&_sigchld;	1661	&_sigchld;
1147	}	1662	}
1148		1663
1149	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1664	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1150	}	1665	};
1151		1666
1152	sub AnyEvent::Base::Child::DESTROY {	1667	*AnyEvent::Base::child::DESTROY = sub {
1153	my ($pid, $cb) = @{$_[0]};	1668	my ($pid, $cb) = @{$_[0]};
1154		1669
1155	delete $PID_CB{$pid}{$cb};	1670	delete $PID_CB{$pid}{$cb};
1156	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1671	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1157		1672
1158	undef $CHLD_W unless keys %PID_CB;	1673	undef $CHLD_W unless keys %PID_CB;
		1674	};
		1675	};
		1676	die if $@;
		1677
		1678	&child
		1679	}
		1680
		1681	# idle emulation is done by simply using a timer, regardless
		1682	# of whether the process is idle or not, and not letting
		1683	# the callback use more than 50% of the time.
		1684	sub idle {
		1685	eval q{ # poor man's autoloading {}
		1686	*idle = sub {
		1687	my (undef, %arg) = @_;
		1688
		1689	my ($cb, $w, $rcb) = $arg{cb};
		1690
		1691	$rcb = sub {
		1692	if ($cb) {
		1693	$w = _time;
		1694	&$cb;
		1695	$w = _time - $w;
		1696
		1697	# never use more then 50% of the time for the idle watcher,
		1698	# within some limits
		1699	$w = 0.0001 if $w < 0.0001;
		1700	$w = 5 if $w > 5;
		1701
		1702	$w = AE::timer $w, 0, $rcb;
		1703	} else {
		1704	# clean up...
		1705	undef $w;
		1706	undef $rcb;
		1707	}
		1708	};
		1709
		1710	$w = AE::timer 0.05, 0, $rcb;
		1711
		1712	bless \\$cb, "AnyEvent::Base::idle"
		1713	};
		1714
		1715	*AnyEvent::Base::idle::DESTROY = sub {
		1716	undef $${$_[0]};
		1717	};
		1718	};
		1719	die if $@;
		1720
		1721	&idle
1159	}	1722	}
1160		1723
1161	package AnyEvent::CondVar;	1724	package AnyEvent::CondVar;
1162		1725
1163	our @ISA = AnyEvent::CondVar::Base::;	1726	our @ISA = AnyEvent::CondVar::Base::;
1164		1727
1165	package AnyEvent::CondVar::Base;	1728	package AnyEvent::CondVar::Base;
1166		1729
1167	use overload	1730	#use overload
1168	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1731	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1169	fallback => 1;	1732	# fallback => 1;
		1733
		1734	# save 300+ kilobytes by dirtily hardcoding overloading
		1735	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1736	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1737	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1738	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1739
		1740	our $WAITING;
1170		1741
1171	sub _send {	1742	sub _send {
1172	# nop	1743	# nop
1173	}	1744	}
1174		1745
…		…
1187	sub ready {	1758	sub ready {
1188	$_[0]{_ae_sent}	1759	$_[0]{_ae_sent}
1189	}	1760	}
1190		1761
1191	sub _wait {	1762	sub _wait {
		1763	$WAITING
		1764	and !$_[0]{_ae_sent}
		1765	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1766
		1767	local $WAITING = 1;
1192	AnyEvent->one_event while !$_[0]{_ae_sent};	1768	AnyEvent->one_event while !$_[0]{_ae_sent};
1193	}	1769	}
1194		1770
1195	sub recv {	1771	sub recv {
1196	$_[0]->_wait;	1772	$_[0]->_wait;
…		…
1198	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1774	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1199	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1775	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1200	}	1776	}
1201		1777
1202	sub cb {	1778	sub cb {
1203	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1779	my $cv = shift;
		1780
		1781	@_
		1782	and $cv->{_ae_cb} = shift
		1783	and $cv->{_ae_sent}
		1784	and (delete $cv->{_ae_cb})->($cv);
		1785
1204	$_[0]{_ae_cb}	1786	$cv->{_ae_cb}
1205	}	1787	}
1206		1788
1207	sub begin {	1789	sub begin {
1208	++$_[0]{_ae_counter};	1790	++$_[0]{_ae_counter};
1209	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1791	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1237	so on.	1819	so on.
1238		1820
1239	=head1 ENVIRONMENT VARIABLES	1821	=head1 ENVIRONMENT VARIABLES
1240		1822
1241	The following environment variables are used by this module or its	1823	The following environment variables are used by this module or its
1242	submodules:	1824	submodules.
		1825
		1826	Note that AnyEvent will remove I<all> environment variables starting with
		1827	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1828	enabled.
1243		1829
1244	=over 4	1830	=over 4
1245		1831
1246	=item C<PERL_ANYEVENT_VERBOSE>	1832	=item C<PERL_ANYEVENT_VERBOSE>
1247		1833
…		…
1254	C<PERL_ANYEVENT_MODEL>.	1840	C<PERL_ANYEVENT_MODEL>.
1255		1841
1256	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1842	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1257	model it chooses.	1843	model it chooses.
1258		1844
		1845	When set to C<8> or higher, then AnyEvent will report extra information on
		1846	which optional modules it loads and how it implements certain features.
		1847
1259	=item C<PERL_ANYEVENT_STRICT>	1848	=item C<PERL_ANYEVENT_STRICT>
1260		1849
1261	AnyEvent does not do much argument checking by default, as thorough	1850	AnyEvent does not do much argument checking by default, as thorough
1262	argument checking is very costly. Setting this variable to a true value	1851	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	1852	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	1853	check the arguments passed to most method calls. If it finds any problems,
1265	it will croak.	1854	it will croak.
1266		1855
1267	In other words, enables "strict" mode.	1856	In other words, enables "strict" mode.
1268		1857
1269	Unlike C<use strict>, it is definitely recommended ot keep it off in	1858	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	1859	>>, it is definitely recommended to keep it off in production. Keeping
1271	developing programs can be very useful, however.	1860	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1861	can be very useful, however.
1272		1862
1273	=item C<PERL_ANYEVENT_MODEL>	1863	=item C<PERL_ANYEVENT_MODEL>
1274		1864
1275	This can be used to specify the event model to be used by AnyEvent, before	1865	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	1866	auto detection and -probing kicks in. It must be a string consisting
…		…
1319		1909
1320	=item C<PERL_ANYEVENT_MAX_FORKS>	1910	=item C<PERL_ANYEVENT_MAX_FORKS>
1321		1911
1322	The maximum number of child processes that C<AnyEvent::Util::fork_call>	1912	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1323	will create in parallel.	1913	will create in parallel.
		1914
		1915	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1916
		1917	The default value for the C<max_outstanding> parameter for the default DNS
		1918	resolver - this is the maximum number of parallel DNS requests that are
		1919	sent to the DNS server.
		1920
		1921	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1922
		1923	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1924	configuration) in the default resolver. When set to the empty string, no
		1925	default config will be used.
		1926
		1927	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1928
		1929	When neither C<ca_file> nor C<ca_path> was specified during
		1930	L<AnyEvent::TLS> context creation, and either of these environment
		1931	variables exist, they will be used to specify CA certificate locations
		1932	instead of a system-dependent default.
		1933
		1934	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1935
		1936	When these are set to C<1>, then the respective modules are not
		1937	loaded. Mostly good for testing AnyEvent itself.
1324		1938
1325	=back	1939	=back
1326		1940
1327	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1941	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1328		1942
…		…
1386	warn "read: $input\n"; # output what has been read	2000	warn "read: $input\n"; # output what has been read
1387	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2001	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1388	},	2002	},
1389	);	2003	);
1390		2004
1391	my $time_watcher; # can only be used once
1392
1393	sub new_timer {
1394	$timer = AnyEvent->timer (after => 1, cb => sub {	2005	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1395	warn "timeout\n"; # print 'timeout' about every second	2006	warn "timeout\n"; # print 'timeout' at most every second
1396	&new_timer; # and restart the time
1397	});	2007	});
1398	}
1399
1400	new_timer; # create first timer
1401		2008
1402	$cv->recv; # wait until user enters /^q/i	2009	$cv->recv; # wait until user enters /^q/i
1403		2010
1404	=head1 REAL-WORLD EXAMPLE	2011	=head1 REAL-WORLD EXAMPLE
1405		2012
…		…
1478		2085
1479	The actual code goes further and collects all errors (C<die>s, exceptions)	2086	The actual code goes further and collects all errors (C<die>s, exceptions)
1480	that occurred during request processing. The C<result> method detects	2087	that occurred during request processing. The C<result> method detects
1481	whether an exception as thrown (it is stored inside the $txn object)	2088	whether an exception as thrown (it is stored inside the $txn object)
1482	and just throws the exception, which means connection errors and other	2089	and just throws the exception, which means connection errors and other
1483	problems get reported tot he code that tries to use the result, not in a	2090	problems get reported to the code that tries to use the result, not in a
1484	random callback.	2091	random callback.
1485		2092
1486	All of this enables the following usage styles:	2093	All of this enables the following usage styles:
1487		2094
1488	1. Blocking:	2095	1. Blocking:
…		…
1536	through AnyEvent. The benchmark creates a lot of timers (with a zero	2143	through AnyEvent. The benchmark creates a lot of timers (with a zero
1537	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2144	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1538	which it is), lets them fire exactly once and destroys them again.	2145	which it is), lets them fire exactly once and destroys them again.
1539		2146
1540	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2147	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1541	distribution.	2148	distribution. It uses the L<AE> interface, which makes a real difference
		2149	for the EV and Perl backends only.
1542		2150
1543	=head3 Explanation of the columns	2151	=head3 Explanation of the columns
1544		2152
1545	I<watcher> is the number of event watchers created/destroyed. Since	2153	I<watcher> is the number of event watchers created/destroyed. Since
1546	different event models feature vastly different performances, each event	2154	different event models feature vastly different performances, each event
…		…
1567	watcher.	2175	watcher.
1568		2176
1569	=head3 Results	2177	=head3 Results
1570		2178
1571	name watchers bytes create invoke destroy comment	2179	name watchers bytes create invoke destroy comment
1572	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2180	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1573	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2181	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1574	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2182	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1575	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2183	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1576	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2184	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1577	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2185	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
		2186	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
		2187	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1578	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2188	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1579	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2189	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1580	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2190	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1581	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2191	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1582		2192
1583	=head3 Discussion	2193	=head3 Discussion
1584		2194
1585	The benchmark does I<not> measure scalability of the event loop very	2195	The benchmark does I<not> measure scalability of the event loop very
1586	well. For example, a select-based event loop (such as the pure perl one)	2196	well. For example, a select-based event loop (such as the pure perl one)
…		…
1598	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2208	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1599	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2209	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1600	cycles with POE.	2210	cycles with POE.
1601		2211
1602	C<EV> is the sole leader regarding speed and memory use, which are both	2212	C<EV> is the sole leader regarding speed and memory use, which are both
1603	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2213	maximal/minimal, respectively. When using the L<AE> API there is zero
		2214	overhead (when going through the AnyEvent API create is about 5-6 times
		2215	slower, with other times being equal, so still uses far less memory than
1604	far less memory than any other event loop and is still faster than Event	2216	any other event loop and is still faster than Event natively).
1605	natively.
1606		2217
1607	The pure perl implementation is hit in a few sweet spots (both the	2218	The pure perl implementation is hit in a few sweet spots (both the
1608	constant timeout and the use of a single fd hit optimisations in the perl	2219	constant timeout and the use of a single fd hit optimisations in the perl
1609	interpreter and the backend itself). Nevertheless this shows that it	2220	interpreter and the backend itself). Nevertheless this shows that it
1610	adds very little overhead in itself. Like any select-based backend its	2221	adds very little overhead in itself. Like any select-based backend its
1611	performance becomes really bad with lots of file descriptors (and few of	2222	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.	2223	them active), of course, but this was not subject of this benchmark.
1613		2224
1614	The C<Event> module has a relatively high setup and callback invocation	2225	The C<Event> module has a relatively high setup and callback invocation
1615	cost, but overall scores in on the third place.	2226	cost, but overall scores in on the third place.
		2227
		2228	C<IO::Async> performs admirably well, about on par with C<Event>, even
		2229	when using its pure perl backend.
1616		2230
1617	C<Glib>'s memory usage is quite a bit higher, but it features a	2231	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	2232	faster callback invocation and overall ends up in the same class as
1619	C<Event>. However, Glib scales extremely badly, doubling the number of	2233	C<Event>. However, Glib scales extremely badly, doubling the number of
1620	watchers increases the processing time by more than a factor of four,	2234	watchers increases the processing time by more than a factor of four,
…		…
1681	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2295	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1682	(1%) are active. This mirrors the activity of large servers with many	2296	(1%) are active. This mirrors the activity of large servers with many
1683	connections, most of which are idle at any one point in time.	2297	connections, most of which are idle at any one point in time.
1684		2298
1685	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2299	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1686	distribution.	2300	distribution. It uses the L<AE> interface, which makes a real difference
		2301	for the EV and Perl backends only.
1687		2302
1688	=head3 Explanation of the columns	2303	=head3 Explanation of the columns
1689		2304
1690	I<sockets> is the number of sockets, and twice the number of "servers" (as	2305	I<sockets> is the number of sockets, and twice the number of "servers" (as
1691	each server has a read and write socket end).	2306	each server has a read and write socket end).
…		…
1698	it to another server. This includes deleting the old timeout and creating	2313	it to another server. This includes deleting the old timeout and creating
1699	a new one that moves the timeout into the future.	2314	a new one that moves the timeout into the future.
1700		2315
1701	=head3 Results	2316	=head3 Results
1702		2317
1703	name sockets create request	2318	name sockets create request
1704	EV 20000 69.01 11.16	2319	EV 20000 62.66 7.99
1705	Perl 20000 73.32 35.87	2320	Perl 20000 68.32 32.64
1706	Event 20000 212.62 257.32	2321	IOAsync 20000 174.06 101.15 epoll
1707	Glib 20000 651.16 1896.30	2322	IOAsync 20000 174.67 610.84 poll
		2323	Event 20000 202.69 242.91
		2324	Glib 20000 557.01 1689.52
1708	POE 20000 349.67 12317.24 uses POE::Loop::Event	2325	POE 20000 341.54 12086.32 uses POE::Loop::Event
1709		2326
1710	=head3 Discussion	2327	=head3 Discussion
1711		2328
1712	This benchmark I<does> measure scalability and overall performance of the	2329	This benchmark I<does> measure scalability and overall performance of the
1713	particular event loop.	2330	particular event loop.
…		…
1715	EV is again fastest. Since it is using epoll on my system, the setup time	2332	EV is again fastest. Since it is using epoll on my system, the setup time
1716	is relatively high, though.	2333	is relatively high, though.
1717		2334
1718	Perl surprisingly comes second. It is much faster than the C-based event	2335	Perl surprisingly comes second. It is much faster than the C-based event
1719	loops Event and Glib.	2336	loops Event and Glib.
		2337
		2338	IO::Async performs very well when using its epoll backend, and still quite
		2339	good compared to Glib when using its pure perl backend.
1720		2340
1721	Event suffers from high setup time as well (look at its code and you will	2341	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	2342	understand why). Callback invocation also has a high overhead compared to
1723	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	2343	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1724	uses select or poll in basically all documented configurations.	2344	uses select or poll in basically all documented configurations.
…		…
1787	=item * C-based event loops perform very well with small number of	2407	=item * C-based event loops perform very well with small number of
1788	watchers, as the management overhead dominates.	2408	watchers, as the management overhead dominates.
1789		2409
1790	=back	2410	=back
1791		2411
		2412	=head2 THE IO::Lambda BENCHMARK
		2413
		2414	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2415	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2416	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2417	shouldn't come as a surprise to anybody). As such, the benchmark is
		2418	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2419	very optimal. But how would AnyEvent compare when used without the extra
		2420	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2421
		2422	The benchmark itself creates an echo-server, and then, for 500 times,
		2423	connects to the echo server, sends a line, waits for the reply, and then
		2424	creates the next connection. This is a rather bad benchmark, as it doesn't
		2425	test the efficiency of the framework or much non-blocking I/O, but it is a
		2426	benchmark nevertheless.
		2427
		2428	name runtime
		2429	Lambda/select 0.330 sec
		2430	+ optimized 0.122 sec
		2431	Lambda/AnyEvent 0.327 sec
		2432	+ optimized 0.138 sec
		2433	Raw sockets/select 0.077 sec
		2434	POE/select, components 0.662 sec
		2435	POE/select, raw sockets 0.226 sec
		2436	POE/select, optimized 0.404 sec
		2437
		2438	AnyEvent/select/nb 0.085 sec
		2439	AnyEvent/EV/nb 0.068 sec
		2440	+state machine 0.134 sec
		2441
		2442	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2443	benchmarks actually make blocking connects and use 100% blocking I/O,
		2444	defeating the purpose of an event-based solution. All of the newly
		2445	written AnyEvent benchmarks use 100% non-blocking connects (using
		2446	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2447	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2448	generally require a lot more bookkeeping and event handling than blocking
		2449	connects (which involve a single syscall only).
		2450
		2451	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2452	offers similar expressive power as POE and IO::Lambda, using conventional
		2453	Perl syntax. This means that both the echo server and the client are 100%
		2454	non-blocking, further placing it at a disadvantage.
		2455
		2456	As you can see, the AnyEvent + EV combination even beats the
		2457	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2458	backend easily beats IO::Lambda and POE.
		2459
		2460	And even the 100% non-blocking version written using the high-level (and
		2461	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
		2462	higher level ("unoptimised") abstractions by a large margin, even though
		2463	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
		2464
		2465	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2466	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2467	part of the IO::Lambda distribution and were used without any changes.
		2468
1792		2469
1793	=head1 SIGNALS	2470	=head1 SIGNALS
1794		2471
1795	AnyEvent currently installs handlers for these signals:	2472	AnyEvent currently installs handlers for these signals:
1796		2473
…		…
1799	=item SIGCHLD	2476	=item SIGCHLD
1800		2477
1801	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2478	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	2479	emulation for event loops that do not support them natively. Also, some
1803	event loops install a similar handler.	2480	event loops install a similar handler.
		2481
		2482	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2483	AnyEvent will reset it to default, to avoid losing child exit statuses.
1804		2484
1805	=item SIGPIPE	2485	=item SIGPIPE
1806		2486
1807	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2487	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1808	when AnyEvent gets loaded.	2488	when AnyEvent gets loaded.
…		…
1820		2500
1821	=back	2501	=back
1822		2502
1823	=cut	2503	=cut
1824		2504
		2505	undef $SIG{CHLD}
		2506	if $SIG{CHLD} eq 'IGNORE';
		2507
1825	$SIG{PIPE} = sub { }	2508	$SIG{PIPE} = sub { }
1826	unless defined $SIG{PIPE};	2509	unless defined $SIG{PIPE};
1827		2510
		2511	=head1 RECOMMENDED/OPTIONAL MODULES
		2512
		2513	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2514	it's built-in modules) are required to use it.
		2515
		2516	That does not mean that AnyEvent won't take advantage of some additional
		2517	modules if they are installed.
		2518
		2519	This section explains which additional modules will be used, and how they
		2520	affect AnyEvent's operation.
		2521
		2522	=over 4
		2523
		2524	=item L<Async::Interrupt>
		2525
		2526	This slightly arcane module is used to implement fast signal handling: To
		2527	my knowledge, there is no way to do completely race-free and quick
		2528	signal handling in pure perl. To ensure that signals still get
		2529	delivered, AnyEvent will start an interval timer to wake up perl (and
		2530	catch the signals) with some delay (default is 10 seconds, look for
		2531	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2532
		2533	If this module is available, then it will be used to implement signal
		2534	catching, which means that signals will not be delayed, and the event loop
		2535	will not be interrupted regularly, which is more efficient (and good for
		2536	battery life on laptops).
		2537
		2538	This affects not just the pure-perl event loop, but also other event loops
		2539	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2540
		2541	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2542	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2543	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2544	does nothing for those backends.
		2545
		2546	=item L<EV>
		2547
		2548	This module isn't really "optional", as it is simply one of the backend
		2549	event loops that AnyEvent can use. However, it is simply the best event
		2550	loop available in terms of features, speed and stability: It supports
		2551	the AnyEvent API optimally, implements all the watcher types in XS, does
		2552	automatic timer adjustments even when no monotonic clock is available,
		2553	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2554	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2555	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2556
		2557	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2558	then this module will do nothing for you.
		2559
		2560	=item L<Guard>
		2561
		2562	The guard module, when used, will be used to implement
		2563	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2564	lot less memory), but otherwise doesn't affect guard operation much. It is
		2565	purely used for performance.
		2566
		2567	=item L<JSON> and L<JSON::XS>
		2568
		2569	One of these modules is required when you want to read or write JSON data
		2570	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
		2571	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2572
		2573	=item L<Net::SSLeay>
		2574
		2575	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2576	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2577	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2578
		2579	=item L<Time::HiRes>
		2580
		2581	This module is part of perl since release 5.008. It will be used when the
		2582	chosen event library does not come with a timing source on it's own. The
		2583	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2584	try to use a monotonic clock for timing stability.
		2585
		2586	=back
		2587
1828		2588
1829	=head1 FORK	2589	=head1 FORK
1830		2590
1831	Most event libraries are not fork-safe. The ones who are usually are	2591	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>	2592	because they rely on inefficient but fork-safe C<select> or C<poll> calls
1833	calls. Only L<EV> is fully fork-aware.	2593	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2594	are usually badly thought-out hacks that are incompatible with fork in
		2595	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2596	continue event-processing in both parent and child (or both, if you know
		2597	what you are doing).
		2598
		2599	This means that, in general, you cannot fork and do event processing in
		2600	the child if the event library was initialised before the fork (which
		2601	usually happens when the first AnyEvent watcher is created, or the library
		2602	is loaded).
1834		2603
1835	If you have to fork, you must either do so I<before> creating your first	2604	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.	2605	watcher OR you must not use AnyEvent at all in the child OR you must do
		2606	something completely out of the scope of AnyEvent.
		2607
		2608	The problem of doing event processing in the parent I<and> the child
		2609	is much more complicated: even for backends that I<are> fork-aware or
		2610	fork-safe, their behaviour is not usually what you want: fork clones all
		2611	watchers, that means all timers, I/O watchers etc. are active in both
		2612	parent and child, which is almost never what you want. USing C<exec>
		2613	to start worker children from some kind of manage rprocess is usually
		2614	preferred, because it is much easier and cleaner, at the expense of having
		2615	to have another binary.
1837		2616
1838		2617
1839	=head1 SECURITY CONSIDERATIONS	2618	=head1 SECURITY CONSIDERATIONS
1840		2619
1841	AnyEvent can be forced to load any event model via	2620	AnyEvent can be forced to load any event model via
…		…
1853	use AnyEvent;	2632	use AnyEvent;
1854		2633
1855	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2634	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	2635	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	2636	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1858	$ENV{PERL_ANYEGENT_STRICT}.	2637	$ENV{PERL_ANYEVENT_STRICT}.
		2638
		2639	Note that AnyEvent will remove I<all> environment variables starting with
		2640	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2641	enabled.
1859		2642
1860		2643
1861	=head1 BUGS	2644	=head1 BUGS
1862		2645
1863	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	2646	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>.	2658	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1876		2659
1877	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2660	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1878	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2661	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1879	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2662	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1880	L<AnyEvent::Impl::POE>.	2663	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1881		2664
1882	Non-blocking file handles, sockets, TCP clients and	2665	Non-blocking file handles, sockets, TCP clients and
1883	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2666	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1884		2667
1885	Asynchronous DNS: L<AnyEvent::DNS>.	2668	Asynchronous DNS: L<AnyEvent::DNS>.
1886		2669
1887	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2670	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2671	L<Coro::Event>,
1888		2672
1889	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2673	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2674	L<AnyEvent::HTTP>.
1890		2675
1891		2676
1892	=head1 AUTHOR	2677	=head1 AUTHOR
1893		2678
1894	Marc Lehmann <schmorp@schmorp.de>	2679	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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