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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.273 by root, Thu Aug 6 13:45:04 2009 UTC vs.
Revision 1.326 by root, Sun Jun 6 10:11:56 2010 UTC

…		…
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 => ...
…		…
363	might affect timers and time-outs.	366	might affect timers and time-outs.
364		367
365	When this is the case, you can call this method, which will update the	368	When this is the case, you can call this method, which will update the
366	event loop's idea of "current time".	369	event loop's idea of "current time".
367		370
		371	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		372	when mod_perl executes the script, then the event loop will have the wrong
		373	idea about the "current time" (being potentially far in the past, when the
		374	script ran the last time). In that case you should arrange a call to C<<
		375	AnyEvent->now_update >> each time the web server process wakes up again
		376	(e.g. at the start of your script, or in a handler).
		377
368	Note that updating the time I<might> cause some events to be handled.	378	Note that updating the time I<might> cause some events to be handled.
369		379
370	=back	380	=back
371		381
372	=head2 SIGNAL WATCHERS	382	=head2 SIGNAL WATCHERS
…		…
395	correctly.	405	correctly.
396		406
397	Example: exit on SIGINT	407	Example: exit on SIGINT
398		408
399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	409	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		410
		411	=head3 Restart Behaviour
		412
		413	While restart behaviour is up to the event loop implementation, most will
		414	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		415	pure perl implementation).
		416
		417	=head3 Safe/Unsafe Signals
		418
		419	Perl signals can be either "safe" (synchronous to opcode handling) or
		420	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		421	latter might corrupt your memory.
		422
		423	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		424	i.e. they will not interrupt your running perl program but will only be
		425	called as part of the normal event handling (just like timer, I/O etc.
		426	callbacks, too).
400		427
401	=head3 Signal Races, Delays and Workarounds	428	=head3 Signal Races, Delays and Workarounds
402		429
403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	430	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
404	callbacks to signals in a generic way, which is a pity, as you cannot	431	callbacks to signals in a generic way, which is a pity, as you cannot
…		…
479		506
480	=head2 IDLE WATCHERS	507	=head2 IDLE WATCHERS
481		508
482	$w = AnyEvent->idle (cb => <callback>);	509	$w = AnyEvent->idle (cb => <callback>);
483		510
484	Sometimes there is a need to do something, but it is not so important	511	Repeatedly invoke the callback after the process becomes idle, until
485	to do it instantly, but only when there is nothing better to do. This	512	either the watcher is destroyed or new events have been detected.
486	"nothing better to do" is usually defined to be "no other events need
487	attention by the event loop".
488		513
489	Idle watchers ideally get invoked when the event loop has nothing	514	Idle watchers are useful when there is a need to do something, but it
490	better to do, just before it would block the process to wait for new	515	is not so important (or wise) to do it instantly. The callback will be
491	events. Instead of blocking, the idle watcher is invoked.	516	invoked only when there is "nothing better to do", which is usually
		517	defined as "all outstanding events have been handled and no new events
		518	have been detected". That means that idle watchers ideally get invoked
		519	when the event loop has just polled for new events but none have been
		520	detected. Instead of blocking to wait for more events, the idle watchers
		521	will be invoked.
