[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs.
Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - events independent of event loop implementation	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
47		47
48	There is a mailinglist for discussing all things AnyEvent, and an IRC	48	There is a mailinglist for discussing all things AnyEvent, and an IRC
49	channel, too.	49	channel, too.
50		50
51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software	51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52	Respository>, at L<http://anyevent.schmorp.de>, for more info.	52	Repository>, at L<http://anyevent.schmorp.de>, for more info.
53		53
54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
55		55
56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	56	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
57	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
181	my variables are only visible after the statement in which they are	181	my variables are only visible after the statement in which they are
182	declared.	182	declared.
183		183
184	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
185		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
186	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	192	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
187	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
188		194
189	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch	195	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
190	for events (AnyEvent might or might not keep a reference to this file	196	for events (AnyEvent might or might not keep a reference to this file
…		…
219	undef $w;	225	undef $w;
220	});	226	});
221		227
222	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
223		229
		230	$w = AnyEvent->timer (after => <seconds>, cb => <callback>);
		231
		232	$w = AnyEvent->timer (
		233	after => <fractional_seconds>,
		234	interval => <fractional_seconds>,
		235	cb => <callback>,
		236	);
		237
224	You can create a time watcher by calling the C<< AnyEvent->timer >>	238	You can create a time watcher by calling the C<< AnyEvent->timer >>
225	method with the following mandatory arguments:	239	method with the following mandatory arguments:
226		240
227	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
228	supported) the callback should be invoked. C<cb> is the callback to invoke	242	supported) the callback should be invoked. C<cb> is the callback to invoke
…		…
349	might affect timers and time-outs.	363	might affect timers and time-outs.
350		364
351	When this is the case, you can call this method, which will update the	365	When this is the case, you can call this method, which will update the
352	event loop's idea of "current time".	366	event loop's idea of "current time".
353		367
		368	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		369	when mod_perl executes the script, then the event loop will have the wrong
		370	idea about the "current time" (being potentially far in the past, when the
		371	script ran the last time). In that case you should arrange a call to C<<
		372	AnyEvent->now_update >> each time the web server process wakes up again
		373	(e.g. at the start of your script, or in a handler).
		374
354	Note that updating the time I<might> cause some events to be handled.	375	Note that updating the time I<might> cause some events to be handled.
355		376
356	=back	377	=back
357		378
358	=head2 SIGNAL WATCHERS	379	=head2 SIGNAL WATCHERS
		380
		381	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
359		382
360	You can watch for signals using a signal watcher, C<signal> is the signal	383	You can watch for signals using a signal watcher, C<signal> is the signal
361	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	384	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362	callback to be invoked whenever a signal occurs.	385	callback to be invoked whenever a signal occurs.
363		386
…		…
380		403
381	Example: exit on SIGINT	404	Example: exit on SIGINT
382		405
383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384		407
		408	=head3 Restart Behaviour
		409
		410	While restart behaviour is up to the event loop implementation, most will
		411	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		412	pure perl implementation).
		413
		414	=head3 Safe/Unsafe Signals
		415
		416	Perl signals can be either "safe" (synchronous to opcode handling) or
		417	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		418	latter might corrupt your memory.
		419
		420	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		421	i.e. they will not interrupt your running perl program but will only be
		422	called as part of the normal event handling (just like timer, I/O etc.
		423	callbacks, too).
		424
385	=head3 Signal Races, Delays and Workarounds	425	=head3 Signal Races, Delays and Workarounds
386		426
387	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	427	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388	callbacks to signals in a generic way, which is a pity, as you cannot do	428	callbacks to signals in a generic way, which is a pity, as you cannot
389	race-free signal handling in perl. AnyEvent will try to do it's best, but	429	do race-free signal handling in perl, requiring C libraries for
		430	this. AnyEvent will try to do it's best, which means in some cases,
390	in some cases, signals will be delayed. The maximum time a signal might	431	signals will be delayed. The maximum time a signal might be delayed is
391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	432	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392	seconds). This variable can be changed only before the first signal	433	variable can be changed only before the first signal watcher is created,
393	watcher is created, and should be left alone otherwise. Higher values	434	and should be left alone otherwise. This variable determines how often
		435	AnyEvent polls for signals (in case a wake-up was missed). Higher values
394	will cause fewer spurious wake-ups, which is better for power and CPU	436	will cause fewer spurious wake-ups, which is better for power and CPU
		437	saving.
		438
395	saving. All these problems can be avoided by installing the optional	439	All these problems can be avoided by installing the optional
396	L<Async::Interrupt> module. This will not work with inherently broken	440	L<Async::Interrupt> module, which works with most event loops. It will not
397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>	441	work with inherently broken event loops such as L<Event> or L<Event::Lib>
398	currently, as POE does it's own workaround with one-second latency). With	442	(and not with L<POE> currently, as POE does it's own workaround with
399	those, you just have to suffer the delays.	443	one-second latency). For those, you just have to suffer the delays.
400		444
401	=head2 CHILD PROCESS WATCHERS	445	=head2 CHILD PROCESS WATCHERS
402		446
		447	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		448
403	You can also watch on a child process exit and catch its exit status.	449	You can also watch on a child process exit and catch its exit status.
404		450
405	The child process is specified by the C<pid> argument (if set to C<0>, it	451	The child process is specified by the C<pid> argument (one some backends,
406	watches for any child process exit). The watcher will triggered only when	452	using C<0> watches for any child process exit, on others this will
407	the child process has finished and an exit status is available, not on	453	croak). The watcher will be triggered only when the child process has
408	any trace events (stopped/continued).	454	finished and an exit status is available, not on any trace events
		455	(stopped/continued).
