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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.241 by root, Fri Jul 17 18:08:35 2009 UTC vs.
Revision 1.279 by root, Sun Aug 9 16:05:11 2009 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - the DBI of event loop programming
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported	5	EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6	event loops.	6	and POE are various supported event loops/environments.
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
40	=head1 INTRODUCTION/TUTORIAL	40	=head1 INTRODUCTION/TUTORIAL
41		41
42	This manpage is mainly a reference manual. If you are interested	42	This manpage is mainly a reference manual. If you are interested
43	in a tutorial or some gentle introduction, have a look at the	43	in a tutorial or some gentle introduction, have a look at the
44	L<AnyEvent::Intro> manpage.	44	L<AnyEvent::Intro> manpage.
		45
		46	=head1 SUPPORT
		47
		48	There is a mailinglist for discussing all things AnyEvent, and an IRC
		49	channel, too.
		50
		51	See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
		52	Repository>, at L<http://anyevent.schmorp.de>, for more info.
45		53
46	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	54	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47		55
48	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
49	nowadays. So what is different about AnyEvent?	57	nowadays. So what is different about AnyEvent?
…		…
173	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
174	declared.	182	declared.
175		183
176	=head2 I/O WATCHERS	184	=head2 I/O WATCHERS
177		185
		186	$w = AnyEvent->io (
		187	fh => <filehandle_or_fileno>,
		188	poll => <"r" or "w">,
		189	cb => <callback>,
		190	);
		191
178	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
179	with the following mandatory key-value pairs as arguments:	193	with the following mandatory key-value pairs as arguments:
180		194
181	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
182	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
…		…
211	undef $w;	225	undef $w;
212	});	226	});
213		227
214	=head2 TIME WATCHERS	228	=head2 TIME WATCHERS
215		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
216	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 >>
217	method with the following mandatory arguments:	239	method with the following mandatory arguments:
218		240
219	C<after> specifies after how many seconds (fractional values are	241	C<after> specifies after how many seconds (fractional values are
220	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
…		…
347		369
348	=back	370	=back
349		371
350	=head2 SIGNAL WATCHERS	372	=head2 SIGNAL WATCHERS
351		373
		374	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
		375
352	You can watch for signals using a signal watcher, C<signal> is the signal	376	You can watch for signals using a signal watcher, C<signal> is the signal
353	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	377	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
354	callback to be invoked whenever a signal occurs.	378	callback to be invoked whenever a signal occurs.
355		379
356	Although the callback might get passed parameters, their value and	380	Although the callback might get passed parameters, their value and
…		…
361	invocation, and callback invocation will be synchronous. Synchronous means	385	invocation, and callback invocation will be synchronous. Synchronous means
362	that it might take a while until the signal gets handled by the process,	386	that it might take a while until the signal gets handled by the process,
363	but it is guaranteed not to interrupt any other callbacks.	387	but it is guaranteed not to interrupt any other callbacks.
364		388
365	The main advantage of using these watchers is that you can share a signal	389	The main advantage of using these watchers is that you can share a signal
366	between multiple watchers.	390	between multiple watchers, and AnyEvent will ensure that signals will not
		391	interrupt your program at bad times.
367		392
368	This watcher might use C<%SIG>, so programs overwriting those signals	393	This watcher might use C<%SIG> (depending on the event loop used),
369	directly will likely not work correctly.	394	so programs overwriting those signals directly will likely not work
		395	correctly.
370		396
371	Example: exit on SIGINT	397	Example: exit on SIGINT
372		398
373	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
374		400
		401	=head3 Signal Races, Delays and Workarounds
		402
		403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		404	callbacks to signals in a generic way, which is a pity, as you cannot
		405	do race-free signal handling in perl, requiring C libraries for
		406	this. AnyEvent will try to do it's best, which means in some cases,
		407	signals will be delayed. The maximum time a signal might be delayed is
		408	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
		409	variable can be changed only before the first signal watcher is created,
		410	and should be left alone otherwise. This variable determines how often
		411	AnyEvent polls for signals (in case a wake-up was missed). Higher values
		412	will cause fewer spurious wake-ups, which is better for power and CPU
		413	saving.
		414
		415	All these problems can be avoided by installing the optional
		416	L<Async::Interrupt> module, which works with most event loops. It will not
		417	work with inherently broken event loops such as L<Event> or L<Event::Lib>
		418	(and not with L<POE> currently, as POE does it's own workaround with
		419	one-second latency). For those, you just have to suffer the delays.
		420
375	=head2 CHILD PROCESS WATCHERS	421	=head2 CHILD PROCESS WATCHERS
376		422
		423	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		424
377	You can also watch on a child process exit and catch its exit status.	425	You can also watch on a child process exit and catch its exit status.
378		426
379	The child process is specified by the C<pid> argument (if set to C<0>, it	427	The child process is specified by the C<pid> argument (one some backends,
380	watches for any child process exit). The watcher will triggered only when	428	using C<0> watches for any child process exit, on others this will
381	the child process has finished and an exit status is available, not on	429	croak). The watcher will be triggered only when the child process has
382	any trace events (stopped/continued).	430	finished and an exit status is available, not on any trace events
		431	(stopped/continued).
383		432
384	The callback will be called with the pid and exit status (as returned by	433	The callback will be called with the pid and exit status (as returned by
385	waitpid), so unlike other watcher types, you I<can> rely on child watcher	434	waitpid), so unlike other watcher types, you I<can> rely on child watcher
386	callback arguments.	435	callback arguments.
387		436
…		…
403		452
404	This means you cannot create a child watcher as the very first	453	This means you cannot create a child watcher as the very first
405	thing in an AnyEvent program, you I<have> to create at least one	454	thing in an AnyEvent program, you I<have> to create at least one
406	watcher before you C<fork> the child (alternatively, you can call	455	watcher before you C<fork> the child (alternatively, you can call
407	C<AnyEvent::detect>).	456	C<AnyEvent::detect>).
		457
		458	As most event loops do not support waiting for child events, they will be
		459	emulated by AnyEvent in most cases, in which the latency and race problems
		460	mentioned in the description of signal watchers apply.
408		461
409	Example: fork a process and wait for it	462	Example: fork a process and wait for it
410		463
411	my $done = AnyEvent->condvar;	464	my $done = AnyEvent->condvar;
412		465
…		…
424	# do something else, then wait for process exit	477	# do something else, then wait for process exit
425	$done->recv;	478	$done->recv;
426		479
427	=head2 IDLE WATCHERS	480	=head2 IDLE WATCHERS
428		481
		482	$w = AnyEvent->idle (cb => <callback>);
		483
429	Sometimes there is a need to do something, but it is not so important	484	Sometimes there is a need to do something, but it is not so important
430	to do it instantly, but only when there is nothing better to do. This	485	to do it instantly, but only when there is nothing better to do. This
431	"nothing better to do" is usually defined to be "no other events need	486	"nothing better to do" is usually defined to be "no other events need
432	attention by the event loop".	487	attention by the event loop".
433		488
…		…
459	});	514	});
460	});	515	});
461		516
462	=head2 CONDITION VARIABLES	517	=head2 CONDITION VARIABLES
463		518
		519	$cv = AnyEvent->condvar;
		520
		521	$cv->send (<list>);
		522	my @res = $cv->recv;
		523
