ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.233 by root, Thu Jul 9 01:22:50 2009 UTC vs.
Revision 1.329 by root, Sun Jul 11 05:44:22 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 and POE are various supported	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6	event loops.	6	and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
…		…
40	=head1 INTRODUCTION/TUTORIAL	43	=head1 INTRODUCTION/TUTORIAL
41		44
42	This manpage is mainly a reference manual. If you are interested	45	This manpage is mainly a reference manual. If you are interested
43	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
44	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.
45		56
46	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	57	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47		58
48	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
49	nowadays. So what is different about AnyEvent?	60	nowadays. So what is different about AnyEvent?
…		…
127	use AnyEvent;	138	use AnyEvent;
128		139
129	# .. AnyEvent will likely default to Tk	140	# .. AnyEvent will likely default to Tk
130		141
131	The I<likely> means that, if any module loads another event model and	142	The I<likely> means that, if any module loads another event model and
132	starts using it, all bets are off. Maybe you should tell their authors to	143	starts using it, all bets are off - this case should be very rare though,
133	use AnyEvent so their modules work together with others seamlessly...	144	as very few modules hardcode event loops without announcing this very
		145	loudly.
134		146
135	The pure-perl implementation of AnyEvent is called	147	The pure-perl implementation of AnyEvent is called
136	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	148	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
137	explicitly and enjoy the high availability of that event loop :)	149	explicitly and enjoy the high availability of that event loop :)
138		150
…		…
172	Note that C<my $w; $w => combination. This is necessary because in Perl,	184	Note that C<my $w; $w => combination. This is necessary because in Perl,
173	my variables are only visible after the statement in which they are	185	my variables are only visible after the statement in which they are
174	declared.	186	declared.
175		187
176	=head2 I/O WATCHERS	188	=head2 I/O WATCHERS
		189
		190	$w = AnyEvent->io (
		191	fh => <filehandle_or_fileno>,
		192	poll => <"r" or "w">,
		193	cb => <callback>,
		194	);
177		195
178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	196	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179	with the following mandatory key-value pairs as arguments:	197	with the following mandatory key-value pairs as arguments:
180		198
181	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch	199	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
…		…
211	undef $w;	229	undef $w;
212	});	230	});
213		231
214	=head2 TIME WATCHERS	232	=head2 TIME WATCHERS
215		233
		234	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		235
		236	$w = AnyEvent->timer (
		237	after => <fractional_seconds>,
		238	interval => <fractional_seconds>,
		239	cb => <callback>,
		240	);
		241
216	You can create a time watcher by calling the C<< AnyEvent->timer >>	242	You can create a time watcher by calling the C<< AnyEvent->timer >>
217	method with the following mandatory arguments:	243	method with the following mandatory arguments:
218		244
219	C<after> specifies after how many seconds (fractional values are	245	C<after> specifies after how many seconds (fractional values are
220	supported) the callback should be invoked. C<cb> is the callback to invoke	246	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
341	might affect timers and time-outs.	367	might affect timers and time-outs.
342		368
343	When this is the case, you can call this method, which will update the	369	When this is the case, you can call this method, which will update the
344	event loop's idea of "current time".	370	event loop's idea of "current time".
345		371
		372	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		373	when mod_perl executes the script, then the event loop will have the wrong
		374	idea about the "current time" (being potentially far in the past, when the
		375	script ran the last time). In that case you should arrange a call to C<<
		376	AnyEvent->now_update >> each time the web server process wakes up again
		377	(e.g. at the start of your script, or in a handler).
		378
346	Note that updating the time I<might> cause some events to be handled.	379	Note that updating the time I<might> cause some events to be handled.
347		380
348	=back	381	=back
349		382
350	=head2 SIGNAL WATCHERS	383	=head2 SIGNAL WATCHERS
		384
		385	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
351		386
352	You can watch for signals using a signal watcher, C<signal> is the signal	387	You can watch for signals using a signal watcher, C<signal> is the signal
353	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	388	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
354	callback to be invoked whenever a signal occurs.	389	callback to be invoked whenever a signal occurs.
355		390
…		…
361	invocation, and callback invocation will be synchronous. Synchronous means	396	invocation, and callback invocation will be synchronous. Synchronous means
362	that it might take a while until the signal gets handled by the process,	397	that it might take a while until the signal gets handled by the process,
363	but it is guaranteed not to interrupt any other callbacks.	398	but it is guaranteed not to interrupt any other callbacks.
364		399
365	The main advantage of using these watchers is that you can share a signal	400	The main advantage of using these watchers is that you can share a signal
366	between multiple watchers.	401	between multiple watchers, and AnyEvent will ensure that signals will not
		402	interrupt your program at bad times.
367		403
368	This watcher might use C<%SIG>, so programs overwriting those signals	404	This watcher might use C<%SIG> (depending on the event loop used),
369	directly will likely not work correctly.	405	so programs overwriting those signals directly will likely not work
		406	correctly.
370		407
371	Example: exit on SIGINT	408	Example: exit on SIGINT
372		409
373	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	410	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
374		411
		412	=head3 Restart Behaviour
		413
		414	While restart behaviour is up to the event loop implementation, most will
		415	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		416	pure perl implementation).
		417
		418	=head3 Safe/Unsafe Signals
		419
		420	Perl signals can be either "safe" (synchronous to opcode handling) or
		421	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		422	latter might corrupt your memory.
		423
		424	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		425	i.e. they will not interrupt your running perl program but will only be
		426	called as part of the normal event handling (just like timer, I/O etc.
		427	callbacks, too).
		428
		429	=head3 Signal Races, Delays and Workarounds
		430
		431	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		432	callbacks to signals in a generic way, which is a pity, as you cannot
		433	do race-free signal handling in perl, requiring C libraries for
		434	this. AnyEvent will try to do it's best, which means in some cases,
		435	signals will be delayed. The maximum time a signal might be delayed is
		436	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
		437	variable can be changed only before the first signal watcher is created,
		438	and should be left alone otherwise. This variable determines how often
		439	AnyEvent polls for signals (in case a wake-up was missed). Higher values
		440	will cause fewer spurious wake-ups, which is better for power and CPU
		441	saving.
		442
		443	All these problems can be avoided by installing the optional
		444	L<Async::Interrupt> module, which works with most event loops. It will not
		445	work with inherently broken event loops such as L<Event> or L<Event::Lib>
		446	(and not with L<POE> currently, as POE does it's own workaround with
		447	one-second latency). For those, you just have to suffer the delays.
		448
375	=head2 CHILD PROCESS WATCHERS	449	=head2 CHILD PROCESS WATCHERS
376		450
		451	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		452
377	You can also watch on a child process exit and catch its exit status.	453	You can also watch on a child process exit and catch its exit status.
378		454
379	The child process is specified by the C<pid> argument (if set to C<0>, it	455	The child process is specified by the C<pid> argument (one some backends,
380	watches for any child process exit). The watcher will triggered only when	456	using C<0> watches for any child process exit, on others this will
381	the child process has finished and an exit status is available, not on	457	croak). The watcher will be triggered only when the child process has
382	any trace events (stopped/continued).	458	finished and an exit status is available, not on any trace events
		459	(stopped/continued).
383		460
384	The callback will be called with the pid and exit status (as returned by	461	The callback will be called with the pid and exit status (as returned by
385	waitpid), so unlike other watcher types, you I<can> rely on child watcher	462	waitpid), so unlike other watcher types, you I<can> rely on child watcher
386	callback arguments.	463	callback arguments.
387		464
…		…
403		480
404	This means you cannot create a child watcher as the very first	481	This means you cannot create a child watcher as the very first
405	thing in an AnyEvent program, you I<have> to create at least one	482	thing in an AnyEvent program, you I<have> to create at least one
406	watcher before you C<fork> the child (alternatively, you can call	483	watcher before you C<fork> the child (alternatively, you can call
407	C<AnyEvent::detect>).	484	C<AnyEvent::detect>).
		485
		486	As most event loops do not support waiting for child events, they will be
		487	emulated by AnyEvent in most cases, in which the latency and race problems
		488	mentioned in the description of signal watchers apply.