492		522
493	Most event loops unfortunately do not really support idle watchers (only	523	Unfortunately, most event loops do not really support idle watchers (only
494	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	524	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
495	will simply call the callback "from time to time".	525	will simply call the callback "from time to time".
496		526
497	Example: read lines from STDIN, but only process them when the	527	Example: read lines from STDIN, but only process them when the
498	program is otherwise idle:	528	program is otherwise idle:
…		…
526	will actively watch for new events and call your callbacks.	556	will actively watch for new events and call your callbacks.
527		557
528	AnyEvent is slightly different: it expects somebody else to run the event	558	AnyEvent is slightly different: it expects somebody else to run the event
529	loop and will only block when necessary (usually when told by the user).	559	loop and will only block when necessary (usually when told by the user).
530		560
531	The instrument to do that is called a "condition variable", so called	561	The tool to do that is called a "condition variable", so called because
532	because they represent a condition that must become true.	562	they represent a condition that must become true.
533		563
534	Now is probably a good time to look at the examples further below.	564	Now is probably a good time to look at the examples further below.
535		565
536	Condition variables can be created by calling the C<< AnyEvent->condvar	566	Condition variables can be created by calling the C<< AnyEvent->condvar
537	>> method, usually without arguments. The only argument pair allowed is	567	>> method, usually without arguments. The only argument pair allowed is
…		…
542	After creation, the condition variable is "false" until it becomes "true"	572	After creation, the condition variable is "false" until it becomes "true"
543	by calling the C<send> method (or calling the condition variable as if it	573	by calling the C<send> method (or calling the condition variable as if it
544	were a callback, read about the caveats in the description for the C<<	574	were a callback, read about the caveats in the description for the C<<
545	->send >> method).	575	->send >> method).
546		576
547	Condition variables are similar to callbacks, except that you can	577	Since condition variables are the most complex part of the AnyEvent API, here are
548	optionally wait for them. They can also be called merge points - points	578	some different mental models of what they are - pick the ones you can connect to:
549	in time where multiple outstanding events have been processed. And yet	579
550	another way to call them is transactions - each condition variable can be	580	=over 4
551	used to represent a transaction, which finishes at some point and delivers	581
552	a result. And yet some people know them as "futures" - a promise to	582	=item * Condition variables are like callbacks - you can call them (and pass them instead
553	compute/deliver something that you can wait for.	583	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		584
		585	=item * Condition variables are signals - one side can emit or send them,
		586	the other side can wait for them, or install a handler that is called when
		587	the signal fires.
		588
		589	=item * Condition variables are like "Merge Points" - points in your program
		590	where you merge multiple independent results/control flows into one.
		591
		592	=item * Condition variables represent a transaction - function that start
		593	some kind of transaction can return them, leaving the caller the choice
		594	between waiting in a blocking fashion, or setting a callback.
		595
		596	=item * Condition variables represent future values, or promises to deliver
		597	some result, long before the result is available.
		598
		599	=back
554		600
555	Condition variables are very useful to signal that something has finished,	601	Condition variables are very useful to signal that something has finished,
556	for example, if you write a module that does asynchronous http requests,	602	for example, if you write a module that does asynchronous http requests,
557	then a condition variable would be the ideal candidate to signal the	603	then a condition variable would be the ideal candidate to signal the
558	availability of results. The user can either act when the callback is	604	availability of results. The user can either act when the callback is
…		…
579	eventually calls C<< -> send >>, and the "consumer side", which waits	625	eventually calls C<< -> send >>, and the "consumer side", which waits
580	for the send to occur.	626	for the send to occur.
581		627
582	Example: wait for a timer.	628	Example: wait for a timer.
583		629
584	# wait till the result is ready	630	# condition: "wait till the timer is fired"
585	my $result_ready = AnyEvent->condvar;	631	my $timer_fired = AnyEvent->condvar;
586		632
587	# do something such as adding a timer	633	# create the timer - we could wait for, say
588	# or socket watcher the calls $result_ready->send	634	# a handle becomign ready, or even an
589	# when the "result" is ready.	635	# AnyEvent::HTTP request to finish, but
590	# in this case, we simply use a timer:	636	# in this case, we simply use a timer:
591	my $w = AnyEvent->timer (	637	my $w = AnyEvent->timer (
592	after => 1,	638	after => 1,
593	cb => sub { $result_ready->send },	639	cb => sub { $timer_fired->send },
594	);	640	);
595		641
596	# this "blocks" (while handling events) till the callback	642	# this "blocks" (while handling events) till the callback
597	# calls -<send	643	# calls ->send
598	$result_ready->recv;	644	$timer_fired->recv;
599		645
600	Example: wait for a timer, but take advantage of the fact that condition	646	Example: wait for a timer, but take advantage of the fact that condition
601	variables are also callable directly.	647	variables are also callable directly.
602		648
603	my $done = AnyEvent->condvar;	649	my $done = AnyEvent->condvar;
…		…
666	one. For example, a function that pings many hosts in parallel might want	712	one. For example, a function that pings many hosts in parallel might want
667	to use a condition variable for the whole process.	713	to use a condition variable for the whole process.
668		714
669	Every call to C<< ->begin >> will increment a counter, and every call to	715	Every call to C<< ->begin >> will increment a counter, and every call to
670	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	716	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
671	>>, the (last) callback passed to C<begin> will be executed. That callback	717	>>, the (last) callback passed to C<begin> will be executed, passing the
672	is I<supposed> to call C<< ->send >>, but that is not required. If no	718	condvar as first argument. That callback is I<supposed> to call C<< ->send
673	callback was set, C<send> will be called without any arguments.	719	>>, but that is not required. If no group callback was set, C<send> will
		720	be called without any arguments.
674		721
675	You can think of C<< $cv->send >> giving you an OR condition (one call	722	You can think of C<< $cv->send >> giving you an OR condition (one call
676	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	723	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
677	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	724	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
678		725
…		…
705	begung can potentially be zero:	752	begung can potentially be zero:
706		753
707	my $cv = AnyEvent->condvar;	754	my $cv = AnyEvent->condvar;
708		755
709	my %result;	756	my %result;
710	$cv->begin (sub { $cv->send (\%result) });	757	$cv->begin (sub { shift->send (\%result) });
711		758
712	for my $host (@list_of_hosts) {	759	for my $host (@list_of_hosts) {
713	$cv->begin;	760	$cv->begin;
714	ping_host_then_call_callback $host, sub {	761	ping_host_then_call_callback $host, sub {
715	$result{$host} = ...;	762	$result{$host} = ...;
…		…
806	=over 4	853	=over 4
807		854
808	=item Backends that are autoprobed when no other event loop can be found.	855	=item Backends that are autoprobed when no other event loop can be found.
809		856
810	EV is the preferred backend when no other event loop seems to be in	857	EV is the preferred backend when no other event loop seems to be in
811	use. If EV is not installed, then AnyEvent will try Event, and, failing	858	use. If EV is not installed, then AnyEvent will fall back to its own
812	that, will fall back to its own pure-perl implementation, which is	859	pure-perl implementation, which is available everywhere as it comes with
813	available everywhere as it comes with AnyEvent itself.	860	AnyEvent itself.
814		861
815	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	862	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
816	AnyEvent::Impl::Event based on Event, very stable, few glitches.
817	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	863	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
818		864
819	=item Backends that are transparently being picked up when they are used.	865	=item Backends that are transparently being picked up when they are used.
820		866
821	These will be used when they are currently loaded when the first watcher	867	These will be used when they are currently loaded when the first watcher
822	is created, in which case it is assumed that the application is using	868	is created, in which case it is assumed that the application is using
823	them. This means that AnyEvent will automatically pick the right backend	869	them. This means that AnyEvent will automatically pick the right backend
824	when the main program loads an event module before anything starts to	870	when the main program loads an event module before anything starts to
825	create watchers. Nothing special needs to be done by the main program.	871	create watchers. Nothing special needs to be done by the main program.
826		872
		873	AnyEvent::Impl::Event based on Event, very stable, few glitches.
827	AnyEvent::Impl::Glib based on Glib, slow but very stable.	874	AnyEvent::Impl::Glib based on Glib, slow but very stable.
828	AnyEvent::Impl::Tk based on Tk, very broken.	875	AnyEvent::Impl::Tk based on Tk, very broken.
829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	876	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
830	AnyEvent::Impl::POE based on POE, very slow, some limitations.	877	AnyEvent::Impl::POE based on POE, very slow, some limitations.
831	AnyEvent::Impl::Irssi used when running within irssi.	878	AnyEvent::Impl::Irssi used when running within irssi.
…		…
941	You should check C<$AnyEvent::MODEL> before adding to this array, though:	988	You should check C<$AnyEvent::MODEL> before adding to this array, though:
942	if it is defined then the event loop has already been detected, and the	989	if it is defined then the event loop has already been detected, and the
943	array will be ignored.	990	array will be ignored.
944		991
945	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	992	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946	it,as it takes care of these details.	993	it, as it takes care of these details.
947		994
948	This variable is mainly useful for modules that can do something useful	995	This variable is mainly useful for modules that can do something useful
949	when AnyEvent is used and thus want to know when it is initialised, but do	996	when AnyEvent is used and thus want to know when it is initialised, but do
950	not need to even load it by default. This array provides the means to hook	997	not need to even load it by default. This array provides the means to hook
951	into AnyEvent passively, without loading it.	998	into AnyEvent passively, without loading it.
		999
		1000	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1001	together, you could put this into Coro (this is the actual code used by
		1002	Coro to accomplish this):
		1003
		1004	if (defined $AnyEvent::MODEL) {
		1005	# AnyEvent already initialised, so load Coro::AnyEvent
		1006	require Coro::AnyEvent;
		1007	} else {
		1008	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1009	# as soon as it is
		1010	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1011	}
952		1012
953	=back	1013	=back
954		1014
955	=head1 WHAT TO DO IN A MODULE	1015	=head1 WHAT TO DO IN A MODULE
956		1016
…		…
1013	=head1 OTHER MODULES	1073	=head1 OTHER MODULES
1014		1074
1015	The following is a non-exhaustive list of additional modules that use	1075	The following is a non-exhaustive list of additional modules that use
1016	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1076	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1017	modules and other event loops in the same program. Some of the modules	1077	modules and other event loops in the same program. Some of the modules
1018	come with AnyEvent, most are available via CPAN.	1078	come as part of AnyEvent, the others are available via CPAN.
1019		1079
1020	=over 4	1080	=over 4
1021		1081
1022	=item L<AnyEvent::Util>	1082	=item L<AnyEvent::Util>
1023		1083
…		…
1038		1098
1039	=item L<AnyEvent::DNS>	1099	=item L<AnyEvent::DNS>
1040		1100
1041	Provides rich asynchronous DNS resolver capabilities.	1101	Provides rich asynchronous DNS resolver capabilities.
1042		1102
		1103	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1104
		1105	Implement event-based interfaces to the protocols of the same name (for
		1106	the curious, IGS is the International Go Server and FCP is the Freenet
		1107	Client Protocol).
		1108
		1109	=item L<AnyEvent::Handle::UDP>
		1110
		1111	Here be danger!
		1112
		1113	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1114	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1115	it's use of a stream-based API with a protocol that isn't streamable, that
		1116	the only way to improve it is to delete it.
		1117
		1118	It features data corruption (but typically only under load) and general
		1119	confusion. On top, the author is not only clueless about UDP but also
		1120	fact-resistant - some gems of his understanding: "connect doesn't work
		1121	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1122	packets", "I don't need to implement proper error checking as UDP doesn't
		1123	support error checking" and so on - he doesn't even understand what's
		1124	wrong with his module when it is explained to him.
		1125
1043	=item L<AnyEvent::HTTP>	1126	=item L<AnyEvent::DBI>
1044		1127
1045	A simple-to-use HTTP library that is capable of making a lot of concurrent	1128	Executes L<DBI> requests asynchronously in a proxy process for you,
1046	HTTP requests.	1129	notifying you in an event-bnased way when the operation is finished.
		1130
		1131	=item L<AnyEvent::AIO>
		1132
		1133	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1134	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1135	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1136	file I/O, and much more.
1047		1137
1048	=item L<AnyEvent::HTTPD>	1138	=item L<AnyEvent::HTTPD>
1049		1139
1050	Provides a simple web application server framework.	1140	A simple embedded webserver.
1051		1141
1052	=item L<AnyEvent::FastPing>	1142	=item L<AnyEvent::FastPing>
1053		1143
1054	The fastest ping in the west.	1144	The fastest ping in the west.
1055
1056	=item L<AnyEvent::DBI>
1057
1058	Executes L<DBI> requests asynchronously in a proxy process.
1059
1060	=item L<AnyEvent::AIO>
1061
1062	Truly asynchronous I/O, should be in the toolbox of every event
1063	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1064	together.
1065
1066	=item L<AnyEvent::BDB>
1067
1068	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1069	L<BDB> and AnyEvent together.
1070
1071	=item L<AnyEvent::GPSD>
1072
1073	A non-blocking interface to gpsd, a daemon delivering GPS information.
1074
1075	=item L<AnyEvent::IRC>
1076
1077	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1078
1079	=item L<AnyEvent::XMPP>
1080
1081	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1082	Net::XMPP2>.
1083
1084	=item L<AnyEvent::IGS>
1085
1086	A non-blocking interface to the Internet Go Server protocol (used by
1087	L<App::IGS>).
1088
1089	=item L<Net::FCP>
1090
1091	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1092	of AnyEvent.
1093
1094	=item L<Event::ExecFlow>
1095
1096	High level API for event-based execution flow control.
1097		1145
1098	=item L<Coro>	1146	=item L<Coro>
1099		1147
1100	Has special support for AnyEvent via L<Coro::AnyEvent>.	1148	Has special support for AnyEvent via L<Coro::AnyEvent>.
1101		1149
…		…
1105		1153
1106	package AnyEvent;	1154	package AnyEvent;
1107		1155
1108	# basically a tuned-down version of common::sense	1156	# basically a tuned-down version of common::sense
1109	sub common_sense {	1157	sub common_sense {
1110	# no warnings	1158	# from common:.sense 1.0
1111	${^WARNING_BITS} ^= ${^WARNING_BITS};	1159	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1112	# use strict vars subs	1160	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1113	$^H \|= 0x00000600;	1161	$^H \|= 0x00000600;
1114	}	1162	}
1115		1163
1116	BEGIN { AnyEvent::common_sense }	1164	BEGIN { AnyEvent::common_sense }
1117		1165
1118	use Carp ();	1166	use Carp ();
1119		1167
1120	our $VERSION = 4.91;	1168	our $VERSION = '5.261';
1121	our $MODEL;	1169	our $MODEL;
1122		1170
1123	our $AUTOLOAD;	1171	our $AUTOLOAD;
1124	our @ISA;	1172	our @ISA;
1125		1173
1126	our @REGISTRY;	1174	our @REGISTRY;
1127		1175
1128	our $WIN32;
1129
1130	our $VERBOSE;	1176	our $VERBOSE;
1131		1177
1132	BEGIN {	1178	BEGIN {
1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1179	require "AnyEvent/constants.pl";
		1180
1134	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1181	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1135		1182
1136	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1183	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137	if ${^TAINT};	1184	if ${^TAINT};
1138		1185
1139	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1186	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1198	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1152	}	1199	}
1153		1200
1154	my @models = (	1201	my @models = (
1155	[EV:: => AnyEvent::Impl::EV:: , 1],	1202	[EV:: => AnyEvent::Impl::EV:: , 1],
1156	[Event:: => AnyEvent::Impl::Event::, 1],
1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],	1203	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1158	# everything below here will not (normally) be autoprobed	1204	# everything below here will not (normally) be autoprobed
1159	# as the pureperl backend should work everywhere	1205	# as the pureperl backend should work everywhere
1160	# and is usually faster	1206	# and is usually faster
		1207	[Event:: => AnyEvent::Impl::Event::, 1],
1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers	1208	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1209	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package	1210	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1211	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1212	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
…		…
1168	[Prima:: => AnyEvent::Impl::POE::],	1215	[Prima:: => AnyEvent::Impl::POE::],
1169	# IO::Async is just too broken - we would need workarounds for its	1216	# IO::Async is just too broken - we would need workarounds for its
1170	# byzantine signal and broken child handling, among others.	1217	# byzantine signal and broken child handling, among others.
1171	# IO::Async is rather hard to detect, as it doesn't have any	1218	# IO::Async is rather hard to detect, as it doesn't have any
1172	# obvious default class.	1219	# obvious default class.
1173	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1220	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1221	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1222	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1223	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176	);	1224	);
1177		1225
1178	our %method = map +($_ => 1),	1226	our %method = map +($_ => 1),
1179	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1227	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1180		1228
1181	our @post_detect;	1229	our @post_detect;
1182		1230
1183	sub post_detect(&) {	1231	sub post_detect(&) {
1184	my ($cb) = @_;	1232	my ($cb) = @_;
1185		1233
1186	if ($MODEL) {
1187	$cb->();
1188
1189	undef
1190	} else {
1191	push @post_detect, $cb;	1234	push @post_detect, $cb;
1192		1235
1193	defined wantarray	1236	defined wantarray
1194	? bless \$cb, "AnyEvent::Util::postdetect"	1237	? bless \$cb, "AnyEvent::Util::postdetect"
1195	: ()	1238	: ()
1196	}
1197	}	1239	}
1198		1240
1199	sub AnyEvent::Util::postdetect::DESTROY {	1241	sub AnyEvent::Util::postdetect::DESTROY {
1200	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1242	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1201	}	1243	}
1202		1244
1203	sub detect() {	1245	sub detect() {
		1246	# free some memory
		1247	*detect = sub () { $MODEL };
		1248
		1249	local $!; # for good measure
		1250	local $SIG{__DIE__};
		1251
		1252	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1253	my $model = "AnyEvent::Impl::$1";
		1254	if (eval "require $model") {
		1255	$MODEL = $model;
		1256	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1257	} else {
		1258	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1259	}
		1260	}
		1261
		1262	# check for already loaded models
1204	unless ($MODEL) {	1263	unless ($MODEL) {
1205	local $SIG{__DIE__};	1264	for (@REGISTRY, @models) {
1206		1265	my ($package, $model) = @$_;
1207	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1266	if (${"$package\::VERSION"} > 0) {
1208	my $model = "AnyEvent::Impl::$1";
1209	if (eval "require $model") {	1267	if (eval "require $model") {
1210	$MODEL = $model;	1268	$MODEL = $model;
1211	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1269	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1212	} else {	1270	last;
1213	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1271	}
1214	}	1272	}
1215	}	1273	}
1216		1274
1217	# check for already loaded models
1218	unless ($MODEL) {	1275	unless ($MODEL) {
		1276	# try to autoload a model
1219	for (@REGISTRY, @models) {	1277	for (@REGISTRY, @models) {
1220	my ($package, $model) = @$_;	1278	my ($package, $model, $autoload) = @$_;
		1279	if (
		1280	$autoload
		1281	and eval "require $package"
1221	if (${"$package\::VERSION"} > 0) {	1282	and ${"$package\::VERSION"} > 0
1222	if (eval "require $model") {	1283	and eval "require $model"
		1284	) {
1223	$MODEL = $model;	1285	$MODEL = $model;
1224	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1286	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1225	last;	1287	last;
1226	}
1227	}	1288	}
1228	}	1289	}
1229		1290
1230	unless ($MODEL) {
1231	# try to autoload a model
1232	for (@REGISTRY, @models) {
1233	my ($package, $model, $autoload) = @$_;
1234	if (
1235	$autoload
1236	and eval "require $package"
1237	and ${"$package\::VERSION"} > 0
1238	and eval "require $model"
1239	) {
1240	$MODEL = $model;
1241	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1242	last;
1243	}
1244	}
1245
1246	$MODEL	1291	$MODEL
1247	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1292	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1248	}
1249	}	1293	}
1250
1251	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1252
1253	unshift @ISA, $MODEL;
1254
1255	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1256
1257	(shift @post_detect)->() while @post_detect;
1258	}	1294	}
		1295
		1296	@models = (); # free probe data
		1297
		1298	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1299	unshift @ISA, $MODEL;
		1300
		1301	# now nuke some methods that are overriden by the backend.
		1302	# SUPER is not allowed.
		1303	for (qw(time signal child idle)) {
		1304	undef &{"AnyEvent::Base::$_"}
		1305	if defined &{"$MODEL\::$_"};
		1306	}
		1307
		1308	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1309
		1310	(shift @post_detect)->() while @post_detect;
		1311
		1312	*post_detect = sub(&) {
		1313	shift->();
		1314
		1315	undef
		1316	};
1259		1317
1260	$MODEL	1318	$MODEL
1261	}	1319	}
1262		1320
1263	sub AUTOLOAD {	1321	sub AUTOLOAD {
1264	(my $func = $AUTOLOAD) =~ s/.*://;	1322	(my $func = $AUTOLOAD) =~ s/.*://;
1265		1323
1266	$method{$func}	1324	$method{$func}
1267	or Carp::croak "$func: not a valid method for AnyEvent objects";	1325	or Carp::croak "$func: not a valid AnyEvent class method";
1268		1326
1269	detect unless $MODEL;	1327	detect;
1270		1328
1271	my $class = shift;	1329	my $class = shift;
1272	$class->$func (@_);	1330	$class->$func (@_);
1273	}	1331	}
1274		1332
…		…
1287	# we assume CLOEXEC is already set by perl in all important cases	1345	# we assume CLOEXEC is already set by perl in all important cases
1288		1346
1289	($fh2, $rw)	1347	($fh2, $rw)
1290	}	1348	}
1291		1349
1292	#############################################################################	1350	=head1 SIMPLIFIED AE API
1293	# "new" API, currently only emulation of it	1351
1294	#############################################################################	1352	Starting with version 5.0, AnyEvent officially supports a second, much
		1353	simpler, API that is designed to reduce the calling, typing and memory
		1354	overhead by using function call syntax and a fixed number of parameters.
		1355
		1356	See the L<AE> manpage for details.
		1357
		1358	=cut
1295		1359
1296	package AE;	1360	package AE;
		1361
		1362	our $VERSION = $AnyEvent::VERSION;
		1363
		1364	# fall back to the main API by default - backends and AnyEvent::Base
		1365	# implementations can overwrite these.
1297		1366
1298	sub io($$$) {	1367	sub io($$$) {
1299	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1368	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1300	}	1369	}
1301		1370
1302	sub timer($$$) {	1371	sub timer($$$) {
1303	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);	1372	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1304	}	1373	}
1305		1374
1306	sub signal($$) {	1375	sub signal($$) {
1307	AnyEvent->signal (signal => $_[0], cb => $_[1]);	1376	AnyEvent->signal (signal => $_[0], cb => $_[1])
1308	}	1377	}
1309		1378
1310	sub child($$) {	1379	sub child($$) {
1311	AnyEvent->child (pid => $_[0], cb => $_[1]);	1380	AnyEvent->child (pid => $_[0], cb => $_[1])
1312	}	1381	}
1313		1382
1314	sub idle($) {	1383	sub idle($) {
1315	AnyEvent->idle (cb => $_[0]);	1384	AnyEvent->idle (cb => $_[0])
1316	}	1385	}
1317		1386
1318	sub cv(;&) {	1387	sub cv(;&) {
1319	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())	1388	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1320	}	1389	}
…		…
1333		1402
1334	package AnyEvent::Base;	1403	package AnyEvent::Base;
1335		1404
1336	# default implementations for many methods	1405	# default implementations for many methods
1337		1406
1338	sub _time {	1407	sub time {
		1408	eval q{ # poor man's autoloading {}
1339	# probe for availability of Time::HiRes	1409	# probe for availability of Time::HiRes
1340	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1410	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1341	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1411	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1342	*_time = \&Time::HiRes::time;	1412	*AE::time = \&Time::HiRes::time;
1343	# if (eval "use POSIX (); (POSIX::times())...	1413	# if (eval "use POSIX (); (POSIX::times())...
1344	} else {	1414	} else {
1345	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1415	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1346	*_time = sub { time }; # epic fail	1416	*AE::time = sub (){ time }; # epic fail
		1417	}
		1418
		1419	*time = sub { AE::time }; # different prototypes
1347	}	1420	};
		1421	die if $@;
1348		1422
1349	&_time	1423	&time
1350	}	1424	}
1351		1425
1352	sub time { _time }	1426	*now = \&time;
1353	sub now { _time }	1427
1354	sub now_update { }	1428	sub now_update { }
1355		1429
1356	# default implementation for ->condvar	1430	# default implementation for ->condvar
1357		1431
1358	sub condvar {	1432	sub condvar {
		1433	eval q{ # poor man's autoloading {}
		1434	*condvar = sub {
1359	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1435	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1436	};
		1437
		1438	*AE::cv = sub (;&) {
		1439	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1440	};
		1441	};
		1442	die if $@;
		1443
		1444	&condvar
1360	}	1445	}
1361		1446
1362	# default implementation for ->signal	1447	# default implementation for ->signal
1363		1448
1364	our $HAVE_ASYNC_INTERRUPT;	1449	our $HAVE_ASYNC_INTERRUPT;
1365		1450
1366	sub _have_async_interrupt() {	1451	sub _have_async_interrupt() {
1367	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1452	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1368	&& eval "use Async::Interrupt 1.0 (); 1")	1453	&& eval "use Async::Interrupt 1.02 (); 1")
1369	unless defined $HAVE_ASYNC_INTERRUPT;	1454	unless defined $HAVE_ASYNC_INTERRUPT;
1370		1455
1371	$HAVE_ASYNC_INTERRUPT	1456	$HAVE_ASYNC_INTERRUPT
1372	}	1457	}
1373		1458
1374	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1459	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1375	our (%SIG_ASY, %SIG_ASY_W);	1460	our (%SIG_ASY, %SIG_ASY_W);
1376	our ($SIG_COUNT, $SIG_TW);	1461	our ($SIG_COUNT, $SIG_TW);
1377		1462
1378	sub _signal_exec {
1379	$HAVE_ASYNC_INTERRUPT
1380	? $SIGPIPE_R->drain
1381	: sysread $SIGPIPE_R, my $dummy, 9;
1382
1383	while (%SIG_EV) {
1384	for (keys %SIG_EV) {
1385	delete $SIG_EV{$_};
1386	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1387	}
1388	}
1389	}
1390
1391	# install a dummy wakeup watcher to reduce signal catching latency	1463	# install a dummy wakeup watcher to reduce signal catching latency
		1464	# used by Impls
