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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.252 by root, Tue Jul 21 03:30:02 2009 UTC vs.
Revision 1.312 by root, Mon Feb 15 18:02:35 2010 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
…		…
562	after => 1,	619	after => 1,
563	cb => sub { $result_ready->send },	620	cb => sub { $result_ready->send },
564	);	621	);
565		622
566	# this "blocks" (while handling events) till the callback	623	# this "blocks" (while handling events) till the callback
567	# calls -<send	624	# calls ->send
568	$result_ready->recv;	625	$result_ready->recv;
569		626
570	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
571	variables are also callable directly.	628	variables are also callable directly.
572		629
…		…
636	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
637	to use a condition variable for the whole process.	694	to use a condition variable for the whole process.
638		695
639	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
640	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
641	>>, 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
642	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
643	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.
644		702
645	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
646	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
647	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).
648		706
…		…
675	begung can potentially be zero:	733	begung can potentially be zero:
676		734
677	my $cv = AnyEvent->condvar;	735	my $cv = AnyEvent->condvar;
678		736
679	my %result;	737	my %result;
680	$cv->begin (sub { $cv->send (\%result) });	738	$cv->begin (sub { shift->send (\%result) });
681		739
682	for my $host (@list_of_hosts) {	740	for my $host (@list_of_hosts) {
683	$cv->begin;	741	$cv->begin;
684	ping_host_then_call_callback $host, sub {	742	ping_host_then_call_callback $host, sub {
685	$result{$host} = ...;	743	$result{$host} = ...;
…		…
760	=item $cb = $cv->cb ($cb->($cv))	818	=item $cb = $cv->cb ($cb->($cv))
761		819
762	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
763	replaces it before doing so.	821	replaces it before doing so.
764		822
765	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)
766	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
767	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>
768	is guaranteed not to block.	826	inside the callback or at any later time is guaranteed not to block.
769		827
770	=back	828	=back
771		829
772	=head1 SUPPORTED EVENT LOOPS/BACKENDS	830	=head1 SUPPORTED EVENT LOOPS/BACKENDS
773		831
…		…
776	=over 4	834	=over 4
777		835
778	=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.
779		837
780	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
781	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
782	that, will fall back to its own pure-perl implementation, which is	840	pure-perl implementation, which is available everywhere as it comes with
783	available everywhere as it comes with AnyEvent itself.	841	AnyEvent itself.
784		842
785	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	843	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
786	AnyEvent::Impl::Event based on Event, very stable, few glitches.
787	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	844	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
788		845
789	=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.
790		847
791	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
792	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
793	them. This means that AnyEvent will automatically pick the right backend	850	them. This means that AnyEvent will automatically pick the right backend
794	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
795	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.
796		853
		854	AnyEvent::Impl::Event based on Event, very stable, few glitches.
797	AnyEvent::Impl::Glib based on Glib, slow but very stable.	855	AnyEvent::Impl::Glib based on Glib, slow but very stable.
798	AnyEvent::Impl::Tk based on Tk, very broken.	856	AnyEvent::Impl::Tk based on Tk, very broken.
799	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	857	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
800	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.
801		860
802	=item Backends with special needs.	861	=item Backends with special needs.
803		862
804	Qt requires the Qt::Application to be instantiated first, but will	863	Qt requires the Qt::Application to be instantiated first, but will
805	otherwise be picked up automatically. As long as the main program	864	otherwise be picked up automatically. As long as the main program
…		…
910	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:
911	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
912	array will be ignored.	971	array will be ignored.
913		972
914	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	973	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
915	it,as it takes care of these details.	974	it, as it takes care of these details.
916		975
917	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
918	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
919	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
920	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	}
921		993
922	=back	994	=back
923		995
924	=head1 WHAT TO DO IN A MODULE	996	=head1 WHAT TO DO IN A MODULE
925		997
…		…
1074		1146
1075	package AnyEvent;	1147	package AnyEvent;
1076		1148
1077	# basically a tuned-down version of common::sense	1149	# basically a tuned-down version of common::sense
1078	sub common_sense {	1150	sub common_sense {
1079	# no warnings	1151	# from common:.sense 1.0
1080	${^WARNING_BITS} ^= ${^WARNING_BITS};	1152	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1081	# use strict vars subs	1153	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1082	$^H \|= 0x00000600;	1154	$^H \|= 0x00000600;
1083	}	1155	}
1084		1156
1085	BEGIN { AnyEvent::common_sense }	1157	BEGIN { AnyEvent::common_sense }
1086		1158
1087	use Carp ();	1159	use Carp ();
1088		1160
1089	our $VERSION = 4.86;	1161	our $VERSION = '5.24';
1090	our $MODEL;	1162	our $MODEL;
1091		1163
1092	our $AUTOLOAD;	1164	our $AUTOLOAD;
1093	our @ISA;	1165	our @ISA;
1094		1166
1095	our @REGISTRY;	1167	our @REGISTRY;
1096		1168
1097	our $WIN32;
1098
1099	our $VERBOSE;	1169	our $VERBOSE;
1100		1170
1101	BEGIN {	1171	BEGIN {
		1172	eval "sub CYGWIN(){" . (($^O =~ /cygwin/i) *1) . "}";
1102	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1173	eval "sub WIN32 (){" . (($^O =~ /mswin32/i)*1) . "}";
1103	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1174	eval "sub TAINT (){" . (${^TAINT} *1) . "}";
1104		1175
1105	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1176	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1106	if ${^TAINT};	1177	if ${^TAINT};
1107		1178
1108	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1179	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1119	for reverse split /\s,\s/,	1190	for reverse split /\s,\s/,
1120	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1191	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1121	}	1192	}
1122		1193
1123	my @models = (	1194	my @models = (
1124	[EV:: => AnyEvent::Impl::EV::],	1195	[EV:: => AnyEvent::Impl::EV:: , 1],
1125	[Event:: => AnyEvent::Impl::Event::],
1126	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1196	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1127	# everything below here will not be autoprobed	1197	# everything below here will not (normally) be autoprobed
1128	# as the pureperl backend should work everywhere	1198	# as the pureperl backend should work everywhere
1129	# and is usually faster	1199	# and is usually faster
		1200	[Event:: => AnyEvent::Impl::Event::, 1],
1130	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1201	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1131	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1202	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1203	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1132	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1204	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1133	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1205	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1134	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1206	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1135	[Wx:: => AnyEvent::Impl::POE::],	1207	[Wx:: => AnyEvent::Impl::POE::],
1136	[Prima:: => AnyEvent::Impl::POE::],	1208	[Prima:: => AnyEvent::Impl::POE::],
1137	# IO::Async is just too broken - we would need workarounds for its	1209	# IO::Async is just too broken - we would need workarounds for its
1138	# byzantine signal and broken child handling, among others.	1210	# byzantine signal and broken child handling, among others.
1139	# IO::Async is rather hard to detect, as it doesn't have any	1211	# IO::Async is rather hard to detect, as it doesn't have any
1140	# obvious default class.	1212	# obvious default class.
1141	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1213	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1142	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1214	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1143	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1215	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1216	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1144	);	1217	);
1145		1218
1146	our %method = map +($_ => 1),	1219	our %method = map +($_ => 1),
1147	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1220	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1148		1221
…		…
1152	my ($cb) = @_;	1225	my ($cb) = @_;
1153		1226
1154	if ($MODEL) {	1227	if ($MODEL) {
1155	$cb->();	1228	$cb->();
1156		1229
1157	1	1230	undef
1158	} else {	1231	} else {
1159	push @post_detect, $cb;	1232	push @post_detect, $cb;
1160		1233
1161	defined wantarray	1234	defined wantarray
1162	? bless \$cb, "AnyEvent::Util::postdetect"	1235	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1167	sub AnyEvent::Util::postdetect::DESTROY {	1240	sub AnyEvent::Util::postdetect::DESTROY {
1168	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1241	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1169	}	1242	}
1170		1243
1171	sub detect() {	1244	sub detect() {
		1245	# free some memory
		1246	*detect = sub () { $MODEL };
		1247
		1248	local $!; # for good measure
		1249	local $SIG{__DIE__};
		1250
		1251	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1252	my $model = "AnyEvent::Impl::$1";
		1253	if (eval "require $model") {
		1254	$MODEL = $model;
		1255	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1256	} else {
		1257	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1258	}
		1259	}
		1260
		1261	# check for already loaded models
1172	unless ($MODEL) {	1262	unless ($MODEL) {
1173	local $SIG{__DIE__};	1263	for (@REGISTRY, @models) {
1174		1264	my ($package, $model) = @$_;
1175	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1265	if (${"$package\::VERSION"} > 0) {
1176	my $model = "AnyEvent::Impl::$1";
1177	if (eval "require $model") {	1266	if (eval "require $model") {
1178	$MODEL = $model;	1267	$MODEL = $model;
1179	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1268	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1180	} else {	1269	last;
1181	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1270	}
1182	}	1271	}
1183	}	1272	}
1184		1273
1185	# check for already loaded models
1186	unless ($MODEL) {	1274	unless ($MODEL) {
		1275	# try to autoload a model
1187	for (@REGISTRY, @models) {	1276	for (@REGISTRY, @models) {
1188	my ($package, $model) = @$_;	1277	my ($package, $model, $autoload) = @$_;
		1278	if (
		1279	$autoload
		1280	and eval "require $package"
1189	if (${"$package\::VERSION"} > 0) {	1281	and ${"$package\::VERSION"} > 0
1190	if (eval "require $model") {	1282	and eval "require $model"
		1283	) {
1191	$MODEL = $model;	1284	$MODEL = $model;
1192	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1285	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1193	last;	1286	last;
1194	}
1195	}	1287	}
1196	}	1288	}
1197		1289
1198	unless ($MODEL) {
1199	# try to load a model
1200
1201	for (@REGISTRY, @models) {
1202	my ($package, $model) = @$_;
1203	if (eval "require $package"
1204	and ${"$package\::VERSION"} > 0
1205	and eval "require $model") {
1206	$MODEL = $model;
1207	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;
1208	last;
1209	}
1210	}
1211
1212	$MODEL	1290	$MODEL
1213	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1291	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1214	}
1215	}	1292	}
1216
1217	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1218
1219	unshift @ISA, $MODEL;
1220
1221	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1222
1223	(shift @post_detect)->() while @post_detect;
1224	}	1293	}
		1294
		1295	@models = (); # free probe data
		1296
		1297	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1298	unshift @ISA, $MODEL;
		1299
		1300	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1301
		1302	(shift @post_detect)->() while @post_detect;
1225		1303
1226	$MODEL	1304	$MODEL
1227	}	1305	}
1228		1306
1229	sub AUTOLOAD {	1307	sub AUTOLOAD {
1230	(my $func = $AUTOLOAD) =~ s/.*://;	1308	(my $func = $AUTOLOAD) =~ s/.*://;
1231		1309
1232	$method{$func}	1310	$method{$func}
1233	or Carp::croak "$func: not a valid method for AnyEvent objects";	1311	or Carp::croak "$func: not a valid AnyEvent class method";
1234		1312
1235	detect unless $MODEL;	1313	detect;
1236		1314
1237	my $class = shift;	1315	my $class = shift;
1238	$class->$func (@_);	1316	$class->$func (@_);
1239	}	1317	}
1240		1318
…		…
1253	# we assume CLOEXEC is already set by perl in all important cases	1331	# we assume CLOEXEC is already set by perl in all important cases
1254		1332
1255	($fh2, $rw)	1333	($fh2, $rw)
1256	}	1334	}
1257		1335
		1336	=head1 SIMPLIFIED AE API
		1337
		1338	Starting with version 5.0, AnyEvent officially supports a second, much
		1339	simpler, API that is designed to reduce the calling, typing and memory
		1340	overhead.
		1341
		1342	See the L<AE> manpage for details.
		1343
		1344	=cut
		1345
		1346	package AE;
		1347
		1348	our $VERSION = $AnyEvent::VERSION;
		1349
		1350	sub io($$$) {
		1351	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1352	}
		1353
		1354	sub timer($$$) {
		1355	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1356	}
		1357
		1358	sub signal($$) {
		1359	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1360	}
		1361
		1362	sub child($$) {
		1363	AnyEvent->child (pid => $_[0], cb => $_[1])
		1364	}
		1365
		1366	sub idle($) {
		1367	AnyEvent->idle (cb => $_[0])
		1368	}
		1369
		1370	sub cv(;&) {
		1371	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1372	}
		1373
		1374	sub now() {
		1375	AnyEvent->now
		1376	}
		1377
		1378	sub now_update() {
		1379	AnyEvent->now_update
		1380	}
		1381
		1382	sub time() {
		1383	AnyEvent->time
		1384	}
		1385