408		489
409	Example: fork a process and wait for it	490	Example: fork a process and wait for it
410		491
411	my $done = AnyEvent->condvar;	492	my $done = AnyEvent->condvar;
412		493
…		…
424	# do something else, then wait for process exit	505	# do something else, then wait for process exit
425	$done->recv;	506	$done->recv;
426		507
427	=head2 IDLE WATCHERS	508	=head2 IDLE WATCHERS
428		509
429	Sometimes there is a need to do something, but it is not so important	510	$w = AnyEvent->idle (cb => <callback>);
430	to do it instantly, but only when there is nothing better to do. This
431	"nothing better to do" is usually defined to be "no other events need
432	attention by the event loop".
433		511
434	Idle watchers ideally get invoked when the event loop has nothing	512	Repeatedly invoke the callback after the process becomes idle, until
435	better to do, just before it would block the process to wait for new	513	either the watcher is destroyed or new events have been detected.
436	events. Instead of blocking, the idle watcher is invoked.
437		514
438	Most event loops unfortunately do not really support idle watchers (only	515	Idle watchers are useful when there is a need to do something, but it
		516	is not so important (or wise) to do it instantly. The callback will be
		517	invoked only when there is "nothing better to do", which is usually
		518	defined as "all outstanding events have been handled and no new events
		519	have been detected". That means that idle watchers ideally get invoked
		520	when the event loop has just polled for new events but none have been
		521	detected. Instead of blocking to wait for more events, the idle watchers
		522	will be invoked.
		523
		524	Unfortunately, most event loops do not really support idle watchers (only
439	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	525	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
440	will simply call the callback "from time to time".	526	will simply call the callback "from time to time".
441		527
442	Example: read lines from STDIN, but only process them when the	528	Example: read lines from STDIN, but only process them when the
443	program is otherwise idle:	529	program is otherwise idle:
…		…
459	});	545	});
460	});	546	});
461		547
462	=head2 CONDITION VARIABLES	548	=head2 CONDITION VARIABLES
463		549
		550	$cv = AnyEvent->condvar;
		551
		552	$cv->send (<list>);
		553	my @res = $cv->recv;
		554
464	If you are familiar with some event loops you will know that all of them	555	If you are familiar with some event loops you will know that all of them
465	require you to run some blocking "loop", "run" or similar function that	556	require you to run some blocking "loop", "run" or similar function that
466	will actively watch for new events and call your callbacks.	557	will actively watch for new events and call your callbacks.
467		558
468	AnyEvent is different, it expects somebody else to run the event loop and	559	AnyEvent is slightly different: it expects somebody else to run the event
469	will only block when necessary (usually when told by the user).	560	loop and will only block when necessary (usually when told by the user).
470		561
471	The instrument to do that is called a "condition variable", so called	562	The tool to do that is called a "condition variable", so called because
472	because they represent a condition that must become true.	563	they represent a condition that must become true.
		564
		565	Now is probably a good time to look at the examples further below.
473		566
474	Condition variables can be created by calling the C<< AnyEvent->condvar	567	Condition variables can be created by calling the C<< AnyEvent->condvar
475	>> method, usually without arguments. The only argument pair allowed is	568	>> method, usually without arguments. The only argument pair allowed is
476
477	C<cb>, which specifies a callback to be called when the condition variable	569	C<cb>, which specifies a callback to be called when the condition variable
478	becomes true, with the condition variable as the first argument (but not	570	becomes true, with the condition variable as the first argument (but not
479	the results).	571	the results).
480		572
481	After creation, the condition variable is "false" until it becomes "true"	573	After creation, the condition variable is "false" until it becomes "true"
482	by calling the C<send> method (or calling the condition variable as if it	574	by calling the C<send> method (or calling the condition variable as if it
483	were a callback, read about the caveats in the description for the C<<	575	were a callback, read about the caveats in the description for the C<<
484	->send >> method).	576	->send >> method).
485		577
486	Condition variables are similar to callbacks, except that you can	578	Since condition variables are the most complex part of the AnyEvent API, here are
487	optionally wait for them. They can also be called merge points - points	579	some different mental models of what they are - pick the ones you can connect to:
488	in time where multiple outstanding events have been processed. And yet	580
489	another way to call them is transactions - each condition variable can be	581	=over 4
490	used to represent a transaction, which finishes at some point and delivers	582
491	a result.	583	=item * Condition variables are like callbacks - you can call them (and pass them instead
		584	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		585
		586	=item * Condition variables are signals - one side can emit or send them,
		587	the other side can wait for them, or install a handler that is called when
		588	the signal fires.
		589
		590	=item * Condition variables are like "Merge Points" - points in your program
		591	where you merge multiple independent results/control flows into one.
		592
		593	=item * Condition variables represent a transaction - function that start
		594	some kind of transaction can return them, leaving the caller the choice
		595	between waiting in a blocking fashion, or setting a callback.
		596
		597	=item * Condition variables represent future values, or promises to deliver
		598	some result, long before the result is available.
		599
		600	=back
492		601
493	Condition variables are very useful to signal that something has finished,	602	Condition variables are very useful to signal that something has finished,
494	for example, if you write a module that does asynchronous http requests,	603	for example, if you write a module that does asynchronous http requests,
495	then a condition variable would be the ideal candidate to signal the	604	then a condition variable would be the ideal candidate to signal the
496	availability of results. The user can either act when the callback is	605	availability of results. The user can either act when the callback is
…		…
517	eventually calls C<< -> send >>, and the "consumer side", which waits	626	eventually calls C<< -> send >>, and the "consumer side", which waits
518	for the send to occur.	627	for the send to occur.
519		628
520	Example: wait for a timer.	629	Example: wait for a timer.
521		630
522	# wait till the result is ready	631	# condition: "wait till the timer is fired"
523	my $result_ready = AnyEvent->condvar;	632	my $timer_fired = AnyEvent->condvar;
524		633
525	# do something such as adding a timer	634	# create the timer - we could wait for, say
526	# or socket watcher the calls $result_ready->send	635	# a handle becomign ready, or even an
527	# when the "result" is ready.	636	# AnyEvent::HTTP request to finish, but
528	# in this case, we simply use a timer:	637	# in this case, we simply use a timer:
529	my $w = AnyEvent->timer (	638	my $w = AnyEvent->timer (
530	after => 1,	639	after => 1,
531	cb => sub { $result_ready->send },	640	cb => sub { $timer_fired->send },
532	);	641	);
533		642
534	# this "blocks" (while handling events) till the callback	643	# this "blocks" (while handling events) till the callback
535	# calls send	644	# calls ->send
536	$result_ready->recv;	645	$timer_fired->recv;
537		646
538	Example: wait for a timer, but take advantage of the fact that	647	Example: wait for a timer, but take advantage of the fact that condition
539	condition variables are also code references.	648	variables are also callable directly.
540		649
541	my $done = AnyEvent->condvar;	650	my $done = AnyEvent->condvar;
542	my $delay = AnyEvent->timer (after => 5, cb => $done);	651	my $delay = AnyEvent->timer (after => 5, cb => $done);
543	$done->recv;	652	$done->recv;
544		653
…		…
550		659
551	...	660	...
552		661
553	my @info = $couchdb->info->recv;	662	my @info = $couchdb->info->recv;
554		663
555	And this is how you would just ste a callback to be called whenever the	664	And this is how you would just set a callback to be called whenever the
556	results are available:	665	results are available:
557		666
558	$couchdb->info->cb (sub {	667	$couchdb->info->cb (sub {
559	my @info = $_[0]->recv;	668	my @info = $_[0]->recv;
560	});	669	});
…		…
578	immediately from within send.	687	immediately from within send.
579		688
580	Any arguments passed to the C<send> call will be returned by all	689	Any arguments passed to the C<send> call will be returned by all
581	future C<< ->recv >> calls.	690	future C<< ->recv >> calls.
582		691
583	Condition variables are overloaded so one can call them directly	692	Condition variables are overloaded so one can call them directly (as if
584	(as a code reference). Calling them directly is the same as calling	693	they were a code reference). Calling them directly is the same as calling
585	C<send>. Note, however, that many C-based event loops do not handle	694	C<send>.
586	overloading, so as tempting as it may be, passing a condition variable
587	instead of a callback does not work. Both the pure perl and EV loops
588	support overloading, however, as well as all functions that use perl to
589	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
590	example).
591		695
592	=item $cv->croak ($error)	696	=item $cv->croak ($error)
593		697
594	Similar to send, but causes all call's to C<< ->recv >> to invoke	698	Similar to send, but causes all call's to C<< ->recv >> to invoke
595	C<Carp::croak> with the given error message/object/scalar.	699	C<Carp::croak> with the given error message/object/scalar.
596		700
597	This can be used to signal any errors to the condition variable	701	This can be used to signal any errors to the condition variable
598	user/consumer.	702	user/consumer. Doing it this way instead of calling C<croak> directly
		703	delays the error detetcion, but has the overwhelmign advantage that it
		704	diagnoses the error at the place where the result is expected, and not
		705	deep in some event clalback without connection to the actual code causing
		706	the problem.
599		707
600	=item $cv->begin ([group callback])	708	=item $cv->begin ([group callback])
601		709
602	=item $cv->end	710	=item $cv->end
603		711
…		…
605	one. For example, a function that pings many hosts in parallel might want	713	one. For example, a function that pings many hosts in parallel might want
606	to use a condition variable for the whole process.	714	to use a condition variable for the whole process.
607		715
608	Every call to C<< ->begin >> will increment a counter, and every call to	716	Every call to C<< ->begin >> will increment a counter, and every call to
609	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	717	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
610	>>, the (last) callback passed to C<begin> will be executed. That callback	718	>>, the (last) callback passed to C<begin> will be executed, passing the
611	is I<supposed> to call C<< ->send >>, but that is not required. If no	719	condvar as first argument. That callback is I<supposed> to call C<< ->send
612	callback was set, C<send> will be called without any arguments.	720	>>, but that is not required. If no group callback was set, C<send> will
		721	be called without any arguments.