1392	sub _sig_add() {	1465	sub _sig_add() {
1393	unless ($SIG_COUNT++) {	1466	unless ($SIG_COUNT++) {
1394	# try to align timer on a full-second boundary, if possible	1467	# try to align timer on a full-second boundary, if possible
1395	my $NOW = AE::now;	1468	my $NOW = AE::now;
1396		1469
…		…
1406	undef $SIG_TW	1479	undef $SIG_TW
1407	unless --$SIG_COUNT;	1480	unless --$SIG_COUNT;
1408	}	1481	}
1409		1482
1410	our $_sig_name_init; $_sig_name_init = sub {	1483	our $_sig_name_init; $_sig_name_init = sub {
1411	eval q{ # poor man's autoloading	1484	eval q{ # poor man's autoloading {}
1412	undef $_sig_name_init;	1485	undef $_sig_name_init;
1413		1486
1414	if (_have_async_interrupt) {	1487	if (_have_async_interrupt) {
1415	*sig2num = \&Async::Interrupt::sig2num;	1488	*sig2num = \&Async::Interrupt::sig2num;
1416	*sig2name = \&Async::Interrupt::sig2name;	1489	*sig2name = \&Async::Interrupt::sig2name;
…		…
1448	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1521	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1449		1522
1450	} else {	1523	} else {
1451	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1524	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1452		1525
1453	require Fcntl;
1454
1455	if (AnyEvent::WIN32) {	1526	if (AnyEvent::WIN32) {
1456	require AnyEvent::Util;	1527	require AnyEvent::Util;
1457		1528
1458	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1529	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1459	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1530	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1460	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1531	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1461	} else {	1532	} else {
1462	pipe $SIGPIPE_R, $SIGPIPE_W;	1533	pipe $SIGPIPE_R, $SIGPIPE_W;
1463	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1534	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1464	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1535	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1465		1536
1466	# not strictly required, as $^F is normally 2, but let's make sure...	1537	# not strictly required, as $^F is normally 2, but let's make sure...
1467	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1538	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1468	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1539	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1469	}	1540	}
1470		1541
1471	$SIGPIPE_R	1542	$SIGPIPE_R
1472	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1543	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1473		1544
1474	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1545	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1475	}	1546	}
1476		1547
1477	*signal = sub {	1548	*signal = $HAVE_ASYNC_INTERRUPT
		1549	? sub {
1478	my (undef, %arg) = @_;	1550	my (undef, %arg) = @_;
1479		1551
1480	my $signal = uc $arg{signal}
1481	or Carp::croak "required option 'signal' is missing";
1482
1483	if ($HAVE_ASYNC_INTERRUPT) {
1484	# async::interrupt	1552	# async::interrupt
1485
1486	$signal = sig2num $signal;	1553	my $signal = sig2num $arg{signal};
1487	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1554	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1488		1555
1489	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1556	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1490	cb => sub { undef $SIG_EV{$signal} },	1557	cb => sub { undef $SIG_EV{$signal} },
1491	signal => $signal,	1558	signal => $signal,
1492	pipe => [$SIGPIPE_R->filenos],	1559	pipe => [$SIGPIPE_R->filenos],
1493	pipe_autodrain => 0,	1560	pipe_autodrain => 0,
1494	;	1561	;
1495		1562
1496	} else {	1563	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1564	}
		1565	: sub {
		1566	my (undef, %arg) = @_;
		1567
1497	# pure perl	1568	# pure perl
1498
1499	# AE::Util has been loaded in signal
1500	$signal = sig2name $signal;	1569	my $signal = sig2name $arg{signal};
1501	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1570	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1502		1571
1503	$SIG{$signal} \|\|= sub {	1572	$SIG{$signal} \|\|= sub {
1504	local $!;	1573	local $!;
1505	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1574	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1506	undef $SIG_EV{$signal};	1575	undef $SIG_EV{$signal};
1507	};	1576	};
1508		1577
1509	# can't do signal processing without introducing races in pure perl,	1578	# can't do signal processing without introducing races in pure perl,
1510	# so limit the signal latency.	1579	# so limit the signal latency.
1511	_sig_add;	1580	_sig_add;
1512	}
1513		1581
1514	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1582	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1583	}
1515	};	1584	;
1516		1585
1517	*AnyEvent::Base::signal::DESTROY = sub {	1586	*AnyEvent::Base::signal::DESTROY = sub {
1518	my ($signal, $cb) = @{$_[0]};	1587	my ($signal, $cb) = @{$_[0]};
1519		1588
1520	_sig_del;	1589	_sig_del;
…		…
1527	# print weird messages, or just unconditionally exit	1596	# print weird messages, or just unconditionally exit
1528	# instead of getting the default action.	1597	# instead of getting the default action.
1529	undef $SIG{$signal}	1598	undef $SIG{$signal}
1530	unless keys %{ $SIG_CB{$signal} };	1599	unless keys %{ $SIG_CB{$signal} };
1531	};	1600	};
		1601
		1602	*_signal_exec = sub {
		1603	$HAVE_ASYNC_INTERRUPT
		1604	? $SIGPIPE_R->drain
		1605	: sysread $SIGPIPE_R, (my $dummy), 9;
		1606
		1607	while (%SIG_EV) {
		1608	for (keys %SIG_EV) {
		1609	delete $SIG_EV{$_};
		1610	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1611	}
		1612	}
		1613	};
1532	};	1614	};
1533	die if $@;	1615	die if $@;
		1616
1534	&signal	1617	&signal
1535	}	1618	}
1536		1619
1537	# default implementation for ->child	1620	# default implementation for ->child
1538		1621
1539	our %PID_CB;	1622	our %PID_CB;
1540	our $CHLD_W;	1623	our $CHLD_W;
1541	our $CHLD_DELAY_W;	1624	our $CHLD_DELAY_W;
1542	our $WNOHANG;	1625	our $WNOHANG;
1543		1626
		1627	# used by many Impl's
1544	sub _emit_childstatus($$) {	1628	sub _emit_childstatus($$) {
1545	my (undef, $rpid, $rstatus) = @_;	1629	my (undef, $rpid, $rstatus) = @_;
1546		1630
1547	$_->($rpid, $rstatus)	1631	$_->($rpid, $rstatus)
1548	for values %{ $PID_CB{$rpid} \|\| {} },	1632	for values %{ $PID_CB{$rpid} \|\| {} },
1549	values %{ $PID_CB{0} \|\| {} };	1633	values %{ $PID_CB{0} \|\| {} };
1550	}	1634	}
1551		1635
1552	sub _sigchld {
1553	my $pid;
1554
1555	AnyEvent->_emit_childstatus ($pid, $?)
1556	while ($pid = waitpid -1, $WNOHANG) > 0;
1557	}
1558
1559	sub child {	1636	sub child {
		1637	eval q{ # poor man's autoloading {}
		1638	*_sigchld = sub {
		1639	my $pid;
		1640
		1641	AnyEvent->_emit_childstatus ($pid, $?)
		1642	while ($pid = waitpid -1, $WNOHANG) > 0;
		1643	};
		1644
		1645	*child = sub {
1560	my (undef, %arg) = @_;	1646	my (undef, %arg) = @_;
1561		1647
1562	defined (my $pid = $arg{pid} + 0)	1648	defined (my $pid = $arg{pid} + 0)
1563	or Carp::croak "required option 'pid' is missing";	1649	or Carp::croak "required option 'pid' is missing";
1564		1650
1565	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1651	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1566		1652
1567	# WNOHANG is almost cetrainly 1 everywhere	1653	# WNOHANG is almost cetrainly 1 everywhere
1568	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1654	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1569	? 1	1655	? 1
1570	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1656	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1571		1657
1572	unless ($CHLD_W) {	1658	unless ($CHLD_W) {
1573	$CHLD_W = AE::signal CHLD => \&_sigchld;	1659	$CHLD_W = AE::signal CHLD => \&_sigchld;
1574	# child could be a zombie already, so make at least one round	1660	# child could be a zombie already, so make at least one round
1575	&_sigchld;	1661	&_sigchld;
1576	}	1662	}
1577		1663
1578	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1664	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1579	}	1665	};
1580		1666
1581	sub AnyEvent::Base::child::DESTROY {	1667	*AnyEvent::Base::child::DESTROY = sub {
1582	my ($pid, $cb) = @{$_[0]};	1668	my ($pid, $cb) = @{$_[0]};
1583		1669
1584	delete $PID_CB{$pid}{$cb};	1670	delete $PID_CB{$pid}{$cb};
1585	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1671	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1586		1672
1587	undef $CHLD_W unless keys %PID_CB;	1673	undef $CHLD_W unless keys %PID_CB;
		1674	};
		1675	};
		1676	die if $@;
		1677
		1678	&child
1588	}	1679	}
1589		1680
1590	# idle emulation is done by simply using a timer, regardless	1681	# idle emulation is done by simply using a timer, regardless
1591	# of whether the process is idle or not, and not letting	1682	# of whether the process is idle or not, and not letting
1592	# the callback use more than 50% of the time.	1683	# the callback use more than 50% of the time.
1593	sub idle {	1684	sub idle {
		1685	eval q{ # poor man's autoloading {}
		1686	*idle = sub {
1594	my (undef, %arg) = @_;	1687	my (undef, %arg) = @_;
1595		1688
1596	my ($cb, $w, $rcb) = $arg{cb};	1689	my ($cb, $w, $rcb) = $arg{cb};
1597		1690
1598	$rcb = sub {	1691	$rcb = sub {
1599	if ($cb) {	1692	if ($cb) {
1600	$w = _time;	1693	$w = _time;
1601	&$cb;	1694	&$cb;
1602	$w = _time - $w;	1695	$w = _time - $w;
1603		1696
1604	# never use more then 50% of the time for the idle watcher,	1697	# never use more then 50% of the time for the idle watcher,
1605	# within some limits	1698	# within some limits
1606	$w = 0.0001 if $w < 0.0001;	1699	$w = 0.0001 if $w < 0.0001;
1607	$w = 5 if $w > 5;	1700	$w = 5 if $w > 5;
1608		1701
1609	$w = AE::timer $w, 0, $rcb;	1702	$w = AE::timer $w, 0, $rcb;
1610	} else {	1703	} else {
1611	# clean up...	1704	# clean up...
1612	undef $w;	1705	undef $w;
1613	undef $rcb;	1706	undef $rcb;
		1707	}
		1708	};
		1709
		1710	$w = AE::timer 0.05, 0, $rcb;
		1711
		1712	bless \\$cb, "AnyEvent::Base::idle"
1614	}	1713	};
		1714
		1715	*AnyEvent::Base::idle::DESTROY = sub {
		1716	undef $${$_[0]};
		1717	};
1615	};	1718	};
		1719	die if $@;
1616		1720
1617	$w = AE::timer 0.05, 0, $rcb;	1721	&idle
1618
1619	bless \\$cb, "AnyEvent::Base::idle"
1620	}
1621
1622	sub AnyEvent::Base::idle::DESTROY {
1623	undef $${$_[0]};
1624	}	1722	}
1625		1723
1626	package AnyEvent::CondVar;	1724	package AnyEvent::CondVar;
1627		1725
1628	our @ISA = AnyEvent::CondVar::Base::;	1726	our @ISA = AnyEvent::CondVar::Base::;
…		…
1902	warn "read: $input\n"; # output what has been read	2000	warn "read: $input\n"; # output what has been read
1903	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2001	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1904	},	2002	},
1905	);	2003	);
1906		2004
1907	my $time_watcher; # can only be used once
1908
1909	sub new_timer {
1910	$timer = AnyEvent->timer (after => 1, cb => sub {	2005	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1911	warn "timeout\n"; # print 'timeout' about every second	2006	warn "timeout\n"; # print 'timeout' at most every second
1912	&new_timer; # and restart the time
1913	});	2007	});
1914	}
1915
1916	new_timer; # create first timer
1917		2008
1918	$cv->recv; # wait until user enters /^q/i	2009	$cv->recv; # wait until user enters /^q/i
1919		2010
1920	=head1 REAL-WORLD EXAMPLE	2011	=head1 REAL-WORLD EXAMPLE
1921		2012
…		…
1994		2085
1995	The actual code goes further and collects all errors (C<die>s, exceptions)	2086	The actual code goes further and collects all errors (C<die>s, exceptions)
1996	that occurred during request processing. The C<result> method detects	2087	that occurred during request processing. The C<result> method detects
1997	whether an exception as thrown (it is stored inside the $txn object)	2088	whether an exception as thrown (it is stored inside the $txn object)
1998	and just throws the exception, which means connection errors and other	2089	and just throws the exception, which means connection errors and other
1999	problems get reported tot he code that tries to use the result, not in a	2090	problems get reported to the code that tries to use the result, not in a
2000	random callback.	2091	random callback.
2001		2092
2002	All of this enables the following usage styles:	2093	All of this enables the following usage styles:
2003		2094
2004	1. Blocking:	2095	1. Blocking:
…		…
2052	through AnyEvent. The benchmark creates a lot of timers (with a zero	2143	through AnyEvent. The benchmark creates a lot of timers (with a zero
2053	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2144	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2054	which it is), lets them fire exactly once and destroys them again.	2145	which it is), lets them fire exactly once and destroys them again.
2055		2146
2056	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2147	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2057	distribution.	2148	distribution. It uses the L<AE> interface, which makes a real difference
		2149	for the EV and Perl backends only.