1258	package AnyEvent::Base;	1386	package AnyEvent::Base;
1259		1387
1260	# default implementations for many methods	1388	# default implementations for many methods
1261		1389
1262	sub _time {	1390	sub _time() {
		1391	eval q{ # poor man's autoloading
1263	# probe for availability of Time::HiRes	1392	# probe for availability of Time::HiRes
1264	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1393	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1265	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1394	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1266	*_time = \&Time::HiRes::time;	1395	*_time = \&Time::HiRes::time;
1267	# if (eval "use POSIX (); (POSIX::times())...	1396	# if (eval "use POSIX (); (POSIX::times())...
1268	} else {	1397	} else {
1269	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1398	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1270	*_time = sub { time }; # epic fail	1399	*_time = sub (){ time }; # epic fail
		1400	}
1271	}	1401	};
		1402	die if $@;
1272		1403
1273	&_time	1404	&_time
1274	}	1405	}
1275		1406
1276	sub time { _time }	1407	sub time { _time }
…		…
1284	}	1415	}
1285		1416
1286	# default implementation for ->signal	1417	# default implementation for ->signal
1287		1418
1288	our $HAVE_ASYNC_INTERRUPT;	1419	our $HAVE_ASYNC_INTERRUPT;
		1420
		1421	sub _have_async_interrupt() {
		1422	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1423	&& eval "use Async::Interrupt 1.02 (); 1")
		1424	unless defined $HAVE_ASYNC_INTERRUPT;
		1425
		1426	$HAVE_ASYNC_INTERRUPT
		1427	}
		1428