613		722
614	You can think of C<< $cv->send >> giving you an OR condition (one call	723	You can think of C<< $cv->send >> giving you an OR condition (one call
615	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	724	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
616	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	725	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
617		726
…		…
644	begung can potentially be zero:	753	begung can potentially be zero:
645		754
646	my $cv = AnyEvent->condvar;	755	my $cv = AnyEvent->condvar;
647		756
648	my %result;	757	my %result;
649	$cv->begin (sub { $cv->send (\%result) });	758	$cv->begin (sub { shift->send (\%result) });
650		759
651	for my $host (@list_of_hosts) {	760	for my $host (@list_of_hosts) {
652	$cv->begin;	761	$cv->begin;
653	ping_host_then_call_callback $host, sub {	762	ping_host_then_call_callback $host, sub {
654	$result{$host} = ...;	763	$result{$host} = ...;
…		…
699	function will call C<croak>.	808	function will call C<croak>.
700		809
701	In list context, all parameters passed to C<send> will be returned,	810	In list context, all parameters passed to C<send> will be returned,
702	in scalar context only the first one will be returned.	811	in scalar context only the first one will be returned.
703		812
		813	Note that doing a blocking wait in a callback is not supported by any
		814	event loop, that is, recursive invocation of a blocking C<< ->recv
		815	>> is not allowed, and the C<recv> call will C<croak> if such a
		816	condition is detected. This condition can be slightly loosened by using
		817	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		818	any thread that doesn't run the event loop itself.
		819
704	Not all event models support a blocking wait - some die in that case	820	Not all event models support a blocking wait - some die in that case
705	(programs might want to do that to stay interactive), so I<if you are	821	(programs might want to do that to stay interactive), so I<if you are
706	using this from a module, never require a blocking wait>, but let the	822	using this from a module, never require a blocking wait>. Instead, let the
707	caller decide whether the call will block or not (for example, by coupling	823	caller decide whether the call will block or not (for example, by coupling
708	condition variables with some kind of request results and supporting	824	condition variables with some kind of request results and supporting
709	callbacks so the caller knows that getting the result will not block,	825	callbacks so the caller knows that getting the result will not block,
710	while still supporting blocking waits if the caller so desires).	826	while still supporting blocking waits if the caller so desires).
711		827
712	Another reason I<never> to C<< ->recv >> in a module is that you cannot
713	sensibly have two C<< ->recv >>'s in parallel, as that would require
714	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
715	can supply.
716
717	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
718	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
719	versions and also integrates coroutines into AnyEvent, making blocking
720	C<< ->recv >> calls perfectly safe as long as they are done from another
721	coroutine (one that doesn't run the event loop).
722
723	You can ensure that C<< -recv >> never blocks by setting a callback and	828	You can ensure that C<< -recv >> never blocks by setting a callback and
724	only calling C<< ->recv >> from within that callback (or at a later	829	only calling C<< ->recv >> from within that callback (or at a later
725	time). This will work even when the event loop does not support blocking	830	time). This will work even when the event loop does not support blocking
726	waits otherwise.	831	waits otherwise.
727		832
…		…
733	=item $cb = $cv->cb ($cb->($cv))	838	=item $cb = $cv->cb ($cb->($cv))
734		839
735	This is a mutator function that returns the callback set and optionally	840	This is a mutator function that returns the callback set and optionally
736	replaces it before doing so.	841	replaces it before doing so.
737		842
738	The callback will be called when the condition becomes "true", i.e. when	843	The callback will be called when the condition becomes (or already was)
739	C<send> or C<croak> are called, with the only argument being the condition	844	"true", i.e. when C<send> or C<croak> are called (or were called), with
740	variable itself. Calling C<recv> inside the callback or at any later time	845	the only argument being the condition variable itself. Calling C<recv>
741	is guaranteed not to block.	846	inside the callback or at any later time is guaranteed not to block.
742		847
743	=back	848	=back
744		849
745	=head1 SUPPORTED EVENT LOOPS/BACKENDS	850	=head1 SUPPORTED EVENT LOOPS/BACKENDS
746		851
…		…
749	=over 4	854	=over 4
750		855
751	=item Backends that are autoprobed when no other event loop can be found.	856	=item Backends that are autoprobed when no other event loop can be found.
752		857
753	EV is the preferred backend when no other event loop seems to be in	858	EV is the preferred backend when no other event loop seems to be in
754	use. If EV is not installed, then AnyEvent will try Event, and, failing	859	use. If EV is not installed, then AnyEvent will fall back to its own
755	that, will fall back to its own pure-perl implementation, which is	860	pure-perl implementation, which is available everywhere as it comes with
756	available everywhere as it comes with AnyEvent itself.	861	AnyEvent itself.
757		862
758	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	863	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
759	AnyEvent::Impl::Event based on Event, very stable, few glitches.
760	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	864	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
761		865
762	=item Backends that are transparently being picked up when they are used.	866	=item Backends that are transparently being picked up when they are used.
763		867
764	These will be used when they are currently loaded when the first watcher	868	These will be used when they are currently loaded when the first watcher
765	is created, in which case it is assumed that the application is using	869	is created, in which case it is assumed that the application is using
766	them. This means that AnyEvent will automatically pick the right backend	870	them. This means that AnyEvent will automatically pick the right backend
767	when the main program loads an event module before anything starts to	871	when the main program loads an event module before anything starts to
768	create watchers. Nothing special needs to be done by the main program.	872	create watchers. Nothing special needs to be done by the main program.
769		873
		874	AnyEvent::Impl::Event based on Event, very stable, few glitches.
770	AnyEvent::Impl::Glib based on Glib, slow but very stable.	875	AnyEvent::Impl::Glib based on Glib, slow but very stable.
771	AnyEvent::Impl::Tk based on Tk, very broken.	876	AnyEvent::Impl::Tk based on Tk, very broken.
772	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	877	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
773	AnyEvent::Impl::POE based on POE, very slow, some limitations.	878	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		879	AnyEvent::Impl::Irssi used when running within irssi.
774		880
775	=item Backends with special needs.	881	=item Backends with special needs.
776		882
777	Qt requires the Qt::Application to be instantiated first, but will	883	Qt requires the Qt::Application to be instantiated first, but will
778	otherwise be picked up automatically. As long as the main program	884	otherwise be picked up automatically. As long as the main program
…		…
852	event module detection too early, for example, L<AnyEvent::AIO> creates	958	event module detection too early, for example, L<AnyEvent::AIO> creates
853	and installs the global L<IO::AIO> watcher in a C<post_detect> block to	959	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
854	avoid autodetecting the event module at load time.	960	avoid autodetecting the event module at load time.
855		961
856	If called in scalar or list context, then it creates and returns an object	962	If called in scalar or list context, then it creates and returns an object
857	that automatically removes the callback again when it is destroyed. See	963	that automatically removes the callback again when it is destroyed (or
		964	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
858	L<Coro::BDB> for a case where this is useful.	965	a case where this is useful.
		966
		967	Example: Create a watcher for the IO::AIO module and store it in
		968	C<$WATCHER>. Only do so after the event loop is initialised, though.
		969
		970	our WATCHER;
		971
		972	my $guard = AnyEvent::post_detect {
		973	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		974	};
		975
		976	# the ||= is important in case post_detect immediately runs the block,
		977	# as to not clobber the newly-created watcher. assigning both watcher and
		978	# post_detect guard to the same variable has the advantage of users being
		979	# able to just C<undef $WATCHER> if the watcher causes them grief.
		980
		981	$WATCHER ||= $guard;
859		982
860	=item @AnyEvent::post_detect	983	=item @AnyEvent::post_detect
861		984
862	If there are any code references in this array (you can C<push> to it	985	If there are any code references in this array (you can C<push> to it
863	before or after loading AnyEvent), then they will called directly after	986	before or after loading AnyEvent), then they will called directly after
…		…
866	You should check C<$AnyEvent::MODEL> before adding to this array, though:	989	You should check C<$AnyEvent::MODEL> before adding to this array, though:
867	if it is defined then the event loop has already been detected, and the	990	if it is defined then the event loop has already been detected, and the
868	array will be ignored.	991	array will be ignored.
869		992
870	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	993	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
871	it,as it takes care of these details.	994	it, as it takes care of these details.
872		995
873	This variable is mainly useful for modules that can do something useful	996	This variable is mainly useful for modules that can do something useful
874	when AnyEvent is used and thus want to know when it is initialised, but do	997	when AnyEvent is used and thus want to know when it is initialised, but do
875	not need to even load it by default. This array provides the means to hook	998	not need to even load it by default. This array provides the means to hook
876	into AnyEvent passively, without loading it.	999	into AnyEvent passively, without loading it.
		1000
		1001	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1002	together, you could put this into Coro (this is the actual code used by
		1003	Coro to accomplish this):
		1004
		1005	if (defined $AnyEvent::MODEL) {
		1006	# AnyEvent already initialised, so load Coro::AnyEvent
		1007	require Coro::AnyEvent;
		1008	} else {
		1009	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1010	# as soon as it is
		1011	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1012	}
877		1013
878	=back	1014	=back
879		1015
880	=head1 WHAT TO DO IN A MODULE	1016	=head1 WHAT TO DO IN A MODULE
881		1017
…		…
938	=head1 OTHER MODULES	1074	=head1 OTHER MODULES
939		1075
940	The following is a non-exhaustive list of additional modules that use	1076	The following is a non-exhaustive list of additional modules that use
941	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1077	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
942	modules and other event loops in the same program. Some of the modules	1078	modules and other event loops in the same program. Some of the modules
943	come with AnyEvent, most are available via CPAN.	1079	come as part of AnyEvent, the others are available via CPAN.
944		1080
945	=over 4	1081	=over 4
946		1082
947	=item L<AnyEvent::Util>	1083	=item L<AnyEvent::Util>
948		1084
…		…
963		1099
964	=item L<AnyEvent::DNS>	1100	=item L<AnyEvent::DNS>
965		1101
966	Provides rich asynchronous DNS resolver capabilities.	1102	Provides rich asynchronous DNS resolver capabilities.
967		1103
		1104	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1105
		1106	Implement event-based interfaces to the protocols of the same name (for
		1107	the curious, IGS is the International Go Server and FCP is the Freenet
		1108	Client Protocol).
		1109
		1110	=item L<AnyEvent::Handle::UDP>
		1111
		1112	Here be danger!
		1113
		1114	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1115	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1116	it's use of a stream-based API with a protocol that isn't streamable, that
		1117	the only way to improve it is to delete it.
		1118
		1119	It features data corruption (but typically only under load) and general
		1120	confusion. On top, the author is not only clueless about UDP but also
		1121	fact-resistant - some gems of his understanding: "connect doesn't work
		1122	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1123	packets", "I don't need to implement proper error checking as UDP doesn't
		1124	support error checking" and so on - he doesn't even understand what's
		1125	wrong with his module when it is explained to him.
		1126
968	=item L<AnyEvent::HTTP>	1127	=item L<AnyEvent::DBI>
969		1128
970	A simple-to-use HTTP library that is capable of making a lot of concurrent	1129	Executes L<DBI> requests asynchronously in a proxy process for you,
971	HTTP requests.	1130	notifying you in an event-bnased way when the operation is finished.
		1131
		1132	=item L<AnyEvent::AIO>
		1133
		1134	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1135	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1136	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1137	file I/O, and much more.
972		1138
973	=item L<AnyEvent::HTTPD>	1139	=item L<AnyEvent::HTTPD>
974		1140
975	Provides a simple web application server framework.	1141	A simple embedded webserver.
976		1142
977	=item L<AnyEvent::FastPing>	1143	=item L<AnyEvent::FastPing>
978		1144
979	The fastest ping in the west.	1145	The fastest ping in the west.
980		1146
981	=item L<AnyEvent::DBI>
982
983	Executes L<DBI> requests asynchronously in a proxy process.
984
985	=item L<AnyEvent::AIO>
986
987	Truly asynchronous I/O, should be in the toolbox of every event
988	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
989	together.
990
991	=item L<AnyEvent::BDB>
992
993	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
994	L<BDB> and AnyEvent together.
995
996	=item L<AnyEvent::GPSD>
997
998	A non-blocking interface to gpsd, a daemon delivering GPS information.
999
1000	=item L<AnyEvent::IRC>
1001
1002	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1003
1004	=item L<AnyEvent::XMPP>
1005
1006	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1007	Net::XMPP2>.
1008
1009	=item L<AnyEvent::IGS>
1010
1011	A non-blocking interface to the Internet Go Server protocol (used by
1012	L<App::IGS>).
1013
1014	=item L<Net::FCP>
1015
1016	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1017	of AnyEvent.
1018
1019	=item L<Event::ExecFlow>
1020
1021	High level API for event-based execution flow control.
1022
1023	=item L<Coro>	1147	=item L<Coro>
1024		1148
1025	Has special support for AnyEvent via L<Coro::AnyEvent>.	1149	Has special support for AnyEvent via L<Coro::AnyEvent>.
1026		1150
1027	=back	1151	=back
1028		1152
1029	=cut	1153	=cut
1030		1154
1031	package AnyEvent;	1155	package AnyEvent;
1032		1156
1033	no warnings;	1157	# basically a tuned-down version of common::sense
1034	use strict qw(vars subs);	1158	sub common_sense {
		1159	# from common:.sense 1.0
		1160	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
		1161	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
		1162	$^H |= 0x00000600;
		1163	}
1035		1164
		1165	BEGIN { AnyEvent::common_sense }
		1166
1036	use Carp;	1167	use Carp ();
1037		1168
1038	our $VERSION = 4.801;	1169	our $VERSION = '5.271';
1039	our $MODEL;	1170	our $MODEL;
1040		1171
1041	our $AUTOLOAD;	1172	our $AUTOLOAD;
1042	our @ISA;	1173	our @ISA;
1043		1174
1044	our @REGISTRY;	1175	our @REGISTRY;
1045		1176
1046	our $WIN32;	1177	our $VERBOSE;
1047		1178
1048	BEGIN {	1179	BEGIN {
1049	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1180	require "AnyEvent/constants.pl";
		1181
1050	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1182	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1051		1183
1052	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1184	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1053	if ${^TAINT};	1185	if ${^TAINT};
1054	}
1055		1186
1056	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1187	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1188
		1189	}
		1190
		1191	our $MAX_SIGNAL_LATENCY = 10;
1057		1192
1058	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1193	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1059		1194
1060	{	1195	{
1061	my $idx;	1196	my $idx;
…		…
1063	for reverse split /\s*,\s*/,	1198	for reverse split /\s*,\s*/,
1064	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";	1199	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1065	}	1200	}
1066		1201
1067	my @models = (	1202	my @models = (
1068	[EV:: => AnyEvent::Impl::EV::],	1203	[EV:: => AnyEvent::Impl::EV:: , 1],
1069	[Event:: => AnyEvent::Impl::Event::],
1070	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1204	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1071	# everything below here will not be autoprobed	1205	# everything below here will not (normally) be autoprobed
1072	# as the pureperl backend should work everywhere	1206	# as the pureperl backend should work everywhere
1073	# and is usually faster	1207	# and is usually faster
		1208	[Event:: => AnyEvent::Impl::Event::, 1],
1074	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1209	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1075	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1210	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1211	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1076	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1212	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		1213	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1077	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1214	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1078	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1079	[Wx:: => AnyEvent::Impl::POE::],	1215	[Wx:: => AnyEvent::Impl::POE::],
1080	[Prima:: => AnyEvent::Impl::POE::],	1216	[Prima:: => AnyEvent::Impl::POE::],
1081	# IO::Async is just too broken - we would need workarounds for its	1217	# IO::Async is just too broken - we would need workarounds for its
1082	# byzantine signal and broken child handling, among others.	1218	# byzantine signal and broken child handling, among others.
1083	# IO::Async is rather hard to detect, as it doesn't have any	1219	# IO::Async is rather hard to detect, as it doesn't have any
1084	# obvious default class.	1220	# obvious default class.
1085	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1221	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1086	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1222	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1087	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1223	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1224	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1088	);	1225	);
1089		1226
1090	our %method = map +($_ => 1),	1227	our %method = map +($_ => 1),
1091	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1228	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1092		1229
1093	our @post_detect;	1230	our @post_detect;
1094		1231
1095	sub post_detect(&) {	1232	sub post_detect(&) {
1096	my ($cb) = @_;	1233	my ($cb) = @_;
1097		1234
1098	if ($MODEL) {
1099	$cb->();
1100
1101	1
1102	} else {
1103	push @post_detect, $cb;	1235	push @post_detect, $cb;
1104		1236
1105	defined wantarray	1237	defined wantarray
1106	? bless \$cb, "AnyEvent::Util::postdetect"	1238	? bless \$cb, "AnyEvent::Util::postdetect"
1107	: ()	1239	: ()
1108	}
1109	}	1240	}
1110		1241
1111	sub AnyEvent::Util::postdetect::DESTROY {	1242	sub AnyEvent::Util::postdetect::DESTROY {
1112	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1243	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1113	}	1244	}
1114		1245
1115	sub detect() {	1246	sub detect() {
		1247	# free some memory
		1248	*detect = sub () { $MODEL };
		1249
		1250	local $!; # for good measure
		1251	local $SIG{__DIE__};
		1252
		1253	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1254	my $model = "AnyEvent::Impl::$1";
		1255	if (eval "require $model") {
		1256	$MODEL = $model;
		1257	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1258	} else {
		1259	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1260	}
		1261	}
		1262
		1263	# check for already loaded models
1116	unless ($MODEL) {	1264	unless ($MODEL) {
1117	no strict 'refs';	1265	for (@REGISTRY, @models) {
1118	local $SIG{__DIE__};	1266	my ($package, $model) = @$_;
1119		1267	if (${"$package\::VERSION"} > 0) {
1120	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1121	my $model = "AnyEvent::Impl::$1";
1122	if (eval "require $model") {	1268	if (eval "require $model") {
1123	$MODEL = $model;	1269	$MODEL = $model;
1124	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1270	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1125	} else {	1271	last;
1126	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1272	}
1127	}	1273	}
1128	}	1274	}
1129		1275
1130	# check for already loaded models
1131	unless ($MODEL) {	1276	unless ($MODEL) {
		1277	# try to autoload a model
1132	for (@REGISTRY, @models) {	1278	for (@REGISTRY, @models) {
1133	my ($package, $model) = @$_;	1279	my ($package, $model, $autoload) = @$_;
		1280	if (
		1281	$autoload
		1282	and eval "require $package"
1134	if (${"$package\::VERSION"} > 0) {	1283	and ${"$package\::VERSION"} > 0
1135	if (eval "require $model") {	1284	and eval "require $model"
		1285	) {
1136	$MODEL = $model;	1286	$MODEL = $model;
1137	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1287	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1138	last;	1288	last;
1139	}
1140	}	1289	}
1141	}	1290	}
1142		1291
1143	unless ($MODEL) {
1144	# try to load a model
1145
1146	for (@REGISTRY, @models) {
1147	my ($package, $model) = @$_;
1148	if (eval "require $package"
1149	and ${"$package\::VERSION"} > 0
1150	and eval "require $model") {
1151	$MODEL = $model;
1152	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
1153	last;
1154	}
1155	}
1156
1157	$MODEL	1292	$MODEL
1158	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1293	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1159	}
1160	}	1294	}
1161
1162	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1163
1164	unshift @ISA, $MODEL;
1165
1166	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1167
1168	(shift @post_detect)->() while @post_detect;
1169	}	1295	}
		1296
		1297	@models = (); # free probe data
		1298
		1299	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1300	unshift @ISA, $MODEL;
		1301
		1302	# now nuke some methods that are overriden by the backend.
		1303	# SUPER is not allowed.
		1304	for (qw(time signal child idle)) {
		1305	undef &{"AnyEvent::Base::$_"}
		1306	if defined &{"$MODEL\::$_"};
		1307	}
		1308
		1309	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1310
		1311	(shift @post_detect)->() while @post_detect;
		1312
		1313	*post_detect = sub(&) {
		1314	shift->();
		1315
		1316	undef
		1317	};
1170		1318
1171	$MODEL	1319	$MODEL
1172	}	1320	}
1173		1321
1174	sub AUTOLOAD {	1322	sub AUTOLOAD {
1175	(my $func = $AUTOLOAD) =~ s/.*://;	1323	(my $func = $AUTOLOAD) =~ s/.*://;
1176		1324
1177	$method{$func}	1325	$method{$func}
1178	or croak "$func: not a valid method for AnyEvent objects";	1326	or Carp::croak "$func: not a valid AnyEvent class method";
1179		1327
1180	detect unless $MODEL;	1328	detect;
1181		1329
1182	my $class = shift;	1330	my $class = shift;
1183	$class->$func (@_);	1331	$class->$func (@_);
1184	}	1332	}
1185		1333
…		…
1188	# allow only one watcher per fd, so we dup it to get a different one).	1336	# allow only one watcher per fd, so we dup it to get a different one).
1189	sub _dupfh($$;$$) {	1337	sub _dupfh($$;$$) {
1190	my ($poll, $fh, $r, $w) = @_;	1338	my ($poll, $fh, $r, $w) = @_;
1191		1339
1192	# cygwin requires the fh mode to be matching, unix doesn't	1340	# cygwin requires the fh mode to be matching, unix doesn't
1193	my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">");	1341	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1194		1342
1195	open my $fh2, "$mode&", $fh	1343	open my $fh2, $mode, $fh
1196	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";	1344	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1197		1345
1198	# we assume CLOEXEC is already set by perl in all important cases	1346	# we assume CLOEXEC is already set by perl in all important cases
1199		1347
1200	($fh2, $rw)	1348	($fh2, $rw)
1201	}	1349	}
1202		1350
		1351	=head1 SIMPLIFIED AE API
		1352
		1353	Starting with version 5.0, AnyEvent officially supports a second, much
		1354	simpler, API that is designed to reduce the calling, typing and memory
		1355	overhead by using function call syntax and a fixed number of parameters.
		1356
		1357	See the L<AE> manpage for details.
		1358
		1359	=cut
		1360
		1361	package AE;
		1362
		1363	our $VERSION = $AnyEvent::VERSION;
		1364
		1365	# fall back to the main API by default - backends and AnyEvent::Base
		1366	# implementations can overwrite these.
		1367
		1368	sub io($$$) {
		1369	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1370	}
		1371
		1372	sub timer($$$) {
		1373	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1374	}
		1375
		1376	sub signal($$) {
		1377	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1378	}
		1379
		1380	sub child($$) {
		1381	AnyEvent->child (pid => $_[0], cb => $_[1])
		1382	}
		1383
		1384	sub idle($) {
		1385	AnyEvent->idle (cb => $_[0])
		1386	}
		1387
		1388	sub cv(;&) {
		1389	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1390	}
		1391
		1392	sub now() {
		1393	AnyEvent->now
		1394	}
		1395
		1396	sub now_update() {
		1397	AnyEvent->now_update
		1398	}
		1399
		1400	sub time() {
		1401	AnyEvent->time
		1402	}
		1403
1203	package AnyEvent::Base;	1404	package AnyEvent::Base;
1204		1405
1205	# default implementations for many methods	1406	# default implementations for many methods
1206		1407
1207	BEGIN {	1408	sub time {
		1409	eval q{ # poor man's autoloading {}
		1410	# probe for availability of Time::HiRes
1208	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1411	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1412	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1209	*_time = \&Time::HiRes::time;	1413	*AE::time = \&Time::HiRes::time;
1210	# if (eval "use POSIX (); (POSIX::times())...	1414	# if (eval "use POSIX (); (POSIX::times())...
1211	} else {	1415	} else {
		1416	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1212	*_time = sub { time }; # epic fail	1417	*AE::time = sub (){ time }; # epic fail
		1418	}
		1419
		1420	*time = sub { AE::time }; # different prototypes
		1421	};
		1422	die if $@;
		1423
		1424	&time
		1425	}
		1426
		1427	*now = \&time;
		1428
		1429	sub now_update { }
		1430
		1431	# default implementation for ->condvar
		1432
		1433	sub condvar {
		1434	eval q{ # poor man's autoloading {}
		1435	*condvar = sub {
		1436	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1437	};
		1438
		1439	*AE::cv = sub (;&) {
		1440	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1441	};
		1442	};
		1443	die if $@;
		1444
		1445	&condvar
		1446	}
		1447
		1448	# default implementation for ->signal
		1449
		1450	our $HAVE_ASYNC_INTERRUPT;
		1451
		1452	sub _have_async_interrupt() {
		1453	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1454	&& eval "use Async::Interrupt 1.02 (); 1")
		1455	unless defined $HAVE_ASYNC_INTERRUPT;
		1456
		1457	$HAVE_ASYNC_INTERRUPT
		1458	}
		1459
		1460	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1461	our (%SIG_ASY, %SIG_ASY_W);
		1462	our ($SIG_COUNT, $SIG_TW);
		1463
		1464	# install a dummy wakeup watcher to reduce signal catching latency
		1465	# used by Impls
		1466	sub _sig_add() {
		1467	unless ($SIG_COUNT++) {
		1468	# try to align timer on a full-second boundary, if possible
		1469	my $NOW = AE::now;
		1470
		1471	$SIG_TW = AE::timer
		1472	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1473	$MAX_SIGNAL_LATENCY,
		1474	sub { } # just for the PERL_ASYNC_CHECK
		1475	;
1213	}	1476	}
1214	}	1477	}
1215		1478
1216	sub time { _time }	1479	sub _sig_del {
1217	sub now { _time }	1480	undef $SIG_TW
1218	sub now_update { }	1481	unless --$SIG_COUNT;
1219
1220	# default implementation for ->condvar
1221
1222	sub condvar {
1223	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1224	}	1482	}
1225		1483
1226	# default implementation for ->signal	1484	our $_sig_name_init; $_sig_name_init = sub {
		1485	eval q{ # poor man's autoloading {}
		1486	undef $_sig_name_init;
1227		1487
1228	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1488	if (_have_async_interrupt) {
		1489	*sig2num = \&Async::Interrupt::sig2num;
		1490	*sig2name = \&Async::Interrupt::sig2name;
		1491	} else {
		1492	require Config;
1229		1493
1230	sub _signal_exec {	1494	my %signame2num;
1231	sysread $SIGPIPE_R, my $dummy, 4;	1495	@signame2num{ split ' ', $Config::Config{sig_name} }
		1496	= split ' ', $Config::Config{sig_num};
1232		1497
1233	while (%SIG_EV) {	1498	my @signum2name;
1234	for (keys %SIG_EV) {	1499	@signum2name[values %signame2num] = keys %signame2num;
1235	delete $SIG_EV{$_};	1500
1236	$_->() for values %{ $SIG_CB{$_} || {} };	1501	*sig2num = sub($) {
		1502	$_[0] > 0 ? shift : $signame2num{+shift}
		1503	};
		1504	*sig2name = sub ($) {
		1505	$_[0] > 0 ? $signum2name[+shift] : shift
		1506	};
1237	}	1507	}
1238	}	1508	};
1239	}	1509	die if $@;
		1510	};
		1511
		1512	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1513	sub sig2name($) { &$_sig_name_init; &sig2name }
1240		1514
1241	sub signal {	1515	sub signal {
1242	my (undef, %arg) = @_;	1516	eval q{ # poor man's autoloading {}
		1517	# probe for availability of Async::Interrupt
		1518	if (_have_async_interrupt) {
		1519	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1243		1520
1244	unless ($SIGPIPE_R) {	1521	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1245	require Fcntl;	1522	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1246		1523
1247	if (AnyEvent::WIN32) {
1248	require AnyEvent::Util;
1249
1250	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1251	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1252	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1253	} else {	1524	} else {
		1525	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1526
		1527	if (AnyEvent::WIN32) {
		1528	require AnyEvent::Util;
		1529
		1530	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1531	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1532	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1533	} else {
1254	pipe $SIGPIPE_R, $SIGPIPE_W;	1534	pipe $SIGPIPE_R, $SIGPIPE_W;
1255	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1535	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1256	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1536	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1257		1537
1258	# not strictly required, as $^F is normally 2, but let's make sure...	1538	# not strictly required, as $^F is normally 2, but let's make sure...
1259	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1539	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1260	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1540	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
		1541	}
		1542
		1543	$SIGPIPE_R
		1544	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1545
		1546	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1261	}	1547	}
1262		1548
1263	$SIGPIPE_R	1549	*signal = $HAVE_ASYNC_INTERRUPT
1264	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1550	? sub {
		1551	my (undef, %arg) = @_;
1265		1552
1266	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);	1553	# async::interrupt
1267	}
1268
1269	my $signal = uc $arg{signal}	1554	my $signal = sig2num $arg{signal};
1270	or Carp::croak "required option 'signal' is missing";
1271
1272	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1555	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1556
		1557	$SIG_ASY{$signal} ||= new Async::Interrupt
		1558	cb => sub { undef $SIG_EV{$signal} },
		1559	signal => $signal,
		1560	pipe => [$SIGPIPE_R->filenos],
		1561	pipe_autodrain => 0,
		1562	;
		1563
		1564	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1565	}
		1566	: sub {
		1567	my (undef, %arg) = @_;
		1568
		1569	# pure perl
		1570	my $signal = sig2name $arg{signal};
		1571	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1572
1273	$SIG{$signal} ||= sub {	1573	$SIG{$signal} ||= sub {
1274	local $!;	1574	local $!;
1275	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1575	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1276	undef $SIG_EV{$signal};	1576	undef $SIG_EV{$signal};
		1577	};
		1578
		1579	# can't do signal processing without introducing races in pure perl,
		1580	# so limit the signal latency.
		1581	_sig_add;
		1582
		1583	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1584	}
		1585	;
		1586
		1587	*AnyEvent::Base::signal::DESTROY = sub {
		1588	my ($signal, $cb) = @{$_[0]};
		1589
		1590	_sig_del;
		1591
		1592	delete $SIG_CB{$signal}{$cb};
		1593
		1594	$HAVE_ASYNC_INTERRUPT
		1595	? delete $SIG_ASY{$signal}
		1596	: # delete doesn't work with older perls - they then
		1597	# print weird messages, or just unconditionally exit
		1598	# instead of getting the default action.
		1599	undef $SIG{$signal}
		1600	unless keys %{ $SIG_CB{$signal} };
		1601	};
		1602
		1603	*_signal_exec = sub {
		1604	$HAVE_ASYNC_INTERRUPT
		1605	? $SIGPIPE_R->drain
		1606	: sysread $SIGPIPE_R, (my $dummy), 9;
		1607
		1608	while (%SIG_EV) {
		1609	for (keys %SIG_EV) {
		1610	delete $SIG_EV{$_};
		1611	$_->() for values %{ $SIG_CB{$_} || {} };
		1612	}
		1613	}
		1614	};
1277	};	1615	};
		1616	die if $@;
1278		1617
1279	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1618	&signal
1280	}
1281
1282	sub AnyEvent::Base::signal::DESTROY {
1283	my ($signal, $cb) = @{$_[0]};
1284
1285	delete $SIG_CB{$signal}{$cb};
1286
1287	# delete doesn't work with older perls - they then
1288	# print weird messages, or just unconditionally exit
1289	# instead of getting the default action.
1290	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1291	}	1619	}
1292		1620
1293	# default implementation for ->child	1621	# default implementation for ->child
1294		1622
1295	our %PID_CB;	1623	our %PID_CB;
1296	our $CHLD_W;	1624	our $CHLD_W;
1297	our $CHLD_DELAY_W;	1625	our $CHLD_DELAY_W;
1298	our $WNOHANG;	1626	our $WNOHANG;
1299		1627
1300	sub _sigchld {	1628	# used by many Impl's
1301	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1629	sub _emit_childstatus($$) {
		1630	my (undef, $rpid, $rstatus) = @_;
		1631
		1632	$_->($rpid, $rstatus)
1302	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1633	for values %{ $PID_CB{$rpid} || {} },
1303	(values %{ $PID_CB{0} || {} });	1634	values %{ $PID_CB{0} || {} };
1304	}
1305	}	1635	}
1306		1636
1307	sub child {	1637	sub child {
		1638	eval q{ # poor man's autoloading {}
		1639	*_sigchld = sub {
		1640	my $pid;
		1641
		1642	AnyEvent->_emit_childstatus ($pid, $?)
		1643	while ($pid = waitpid -1, $WNOHANG) > 0;
		1644	};
		1645
		1646	*child = sub {
1308	my (undef, %arg) = @_;	1647	my (undef, %arg) = @_;
1309		1648
1310	defined (my $pid = $arg{pid} + 0)	1649	defined (my $pid = $arg{pid} + 0)
1311	or Carp::croak "required option 'pid' is missing";	1650	or Carp::croak "required option 'pid' is missing";
1312		1651
1313	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1652	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1314		1653
		1654	# WNOHANG is almost cetrainly 1 everywhere
		1655	$WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
		1656	? 1
1315	$WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1657	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1316		1658
1317	unless ($CHLD_W) {	1659	unless ($CHLD_W) {
1318	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1660	$CHLD_W = AE::signal CHLD => \&_sigchld;
1319	# child could be a zombie already, so make at least one round	1661	# child could be a zombie already, so make at least one round
1320	&_sigchld;	1662	&_sigchld;
1321	}	1663	}
1322		1664
1323	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1665	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1324	}	1666	};
1325		1667
1326	sub AnyEvent::Base::child::DESTROY {	1668	*AnyEvent::Base::child::DESTROY = sub {
1327	my ($pid, $cb) = @{$_[0]};	1669	my ($pid, $cb) = @{$_[0]};
1328		1670
1329	delete $PID_CB{$pid}{$cb};	1671	delete $PID_CB{$pid}{$cb};
1330	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1672	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1331		1673
1332	undef $CHLD_W unless keys %PID_CB;	1674	undef $CHLD_W unless keys %PID_CB;
		1675	};
		1676	};
		1677	die if $@;
		1678
		1679	&child
1333	}	1680	}
1334		1681
1335	# idle emulation is done by simply using a timer, regardless	1682	# idle emulation is done by simply using a timer, regardless
1336	# of whether the process is idle or not, and not letting	1683	# of whether the process is idle or not, and not letting
1337	# the callback use more than 50% of the time.	1684	# the callback use more than 50% of the time.
1338	sub idle {	1685	sub idle {
		1686	eval q{ # poor man's autoloading {}
		1687	*idle = sub {
1339	my (undef, %arg) = @_;	1688	my (undef, %arg) = @_;
1340		1689
1341	my ($cb, $w, $rcb) = $arg{cb};	1690	my ($cb, $w, $rcb) = $arg{cb};
1342		1691
1343	$rcb = sub {	1692	$rcb = sub {
1344	if ($cb) {	1693	if ($cb) {
1345	$w = _time;	1694	$w = _time;
1346	&$cb;	1695	&$cb;
1347	$w = _time - $w;	1696	$w = _time - $w;
1348		1697
1349	# never use more then 50% of the time for the idle watcher,	1698	# never use more then 50% of the time for the idle watcher,
1350	# within some limits	1699	# within some limits
1351	$w = 0.0001 if $w < 0.0001;	1700	$w = 0.0001 if $w < 0.0001;
1352	$w = 5 if $w > 5;	1701	$w = 5 if $w > 5;
1353		1702
1354	$w = AnyEvent->timer (after => $w, cb => $rcb);	1703	$w = AE::timer $w, 0, $rcb;
1355	} else {	1704	} else {
1356	# clean up...	1705	# clean up...
1357	undef $w;	1706	undef $w;
1358	undef $rcb;	1707	undef $rcb;
		1708	}
		1709	};
		1710
		1711	$w = AE::timer 0.05, 0, $rcb;
		1712
		1713	bless \\$cb, "AnyEvent::Base::idle"
1359	}	1714	};
		1715
		1716	*AnyEvent::Base::idle::DESTROY = sub {
		1717	undef $${$_[0]};
		1718	};
1360	};	1719	};
		1720	die if $@;
1361		1721
1362	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1722	&idle
1363
1364	bless \\$cb, "AnyEvent::Base::idle"
1365	}
1366
1367	sub AnyEvent::Base::idle::DESTROY {
1368	undef $${$_[0]};
1369	}	1723	}
1370		1724
1371	package AnyEvent::CondVar;	1725	package AnyEvent::CondVar;
1372		1726
1373	our @ISA = AnyEvent::CondVar::Base::;	1727	our @ISA = AnyEvent::CondVar::Base::;
1374		1728
1375	package AnyEvent::CondVar::Base;	1729	package AnyEvent::CondVar::Base;
1376		1730
1377	use overload	1731	#use overload
1378	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1732	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1379	fallback => 1;	1733	# fallback => 1;
		1734
		1735	# save 300+ kilobytes by dirtily hardcoding overloading
		1736	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1737	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1738	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1739	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
		1740
		1741	our $WAITING;
1380		1742
1381	sub _send {	1743	sub _send {
1382	# nop	1744	# nop
1383	}	1745	}
1384		1746
…		…
1397	sub ready {	1759	sub ready {
1398	$_[0]{_ae_sent}	1760	$_[0]{_ae_sent}
1399	}	1761	}
1400		1762
1401	sub _wait {	1763	sub _wait {
		1764	$WAITING
		1765	and !$_[0]{_ae_sent}
		1766	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1767
		1768	local $WAITING = 1;
1402	AnyEvent->one_event while !$_[0]{_ae_sent};	1769	AnyEvent->one_event while !$_[0]{_ae_sent};
1403	}	1770	}
1404		1771
1405	sub recv {	1772	sub recv {
1406	$_[0]->_wait;	1773	$_[0]->_wait;
…		…
1408	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1775	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1409	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1776	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1410	}	1777	}
1411		1778
1412	sub cb {	1779	sub cb {
1413	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1780	my $cv = shift;
		1781
		1782	@_
		1783	and $cv->{_ae_cb} = shift
		1784	and $cv->{_ae_sent}
		1785	and (delete $cv->{_ae_cb})->($cv);
		1786
1414	$_[0]{_ae_cb}	1787	$cv->{_ae_cb}
1415	}	1788	}
1416		1789
1417	sub begin {	1790	sub begin {
1418	++$_[0]{_ae_counter};	1791	++$_[0]{_ae_counter};
1419	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1792	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1468	C<PERL_ANYEVENT_MODEL>.	1841	C<PERL_ANYEVENT_MODEL>.
1469		1842
1470	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1843	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1471	model it chooses.	1844	model it chooses.
1472		1845
		1846	When set to C<8> or higher, then AnyEvent will report extra information on
		1847	which optional modules it loads and how it implements certain features.
		1848
1473	=item C<PERL_ANYEVENT_STRICT>	1849	=item C<PERL_ANYEVENT_STRICT>
1474		1850
1475	AnyEvent does not do much argument checking by default, as thorough	1851	AnyEvent does not do much argument checking by default, as thorough
1476	argument checking is very costly. Setting this variable to a true value	1852	argument checking is very costly. Setting this variable to a true value
1477	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1853	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1478	check the arguments passed to most method calls. If it finds any problems,	1854	check the arguments passed to most method calls. If it finds any problems,
1479	it will croak.	1855	it will croak.
1480		1856
1481	In other words, enables "strict" mode.	1857	In other words, enables "strict" mode.
1482		1858
1483	Unlike C<use strict>, it is definitely recommended to keep it off in	1859	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1484	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1860	>>, it is definitely recommended to keep it off in production. Keeping
1485	developing programs can be very useful, however.	1861	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1862	can be very useful, however.
1486		1863
1487	=item C<PERL_ANYEVENT_MODEL>	1864	=item C<PERL_ANYEVENT_MODEL>
1488		1865
1489	This can be used to specify the event model to be used by AnyEvent, before	1866	This can be used to specify the event model to be used by AnyEvent, before
1490	auto detection and -probing kicks in. It must be a string consisting	1867	auto detection and -probing kicks in. It must be a string consisting
…		…
1552		1929
1553	When neither C<ca_file> nor C<ca_path> was specified during	1930	When neither C<ca_file> nor C<ca_path> was specified during
1554	L<AnyEvent::TLS> context creation, and either of these environment	1931	L<AnyEvent::TLS> context creation, and either of these environment
1555	variables exist, they will be used to specify CA certificate locations	1932	variables exist, they will be used to specify CA certificate locations
1556	instead of a system-dependent default.	1933	instead of a system-dependent default.
		1934
		1935	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1936
		1937	When these are set to C<1>, then the respective modules are not
		1938	loaded. Mostly good for testing AnyEvent itself.
1557		1939
1558	=back	1940	=back
1559		1941
1560	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1942	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1561		1943
…		…
1619	warn "read: $input\n"; # output what has been read	2001	warn "read: $input\n"; # output what has been read
1620	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2002	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1621	},	2003	},
1622	);	2004	);
1623		2005
1624	my $time_watcher; # can only be used once
1625
1626	sub new_timer {
1627	$timer = AnyEvent->timer (after => 1, cb => sub {	2006	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1628	warn "timeout\n"; # print 'timeout' about every second	2007	warn "timeout\n"; # print 'timeout' at most every second
1629	&new_timer; # and restart the time
1630	});	2008	});
1631	}
1632
1633	new_timer; # create first timer
1634		2009
1635	$cv->recv; # wait until user enters /^q/i	2010	$cv->recv; # wait until user enters /^q/i
1636		2011
1637	=head1 REAL-WORLD EXAMPLE	2012	=head1 REAL-WORLD EXAMPLE
1638		2013
…		…
1711		2086
1712	The actual code goes further and collects all errors (C<die>s, exceptions)	2087	The actual code goes further and collects all errors (C<die>s, exceptions)
1713	that occurred during request processing. The C<result> method detects	2088	that occurred during request processing. The C<result> method detects
1714	whether an exception as thrown (it is stored inside the $txn object)	2089	whether an exception as thrown (it is stored inside the $txn object)
1715	and just throws the exception, which means connection errors and other	2090	and just throws the exception, which means connection errors and other
1716	problems get reported tot he code that tries to use the result, not in a	2091	problems get reported to the code that tries to use the result, not in a
1717	random callback.	2092	random callback.
1718		2093
1719	All of this enables the following usage styles:	2094	All of this enables the following usage styles:
1720		2095
1721	1. Blocking:	2096	1. Blocking:
…		…
1769	through AnyEvent. The benchmark creates a lot of timers (with a zero	2144	through AnyEvent. The benchmark creates a lot of timers (with a zero
1770	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2145	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1771	which it is), lets them fire exactly once and destroys them again.	2146	which it is), lets them fire exactly once and destroys them again.
1772		2147
1773	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2148	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1774	distribution.	2149	distribution. It uses the L<AE> interface, which makes a real difference
		2150	for the EV and Perl backends only.