2058		2150
2059	=head3 Explanation of the columns	2151	=head3 Explanation of the columns
2060		2152
2061	I<watcher> is the number of event watchers created/destroyed. Since	2153	I<watcher> is the number of event watchers created/destroyed. Since
2062	different event models feature vastly different performances, each event	2154	different event models feature vastly different performances, each event
…		…
2083	watcher.	2175	watcher.
2084		2176
2085	=head3 Results	2177	=head3 Results
2086		2178
2087	name watchers bytes create invoke destroy comment	2179	name watchers bytes create invoke destroy comment
2088	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2180	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2089	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2181	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2090	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2182	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2091	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2183	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2092	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2184	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2093	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2185	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2094	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2186	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2095	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2187	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2096	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2188	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2097	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2189	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2098	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2190	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2099	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2191	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2100		2192
2101	=head3 Discussion	2193	=head3 Discussion
2102		2194
2103	The benchmark does I<not> measure scalability of the event loop very	2195	The benchmark does I<not> measure scalability of the event loop very
2104	well. For example, a select-based event loop (such as the pure perl one)	2196	well. For example, a select-based event loop (such as the pure perl one)
…		…
2116	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2208	benchmark machine, handling an event takes roughly 1600 CPU cycles with
2117	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2209	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2118	cycles with POE.	2210	cycles with POE.
2119		2211
2120	C<EV> is the sole leader regarding speed and memory use, which are both	2212	C<EV> is the sole leader regarding speed and memory use, which are both
2121	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2213	maximal/minimal, respectively. When using the L<AE> API there is zero
		2214	overhead (when going through the AnyEvent API create is about 5-6 times
		2215	slower, with other times being equal, so still uses far less memory than
2122	far less memory than any other event loop and is still faster than Event	2216	any other event loop and is still faster than Event natively).
2123	natively.
2124		2217
2125	The pure perl implementation is hit in a few sweet spots (both the	2218	The pure perl implementation is hit in a few sweet spots (both the
2126	constant timeout and the use of a single fd hit optimisations in the perl	2219	constant timeout and the use of a single fd hit optimisations in the perl
2127	interpreter and the backend itself). Nevertheless this shows that it	2220	interpreter and the backend itself). Nevertheless this shows that it
2128	adds very little overhead in itself. Like any select-based backend its	2221	adds very little overhead in itself. Like any select-based backend its
…		…
2202	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2295	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2203	(1%) are active. This mirrors the activity of large servers with many	2296	(1%) are active. This mirrors the activity of large servers with many
2204	connections, most of which are idle at any one point in time.	2297	connections, most of which are idle at any one point in time.
2205		2298
2206	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2299	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2207	distribution.	2300	distribution. It uses the L<AE> interface, which makes a real difference
		2301	for the EV and Perl backends only.