464	If you are familiar with some event loops you will know that all of them	524	If you are familiar with some event loops you will know that all of them
465	require you to run some blocking "loop", "run" or similar function that	525	require you to run some blocking "loop", "run" or similar function that
466	will actively watch for new events and call your callbacks.	526	will actively watch for new events and call your callbacks.
467		527
468	AnyEvent is slightly different: it expects somebody else to run the event	528	AnyEvent is slightly different: it expects somebody else to run the event
…		…
487	Condition variables are similar to callbacks, except that you can	547	Condition variables are similar to callbacks, except that you can
488	optionally wait for them. They can also be called merge points - points	548	optionally wait for them. They can also be called merge points - points
489	in time where multiple outstanding events have been processed. And yet	549	in time where multiple outstanding events have been processed. And yet
490	another way to call them is transactions - each condition variable can be	550	another way to call them is transactions - each condition variable can be
491	used to represent a transaction, which finishes at some point and delivers	551	used to represent a transaction, which finishes at some point and delivers
492	a result.	552	a result. And yet some people know them as "futures" - a promise to
		553	compute/deliver something that you can wait for.
493		554
494	Condition variables are very useful to signal that something has finished,	555	Condition variables are very useful to signal that something has finished,
495	for example, if you write a module that does asynchronous http requests,	556	for example, if you write a module that does asynchronous http requests,
496	then a condition variable would be the ideal candidate to signal the	557	then a condition variable would be the ideal candidate to signal the
497	availability of results. The user can either act when the callback is	558	availability of results. The user can either act when the callback is
…		…
729	=item $cb = $cv->cb ($cb->($cv))	790	=item $cb = $cv->cb ($cb->($cv))
730		791
731	This is a mutator function that returns the callback set and optionally	792	This is a mutator function that returns the callback set and optionally
732	replaces it before doing so.	793	replaces it before doing so.
733		794
734	The callback will be called when the condition becomes "true", i.e. when	795	The callback will be called when the condition becomes (or already was)
735	C<send> or C<croak> are called, with the only argument being the condition	796	"true", i.e. when C<send> or C<croak> are called (or were called), with
736	variable itself. Calling C<recv> inside the callback or at any later time	797	the only argument being the condition variable itself. Calling C<recv>
737	is guaranteed not to block.	798	inside the callback or at any later time is guaranteed not to block.
738		799
739	=back	800	=back
740		801
741	=head1 SUPPORTED EVENT LOOPS/BACKENDS	802	=head1 SUPPORTED EVENT LOOPS/BACKENDS
742		803
…		…
745	=over 4	806	=over 4
746		807
747	=item Backends that are autoprobed when no other event loop can be found.	808	=item Backends that are autoprobed when no other event loop can be found.
748		809
749	EV is the preferred backend when no other event loop seems to be in	810	EV is the preferred backend when no other event loop seems to be in
750	use. If EV is not installed, then AnyEvent will try Event, and, failing	811	use. If EV is not installed, then AnyEvent will fall back to its own
751	that, will fall back to its own pure-perl implementation, which is	812	pure-perl implementation, which is available everywhere as it comes with
752	available everywhere as it comes with AnyEvent itself.	813	AnyEvent itself.
753		814
754	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	815	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
755	AnyEvent::Impl::Event based on Event, very stable, few glitches.
756	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	816	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
757		817
758	=item Backends that are transparently being picked up when they are used.	818	=item Backends that are transparently being picked up when they are used.
759		819
760	These will be used when they are currently loaded when the first watcher	820	These will be used when they are currently loaded when the first watcher
761	is created, in which case it is assumed that the application is using	821	is created, in which case it is assumed that the application is using
762	them. This means that AnyEvent will automatically pick the right backend	822	them. This means that AnyEvent will automatically pick the right backend
763	when the main program loads an event module before anything starts to	823	when the main program loads an event module before anything starts to
764	create watchers. Nothing special needs to be done by the main program.	824	create watchers. Nothing special needs to be done by the main program.
765		825
		826	AnyEvent::Impl::Event based on Event, very stable, few glitches.