409		456
410	The callback will be called with the pid and exit status (as returned by	457	The callback will be called with the pid and exit status (as returned by
411	waitpid), so unlike other watcher types, you I<can> rely on child watcher	458	waitpid), so unlike other watcher types, you I<can> rely on child watcher
412	callback arguments.	459	callback arguments.
413		460
…		…
454	# do something else, then wait for process exit	501	# do something else, then wait for process exit
455	$done->recv;	502	$done->recv;
456		503
457	=head2 IDLE WATCHERS	504	=head2 IDLE WATCHERS
458		505
459	Sometimes there is a need to do something, but it is not so important	506	$w = AnyEvent->idle (cb => <callback>);
460	to do it instantly, but only when there is nothing better to do. This
461	"nothing better to do" is usually defined to be "no other events need
462	attention by the event loop".
463		507
464	Idle watchers ideally get invoked when the event loop has nothing	508	Repeatedly invoke the callback after the process becomes idle, until
465	better to do, just before it would block the process to wait for new	509	either the watcher is destroyed or new events have been detected.
466	events. Instead of blocking, the idle watcher is invoked.
467		510
468	Most event loops unfortunately do not really support idle watchers (only	511	Idle watchers are useful when there is a need to do something, but it
		512	is not so important (or wise) to do it instantly. The callback will be
		513	invoked only when there is "nothing better to do", which is usually
		514	defined as "all outstanding events have been handled and no new events
		515	have been detected". That means that idle watchers ideally get invoked
		516	when the event loop has just polled for new events but none have been
		517	detected. Instead of blocking to wait for more events, the idle watchers
		518	will be invoked.
		519
		520	Unfortunately, most event loops do not really support idle watchers (only
469	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	521	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
470	will simply call the callback "from time to time".	522	will simply call the callback "from time to time".
471		523
472	Example: read lines from STDIN, but only process them when the	524	Example: read lines from STDIN, but only process them when the
473	program is otherwise idle:	525	program is otherwise idle:
…		…
489	});	541	});
490	});	542	});
491		543
492	=head2 CONDITION VARIABLES	544	=head2 CONDITION VARIABLES
493		545
		546	$cv = AnyEvent->condvar;
		547
		548	$cv->send (<list>);
		549	my @res = $cv->recv;
		550
494	If you are familiar with some event loops you will know that all of them	551	If you are familiar with some event loops you will know that all of them
495	require you to run some blocking "loop", "run" or similar function that	552	require you to run some blocking "loop", "run" or similar function that
496	will actively watch for new events and call your callbacks.	553	will actively watch for new events and call your callbacks.
497		554
498	AnyEvent is slightly different: it expects somebody else to run the event	555	AnyEvent is slightly different: it expects somebody else to run the event
…		…
517	Condition variables are similar to callbacks, except that you can	574	Condition variables are similar to callbacks, except that you can
518	optionally wait for them. They can also be called merge points - points	575	optionally wait for them. They can also be called merge points - points
519	in time where multiple outstanding events have been processed. And yet	576	in time where multiple outstanding events have been processed. And yet
520	another way to call them is transactions - each condition variable can be	577	another way to call them is transactions - each condition variable can be
521	used to represent a transaction, which finishes at some point and delivers	578	used to represent a transaction, which finishes at some point and delivers
522	a result.	579	a result. And yet some people know them as "futures" - a promise to
		580	compute/deliver something that you can wait for.
523		581
524	Condition variables are very useful to signal that something has finished,	582	Condition variables are very useful to signal that something has finished,
525	for example, if you write a module that does asynchronous http requests,	583	for example, if you write a module that does asynchronous http requests,
526	then a condition variable would be the ideal candidate to signal the	584	then a condition variable would be the ideal candidate to signal the
527	availability of results. The user can either act when the callback is	585	availability of results. The user can either act when the callback is
…		…
561	after => 1,	619	after => 1,
562	cb => sub { $result_ready->send },	620	cb => sub { $result_ready->send },
563	);	621	);
564		622
565	# this "blocks" (while handling events) till the callback	623	# this "blocks" (while handling events) till the callback
566	# calls -<send	624	# calls ->send
567	$result_ready->recv;	625	$result_ready->recv;
568		626
569	Example: wait for a timer, but take advantage of the fact that condition	627	Example: wait for a timer, but take advantage of the fact that condition
570	variables are also callable directly.	628	variables are also callable directly.
571		629
…		…
635	one. For example, a function that pings many hosts in parallel might want	693	one. For example, a function that pings many hosts in parallel might want
636	to use a condition variable for the whole process.	694	to use a condition variable for the whole process.
637		695
638	Every call to C<< ->begin >> will increment a counter, and every call to	696	Every call to C<< ->begin >> will increment a counter, and every call to
639	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	697	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
640	>>, the (last) callback passed to C<begin> will be executed. That callback	698	>>, the (last) callback passed to C<begin> will be executed, passing the
641	is I<supposed> to call C<< ->send >>, but that is not required. If no	699	condvar as first argument. That callback is I<supposed> to call C<< ->send
642	callback was set, C<send> will be called without any arguments.	700	>>, but that is not required. If no group callback was set, C<send> will
		701	be called without any arguments.