1289	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1429	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1290	our (%SIG_ASY, %SIG_ASY_W);	1430	our (%SIG_ASY, %SIG_ASY_W);
1291	our ($SIG_COUNT, $SIG_TW);	1431	our ($SIG_COUNT, $SIG_TW);
1292		1432
1293	sub _signal_exec {
1294	$HAVE_ASYNC_INTERRUPT
1295	? $SIGPIPE_R->drain
1296	: sysread $SIGPIPE_R, my $dummy, 9;
1297
1298	while (%SIG_EV) {
1299	for (keys %SIG_EV) {
1300	delete $SIG_EV{$_};
1301	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1302	}
1303	}
1304	}
1305
1306	# install a dumym wakeupw atcher to reduce signal catching latency	1433	# install a dummy wakeup watcher to reduce signal catching latency
		1434	# used by Impls
1307	sub _sig_add() {	1435	sub _sig_add() {
1308	unless ($SIG_COUNT++) {	1436	unless ($SIG_COUNT++) {
1309	# try to align timer on a full-second boundary, if possible	1437	# try to align timer on a full-second boundary, if possible
1310	my $NOW = AnyEvent->now;	1438	my $NOW = AE::now;
1311		1439
1312	$SIG_TW = AnyEvent->timer (	1440	$SIG_TW = AE::timer
1313	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),	1441	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1314	interval => $MAX_SIGNAL_LATENCY,	1442	$MAX_SIGNAL_LATENCY,
1315	cb => sub { }, # just for the PERL_ASYNC_CHECK	1443	sub { } # just for the PERL_ASYNC_CHECK
1316	);	1444	;
1317	}	1445	}
1318	}	1446	}
1319		1447
1320	sub _sig_del {	1448	sub _sig_del {
1321	undef $SIG_TW	1449	undef $SIG_TW
1322	unless --$SIG_COUNT;	1450	unless --$SIG_COUNT;
1323	}	1451	}
1324		1452
		1453	our $_sig_name_init; $_sig_name_init = sub {
		1454	eval q{ # poor man's autoloading
		1455	undef $_sig_name_init;
		1456
		1457	if (_have_async_interrupt) {
		1458	*sig2num = \&Async::Interrupt::sig2num;
		1459	*sig2name = \&Async::Interrupt::sig2name;
		1460	} else {
		1461	require Config;
		1462
		1463	my %signame2num;
		1464	@signame2num{ split ' ', $Config::Config{sig_name} }
		1465	= split ' ', $Config::Config{sig_num};
		1466
		1467	my @signum2name;
		1468	@signum2name[values %signame2num] = keys %signame2num;
		1469
		1470	*sig2num = sub($) {
		1471	$_[0] > 0 ? shift : $signame2num{+shift}
		1472	};
		1473	*sig2name = sub ($) {
		1474	$_[0] > 0 ? $signum2name[+shift] : shift
		1475	};
		1476	}
		1477	};
		1478	die if $@;
		1479	};
		1480
		1481	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1482	sub sig2name($) { &$_sig_name_init; &sig2name }
		1483