766	AnyEvent::Impl::Glib based on Glib, slow but very stable.	827	AnyEvent::Impl::Glib based on Glib, slow but very stable.
767	AnyEvent::Impl::Tk based on Tk, very broken.	828	AnyEvent::Impl::Tk based on Tk, very broken.
768	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	829	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
769	AnyEvent::Impl::POE based on POE, very slow, some limitations.	830	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		831	AnyEvent::Impl::Irssi used when running within irssi.
770		832
771	=item Backends with special needs.	833	=item Backends with special needs.
772		834
773	Qt requires the Qt::Application to be instantiated first, but will	835	Qt requires the Qt::Application to be instantiated first, but will
774	otherwise be picked up automatically. As long as the main program	836	otherwise be picked up automatically. As long as the main program
…		…
848	event module detection too early, for example, L<AnyEvent::AIO> creates	910	event module detection too early, for example, L<AnyEvent::AIO> creates
849	and installs the global L<IO::AIO> watcher in a C<post_detect> block to	911	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
850	avoid autodetecting the event module at load time.	912	avoid autodetecting the event module at load time.
851		913
852	If called in scalar or list context, then it creates and returns an object	914	If called in scalar or list context, then it creates and returns an object
853	that automatically removes the callback again when it is destroyed. See	915	that automatically removes the callback again when it is destroyed (or
		916	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
854	L<Coro::BDB> for a case where this is useful.	917	a case where this is useful.
		918
		919	Example: Create a watcher for the IO::AIO module and store it in
		920	C<$WATCHER>. Only do so after the event loop is initialised, though.
		921
		922	our WATCHER;
		923
		924	my $guard = AnyEvent::post_detect {
		925	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		926	};
		927
		928	# the \|\|= is important in case post_detect immediately runs the block,
		929	# as to not clobber the newly-created watcher. assigning both watcher and
		930	# post_detect guard to the same variable has the advantage of users being
		931	# able to just C<undef $WATCHER> if the watcher causes them grief.
		932
		933	$WATCHER \|\|= $guard;
855		934
856	=item @AnyEvent::post_detect	935	=item @AnyEvent::post_detect
857		936
858	If there are any code references in this array (you can C<push> to it	937	If there are any code references in this array (you can C<push> to it
859	before or after loading AnyEvent), then they will called directly after	938	before or after loading AnyEvent), then they will called directly after
…		…
1024		1103
1025	=cut	1104	=cut
1026		1105
1027	package AnyEvent;	1106	package AnyEvent;
1028		1107
		1108	# basically a tuned-down version of common::sense
		1109	sub common_sense {
1029	no warnings;	1110	# no warnings
		1111	${^WARNING_BITS} ^= ${^WARNING_BITS};
1030	use strict qw(vars subs);	1112	# use strict vars subs
		1113	$^H \|= 0x00000600;
		1114	}
		1115
		1116	BEGIN { AnyEvent::common_sense }
1031		1117
1032	use Carp ();	1118	use Carp ();
1033		1119
1034	our $VERSION = 4.83;	1120	our $VERSION = '5.0';
1035	our $MODEL;	1121	our $MODEL;
1036		1122
1037	our $AUTOLOAD;	1123	our $AUTOLOAD;
1038	our @ISA;	1124	our @ISA;
1039		1125
1040	our @REGISTRY;	1126	our @REGISTRY;
1041		1127
1042	our $WIN32;	1128	our $WIN32;
		1129
		1130	our $VERBOSE;
1043		1131
1044	BEGIN {	1132	BEGIN {
1045	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1133	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1046	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1134	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
1047		1135
1048	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1136	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1049	if ${^TAINT};	1137	if ${^TAINT};
1050	}
1051		1138
1052	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1139	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1140
		1141	}
		1142
		1143	our $MAX_SIGNAL_LATENCY = 10;
1053		1144
1054	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1145	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
1055		1146
1056	{	1147	{
1057	my $idx;	1148	my $idx;
…		…
1059	for reverse split /\s,\s/,	1150	for reverse split /\s,\s/,
1060	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1151	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1061	}	1152	}
1062		1153
1063	my @models = (	1154	my @models = (
1064	[EV:: => AnyEvent::Impl::EV::],	1155	[EV:: => AnyEvent::Impl::EV:: , 1],
1065	[Event:: => AnyEvent::Impl::Event::],
1066	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1156	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1067	# everything below here will not be autoprobed	1157	# everything below here will not (normally) be autoprobed
1068	# as the pureperl backend should work everywhere	1158	# as the pureperl backend should work everywhere
1069	# and is usually faster	1159	# and is usually faster
		1160	[Event:: => AnyEvent::Impl::Event::, 1],
1070	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1161	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1071	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1162	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1163	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1072	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1164	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1073	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1165	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1074	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1166	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1075	[Wx:: => AnyEvent::Impl::POE::],	1167	[Wx:: => AnyEvent::Impl::POE::],
1076	[Prima:: => AnyEvent::Impl::POE::],	1168	[Prima:: => AnyEvent::Impl::POE::],
1077	# IO::Async is just too broken - we would need workarounds for its	1169	# IO::Async is just too broken - we would need workarounds for its
1078	# byzantine signal and broken child handling, among others.	1170	# byzantine signal and broken child handling, among others.
1079	# IO::Async is rather hard to detect, as it doesn't have any	1171	# IO::Async is rather hard to detect, as it doesn't have any
1080	# obvious default class.	1172	# obvious default class.
1081	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1173	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1082	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1083	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1176	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1084	);	1177	);
1085		1178
1086	our %method = map +($_ => 1),	1179	our %method = map +($_ => 1),
1087	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1180	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1088		1181
…		…
1092	my ($cb) = @_;	1185	my ($cb) = @_;
1093		1186
1094	if ($MODEL) {	1187	if ($MODEL) {
1095	$cb->();	1188	$cb->();
1096		1189
1097	1	1190	undef
1098	} else {	1191	} else {
1099	push @post_detect, $cb;	1192	push @post_detect, $cb;
1100		1193
1101	defined wantarray	1194	defined wantarray
1102	? bless \$cb, "AnyEvent::Util::postdetect"	1195	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1108	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1201	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1109	}	1202	}
1110		1203
1111	sub detect() {	1204	sub detect() {
1112	unless ($MODEL) {	1205	unless ($MODEL) {
1113	no strict 'refs';
1114	local $SIG{__DIE__};	1206	local $SIG{__DIE__};
1115		1207
1116	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1208	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1117	my $model = "AnyEvent::Impl::$1";	1209	my $model = "AnyEvent::Impl::$1";
1118	if (eval "require $model") {	1210	if (eval "require $model") {
1119	$MODEL = $model;	1211	$MODEL = $model;
1120	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $verbose > 1;	1212	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1121	} else {	1213	} else {
1122	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $verbose;	1214	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1123	}	1215	}
1124	}	1216	}
1125		1217
1126	# check for already loaded models	1218	# check for already loaded models
1127	unless ($MODEL) {	1219	unless ($MODEL) {
1128	for (@REGISTRY, @models) {	1220	for (@REGISTRY, @models) {
1129	my ($package, $model) = @$_;	1221	my ($package, $model) = @$_;
1130	if (${"$package\::VERSION"} > 0) {	1222	if (${"$package\::VERSION"} > 0) {
1131	if (eval "require $model") {	1223	if (eval "require $model") {
1132	$MODEL = $model;	1224	$MODEL = $model;
1133	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1225	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1134	last;	1226	last;
1135	}	1227	}
1136	}	1228	}
1137	}	1229	}
1138		1230
1139	unless ($MODEL) {	1231	unless ($MODEL) {
1140	# try to load a model	1232	# try to autoload a model
1141
1142	for (@REGISTRY, @models) {	1233	for (@REGISTRY, @models) {
1143	my ($package, $model) = @$_;	1234	my ($package, $model, $autoload) = @$_;
		1235	if (
		1236	$autoload
1144	if (eval "require $package"	1237	and eval "require $package"
1145	and ${"$package\::VERSION"} > 0	1238	and ${"$package\::VERSION"} > 0
1146	and eval "require $model") {	1239	and eval "require $model"
		1240	) {
1147	$MODEL = $model;	1241	$MODEL = $model;
1148	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1242	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1149	last;	1243	last;
1150	}	1244	}
1151	}	1245	}
1152		1246
1153	$MODEL	1247	$MODEL
…		…
1194	# we assume CLOEXEC is already set by perl in all important cases	1288	# we assume CLOEXEC is already set by perl in all important cases
1195		1289
1196	($fh2, $rw)	1290	($fh2, $rw)
1197	}	1291	}
1198		1292
		1293	=head1 SIMPLIFIED AE API
		1294
		1295	Starting with version 5.0, AnyEvent officially supports a second, much
		1296	simpler, API that is designed to reduce the calling, typing and memory
		1297	overhead.
		1298
		1299	See the L<AE> manpage for details.
		1300
		1301	=cut
		1302
		1303	package AE;
		1304
		1305	our $VERSION = $AnyEvent::VERSION;
		1306
		1307	sub io($$$) {
		1308	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1309	}
		1310
		1311	sub timer($$$) {
		1312	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1313	}
		1314
		1315	sub signal($$) {
		1316	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1317	}
		1318
		1319	sub child($$) {
		1320	AnyEvent->child (pid => $_[0], cb => $_[1])
		1321	}
		1322
		1323	sub idle($) {
		1324	AnyEvent->idle (cb => $_[0])
		1325	}
		1326
		1327	sub cv(;&) {
		1328	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1329	}
		1330
		1331	sub now() {
		1332	AnyEvent->now
		1333	}
		1334
		1335	sub now_update() {
		1336	AnyEvent->now_update
		1337	}
		1338
		1339	sub time() {
		1340	AnyEvent->time
		1341	}
		1342
1199	package AnyEvent::Base;	1343	package AnyEvent::Base;
1200		1344
1201	# default implementations for many methods	1345	# default implementations for many methods
1202		1346
1203	BEGIN {	1347	sub _time {
		1348	# probe for availability of Time::HiRes
1204	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1349	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1350	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1205	*_time = \&Time::HiRes::time;	1351	*_time = \&Time::HiRes::time;
1206	# if (eval "use POSIX (); (POSIX::times())...	1352	# if (eval "use POSIX (); (POSIX::times())...
1207	} else {	1353	} else {
		1354	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1208	*_time = sub { time }; # epic fail	1355	*_time = sub { time }; # epic fail
1209	}	1356	}
		1357
		1358	&_time
1210	}	1359	}
1211		1360
1212	sub time { _time }	1361	sub time { _time }
1213	sub now { _time }	1362	sub now { _time }
1214	sub now_update { }	1363	sub now_update { }
…		…
1219	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1368	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1220	}	1369	}
1221		1370
1222	# default implementation for ->signal	1371	# default implementation for ->signal
1223		1372
		1373	our $HAVE_ASYNC_INTERRUPT;
		1374
		1375	sub _have_async_interrupt() {
		1376	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1377	&& eval "use Async::Interrupt 1.0 (); 1")
		1378	unless defined $HAVE_ASYNC_INTERRUPT;
		1379
		1380	$HAVE_ASYNC_INTERRUPT
		1381	}
		1382