643		702
644	You can think of C<< $cv->send >> giving you an OR condition (one call	703	You can think of C<< $cv->send >> giving you an OR condition (one call
645	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	704	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
646	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	705	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
647		706
…		…
674	begung can potentially be zero:	733	begung can potentially be zero:
675		734
676	my $cv = AnyEvent->condvar;	735	my $cv = AnyEvent->condvar;
677		736
678	my %result;	737	my %result;
679	$cv->begin (sub { $cv->send (\%result) });	738	$cv->begin (sub { shift->send (\%result) });
680		739
681	for my $host (@list_of_hosts) {	740	for my $host (@list_of_hosts) {
682	$cv->begin;	741	$cv->begin;
683	ping_host_then_call_callback $host, sub {	742	ping_host_then_call_callback $host, sub {
684	$result{$host} = ...;	743	$result{$host} = ...;
…		…
759	=item $cb = $cv->cb ($cb->($cv))	818	=item $cb = $cv->cb ($cb->($cv))
760		819
761	This is a mutator function that returns the callback set and optionally	820	This is a mutator function that returns the callback set and optionally
762	replaces it before doing so.	821	replaces it before doing so.
763		822
764	The callback will be called when the condition becomes "true", i.e. when	823	The callback will be called when the condition becomes (or already was)
765	C<send> or C<croak> are called, with the only argument being the condition	824	"true", i.e. when C<send> or C<croak> are called (or were called), with
766	variable itself. Calling C<recv> inside the callback or at any later time	825	the only argument being the condition variable itself. Calling C<recv>
767	is guaranteed not to block.	826	inside the callback or at any later time is guaranteed not to block.
768		827
769	=back	828	=back
770		829
771	=head1 SUPPORTED EVENT LOOPS/BACKENDS	830	=head1 SUPPORTED EVENT LOOPS/BACKENDS
772		831
…		…
775	=over 4	834	=over 4
776		835
777	=item Backends that are autoprobed when no other event loop can be found.	836	=item Backends that are autoprobed when no other event loop can be found.
778		837
779	EV is the preferred backend when no other event loop seems to be in	838	EV is the preferred backend when no other event loop seems to be in
780	use. If EV is not installed, then AnyEvent will try Event, and, failing	839	use. If EV is not installed, then AnyEvent will fall back to its own
781	that, will fall back to its own pure-perl implementation, which is	840	pure-perl implementation, which is available everywhere as it comes with
782	available everywhere as it comes with AnyEvent itself.	841	AnyEvent itself.
783		842
784	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	843	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
785	AnyEvent::Impl::Event based on Event, very stable, few glitches.
786	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	844	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
787		845
788	=item Backends that are transparently being picked up when they are used.	846	=item Backends that are transparently being picked up when they are used.
789		847
790	These will be used when they are currently loaded when the first watcher	848	These will be used when they are currently loaded when the first watcher
791	is created, in which case it is assumed that the application is using	849	is created, in which case it is assumed that the application is using
792	them. This means that AnyEvent will automatically pick the right backend	850	them. This means that AnyEvent will automatically pick the right backend
793	when the main program loads an event module before anything starts to	851	when the main program loads an event module before anything starts to
794	create watchers. Nothing special needs to be done by the main program.	852	create watchers. Nothing special needs to be done by the main program.
795		853
		854	AnyEvent::Impl::Event based on Event, very stable, few glitches.
796	AnyEvent::Impl::Glib based on Glib, slow but very stable.	855	AnyEvent::Impl::Glib based on Glib, slow but very stable.
797	AnyEvent::Impl::Tk based on Tk, very broken.	856	AnyEvent::Impl::Tk based on Tk, very broken.
798	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	857	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
799	AnyEvent::Impl::POE based on POE, very slow, some limitations.	858	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		859	AnyEvent::Impl::Irssi used when running within irssi.
800		860
801	=item Backends with special needs.	861	=item Backends with special needs.
802		862
803	Qt requires the Qt::Application to be instantiated first, but will	863	Qt requires the Qt::Application to be instantiated first, but will
804	otherwise be picked up automatically. As long as the main program	864	otherwise be picked up automatically. As long as the main program
…		…
878	event module detection too early, for example, L<AnyEvent::AIO> creates	938	event module detection too early, for example, L<AnyEvent::AIO> creates
879	and installs the global L<IO::AIO> watcher in a C<post_detect> block to	939	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
880	avoid autodetecting the event module at load time.	940	avoid autodetecting the event module at load time.
881		941
882	If called in scalar or list context, then it creates and returns an object	942	If called in scalar or list context, then it creates and returns an object
883	that automatically removes the callback again when it is destroyed. See	943	that automatically removes the callback again when it is destroyed (or
		944	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
884	L<Coro::BDB> for a case where this is useful.	945	a case where this is useful.
		946
		947	Example: Create a watcher for the IO::AIO module and store it in
		948	C<$WATCHER>. Only do so after the event loop is initialised, though.
		949
		950	our WATCHER;
		951
		952	my $guard = AnyEvent::post_detect {
		953	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		954	};
		955
		956	# the \|\|= is important in case post_detect immediately runs the block,
		957	# as to not clobber the newly-created watcher. assigning both watcher and
		958	# post_detect guard to the same variable has the advantage of users being
		959	# able to just C<undef $WATCHER> if the watcher causes them grief.
		960
		961	$WATCHER \|\|= $guard;
885		962
886	=item @AnyEvent::post_detect	963	=item @AnyEvent::post_detect
887		964
888	If there are any code references in this array (you can C<push> to it	965	If there are any code references in this array (you can C<push> to it
889	before or after loading AnyEvent), then they will called directly after	966	before or after loading AnyEvent), then they will called directly after
…		…
892	You should check C<$AnyEvent::MODEL> before adding to this array, though:	969	You should check C<$AnyEvent::MODEL> before adding to this array, though:
893	if it is defined then the event loop has already been detected, and the	970	if it is defined then the event loop has already been detected, and the
894	array will be ignored.	971	array will be ignored.
895		972
896	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	973	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
897	it,as it takes care of these details.	974	it, as it takes care of these details.
898		975
899	This variable is mainly useful for modules that can do something useful	976	This variable is mainly useful for modules that can do something useful
900	when AnyEvent is used and thus want to know when it is initialised, but do	977	when AnyEvent is used and thus want to know when it is initialised, but do
901	not need to even load it by default. This array provides the means to hook	978	not need to even load it by default. This array provides the means to hook
902	into AnyEvent passively, without loading it.	979	into AnyEvent passively, without loading it.
		980
		981	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		982	together, you could put this into Coro (this is the actual code used by
		983	Coro to accomplish this):
		984
		985	if (defined $AnyEvent::MODEL) {
		986	# AnyEvent already initialised, so load Coro::AnyEvent
		987	require Coro::AnyEvent;
		988	} else {
		989	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		990	# as soon as it is
		991	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		992	}
903		993
904	=back	994	=back
905		995
906	=head1 WHAT TO DO IN A MODULE	996	=head1 WHAT TO DO IN A MODULE
907		997
…		…
1056		1146
1057	package AnyEvent;	1147	package AnyEvent;
1058		1148
1059	# basically a tuned-down version of common::sense	1149	# basically a tuned-down version of common::sense
1060	sub common_sense {	1150	sub common_sense {
1061	# no warnings	1151	# from common:.sense 1.0
1062	${^WARNING_BITS} ^= ${^WARNING_BITS};	1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1063	# use strict vars subs	1153	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1064	$^H \|= 0x00000600;	1154	$^H \|= 0x00000600;
1065	}	1155	}
1066		1156
1067	BEGIN { AnyEvent::common_sense }	1157	BEGIN { AnyEvent::common_sense }
1068		1158
1069	use Carp ();	1159	use Carp ();
1070		1160
1071	our $VERSION = 4.85;	1161	our $VERSION = '5.23';
1072	our $MODEL;	1162	our $MODEL;
1073		1163
1074	our $AUTOLOAD;	1164	our $AUTOLOAD;
1075	our @ISA;	1165	our @ISA;
1076		1166
1077	our @REGISTRY;	1167	our @REGISTRY;
1078
1079	our $WIN32;
1080		1168
1081	our $VERBOSE;	1169	our $VERBOSE;
1082		1170
1083	BEGIN {	1171	BEGIN {
1084	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1172	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
…		…
1101	for reverse split /\s,\s/,	1189	for reverse split /\s,\s/,
1102	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1190	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1103	}	1191	}
1104		1192
1105	my @models = (	1193	my @models = (
1106	[EV:: => AnyEvent::Impl::EV::],	1194	[EV:: => AnyEvent::Impl::EV:: , 1],
1107	[Event:: => AnyEvent::Impl::Event::],
1108	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1195	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1109	# everything below here will not be autoprobed	1196	# everything below here will not (normally) be autoprobed
1110	# as the pureperl backend should work everywhere	1197	# as the pureperl backend should work everywhere
1111	# and is usually faster	1198	# and is usually faster
		1199	[Event:: => AnyEvent::Impl::Event::, 1],
1112	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1200	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1113	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1201	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1202	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1114	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1203	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1115	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1204	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1116	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1205	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1117	[Wx:: => AnyEvent::Impl::POE::],	1206	[Wx:: => AnyEvent::Impl::POE::],
1118	[Prima:: => AnyEvent::Impl::POE::],	1207	[Prima:: => AnyEvent::Impl::POE::],
1119	# IO::Async is just too broken - we would need workarounds for its	1208	# IO::Async is just too broken - we would need workarounds for its
1120	# byzantine signal and broken child handling, among others.	1209	# byzantine signal and broken child handling, among others.
1121	# IO::Async is rather hard to detect, as it doesn't have any	1210	# IO::Async is rather hard to detect, as it doesn't have any
1122	# obvious default class.	1211	# obvious default class.
1123	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1212	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1124	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1213	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1125	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1214	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1215	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1126	);	1216	);
1127		1217
1128	our %method = map +($_ => 1),	1218	our %method = map +($_ => 1),
1129	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1219	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1130		1220
…		…
1134	my ($cb) = @_;	1224	my ($cb) = @_;
1135		1225
1136	if ($MODEL) {	1226	if ($MODEL) {
1137	$cb->();	1227	$cb->();
1138		1228
1139	1	1229	undef
1140	} else {	1230	} else {
1141	push @post_detect, $cb;	1231	push @post_detect, $cb;
1142		1232
1143	defined wantarray	1233	defined wantarray
1144	? bless \$cb, "AnyEvent::Util::postdetect"	1234	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1176	}	1266	}
1177	}	1267	}
1178	}	1268	}
1179		1269
1180	unless ($MODEL) {	1270	unless ($MODEL) {
1181	# try to load a model	1271	# try to autoload a model
1182
1183	for (@REGISTRY, @models) {	1272	for (@REGISTRY, @models) {
1184	my ($package, $model) = @$_;	1273	my ($package, $model, $autoload) = @$_;
		1274	if (
		1275	$autoload
1185	if (eval "require $package"	1276	and eval "require $package"
1186	and ${"$package\::VERSION"} > 0	1277	and ${"$package\::VERSION"} > 0
1187	and eval "require $model") {	1278	and eval "require $model"
		1279	) {
1188	$MODEL = $model;	1280	$MODEL = $model;
1189	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1281	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1190	last;	1282	last;
1191	}	1283	}
1192	}	1284	}
1193		1285
1194	$MODEL	1286	$MODEL
…		…
1235	# we assume CLOEXEC is already set by perl in all important cases	1327	# we assume CLOEXEC is already set by perl in all important cases
1236		1328
1237	($fh2, $rw)	1329	($fh2, $rw)
1238	}	1330	}
1239		1331
		1332	=head1 SIMPLIFIED AE API
		1333
		1334	Starting with version 5.0, AnyEvent officially supports a second, much
		1335	simpler, API that is designed to reduce the calling, typing and memory
		1336	overhead.
		1337
		1338	See the L<AE> manpage for details.
		1339
		1340	=cut
		1341
		1342	package AE;
		1343
		1344	our $VERSION = $AnyEvent::VERSION;
		1345
		1346	sub io($$$) {
		1347	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1348	}
		1349
		1350	sub timer($$$) {
		1351	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1352	}
		1353
		1354	sub signal($$) {
		1355	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1356	}
		1357
		1358	sub child($$) {
		1359	AnyEvent->child (pid => $_[0], cb => $_[1])
		1360	}
		1361
		1362	sub idle($) {
		1363	AnyEvent->idle (cb => $_[0])
		1364	}
		1365
		1366	sub cv(;&) {
		1367	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1368	}
		1369
		1370	sub now() {
		1371	AnyEvent->now
		1372	}
		1373
		1374	sub now_update() {
		1375	AnyEvent->now_update
		1376	}
		1377
		1378	sub time() {
		1379	AnyEvent->time
		1380	}
		1381
1240	package AnyEvent::Base;	1382	package AnyEvent::Base;
1241		1383
1242	# default implementations for many methods	1384	# default implementations for many methods
1243		1385
1244	sub _time {	1386	sub _time() {
1245	# probe for availability of Time::HiRes	1387	# probe for availability of Time::HiRes
1246	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1388	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1247	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1389	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1248	*_time = \&Time::HiRes::time;	1390	*_time = \&Time::HiRes::time;
1249	# if (eval "use POSIX (); (POSIX::times())...	1391	# if (eval "use POSIX (); (POSIX::times())...
…		…
1266	}	1408	}
1267		1409
1268	# default implementation for ->signal	1410	# default implementation for ->signal
1269		1411
1270	our $HAVE_ASYNC_INTERRUPT;	1412	our $HAVE_ASYNC_INTERRUPT;
		1413
		1414	sub _have_async_interrupt() {
		1415	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1416	&& eval "use Async::Interrupt 1.02 (); 1")
		1417	unless defined $HAVE_ASYNC_INTERRUPT;
		1418
		1419	$HAVE_ASYNC_INTERRUPT
		1420	}
		1421
1271	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1422	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1272	our (%SIG_ASY, %SIG_ASY_W);	1423	our (%SIG_ASY, %SIG_ASY_W);
1273	our ($SIG_COUNT, $SIG_TW);	1424	our ($SIG_COUNT, $SIG_TW);
1274		1425
1275	sub _signal_exec {	1426	sub _signal_exec {
1276	$HAVE_ASYNC_INTERRUPT	1427	$HAVE_ASYNC_INTERRUPT
1277	? $SIGPIPE_R->drain	1428	? $SIGPIPE_R->drain
1278	: sysread $SIGPIPE_R, my $dummy, 9;	1429	: sysread $SIGPIPE_R, (my $dummy), 9;
1279		1430
1280	while (%SIG_EV) {	1431	while (%SIG_EV) {
1281	for (keys %SIG_EV) {	1432	for (keys %SIG_EV) {
1282	delete $SIG_EV{$_};	1433	delete $SIG_EV{$_};
1283	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1434	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1284	}	1435	}
1285	}	1436	}
1286	}	1437	}
1287		1438
1288	# install a dumym wakeupw atcher to reduce signal catching latency	1439	# install a dummy wakeup watcher to reduce signal catching latency
1289	sub _sig_add() {	1440	sub _sig_add() {
1290	unless ($SIG_COUNT++) {	1441	unless ($SIG_COUNT++) {
1291	# try to align timer on a full-second boundary, if possible	1442	# try to align timer on a full-second boundary, if possible
1292	my $NOW = AnyEvent->now;	1443	my $NOW = AE::now;
1293		1444
1294	$SIG_TW = AnyEvent->timer (	1445	$SIG_TW = AE::timer
1295	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1446	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1296	interval => $MAX_SIGNAL_LATENCY,	1447	$MAX_SIGNAL_LATENCY,
1297	cb => sub { }, # just for the PERL_ASYNC_CHECK	1448	sub { } # just for the PERL_ASYNC_CHECK
1298	);	1449	;
1299	}	1450	}
1300	}	1451	}
1301		1452
1302	sub _sig_del {	1453	sub _sig_del {
1303	undef $SIG_TW	1454	undef $SIG_TW
1304	unless --$SIG_COUNT;	1455	unless --$SIG_COUNT;
1305	}	1456	}
1306		1457
		1458	our $_sig_name_init; $_sig_name_init = sub {
		1459	eval q{ # poor man's autoloading
		1460	undef $_sig_name_init;
		1461
		1462	if (_have_async_interrupt) {
		1463	*sig2num = \&Async::Interrupt::sig2num;
		1464	*sig2name = \&Async::Interrupt::sig2name;
		1465	} else {
		1466	require Config;
		1467
		1468	my %signame2num;
		1469	@signame2num{ split ' ', $Config::Config{sig_name} }
		1470	= split ' ', $Config::Config{sig_num};
		1471
		1472	my @signum2name;
		1473	@signum2name[values %signame2num] = keys %signame2num;
		1474
		1475	*sig2num = sub($) {
		1476	$_[0] > 0 ? shift : $signame2num{+shift}
		1477	};
		1478	*sig2name = sub ($) {
		1479	$_[0] > 0 ? $signum2name[+shift] : shift
		1480	};
		1481	}
		1482	};
		1483	die if $@;
		1484	};
		1485
		1486	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1487	sub sig2name($) { &$_sig_name_init; &sig2name }
		1488
1307	sub _signal {	1489	sub signal {
		1490	eval q{ # poor man's autoloading {}
		1491	# probe for availability of Async::Interrupt
		1492	if (_have_async_interrupt) {
		1493	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1494
		1495	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1496	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1497
		1498	} else {
		1499	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1500
		1501	require Fcntl;
		1502
		1503	if (AnyEvent::WIN32) {
		1504	require AnyEvent::Util;
		1505
		1506	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1507	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1508	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1509	} else {
		1510	pipe $SIGPIPE_R, $SIGPIPE_W;
		1511	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1512	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1513
		1514	# not strictly required, as $^F is normally 2, but let's make sure...
		1515	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1516	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1517	}
		1518
		1519	$SIGPIPE_R
		1520	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1521
		1522	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1523	}
		1524
		1525	*signal = sub {
1308	my (undef, %arg) = @_;	1526	my (undef, %arg) = @_;
1309		1527
1310	my $signal = uc $arg{signal}	1528	my $signal = uc $arg{signal}
1311	or Carp::croak "required option 'signal' is missing";	1529	or Carp::croak "required option 'signal' is missing";
1312		1530
1313	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1314
1315	if ($HAVE_ASYNC_INTERRUPT) {	1531	if ($HAVE_ASYNC_INTERRUPT) {
1316	# async::interrupt	1532	# async::interrupt
1317		1533
1318	$SIG_ASY{$signal} \|\|= do {	1534	$signal = sig2num $signal;
1319	my $asy = new Async::Interrupt	1535	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1536
		1537	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1320	cb => sub { undef $SIG_EV{$signal} },	1538	cb => sub { undef $SIG_EV{$signal} },
1321	signal => $signal,	1539	signal => $signal,
1322	pipe => [$SIGPIPE_R->filenos],	1540	pipe => [$SIGPIPE_R->filenos],
		1541	pipe_autodrain => 0,
		1542	;
		1543
		1544	} else {
		1545	# pure perl
		1546
		1547	# AE::Util has been loaded in signal
		1548	$signal = sig2name $signal;
		1549	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1550
		1551	$SIG{$signal} \|\|= sub {
		1552	local $!;
		1553	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1554	undef $SIG_EV{$signal};
		1555	};
		1556
		1557	# can't do signal processing without introducing races in pure perl,
		1558	# so limit the signal latency.
		1559	_sig_add;
1323	;	1560	}
1324	$asy->pipe_autodrain (0);
1325		1561
1326	$asy	1562	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1327	};	1563	};
1328		1564
1329	} else {	1565	*AnyEvent::Base::signal::DESTROY = sub {
1330	# pure perl	1566	my ($signal, $cb) = @{$_[0]};
1331		1567
1332	$SIG{$signal} \|\|= sub {	1568	_sig_del;
1333	local $!;	1569
1334	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1570	delete $SIG_CB{$signal}{$cb};
		1571
		1572	$HAVE_ASYNC_INTERRUPT
		1573	? delete $SIG_ASY{$signal}
		1574	: # delete doesn't work with older perls - they then
		1575	# print weird messages, or just unconditionally exit
		1576	# instead of getting the default action.
1335	undef $SIG_EV{$signal};	1577	undef $SIG{$signal}
		1578	unless keys %{ $SIG_CB{$signal} };
1336	};	1579	};
1337
1338	# can't do signal processing without introducing races in pure perl,
1339	# so limit the signal latency.
1340	_sig_add;
1341	}	1580	};
1342		1581	die if $@;
1343	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1344	}
1345
1346	sub signal {
1347	# probe for availability of Async::Interrupt
1348	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1349	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1350
1351	$HAVE_ASYNC_INTERRUPT = 1;
1352	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1353	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1354
1355	} else {
1356	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1357
1358	require Fcntl;
1359
1360	if (AnyEvent::WIN32) {
1361	require AnyEvent::Util;
1362
1363	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1364	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1365	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1366	} else {
1367	pipe $SIGPIPE_R, $SIGPIPE_W;
1368	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1369	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1370
1371	# not strictly required, as $^F is normally 2, but let's make sure...
1372	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1373	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1374	}
1375
1376	$SIGPIPE_R
1377	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1378
1379	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1380	}
1381
1382	*signal = \&_signal;
1383	&signal	1582	&signal
1384	}
1385
1386	sub AnyEvent::Base::signal::DESTROY {
1387	my ($signal, $cb) = @{$_[0]};
1388
1389	_sig_del;
1390
1391	delete $SIG_CB{$signal}{$cb};
1392
1393	$HAVE_ASYNC_INTERRUPT
1394	? delete $SIG_ASY{$signal}
1395	: # delete doesn't work with older perls - they then
1396	# print weird messages, or just unconditionally exit
1397	# instead of getting the default action.
1398	undef $SIG{$signal}
1399	unless keys %{ $SIG_CB{$signal} };
1400	}	1583	}
1401		1584
1402	# default implementation for ->child	1585	# default implementation for ->child
1403		1586
1404	our %PID_CB;	1587	our %PID_CB;
1405	our $CHLD_W;	1588	our $CHLD_W;
1406	our $CHLD_DELAY_W;	1589	our $CHLD_DELAY_W;
1407	our $WNOHANG;	1590	our $WNOHANG;
1408		1591
		1592	sub _emit_childstatus($$) {
		1593	my (undef, $rpid, $rstatus) = @_;
		1594
		1595	$_->($rpid, $rstatus)
		1596	for values %{ $PID_CB{$rpid} \|\| {} },
		1597	values %{ $PID_CB{0} \|\| {} };
		1598	}
		1599
1409	sub _sigchld {	1600	sub _sigchld {
		1601	my $pid;
		1602
		1603	AnyEvent->_emit_childstatus ($pid, $?)
1410	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1604	while ($pid = waitpid -1, $WNOHANG) > 0;
1411	$_->($pid, $?)
1412	for values %{ $PID_CB{$pid} \|\| {} },
1413	values %{ $PID_CB{0} \|\| {} };
1414	}
1415	}	1605	}
1416		1606
1417	sub child {	1607	sub child {
1418	my (undef, %arg) = @_;	1608	my (undef, %arg) = @_;
1419		1609
…		…
1426	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1616	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1427	? 1	1617	? 1
1428	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1618	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1429		1619
1430	unless ($CHLD_W) {	1620	unless ($CHLD_W) {
1431	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1621	$CHLD_W = AE::signal CHLD => \&_sigchld;
1432	# child could be a zombie already, so make at least one round	1622	# child could be a zombie already, so make at least one round
1433	&_sigchld;	1623	&_sigchld;
1434	}	1624	}
1435		1625
1436	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1626	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1462	# never use more then 50% of the time for the idle watcher,	1652	# never use more then 50% of the time for the idle watcher,
1463	# within some limits	1653	# within some limits
1464	$w = 0.0001 if $w < 0.0001;	1654	$w = 0.0001 if $w < 0.0001;
1465	$w = 5 if $w > 5;	1655	$w = 5 if $w > 5;
1466		1656
1467	$w = AnyEvent->timer (after => $w, cb => $rcb);	1657	$w = AE::timer $w, 0, $rcb;
1468	} else {	1658	} else {
1469	# clean up...	1659	# clean up...
1470	undef $w;	1660	undef $w;
1471	undef $rcb;	1661	undef $rcb;
1472	}	1662	}
1473	};	1663	};
1474		1664
1475	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1665	$w = AE::timer 0.05, 0, $rcb;
1476		1666
1477	bless \\$cb, "AnyEvent::Base::idle"	1667	bless \\$cb, "AnyEvent::Base::idle"
1478	}	1668	}
1479		1669
1480	sub AnyEvent::Base::idle::DESTROY {	1670	sub AnyEvent::Base::idle::DESTROY {
…		…
1534	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1724	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1535	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1725	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1536	}	1726	}
1537		1727
1538	sub cb {	1728	sub cb {
1539	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1729	my $cv = shift;
		1730
		1731	@_
		1732	and $cv->{_ae_cb} = shift
		1733	and $cv->{_ae_sent}
		1734	and (delete $cv->{_ae_cb})->($cv);
		1735
1540	$_[0]{_ae_cb}	1736	$cv->{_ae_cb}
1541	}	1737	}
1542		1738
1543	sub begin {	1739	sub begin {
1544	++$_[0]{_ae_counter};	1740	++$_[0]{_ae_counter};
1545	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1741	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1754	warn "read: $input\n"; # output what has been read	1950	warn "read: $input\n"; # output what has been read
1755	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1951	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1756	},	1952	},
1757	);	1953	);
1758		1954
1759	my $time_watcher; # can only be used once
1760
1761	sub new_timer {
1762	$timer = AnyEvent->timer (after => 1, cb => sub {	1955	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1763	warn "timeout\n"; # print 'timeout' about every second	1956	warn "timeout\n"; # print 'timeout' at most every second
1764	&new_timer; # and restart the time
1765	});	1957	});
1766	}
1767
1768	new_timer; # create first timer
1769		1958
1770	$cv->recv; # wait until user enters /^q/i	1959	$cv->recv; # wait until user enters /^q/i
1771		1960
1772	=head1 REAL-WORLD EXAMPLE	1961	=head1 REAL-WORLD EXAMPLE
1773		1962
…		…
1904	through AnyEvent. The benchmark creates a lot of timers (with a zero	2093	through AnyEvent. The benchmark creates a lot of timers (with a zero
1905	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2094	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1906	which it is), lets them fire exactly once and destroys them again.	2095	which it is), lets them fire exactly once and destroys them again.
1907		2096
1908	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2097	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1909	distribution.	2098	distribution. It uses the L<AE> interface, which makes a real difference
		2099	for the EV and Perl backends only.