1325	sub _signal {	1484	sub signal {
		1485	eval q{ # poor man's autoloading {}
		1486	# probe for availability of Async::Interrupt
		1487	if (_have_async_interrupt) {
		1488	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1489
		1490	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1491	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
		1492
		1493	} else {
		1494	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1495
		1496	require Fcntl;
		1497
		1498	if (AnyEvent::WIN32) {
		1499	require AnyEvent::Util;
		1500
		1501	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1502	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1503	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1504	} else {
		1505	pipe $SIGPIPE_R, $SIGPIPE_W;
		1506	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1507	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1508
		1509	# not strictly required, as $^F is normally 2, but let's make sure...
		1510	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1511	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1512	}
		1513
		1514	$SIGPIPE_R
		1515	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1516
		1517	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
		1518	}
		1519
		1520	*signal = sub {
1326	my (undef, %arg) = @_;	1521	my (undef, %arg) = @_;
1327		1522
1328	my $signal = uc $arg{signal}	1523	my $signal = uc $arg{signal}
1329	or Carp::croak "required option 'signal' is missing";	1524	or Carp::croak "required option 'signal' is missing";
1330		1525
1331	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1332
1333	if ($HAVE_ASYNC_INTERRUPT) {	1526	if ($HAVE_ASYNC_INTERRUPT) {
1334	# async::interrupt	1527	# async::interrupt
1335		1528
1336	$SIG_ASY{$signal} \|\|= do {	1529	$signal = sig2num $signal;
1337	my $asy = new Async::Interrupt	1530	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1531
		1532	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1338	cb => sub { undef $SIG_EV{$signal} },	1533	cb => sub { undef $SIG_EV{$signal} },
1339	signal => $signal,	1534	signal => $signal,
1340	pipe => [$SIGPIPE_R->filenos],	1535	pipe => [$SIGPIPE_R->filenos],
		1536	pipe_autodrain => 0,
		1537	;
		1538
		1539	} else {
		1540	# pure perl
		1541
		1542	# AE::Util has been loaded in signal
		1543	$signal = sig2name $signal;
		1544	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1545
		1546	$SIG{$signal} \|\|= sub {
		1547	local $!;
		1548	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1549	undef $SIG_EV{$signal};
		1550	};
		1551
		1552	# can't do signal processing without introducing races in pure perl,
		1553	# so limit the signal latency.
		1554	_sig_add;
1341	;	1555	}
1342	$asy->pipe_autodrain (0);
1343		1556
1344	$asy	1557	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1345	};	1558	};
1346		1559
1347	} else {	1560	*AnyEvent::Base::signal::DESTROY = sub {
1348	# pure perl	1561	my ($signal, $cb) = @{$_[0]};
1349		1562
1350	$SIG{$signal} \|\|= sub {	1563	_sig_del;
1351	local $!;	1564
1352	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1565	delete $SIG_CB{$signal}{$cb};
		1566
		1567	$HAVE_ASYNC_INTERRUPT
		1568	? delete $SIG_ASY{$signal}
		1569	: # delete doesn't work with older perls - they then
		1570	# print weird messages, or just unconditionally exit
		1571	# instead of getting the default action.
1353	undef $SIG_EV{$signal};	1572	undef $SIG{$signal}
		1573	unless keys %{ $SIG_CB{$signal} };
1354	};	1574	};
1355		1575
1356	# can't do signal processing without introducing races in pure perl,	1576	*_signal_exec = sub {
1357	# so limit the signal latency.
1358	_sig_add;
1359	}
1360
1361	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1362	}
1363
1364	sub signal {
1365	# probe for availability of Async::Interrupt
1366	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1367	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1368
1369	$HAVE_ASYNC_INTERRUPT = 1;	1577	$HAVE_ASYNC_INTERRUPT
1370	$SIGPIPE_R = new Async::Interrupt::EventPipe;	1578	? $SIGPIPE_R->drain
1371	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);	1579	: sysread $SIGPIPE_R, (my $dummy), 9;
1372		1580
1373	} else {	1581	while (%SIG_EV) {
1374	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1582	for (keys %SIG_EV) {
1375		1583	delete $SIG_EV{$_};
1376	require Fcntl;	1584	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1377		1585	}
1378	if (AnyEvent::WIN32) {	1586	}
1379	require AnyEvent::Util;
1380
1381	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1382	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1383	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1384	} else {
1385	pipe $SIGPIPE_R, $SIGPIPE_W;
1386	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1387	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1388
1389	# not strictly required, as $^F is normally 2, but let's make sure...
1390	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1391	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1392	}	1587	};
1393
1394	$SIGPIPE_R
1395	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1396
1397	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1398	}	1588	};
		1589	die if $@;