1775		2151
1776	=head3 Explanation of the columns	2152	=head3 Explanation of the columns
1777		2153
1778	I<watcher> is the number of event watchers created/destroyed. Since	2154	I<watcher> is the number of event watchers created/destroyed. Since
1779	different event models feature vastly different performances, each event	2155	different event models feature vastly different performances, each event
…		…
1800	watcher.	2176	watcher.
1801		2177
1802	=head3 Results	2178	=head3 Results
1803		2179
1804	name watchers bytes create invoke destroy comment	2180	name watchers bytes create invoke destroy comment
1805	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2181	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1806	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2182	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1807	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2183	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1808	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2184	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1809	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2185	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1810	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2186	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1811	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2187	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1812	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2188	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1813	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2189	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1814	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2190	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1815	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2191	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1816	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2192	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1817		2193
1818	=head3 Discussion	2194	=head3 Discussion
1819		2195
1820	The benchmark does I<not> measure scalability of the event loop very	2196	The benchmark does I<not> measure scalability of the event loop very
1821	well. For example, a select-based event loop (such as the pure perl one)	2197	well. For example, a select-based event loop (such as the pure perl one)
…		…
1833	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2209	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1834	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2210	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1835	cycles with POE.	2211	cycles with POE.
1836		2212
1837	C<EV> is the sole leader regarding speed and memory use, which are both	2213	C<EV> is the sole leader regarding speed and memory use, which are both
1838	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2214	maximal/minimal, respectively. When using the L<AE> API there is zero
		2215	overhead (when going through the AnyEvent API create is about 5-6 times
		2216	slower, with other times being equal, so still uses far less memory than
1839	far less memory than any other event loop and is still faster than Event	2217	any other event loop and is still faster than Event natively).
1840	natively.
1841		2218
1842	The pure perl implementation is hit in a few sweet spots (both the	2219	The pure perl implementation is hit in a few sweet spots (both the
1843	constant timeout and the use of a single fd hit optimisations in the perl	2220	constant timeout and the use of a single fd hit optimisations in the perl
1844	interpreter and the backend itself). Nevertheless this shows that it	2221	interpreter and the backend itself). Nevertheless this shows that it
1845	adds very little overhead in itself. Like any select-based backend its	2222	adds very little overhead in itself. Like any select-based backend its
…		…
1919	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2296	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1920	(1%) are active. This mirrors the activity of large servers with many	2297	(1%) are active. This mirrors the activity of large servers with many
1921	connections, most of which are idle at any one point in time.	2298	connections, most of which are idle at any one point in time.
1922		2299
1923	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2300	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1924	distribution.	2301	distribution. It uses the L<AE> interface, which makes a real difference
		2302	for the EV and Perl backends only.