2208		2302
2209	=head3 Explanation of the columns	2303	=head3 Explanation of the columns
2210		2304
2211	I<sockets> is the number of sockets, and twice the number of "servers" (as	2305	I<sockets> is the number of sockets, and twice the number of "servers" (as
2212	each server has a read and write socket end).	2306	each server has a read and write socket end).
…		…
2220	a new one that moves the timeout into the future.	2314	a new one that moves the timeout into the future.
2221		2315
2222	=head3 Results	2316	=head3 Results
2223		2317
2224	name sockets create request	2318	name sockets create request
2225	EV 20000 69.01 11.16	2319	EV 20000 62.66 7.99
2226	Perl 20000 73.32 35.87	2320	Perl 20000 68.32 32.64
2227	IOAsync 20000 157.00 98.14 epoll	2321	IOAsync 20000 174.06 101.15 epoll
2228	IOAsync 20000 159.31 616.06 poll	2322	IOAsync 20000 174.67 610.84 poll
2229	Event 20000 212.62 257.32	2323	Event 20000 202.69 242.91
2230	Glib 20000 651.16 1896.30	2324	Glib 20000 557.01 1689.52
2231	POE 20000 349.67 12317.24 uses POE::Loop::Event	2325	POE 20000 341.54 12086.32 uses POE::Loop::Event
2232		2326
2233	=head3 Discussion	2327	=head3 Discussion
2234		2328
2235	This benchmark I<does> measure scalability and overall performance of the	2329	This benchmark I<does> measure scalability and overall performance of the
2236	particular event loop.	2330	particular event loop.
…		…
2362	As you can see, the AnyEvent + EV combination even beats the	2456	As you can see, the AnyEvent + EV combination even beats the
2363	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2457	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2364	backend easily beats IO::Lambda and POE.	2458	backend easily beats IO::Lambda and POE.
2365		2459
2366	And even the 100% non-blocking version written using the high-level (and	2460	And even the 100% non-blocking version written using the high-level (and
2367	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2461	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2368	large margin, even though it does all of DNS, tcp-connect and socket I/O	2462	higher level ("unoptimised") abstractions by a large margin, even though
2369	in a non-blocking way.	2463	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2370		2464
2371	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2465	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2372	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2466	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2373	part of the IO::lambda distribution and were used without any changes.	2467	part of the IO::Lambda distribution and were used without any changes.
2374		2468
2375		2469
2376	=head1 SIGNALS	2470	=head1 SIGNALS
2377		2471
2378	AnyEvent currently installs handlers for these signals:	2472	AnyEvent currently installs handlers for these signals:
…		…
2420	it's built-in modules) are required to use it.	2514	it's built-in modules) are required to use it.
2421		2515
2422	That does not mean that AnyEvent won't take advantage of some additional	2516	That does not mean that AnyEvent won't take advantage of some additional
2423	modules if they are installed.	2517	modules if they are installed.
2424		2518
2425	This section epxlains which additional modules will be used, and how they	2519	This section explains which additional modules will be used, and how they
2426	affect AnyEvent's operetion.	2520	affect AnyEvent's operation.
2427		2521
2428	=over 4	2522	=over 4
2429		2523
2430	=item L<Async::Interrupt>	2524	=item L<Async::Interrupt>
2431		2525
…		…
2436	catch the signals) with some delay (default is 10 seconds, look for	2530	catch the signals) with some delay (default is 10 seconds, look for
2437	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2531	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2438		2532
2439	If this module is available, then it will be used to implement signal	2533	If this module is available, then it will be used to implement signal
2440	catching, which means that signals will not be delayed, and the event loop	2534	catching, which means that signals will not be delayed, and the event loop
2441	will not be interrupted regularly, which is more efficient (And good for	2535	will not be interrupted regularly, which is more efficient (and good for
2442	battery life on laptops).	2536	battery life on laptops).
2443		2537
2444	This affects not just the pure-perl event loop, but also other event loops	2538	This affects not just the pure-perl event loop, but also other event loops
2445	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2539	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2446		2540
…		…
2458	automatic timer adjustments even when no monotonic clock is available,	2552	automatic timer adjustments even when no monotonic clock is available,
2459	can take avdantage of advanced kernel interfaces such as C<epoll> and	2553	can take avdantage of advanced kernel interfaces such as C<epoll> and
2460	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2554	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2461	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2555	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2462		2556
		2557	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2558	then this module will do nothing for you.
		2559
2463	=item L<Guard>	2560	=item L<Guard>
2464		2561
2465	The guard module, when used, will be used to implement	2562	The guard module, when used, will be used to implement
2466	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2563	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2467	lot less memory), but otherwise doesn't affect guard operation much. It is	2564	lot less memory), but otherwise doesn't affect guard operation much. It is
2468	purely used for performance.	2565	purely used for performance.
2469		2566
2470	=item L<JSON> and L<JSON::XS>	2567	=item L<JSON> and L<JSON::XS>
2471		2568
2472	This module is required when you want to read or write JSON data via	2569	One of these modules is required when you want to read or write JSON data
2473	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2570	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2474	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2571	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2475
2476	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2477	installed.
2478		2572
2479	=item L<Net::SSLeay>	2573	=item L<Net::SSLeay>
2480		2574
2481	Implementing TLS/SSL in Perl is certainly interesting, but not very	2575	Implementing TLS/SSL in Perl is certainly interesting, but not very
2482	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2576	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2493		2587
2494		2588
2495	=head1 FORK	2589	=head1 FORK
2496		2590
2497	Most event libraries are not fork-safe. The ones who are usually are	2591	Most event libraries are not fork-safe. The ones who are usually are
2498	because they rely on inefficient but fork-safe C<select> or C<poll>	2592	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2499	calls. Only L<EV> is fully fork-aware.	2593	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2594	are usually badly thought-out hacks that are incompatible with fork in
		2595	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2596	continue event-processing in both parent and child (or both, if you know
		2597	what you are doing).
		2598
		2599	This means that, in general, you cannot fork and do event processing in
		2600	the child if the event library was initialised before the fork (which
		2601	usually happens when the first AnyEvent watcher is created, or the library
		2602	is loaded).