1399		1590
1400	*signal = \&_signal;
1401	&signal	1591	&signal
1402	}
1403
1404	sub AnyEvent::Base::signal::DESTROY {
1405	my ($signal, $cb) = @{$_[0]};
1406
1407	_sig_del;
1408
1409	delete $SIG_CB{$signal}{$cb};
1410
1411	$HAVE_ASYNC_INTERRUPT
1412	? delete $SIG_ASY{$signal}
1413	: # delete doesn't work with older perls - they then
1414	# print weird messages, or just unconditionally exit
1415	# instead of getting the default action.
1416	undef $SIG{$signal}
1417	unless keys %{ $SIG_CB{$signal} };
1418	}	1592	}
1419		1593
1420	# default implementation for ->child	1594	# default implementation for ->child
1421		1595
1422	our %PID_CB;	1596	our %PID_CB;
1423	our $CHLD_W;	1597	our $CHLD_W;
1424	our $CHLD_DELAY_W;	1598	our $CHLD_DELAY_W;
1425	our $WNOHANG;	1599	our $WNOHANG;
1426		1600
1427	sub _sigchld {	1601	# used by many Impl's
1428	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1602	sub _emit_childstatus($$) {
1429	$_->($pid, $?)	1603	my (undef, $rpid, $rstatus) = @_;
		1604
		1605	$_->($rpid, $rstatus)
1430	for values %{ $PID_CB{$pid} \|\| {} },	1606	for values %{ $PID_CB{$rpid} \|\| {} },
1431	values %{ $PID_CB{0} \|\| {} };	1607	values %{ $PID_CB{0} \|\| {} };
1432	}
1433	}	1608	}
1434		1609
1435	sub child {	1610	sub child {
		1611	eval q{ # poor man's autoloading {}
		1612	*_sigchld = sub {
		1613	my $pid;
		1614
		1615	AnyEvent->_emit_childstatus ($pid, $?)
		1616	while ($pid = waitpid -1, $WNOHANG) > 0;
		1617	};
		1618
		1619	*child = sub {
1436	my (undef, %arg) = @_;	1620	my (undef, %arg) = @_;
1437		1621
1438	defined (my $pid = $arg{pid} + 0)	1622	defined (my $pid = $arg{pid} + 0)
1439	or Carp::croak "required option 'pid' is missing";	1623	or Carp::croak "required option 'pid' is missing";
1440		1624
1441	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1625	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1442		1626
1443	# WNOHANG is almost cetrainly 1 everywhere	1627	# WNOHANG is almost cetrainly 1 everywhere
1444	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1628	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1445	? 1	1629	? 1
1446	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1630	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1447		1631
1448	unless ($CHLD_W) {	1632	unless ($CHLD_W) {
1449	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1633	$CHLD_W = AE::signal CHLD => \&_sigchld;
1450	# child could be a zombie already, so make at least one round	1634	# child could be a zombie already, so make at least one round
1451	&_sigchld;	1635	&_sigchld;
1452	}	1636	}
1453		1637
1454	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1638	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1455	}	1639	};
1456		1640
1457	sub AnyEvent::Base::child::DESTROY {	1641	*AnyEvent::Base::child::DESTROY = sub {
1458	my ($pid, $cb) = @{$_[0]};	1642	my ($pid, $cb) = @{$_[0]};
1459		1643
1460	delete $PID_CB{$pid}{$cb};	1644	delete $PID_CB{$pid}{$cb};
1461	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1645	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1462		1646
1463	undef $CHLD_W unless keys %PID_CB;	1647	undef $CHLD_W unless keys %PID_CB;
		1648	};
		1649	};
		1650	die if $@;
		1651
		1652	&child
1464	}	1653	}
1465		1654
1466	# idle emulation is done by simply using a timer, regardless	1655	# idle emulation is done by simply using a timer, regardless
1467	# of whether the process is idle or not, and not letting	1656	# of whether the process is idle or not, and not letting
1468	# the callback use more than 50% of the time.	1657	# the callback use more than 50% of the time.
1469	sub idle {	1658	sub idle {
		1659	eval q{ # poor man's autoloading {}
		1660	*idle = sub {
1470	my (undef, %arg) = @_;	1661	my (undef, %arg) = @_;
1471		1662
1472	my ($cb, $w, $rcb) = $arg{cb};	1663	my ($cb, $w, $rcb) = $arg{cb};
1473		1664
1474	$rcb = sub {	1665	$rcb = sub {
1475	if ($cb) {	1666	if ($cb) {
1476	$w = _time;	1667	$w = _time;
1477	&$cb;	1668	&$cb;
1478	$w = _time - $w;	1669	$w = _time - $w;
1479		1670
1480	# never use more then 50% of the time for the idle watcher,	1671	# never use more then 50% of the time for the idle watcher,
1481	# within some limits	1672	# within some limits
1482	$w = 0.0001 if $w < 0.0001;	1673	$w = 0.0001 if $w < 0.0001;
1483	$w = 5 if $w > 5;	1674	$w = 5 if $w > 5;
1484		1675
1485	$w = AnyEvent->timer (after => $w, cb => $rcb);	1676	$w = AE::timer $w, 0, $rcb;
1486	} else {	1677	} else {
1487	# clean up...	1678	# clean up...
1488	undef $w;	1679	undef $w;
1489	undef $rcb;	1680	undef $rcb;
		1681	}
		1682	};
		1683
		1684	$w = AE::timer 0.05, 0, $rcb;
		1685
		1686	bless \\$cb, "AnyEvent::Base::idle"
1490	}	1687	};
		1688
		1689	*AnyEvent::Base::idle::DESTROY = sub {
		1690	undef $${$_[0]};
		1691	};
1491	};	1692	};
		1693	die if $@;
1492		1694
1493	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1695	&idle
1494
1495	bless \\$cb, "AnyEvent::Base::idle"
1496	}
1497
1498	sub AnyEvent::Base::idle::DESTROY {
1499	undef $${$_[0]};
1500	}	1696	}
1501		1697
1502	package AnyEvent::CondVar;	1698	package AnyEvent::CondVar;
1503		1699
1504	our @ISA = AnyEvent::CondVar::Base::;	1700	our @ISA = AnyEvent::CondVar::Base::;
…		…
1552	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1748	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1553	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1749	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1554	}	1750	}
1555		1751
1556	sub cb {	1752	sub cb {
1557	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1753	my $cv = shift;
		1754
		1755	@_
		1756	and $cv->{_ae_cb} = shift
		1757	and $cv->{_ae_sent}
		1758	and (delete $cv->{_ae_cb})->($cv);
		1759
1558	$_[0]{_ae_cb}	1760	$cv->{_ae_cb}
1559	}	1761	}
1560		1762
1561	sub begin {	1763	sub begin {
1562	++$_[0]{_ae_counter};	1764	++$_[0]{_ae_counter};
1563	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1765	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1772	warn "read: $input\n"; # output what has been read	1974	warn "read: $input\n"; # output what has been read
1773	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1975	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1774	},	1976	},
1775	);	1977	);
1776		1978
1777	my $time_watcher; # can only be used once
1778
1779	sub new_timer {
1780	$timer = AnyEvent->timer (after => 1, cb => sub {	1979	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1781	warn "timeout\n"; # print 'timeout' about every second	1980	warn "timeout\n"; # print 'timeout' at most every second
1782	&new_timer; # and restart the time
1783	});	1981	});
1784	}
1785
1786	new_timer; # create first timer
1787		1982
1788	$cv->recv; # wait until user enters /^q/i	1983	$cv->recv; # wait until user enters /^q/i
1789		1984
1790	=head1 REAL-WORLD EXAMPLE	1985	=head1 REAL-WORLD EXAMPLE
1791		1986
…		…
1922	through AnyEvent. The benchmark creates a lot of timers (with a zero	2117	through AnyEvent. The benchmark creates a lot of timers (with a zero
1923	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2118	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1924	which it is), lets them fire exactly once and destroys them again.	2119	which it is), lets them fire exactly once and destroys them again.
1925		2120
1926	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2121	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1927	distribution.	2122	distribution. It uses the L<AE> interface, which makes a real difference
		2123	for the EV and Perl backends only.