1910		2100
1911	=head3 Explanation of the columns	2101	=head3 Explanation of the columns
1912		2102
1913	I<watcher> is the number of event watchers created/destroyed. Since	2103	I<watcher> is the number of event watchers created/destroyed. Since
1914	different event models feature vastly different performances, each event	2104	different event models feature vastly different performances, each event
…		…
1935	watcher.	2125	watcher.
1936		2126
1937	=head3 Results	2127	=head3 Results
1938		2128
1939	name watchers bytes create invoke destroy comment	2129	name watchers bytes create invoke destroy comment
1940	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2130	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1941	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2131	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1942	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2132	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1943	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2133	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1944	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2134	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1945	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2135	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1946	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2136	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1947	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2137	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1948	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2138	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1949	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2139	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1950	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2140	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1951	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2141	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1952		2142
1953	=head3 Discussion	2143	=head3 Discussion
1954		2144
1955	The benchmark does I<not> measure scalability of the event loop very	2145	The benchmark does I<not> measure scalability of the event loop very
1956	well. For example, a select-based event loop (such as the pure perl one)	2146	well. For example, a select-based event loop (such as the pure perl one)
…		…
1968	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2158	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1969	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2159	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1970	cycles with POE.	2160	cycles with POE.
1971		2161
1972	C<EV> is the sole leader regarding speed and memory use, which are both	2162	C<EV> is the sole leader regarding speed and memory use, which are both
1973	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2163	maximal/minimal, respectively. When using the L<AE> API there is zero
		2164	overhead (when going through the AnyEvent API create is about 5-6 times
		2165	slower, with other times being equal, so still uses far less memory than
1974	far less memory than any other event loop and is still faster than Event	2166	any other event loop and is still faster than Event natively).
1975	natively.
1976		2167
1977	The pure perl implementation is hit in a few sweet spots (both the	2168	The pure perl implementation is hit in a few sweet spots (both the
1978	constant timeout and the use of a single fd hit optimisations in the perl	2169	constant timeout and the use of a single fd hit optimisations in the perl
1979	interpreter and the backend itself). Nevertheless this shows that it	2170	interpreter and the backend itself). Nevertheless this shows that it
1980	adds very little overhead in itself. Like any select-based backend its	2171	adds very little overhead in itself. Like any select-based backend its
…		…
2054	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2245	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2055	(1%) are active. This mirrors the activity of large servers with many	2246	(1%) are active. This mirrors the activity of large servers with many
2056	connections, most of which are idle at any one point in time.	2247	connections, most of which are idle at any one point in time.
2057		2248
2058	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2249	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2059	distribution.	2250	distribution. It uses the L<AE> interface, which makes a real difference
		2251	for the EV and Perl backends only.