1925		2303
1926	=head3 Explanation of the columns	2304	=head3 Explanation of the columns
1927		2305
1928	I<sockets> is the number of sockets, and twice the number of "servers" (as	2306	I<sockets> is the number of sockets, and twice the number of "servers" (as
1929	each server has a read and write socket end).	2307	each server has a read and write socket end).
…		…
1937	a new one that moves the timeout into the future.	2315	a new one that moves the timeout into the future.
1938		2316
1939	=head3 Results	2317	=head3 Results
1940		2318
1941	name sockets create request	2319	name sockets create request
1942	EV 20000 69.01 11.16	2320	EV 20000 62.66 7.99
1943	Perl 20000 73.32 35.87	2321	Perl 20000 68.32 32.64
1944	IOAsync 20000 157.00 98.14 epoll	2322	IOAsync 20000 174.06 101.15 epoll
1945	IOAsync 20000 159.31 616.06 poll	2323	IOAsync 20000 174.67 610.84 poll
1946	Event 20000 212.62 257.32	2324	Event 20000 202.69 242.91
1947	Glib 20000 651.16 1896.30	2325	Glib 20000 557.01 1689.52
1948	POE 20000 349.67 12317.24 uses POE::Loop::Event	2326	POE 20000 341.54 12086.32 uses POE::Loop::Event
1949		2327
1950	=head3 Discussion	2328	=head3 Discussion
1951		2329
1952	This benchmark I<does> measure scalability and overall performance of the	2330	This benchmark I<does> measure scalability and overall performance of the
1953	particular event loop.	2331	particular event loop.
…		…
2079	As you can see, the AnyEvent + EV combination even beats the	2457	As you can see, the AnyEvent + EV combination even beats the
2080	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2458	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2081	backend easily beats IO::Lambda and POE.	2459	backend easily beats IO::Lambda and POE.
2082		2460
2083	And even the 100% non-blocking version written using the high-level (and	2461	And even the 100% non-blocking version written using the high-level (and
2084	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2462	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2085	large margin, even though it does all of DNS, tcp-connect and socket I/O	2463	higher level ("unoptimised") abstractions by a large margin, even though
2086	in a non-blocking way.	2464	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2087		2465
2088	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2466	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2089	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2467	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2090	part of the IO::lambda distribution and were used without any changes.	2468	part of the IO::Lambda distribution and were used without any changes.
2091		2469
2092		2470
2093	=head1 SIGNALS	2471	=head1 SIGNALS
2094		2472
2095	AnyEvent currently installs handlers for these signals:	2473	AnyEvent currently installs handlers for these signals:
…		…
2100		2478
2101	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2479	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2102	emulation for event loops that do not support them natively. Also, some	2480	emulation for event loops that do not support them natively. Also, some
2103	event loops install a similar handler.	2481	event loops install a similar handler.
2104		2482
2105	If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will	2483	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2106	reset it to default, to avoid losing child exit statuses.	2484	AnyEvent will reset it to default, to avoid losing child exit statuses.
2107		2485
2108	=item SIGPIPE	2486	=item SIGPIPE
2109		2487
2110	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2488	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2111	when AnyEvent gets loaded.	2489	when AnyEvent gets loaded.
…		…
2129	if $SIG{CHLD} eq 'IGNORE';	2507	if $SIG{CHLD} eq 'IGNORE';
2130		2508
2131	$SIG{PIPE} = sub { }	2509	$SIG{PIPE} = sub { }
2132	unless defined $SIG{PIPE};	2510	unless defined $SIG{PIPE};
2133		2511
		2512	=head1 RECOMMENDED/OPTIONAL MODULES
		2513
		2514	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2515	it's built-in modules) are required to use it.
		2516
		2517	That does not mean that AnyEvent won't take advantage of some additional
		2518	modules if they are installed.
		2519
		2520	This section explains which additional modules will be used, and how they
		2521	affect AnyEvent's operation.
		2522
		2523	=over 4
		2524
		2525	=item L<Async::Interrupt>
		2526
		2527	This slightly arcane module is used to implement fast signal handling: To
		2528	my knowledge, there is no way to do completely race-free and quick
		2529	signal handling in pure perl. To ensure that signals still get
		2530	delivered, AnyEvent will start an interval timer to wake up perl (and
		2531	catch the signals) with some delay (default is 10 seconds, look for
		2532	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2533
		2534	If this module is available, then it will be used to implement signal
		2535	catching, which means that signals will not be delayed, and the event loop
		2536	will not be interrupted regularly, which is more efficient (and good for
		2537	battery life on laptops).
		2538
		2539	This affects not just the pure-perl event loop, but also other event loops
		2540	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2541
		2542	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2543	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2544	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2545	does nothing for those backends.
		2546
		2547	=item L<EV>
		2548
		2549	This module isn't really "optional", as it is simply one of the backend
		2550	event loops that AnyEvent can use. However, it is simply the best event
		2551	loop available in terms of features, speed and stability: It supports
		2552	the AnyEvent API optimally, implements all the watcher types in XS, does
		2553	automatic timer adjustments even when no monotonic clock is available,
		2554	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2555	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2556	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2557
		2558	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2559	then this module will do nothing for you.
		2560
		2561	=item L<Guard>
		2562
		2563	The guard module, when used, will be used to implement
		2564	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2565	lot less memory), but otherwise doesn't affect guard operation much. It is
		2566	purely used for performance.
		2567
		2568	=item L<JSON> and L<JSON::XS>
		2569
		2570	One of these modules is required when you want to read or write JSON data
		2571	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
		2572	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2573
		2574	=item L<Net::SSLeay>
		2575
		2576	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2577	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2578	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2579
		2580	=item L<Time::HiRes>
		2581
		2582	This module is part of perl since release 5.008. It will be used when the
		2583	chosen event library does not come with a timing source on it's own. The
		2584	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2585	try to use a monotonic clock for timing stability.
		2586
		2587	=back
		2588
		2589
2134	=head1 FORK	2590	=head1 FORK
2135		2591
2136	Most event libraries are not fork-safe. The ones who are usually are	2592	Most event libraries are not fork-safe. The ones who are usually are
2137	because they rely on inefficient but fork-safe C<select> or C<poll>	2593	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2138	calls. Only L<EV> is fully fork-aware.	2594	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2595	are usually badly thought-out hacks that are incompatible with fork in
		2596	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2597	continue event-processing in both parent and child (or both, if you know
		2598	what you are doing).
		2599
		2600	This means that, in general, you cannot fork and do event processing in
		2601	the child if the event library was initialised before the fork (which
		2602	usually happens when the first AnyEvent watcher is created, or the library
		2603	is loaded).
2139		2604
2140	If you have to fork, you must either do so I<before> creating your first	2605	If you have to fork, you must either do so I<before> creating your first
2141	watcher OR you must not use AnyEvent at all in the child.	2606	watcher OR you must not use AnyEvent at all in the child OR you must do
		2607	something completely out of the scope of AnyEvent.
		2608
		2609	The problem of doing event processing in the parent I<and> the child
		2610	is much more complicated: even for backends that I<are> fork-aware or
		2611	fork-safe, their behaviour is not usually what you want: fork clones all
		2612	watchers, that means all timers, I/O watchers etc. are active in both
		2613	parent and child, which is almost never what you want. USing C<exec>
		2614	to start worker children from some kind of manage rprocess is usually
		2615	preferred, because it is much easier and cleaner, at the expense of having
		2616	to have another binary.
2142		2617
2143		2618
2144	=head1 SECURITY CONSIDERATIONS	2619	=head1 SECURITY CONSIDERATIONS
2145		2620
2146	AnyEvent can be forced to load any event model via	2621	AnyEvent can be forced to load any event model via
…		…
2184	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2659	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2185		2660
2186	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2661	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2187	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2662	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2188	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2663	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2189	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2664	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2190		2665
2191	Non-blocking file handles, sockets, TCP clients and	2666	Non-blocking file handles, sockets, TCP clients and
2192	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2667	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2193		2668
2194	Asynchronous DNS: L<AnyEvent::DNS>.	2669	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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