1224	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1383	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1384	our (%SIG_ASY, %SIG_ASY_W);
		1385	our ($SIG_COUNT, $SIG_TW);
1225		1386
1226	sub _signal_exec {	1387	sub _signal_exec {
		1388	$HAVE_ASYNC_INTERRUPT
		1389	? $SIGPIPE_R->drain
1227	sysread $SIGPIPE_R, my $dummy, 4;	1390	: sysread $SIGPIPE_R, my $dummy, 9;
1228		1391
1229	while (%SIG_EV) {	1392	while (%SIG_EV) {
1230	for (keys %SIG_EV) {	1393	for (keys %SIG_EV) {
1231	delete $SIG_EV{$_};	1394	delete $SIG_EV{$_};
1232	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1395	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1233	}	1396	}
1234	}	1397	}
1235	}	1398	}
1236		1399
		1400	# install a dummy wakeup watcher to reduce signal catching latency
		1401	sub _sig_add() {
		1402	unless ($SIG_COUNT++) {
		1403	# try to align timer on a full-second boundary, if possible
		1404	my $NOW = AE::now;
		1405
		1406	$SIG_TW = AE::timer
		1407	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1408	$MAX_SIGNAL_LATENCY,
		1409	sub { } # just for the PERL_ASYNC_CHECK
		1410	;
		1411	}
		1412	}
		1413
		1414	sub _sig_del {
		1415	undef $SIG_TW
		1416	unless --$SIG_COUNT;
		1417	}
		1418
		1419	our $_sig_name_init; $_sig_name_init = sub {
		1420	eval q{ # poor man's autoloading
		1421	undef $_sig_name_init;
		1422
		1423	if (_have_async_interrupt) {
		1424	*sig2num = \&Async::Interrupt::sig2num;
		1425	*sig2name = \&Async::Interrupt::sig2name;
		1426	} else {
		1427	require Config;
		1428
		1429	my %signame2num;
		1430	@signame2num{ split ' ', $Config::Config{sig_name} }
		1431	= split ' ', $Config::Config{sig_num};
		1432
		1433	my @signum2name;
		1434	@signum2name[values %signame2num] = keys %signame2num;
		1435
		1436	*sig2num = sub($) {
		1437	$_[0] > 0 ? shift : $signame2num{+shift}
		1438	};
		1439	*sig2name = sub ($) {
		1440	$_[0] > 0 ? $signum2name[+shift] : shift
		1441	};
		1442	}
		1443	};
		1444	die if $@;
		1445	};
		1446
		1447	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1448	sub sig2name($) { &$_sig_name_init; &sig2name }
		1449