2060		2252
2061	=head3 Explanation of the columns	2253	=head3 Explanation of the columns
2062		2254
2063	I<sockets> is the number of sockets, and twice the number of "servers" (as	2255	I<sockets> is the number of sockets, and twice the number of "servers" (as
2064	each server has a read and write socket end).	2256	each server has a read and write socket end).
…		…
2072	a new one that moves the timeout into the future.	2264	a new one that moves the timeout into the future.
2073		2265
2074	=head3 Results	2266	=head3 Results
2075		2267
2076	name sockets create request	2268	name sockets create request
2077	EV 20000 69.01 11.16	2269	EV 20000 62.66 7.99
2078	Perl 20000 73.32 35.87	2270	Perl 20000 68.32 32.64
2079	IOAsync 20000 157.00 98.14 epoll	2271	IOAsync 20000 174.06 101.15 epoll
2080	IOAsync 20000 159.31 616.06 poll	2272	IOAsync 20000 174.67 610.84 poll
2081	Event 20000 212.62 257.32	2273	Event 20000 202.69 242.91
2082	Glib 20000 651.16 1896.30	2274	Glib 20000 557.01 1689.52
2083	POE 20000 349.67 12317.24 uses POE::Loop::Event	2275	POE 20000 341.54 12086.32 uses POE::Loop::Event
2084		2276
2085	=head3 Discussion	2277	=head3 Discussion
2086		2278
2087	This benchmark I<does> measure scalability and overall performance of the	2279	This benchmark I<does> measure scalability and overall performance of the
2088	particular event loop.	2280	particular event loop.
…		…
2214	As you can see, the AnyEvent + EV combination even beats the	2406	As you can see, the AnyEvent + EV combination even beats the
2215	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2407	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2216	backend easily beats IO::Lambda and POE.	2408	backend easily beats IO::Lambda and POE.
2217		2409
2218	And even the 100% non-blocking version written using the high-level (and	2410	And even the 100% non-blocking version written using the high-level (and
2219	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2411	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2220	large margin, even though it does all of DNS, tcp-connect and socket I/O	2412	higher level ("unoptimised") abstractions by a large margin, even though
2221	in a non-blocking way.	2413	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2222		2414
2223	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2415	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2224	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2416	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2225	part of the IO::lambda distribution and were used without any changes.	2417	part of the IO::Lambda distribution and were used without any changes.
2226		2418
2227		2419
2228	=head1 SIGNALS	2420	=head1 SIGNALS
2229		2421
2230	AnyEvent currently installs handlers for these signals:	2422	AnyEvent currently installs handlers for these signals:
…		…
2272	it's built-in modules) are required to use it.	2464	it's built-in modules) are required to use it.
2273		2465
2274	That does not mean that AnyEvent won't take advantage of some additional	2466	That does not mean that AnyEvent won't take advantage of some additional
2275	modules if they are installed.	2467	modules if they are installed.
2276		2468
2277	This section epxlains which additional modules will be used, and how they	2469	This section explains which additional modules will be used, and how they
2278	affect AnyEvent's operetion.	2470	affect AnyEvent's operation.
2279		2471
2280	=over 4	2472	=over 4
2281		2473
2282	=item L<Async::Interrupt>	2474	=item L<Async::Interrupt>
2283		2475
…		…
2288	catch the signals) with some delay (default is 10 seconds, look for	2480	catch the signals) with some delay (default is 10 seconds, look for
2289	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2481	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2290		2482
2291	If this module is available, then it will be used to implement signal	2483	If this module is available, then it will be used to implement signal
2292	catching, which means that signals will not be delayed, and the event loop	2484	catching, which means that signals will not be delayed, and the event loop
2293	will not be interrupted regularly, which is more efficient (And good for	2485	will not be interrupted regularly, which is more efficient (and good for
2294	battery life on laptops).	2486	battery life on laptops).
2295		2487
2296	This affects not just the pure-perl event loop, but also other event loops	2488	This affects not just the pure-perl event loop, but also other event loops
2297	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2489	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2298		2490
…		…
2319	lot less memory), but otherwise doesn't affect guard operation much. It is	2511	lot less memory), but otherwise doesn't affect guard operation much. It is
2320	purely used for performance.	2512	purely used for performance.
2321		2513
2322	=item L<JSON> and L<JSON::XS>	2514	=item L<JSON> and L<JSON::XS>
2323		2515
2324	This module is required when you want to read or write JSON data via	2516	One of these modules is required when you want to read or write JSON data
2325	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2517	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2326	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2518	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2327		2519
2328	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2520	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2329	installed.	2521	installed.
2330		2522
…		…
2345		2537
2346		2538
2347	=head1 FORK	2539	=head1 FORK
2348		2540
2349	Most event libraries are not fork-safe. The ones who are usually are	2541	Most event libraries are not fork-safe. The ones who are usually are
2350	because they rely on inefficient but fork-safe C<select> or C<poll>	2542	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2351	calls. Only L<EV> is fully fork-aware.	2543	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2544	are usually badly thought-out hacks that are incompatible with fork in
		2545	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2546	continue event-processing in both parent and child (or both, if you know
		2547	what you are doing).
		2548
		2549	This means that, in general, you cannot fork and do event processing in
		2550	the child if the event library was initialised before the fork (which
		2551	usually happens when the first AnyEvent watcher is created, or the library
		2552	is loaded).