1928		2124
1929	=head3 Explanation of the columns	2125	=head3 Explanation of the columns
1930		2126
1931	I<watcher> is the number of event watchers created/destroyed. Since	2127	I<watcher> is the number of event watchers created/destroyed. Since
1932	different event models feature vastly different performances, each event	2128	different event models feature vastly different performances, each event
…		…
1953	watcher.	2149	watcher.
1954		2150
1955	=head3 Results	2151	=head3 Results
1956		2152
1957	name watchers bytes create invoke destroy comment	2153	name watchers bytes create invoke destroy comment
1958	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2154	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1959	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2155	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1960	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2156	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1961	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2157	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1962	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2158	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1963	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2159	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1964	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2160	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1965	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2161	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1966	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2162	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1967	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2163	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1968	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2164	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1969	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2165	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1970		2166
1971	=head3 Discussion	2167	=head3 Discussion
1972		2168
1973	The benchmark does I<not> measure scalability of the event loop very	2169	The benchmark does I<not> measure scalability of the event loop very
1974	well. For example, a select-based event loop (such as the pure perl one)	2170	well. For example, a select-based event loop (such as the pure perl one)
…		…
1986	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2182	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1987	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2183	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1988	cycles with POE.	2184	cycles with POE.
1989		2185
1990	C<EV> is the sole leader regarding speed and memory use, which are both	2186	C<EV> is the sole leader regarding speed and memory use, which are both
1991	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2187	maximal/minimal, respectively. When using the L<AE> API there is zero
		2188	overhead (when going through the AnyEvent API create is about 5-6 times
		2189	slower, with other times being equal, so still uses far less memory than
1992	far less memory than any other event loop and is still faster than Event	2190	any other event loop and is still faster than Event natively).
1993	natively.
1994		2191
1995	The pure perl implementation is hit in a few sweet spots (both the	2192	The pure perl implementation is hit in a few sweet spots (both the
1996	constant timeout and the use of a single fd hit optimisations in the perl	2193	constant timeout and the use of a single fd hit optimisations in the perl
1997	interpreter and the backend itself). Nevertheless this shows that it	2194	interpreter and the backend itself). Nevertheless this shows that it
1998	adds very little overhead in itself. Like any select-based backend its	2195	adds very little overhead in itself. Like any select-based backend its
…		…
2072	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2269	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2073	(1%) are active. This mirrors the activity of large servers with many	2270	(1%) are active. This mirrors the activity of large servers with many
2074	connections, most of which are idle at any one point in time.	2271	connections, most of which are idle at any one point in time.
2075		2272
2076	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2273	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2077	distribution.	2274	distribution. It uses the L<AE> interface, which makes a real difference
		2275	for the EV and Perl backends only.
2078		2276
2079	=head3 Explanation of the columns	2277	=head3 Explanation of the columns
2080		2278
2081	I<sockets> is the number of sockets, and twice the number of "servers" (as	2279	I<sockets> is the number of sockets, and twice the number of "servers" (as
2082	each server has a read and write socket end).	2280	each server has a read and write socket end).
…		…
2090	a new one that moves the timeout into the future.	2288	a new one that moves the timeout into the future.
2091		2289
2092	=head3 Results	2290	=head3 Results
2093		2291
2094	name sockets create request	2292	name sockets create request
2095	EV 20000 69.01 11.16	2293	EV 20000 62.66 7.99
2096	Perl 20000 73.32 35.87	2294	Perl 20000 68.32 32.64
2097	IOAsync 20000 157.00 98.14 epoll	2295	IOAsync 20000 174.06 101.15 epoll
2098	IOAsync 20000 159.31 616.06 poll	2296	IOAsync 20000 174.67 610.84 poll
2099	Event 20000 212.62 257.32	2297	Event 20000 202.69 242.91
2100	Glib 20000 651.16 1896.30	2298	Glib 20000 557.01 1689.52
2101	POE 20000 349.67 12317.24 uses POE::Loop::Event	2299	POE 20000 341.54 12086.32 uses POE::Loop::Event
2102		2300
2103	=head3 Discussion	2301	=head3 Discussion
2104		2302
2105	This benchmark I<does> measure scalability and overall performance of the	2303	This benchmark I<does> measure scalability and overall performance of the
2106	particular event loop.	2304	particular event loop.
…		…
2232	As you can see, the AnyEvent + EV combination even beats the	2430	As you can see, the AnyEvent + EV combination even beats the
2233	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2431	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2234	backend easily beats IO::Lambda and POE.	2432	backend easily beats IO::Lambda and POE.
2235		2433
2236	And even the 100% non-blocking version written using the high-level (and	2434	And even the 100% non-blocking version written using the high-level (and
2237	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2435	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2238	large margin, even though it does all of DNS, tcp-connect and socket I/O	2436	higher level ("unoptimised") abstractions by a large margin, even though
2239	in a non-blocking way.	2437	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2240		2438
2241	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2439	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2242	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2440	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2243	part of the IO::lambda distribution and were used without any changes.	2441	part of the IO::Lambda distribution and were used without any changes.
2244		2442
2245		2443
2246	=head1 SIGNALS	2444	=head1 SIGNALS
2247		2445
2248	AnyEvent currently installs handlers for these signals:	2446	AnyEvent currently installs handlers for these signals:
…		…
2290	it's built-in modules) are required to use it.	2488	it's built-in modules) are required to use it.
2291		2489
2292	That does not mean that AnyEvent won't take advantage of some additional	2490	That does not mean that AnyEvent won't take advantage of some additional
2293	modules if they are installed.	2491	modules if they are installed.
2294		2492
2295	This section epxlains which additional modules will be used, and how they	2493	This section explains which additional modules will be used, and how they
2296	affect AnyEvent's operetion.	2494	affect AnyEvent's operation.
2297		2495
2298	=over 4	2496	=over 4
2299		2497
2300	=item L<Async::Interrupt>	2498	=item L<Async::Interrupt>
2301		2499
…		…
2306	catch the signals) with some delay (default is 10 seconds, look for	2504	catch the signals) with some delay (default is 10 seconds, look for
2307	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2505	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2308		2506
2309	If this module is available, then it will be used to implement signal	2507	If this module is available, then it will be used to implement signal
2310	catching, which means that signals will not be delayed, and the event loop	2508	catching, which means that signals will not be delayed, and the event loop
2311	will not be interrupted regularly, which is more efficient (And good for	2509	will not be interrupted regularly, which is more efficient (and good for
2312	battery life on laptops).	2510	battery life on laptops).
2313		2511
2314	This affects not just the pure-perl event loop, but also other event loops	2512	This affects not just the pure-perl event loop, but also other event loops
2315	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2513	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2316		2514
…		…
2337	lot less memory), but otherwise doesn't affect guard operation much. It is	2535	lot less memory), but otherwise doesn't affect guard operation much. It is
2338	purely used for performance.	2536	purely used for performance.
2339		2537
2340	=item L<JSON> and L<JSON::XS>	2538	=item L<JSON> and L<JSON::XS>
2341		2539
2342	This module is required when you want to read or write JSON data via	2540	One of these modules is required when you want to read or write JSON data
2343	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2541	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2344	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2542	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2345		2543
2346	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2544	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2347	installed.	2545	installed.
2348		2546
…		…
2363		2561
2364		2562
2365	=head1 FORK	2563	=head1 FORK
2366		2564
2367	Most event libraries are not fork-safe. The ones who are usually are	2565	Most event libraries are not fork-safe. The ones who are usually are
2368	because they rely on inefficient but fork-safe C<select> or C<poll>	2566	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2369	calls. Only L<EV> is fully fork-aware.	2567	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2568	are usually badly thought-out hacks that are incompatible with fork in
		2569	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2570	continue event-processing in both parent and child (or both, if you know
		2571	what you are doing).
		2572
		2573	This means that, in general, you cannot fork and do event processing in
		2574	the child if the event library was initialised before the fork (which
		2575	usually happens when the first AnyEvent watcher is created, or the library
		2576	is loaded).