1237	sub signal {	1450	sub signal {
1238	my (undef, %arg) = @_;	1451	eval q{ # poor man's autoloading {}
		1452	# probe for availability of Async::Interrupt
		1453	if (_have_async_interrupt) {
		1454	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1239		1455
1240	unless ($SIGPIPE_R) {	1456	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1241	require Fcntl;	1457	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1242		1458
1243	if (AnyEvent::WIN32) {
1244	require AnyEvent::Util;
1245
1246	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1247	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1248	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1249	} else {	1459	} else {
		1460	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1461
		1462	require Fcntl;
		1463
		1464	if (AnyEvent::WIN32) {
		1465	require AnyEvent::Util;
		1466
		1467	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1468	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1470	} else {
1250	pipe $SIGPIPE_R, $SIGPIPE_W;	1471	pipe $SIGPIPE_R, $SIGPIPE_W;
1251	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1472	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1252	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1473	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1253		1474
1254	# not strictly required, as $^F is normally 2, but let's make sure...	1475	# not strictly required, as $^F is normally 2, but let's make sure...
1255	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1476	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1256	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1477	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1478	}
		1479
		1480	$SIGPIPE_R
		1481	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1482
		1483	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1257	}	1484	}
1258		1485
1259	$SIGPIPE_R	1486	*signal = sub {
1260	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1487	my (undef, %arg) = @_;
1261		1488
1262	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1263	}
1264
1265	my $signal = uc $arg{signal}	1489	my $signal = uc $arg{signal}
1266	or Carp::croak "required option 'signal' is missing";	1490	or Carp::croak "required option 'signal' is missing";
1267		1491
		1492	if ($HAVE_ASYNC_INTERRUPT) {
		1493	# async::interrupt
		1494
		1495	$signal = sig2num $signal;
1268	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1496	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1497
		1498	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1499	cb => sub { undef $SIG_EV{$signal} },
		1500	signal => $signal,
		1501	pipe => [$SIGPIPE_R->filenos],
		1502	pipe_autodrain => 0,
		1503	;
		1504
		1505	} else {
		1506	# pure perl
		1507
		1508	# AE::Util has been loaded in signal
		1509	$signal = sig2name $signal;
		1510	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1511
1269	$SIG{$signal} \|\|= sub {	1512	$SIG{$signal} \|\|= sub {
1270	local $!;	1513	local $!;
1271	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1514	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1272	undef $SIG_EV{$signal};	1515	undef $SIG_EV{$signal};
		1516	};
		1517
		1518	# can't do signal processing without introducing races in pure perl,
		1519	# so limit the signal latency.
		1520	_sig_add;
		1521	}
		1522
		1523	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1524	};
		1525
		1526	*AnyEvent::Base::signal::DESTROY = sub {
		1527	my ($signal, $cb) = @{$_[0]};
		1528
		1529	_sig_del;
		1530
		1531	delete $SIG_CB{$signal}{$cb};
		1532
		1533	$HAVE_ASYNC_INTERRUPT
		1534	? delete $SIG_ASY{$signal}
		1535	: # delete doesn't work with older perls - they then
		1536	# print weird messages, or just unconditionally exit
		1537	# instead of getting the default action.
		1538	undef $SIG{$signal}
		1539	unless keys %{ $SIG_CB{$signal} };
		1540	};
1273	};	1541	};
1274		1542	die if $@;
1275	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1543	&signal
1276	}
1277
1278	sub AnyEvent::Base::signal::DESTROY {
1279	my ($signal, $cb) = @{$_[0]};
1280
1281	delete $SIG_CB{$signal}{$cb};
1282
1283	# delete doesn't work with older perls - they then
1284	# print weird messages, or just unconditionally exit
1285	# instead of getting the default action.
1286	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1287	}	1544	}
1288		1545
1289	# default implementation for ->child	1546	# default implementation for ->child
1290		1547
1291	our %PID_CB;	1548	our %PID_CB;
1292	our $CHLD_W;	1549	our $CHLD_W;
1293	our $CHLD_DELAY_W;	1550	our $CHLD_DELAY_W;
1294	our $WNOHANG;	1551	our $WNOHANG;
1295		1552
		1553	sub _emit_childstatus($$) {
		1554	my (undef, $rpid, $rstatus) = @_;
		1555
		1556	$_->($rpid, $rstatus)
		1557	for values %{ $PID_CB{$rpid} \|\| {} },
		1558	values %{ $PID_CB{0} \|\| {} };
		1559	}
		1560
1296	sub _sigchld {	1561	sub _sigchld {
		1562	my $pid;
		1563
		1564	AnyEvent->_emit_childstatus ($pid, $?)
1297	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1565	while ($pid = waitpid -1, $WNOHANG) > 0;
1298	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),
1299	(values %{ $PID_CB{0} \|\| {} });
1300	}
1301	}	1566	}
1302		1567
1303	sub child {	1568	sub child {
1304	my (undef, %arg) = @_;	1569	my (undef, %arg) = @_;
1305		1570
1306	defined (my $pid = $arg{pid} + 0)	1571	defined (my $pid = $arg{pid} + 0)
1307	or Carp::croak "required option 'pid' is missing";	1572	or Carp::croak "required option 'pid' is missing";
1308		1573
1309	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1574	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1310		1575
		1576	# WNOHANG is almost cetrainly 1 everywhere
		1577	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1578	? 1
1311	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1579	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1312		1580
1313	unless ($CHLD_W) {	1581	unless ($CHLD_W) {
1314	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1582	$CHLD_W = AE::signal CHLD => \&_sigchld;
1315	# child could be a zombie already, so make at least one round	1583	# child could be a zombie already, so make at least one round
1316	&_sigchld;	1584	&_sigchld;
1317	}	1585	}
1318		1586
1319	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1587	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1345	# never use more then 50% of the time for the idle watcher,	1613	# never use more then 50% of the time for the idle watcher,
1346	# within some limits	1614	# within some limits
1347	$w = 0.0001 if $w < 0.0001;	1615	$w = 0.0001 if $w < 0.0001;
1348	$w = 5 if $w > 5;	1616	$w = 5 if $w > 5;
1349		1617
1350	$w = AnyEvent->timer (after => $w, cb => $rcb);	1618	$w = AE::timer $w, 0, $rcb;
1351	} else {	1619	} else {
1352	# clean up...	1620	# clean up...
1353	undef $w;	1621	undef $w;
1354	undef $rcb;	1622	undef $rcb;
1355	}	1623	}
1356	};	1624	};
1357		1625
1358	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1626	$w = AE::timer 0.05, 0, $rcb;
1359		1627
1360	bless \\$cb, "AnyEvent::Base::idle"	1628	bless \\$cb, "AnyEvent::Base::idle"
1361	}	1629	}
1362		1630
1363	sub AnyEvent::Base::idle::DESTROY {	1631	sub AnyEvent::Base::idle::DESTROY {
…		…
1368		1636
1369	our @ISA = AnyEvent::CondVar::Base::;	1637	our @ISA = AnyEvent::CondVar::Base::;
1370		1638
1371	package AnyEvent::CondVar::Base;	1639	package AnyEvent::CondVar::Base;
1372		1640
1373	use overload	1641	#use overload
1374	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1642	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1375	fallback => 1;	1643	# fallback => 1;
		1644
		1645	# save 300+ kilobytes by dirtily hardcoding overloading
		1646	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1647	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1648	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1649	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1376		1650
1377	our $WAITING;	1651	our $WAITING;
1378		1652
1379	sub _send {	1653	sub _send {
1380	# nop	1654	# nop
…		…
1411	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1685	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1412	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1686	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1413	}	1687	}
1414		1688
1415	sub cb {	1689	sub cb {
1416	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1690	my $cv = shift;
		1691
		1692	@_
		1693	and $cv->{_ae_cb} = shift
		1694	and $cv->{_ae_sent}
		1695	and (delete $cv->{_ae_cb})->($cv);
		1696
1417	$_[0]{_ae_cb}	1697	$cv->{_ae_cb}
1418	}	1698	}
1419		1699
1420	sub begin {	1700	sub begin {
1421	++$_[0]{_ae_counter};	1701	++$_[0]{_ae_counter};
1422	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1702	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1471	C<PERL_ANYEVENT_MODEL>.	1751	C<PERL_ANYEVENT_MODEL>.
1472		1752
1473	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1753	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1474	model it chooses.	1754	model it chooses.
1475		1755
		1756	When set to C<8> or higher, then AnyEvent will report extra information on
		1757	which optional modules it loads and how it implements certain features.
		1758
1476	=item C<PERL_ANYEVENT_STRICT>	1759	=item C<PERL_ANYEVENT_STRICT>
1477		1760
1478	AnyEvent does not do much argument checking by default, as thorough	1761	AnyEvent does not do much argument checking by default, as thorough
1479	argument checking is very costly. Setting this variable to a true value	1762	argument checking is very costly. Setting this variable to a true value
1480	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1763	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1481	check the arguments passed to most method calls. If it finds any problems,	1764	check the arguments passed to most method calls. If it finds any problems,
1482	it will croak.	1765	it will croak.
1483		1766
1484	In other words, enables "strict" mode.	1767	In other words, enables "strict" mode.
1485		1768
1486	Unlike C<use strict>, it is definitely recommended to keep it off in	1769	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1487	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1770	>>, it is definitely recommended to keep it off in production. Keeping
1488	developing programs can be very useful, however.	1771	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1772	can be very useful, however.
1489		1773
1490	=item C<PERL_ANYEVENT_MODEL>	1774	=item C<PERL_ANYEVENT_MODEL>
1491		1775
1492	This can be used to specify the event model to be used by AnyEvent, before	1776	This can be used to specify the event model to be used by AnyEvent, before
1493	auto detection and -probing kicks in. It must be a string consisting	1777	auto detection and -probing kicks in. It must be a string consisting
…		…
1555		1839
1556	When neither C<ca_file> nor C<ca_path> was specified during	1840	When neither C<ca_file> nor C<ca_path> was specified during
1557	L<AnyEvent::TLS> context creation, and either of these environment	1841	L<AnyEvent::TLS> context creation, and either of these environment
1558	variables exist, they will be used to specify CA certificate locations	1842	variables exist, they will be used to specify CA certificate locations
1559	instead of a system-dependent default.	1843	instead of a system-dependent default.
		1844
		1845	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1846
		1847	When these are set to C<1>, then the respective modules are not
		1848	loaded. Mostly good for testing AnyEvent itself.
1560		1849
1561	=back	1850	=back
1562		1851
1563	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1852	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1564		1853
…		…
1772	through AnyEvent. The benchmark creates a lot of timers (with a zero	2061	through AnyEvent. The benchmark creates a lot of timers (with a zero
1773	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	2062	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1774	which it is), lets them fire exactly once and destroys them again.	2063	which it is), lets them fire exactly once and destroys them again.
1775		2064
1776	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2065	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1777	distribution.	2066	distribution. It uses the L<AE> interface, which makes a real difference
		2067	for the EV and Perl backends only.
1778		2068
1779	=head3 Explanation of the columns	2069	=head3 Explanation of the columns
1780		2070
1781	I<watcher> is the number of event watchers created/destroyed. Since	2071	I<watcher> is the number of event watchers created/destroyed. Since
1782	different event models feature vastly different performances, each event	2072	different event models feature vastly different performances, each event
…		…
1803	watcher.	2093	watcher.
1804		2094
1805	=head3 Results	2095	=head3 Results
1806		2096
1807	name watchers bytes create invoke destroy comment	2097	name watchers bytes create invoke destroy comment
1808	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2098	EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1809	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers	2099	EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1810	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal	2100	Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1811	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation	2101	Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1812	Event/Event 16000 517 32.20 31.80 0.81 Event native interface	2102	Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1813	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers	2103	Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1814	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll	2104	IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1815	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll	2105	IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1816	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour	2106	Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1817	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers	2107	Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1818	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event	2108	POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1819	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select	2109	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1820		2110
1821	=head3 Discussion	2111	=head3 Discussion
1822		2112
1823	The benchmark does I<not> measure scalability of the event loop very	2113	The benchmark does I<not> measure scalability of the event loop very
1824	well. For example, a select-based event loop (such as the pure perl one)	2114	well. For example, a select-based event loop (such as the pure perl one)
…		…
1836	benchmark machine, handling an event takes roughly 1600 CPU cycles with	2126	benchmark machine, handling an event takes roughly 1600 CPU cycles with
1837	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU	2127	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1838	cycles with POE.	2128	cycles with POE.
1839		2129
1840	C<EV> is the sole leader regarding speed and memory use, which are both	2130	C<EV> is the sole leader regarding speed and memory use, which are both
1841	maximal/minimal, respectively. Even when going through AnyEvent, it uses	2131	maximal/minimal, respectively. When using the L<AE> API there is zero
		2132	overhead (when going through the AnyEvent API create is about 5-6 times
		2133	slower, with other times being equal, so still uses far less memory than
1842	far less memory than any other event loop and is still faster than Event	2134	any other event loop and is still faster than Event natively).
1843	natively.
1844		2135
1845	The pure perl implementation is hit in a few sweet spots (both the	2136	The pure perl implementation is hit in a few sweet spots (both the
1846	constant timeout and the use of a single fd hit optimisations in the perl	2137	constant timeout and the use of a single fd hit optimisations in the perl
1847	interpreter and the backend itself). Nevertheless this shows that it	2138	interpreter and the backend itself). Nevertheless this shows that it
1848	adds very little overhead in itself. Like any select-based backend its	2139	adds very little overhead in itself. Like any select-based backend its
…		…
1922	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100	2213	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1923	(1%) are active. This mirrors the activity of large servers with many	2214	(1%) are active. This mirrors the activity of large servers with many
1924	connections, most of which are idle at any one point in time.	2215	connections, most of which are idle at any one point in time.
1925		2216
1926	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2217	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1927	distribution.	2218	distribution. It uses the L<AE> interface, which makes a real difference
		2219	for the EV and Perl backends only.
1928		2220
1929	=head3 Explanation of the columns	2221	=head3 Explanation of the columns
1930		2222
1931	I<sockets> is the number of sockets, and twice the number of "servers" (as	2223	I<sockets> is the number of sockets, and twice the number of "servers" (as
1932	each server has a read and write socket end).	2224	each server has a read and write socket end).
…		…
1940	a new one that moves the timeout into the future.	2232	a new one that moves the timeout into the future.
1941		2233
1942	=head3 Results	2234	=head3 Results
1943		2235
1944	name sockets create request	2236	name sockets create request
1945	EV 20000 69.01 11.16	2237	EV 20000 62.66 7.99
1946	Perl 20000 73.32 35.87	2238	Perl 20000 68.32 32.64
1947	IOAsync 20000 157.00 98.14 epoll	2239	IOAsync 20000 174.06 101.15 epoll
1948	IOAsync 20000 159.31 616.06 poll	2240	IOAsync 20000 174.67 610.84 poll
1949	Event 20000 212.62 257.32	2241	Event 20000 202.69 242.91
1950	Glib 20000 651.16 1896.30	2242	Glib 20000 557.01 1689.52
1951	POE 20000 349.67 12317.24 uses POE::Loop::Event	2243	POE 20000 341.54 12086.32 uses POE::Loop::Event
1952		2244
1953	=head3 Discussion	2245	=head3 Discussion
1954		2246
1955	This benchmark I<does> measure scalability and overall performance of the	2247	This benchmark I<does> measure scalability and overall performance of the
1956	particular event loop.	2248	particular event loop.
…		…
2132	if $SIG{CHLD} eq 'IGNORE';	2424	if $SIG{CHLD} eq 'IGNORE';
2133		2425
2134	$SIG{PIPE} = sub { }	2426	$SIG{PIPE} = sub { }
2135	unless defined $SIG{PIPE};	2427	unless defined $SIG{PIPE};
2136		2428
		2429	=head1 RECOMMENDED/OPTIONAL MODULES
		2430
		2431	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2432	it's built-in modules) are required to use it.
		2433
		2434	That does not mean that AnyEvent won't take advantage of some additional
		2435	modules if they are installed.
		2436
		2437	This section epxlains which additional modules will be used, and how they
		2438	affect AnyEvent's operetion.
		2439
		2440	=over 4
		2441
		2442	=item L<Async::Interrupt>
		2443
		2444	This slightly arcane module is used to implement fast signal handling: To
		2445	my knowledge, there is no way to do completely race-free and quick
		2446	signal handling in pure perl. To ensure that signals still get
		2447	delivered, AnyEvent will start an interval timer to wake up perl (and
		2448	catch the signals) with some delay (default is 10 seconds, look for
		2449	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2450
		2451	If this module is available, then it will be used to implement signal
		2452	catching, which means that signals will not be delayed, and the event loop
		2453	will not be interrupted regularly, which is more efficient (And good for
		2454	battery life on laptops).
		2455
		2456	This affects not just the pure-perl event loop, but also other event loops
		2457	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2458
		2459	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2460	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2461	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2462	does nothing for those backends.
		2463
		2464	=item L<EV>
		2465
		2466	This module isn't really "optional", as it is simply one of the backend
		2467	event loops that AnyEvent can use. However, it is simply the best event
		2468	loop available in terms of features, speed and stability: It supports
		2469	the AnyEvent API optimally, implements all the watcher types in XS, does
		2470	automatic timer adjustments even when no monotonic clock is available,
		2471	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2472	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2473	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2474
		2475	=item L<Guard>
		2476
		2477	The guard module, when used, will be used to implement
		2478	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2479	lot less memory), but otherwise doesn't affect guard operation much. It is
		2480	purely used for performance.
		2481
		2482	=item L<JSON> and L<JSON::XS>
		2483
		2484	This module is required when you want to read or write JSON data via
		2485	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2486	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2487
		2488	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2489	installed.
		2490
		2491	=item L<Net::SSLeay>
		2492
		2493	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2494	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2495	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2496
		2497	=item L<Time::HiRes>
		2498
		2499	This module is part of perl since release 5.008. It will be used when the
		2500	chosen event library does not come with a timing source on it's own. The
		2501	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2502	try to use a monotonic clock for timing stability.
		2503
		2504	=back
		2505
		2506
2137	=head1 FORK	2507	=head1 FORK
2138		2508
2139	Most event libraries are not fork-safe. The ones who are usually are	2509	Most event libraries are not fork-safe. The ones who are usually are
2140	because they rely on inefficient but fork-safe C<select> or C<poll>	2510	because they rely on inefficient but fork-safe C<select> or C<poll>
2141	calls. Only L<EV> is fully fork-aware.	2511	calls. Only L<EV> is fully fork-aware.
2142		2512
2143	If you have to fork, you must either do so I<before> creating your first	2513	If you have to fork, you must either do so I<before> creating your first
2144	watcher OR you must not use AnyEvent at all in the child.	2514	watcher OR you must not use AnyEvent at all in the child OR you must do
		2515	something completely out of the scope of AnyEvent.
2145		2516
2146		2517
2147	=head1 SECURITY CONSIDERATIONS	2518	=head1 SECURITY CONSIDERATIONS
2148		2519
2149	AnyEvent can be forced to load any event model via	2520	AnyEvent can be forced to load any event model via
…		…
2187	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2558	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2188		2559
2189	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2560	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2190	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2561	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2191	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2562	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2192	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2563	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2193		2564
2194	Non-blocking file handles, sockets, TCP clients and	2565	Non-blocking file handles, sockets, TCP clients and
2195	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2566	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2196		2567
2197	Asynchronous DNS: L<AnyEvent::DNS>.	2568	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.241 by root, Fri Jul 17 18:08:35 2009 UTC vs. Revision 1.279 by root, Sun Aug 9 16:05:11 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.241 by root, Fri Jul 17 18:08:35 2009 UTC vs.
Revision 1.279 by root, Sun Aug 9 16:05:11 2009 UTC