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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.251 by root, Mon Jul 20 22:39:57 2009 UTC vs.
Revision 1.308 by root, Fri Dec 25 07:39:41 2009 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.251 by root, Mon Jul 20 22:39:57 2009 UTC vs. Revision 1.308 by root, Fri Dec 25 07:39:41 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.251 by root, Mon Jul 20 22:39:57 2009 UTC vs.
Revision 1.308 by root, Fri Dec 25 07:39:41 2009 UTC