2500		2603
2501	If you have to fork, you must either do so I<before> creating your first	2604	If you have to fork, you must either do so I<before> creating your first
2502	watcher OR you must not use AnyEvent at all in the child OR you must do	2605	watcher OR you must not use AnyEvent at all in the child OR you must do
2503	something completely out of the scope of AnyEvent.	2606	something completely out of the scope of AnyEvent.
		2607
		2608	The problem of doing event processing in the parent I<and> the child
		2609	is much more complicated: even for backends that I<are> fork-aware or
		2610	fork-safe, their behaviour is not usually what you want: fork clones all
		2611	watchers, that means all timers, I/O watchers etc. are active in both
		2612	parent and child, which is almost never what you want. USing C<exec>
		2613	to start worker children from some kind of manage rprocess is usually
		2614	preferred, because it is much easier and cleaner, at the expense of having
		2615	to have another binary.
2504		2616
2505		2617
2506	=head1 SECURITY CONSIDERATIONS	2618	=head1 SECURITY CONSIDERATIONS
2507		2619
2508	AnyEvent can be forced to load any event model via	2620	AnyEvent can be forced to load any event model via

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.273 by root, Thu Aug 6 13:45:04 2009 UTC vs. Revision 1.326 by root, Sun Jun 6 10:11:56 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.273 by root, Thu Aug 6 13:45:04 2009 UTC vs.
Revision 1.326 by root, Sun Jun 6 10:11:56 2010 UTC