2370		2577
2371	If you have to fork, you must either do so I<before> creating your first	2578	If you have to fork, you must either do so I<before> creating your first
2372	watcher OR you must not use AnyEvent at all in the child OR you must do	2579	watcher OR you must not use AnyEvent at all in the child OR you must do
2373	something completely out of the scope of AnyEvent.	2580	something completely out of the scope of AnyEvent.
		2581
		2582	The problem of doing event processing in the parent I<and> the child
		2583	is much more complicated: even for backends that I<are> fork-aware or
		2584	fork-safe, their behaviour is not usually what you want: fork clones all
		2585	watchers, that means all timers, I/O watchers etc. are active in both
		2586	parent and child, which is almost never what you want. USing C<exec>
		2587	to start worker children from some kind of manage rprocess is usually
		2588	preferred, because it is much easier and cleaner, at the expense of having
		2589	to have another binary.
2374		2590
2375		2591
2376	=head1 SECURITY CONSIDERATIONS	2592	=head1 SECURITY CONSIDERATIONS
2377		2593
2378	AnyEvent can be forced to load any event model via	2594	AnyEvent can be forced to load any event model via
…		…
2416	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2632	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2417		2633
2418	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2634	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2419	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2635	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2420	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2636	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2421	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2637	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2422		2638
2423	Non-blocking file handles, sockets, TCP clients and	2639	Non-blocking file handles, sockets, TCP clients and
2424	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2640	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2425		2641
2426	Asynchronous DNS: L<AnyEvent::DNS>.	2642	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.252 by root, Tue Jul 21 03:30:02 2009 UTC vs. Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.252 by root, Tue Jul 21 03:30:02 2009 UTC vs.
Revision 1.312 by root, Mon Feb 15 18:02:35 2010 UTC