2352		2553
2353	If you have to fork, you must either do so I<before> creating your first	2554	If you have to fork, you must either do so I<before> creating your first
2354	watcher OR you must not use AnyEvent at all in the child OR you must do	2555	watcher OR you must not use AnyEvent at all in the child OR you must do
2355	something completely out of the scope of AnyEvent.	2556	something completely out of the scope of AnyEvent.
		2557
		2558	The problem of doing event processing in the parent I<and> the child
		2559	is much more complicated: even for backends that I<are> fork-aware or
		2560	fork-safe, their behaviour is not usually what you want: fork clones all
		2561	watchers, that means all timers, I/O watchers etc. are active in both
		2562	parent and child, which is almost never what you want. USing C<exec>
		2563	to start worker children from some kind of manage rprocess is usually
		2564	preferred, because it is much easier and cleaner, at the expense of having
		2565	to have another binary.
2356		2566
2357		2567
2358	=head1 SECURITY CONSIDERATIONS	2568	=head1 SECURITY CONSIDERATIONS
2359		2569
2360	AnyEvent can be forced to load any event model via	2570	AnyEvent can be forced to load any event model via
…		…
2398	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2608	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2399		2609
2400	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2610	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2401	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2611	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2402	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2612	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2403	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2613	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2404		2614
2405	Non-blocking file handles, sockets, TCP clients and	2615	Non-blocking file handles, sockets, TCP clients and
2406	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2616	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2407		2617
2408	Asynchronous DNS: L<AnyEvent::DNS>.	2618	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs. Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.249 by root, Mon Jul 20 06:00:42 2009 UTC vs.
Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC