[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.282 by root, Tue Aug 11 01:18:27 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
…		…
605	one. For example, a function that pings many hosts in parallel might want	666	one. For example, a function that pings many hosts in parallel might want
606	to use a condition variable for the whole process.	667	to use a condition variable for the whole process.
607		668
608	Every call to C<< ->begin >> will increment a counter, and every call to	669	Every call to C<< ->begin >> will increment a counter, and every call to
609	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	670	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
610	>>, the (last) callback passed to C<begin> will be executed. That callback	671	>>, the (last) callback passed to C<begin> will be executed, passing the
611	is I<supposed> to call C<< ->send >>, but that is not required. If no	672	condvar as first argument. That callback is I<supposed> to call C<< ->send
612	callback was set, C<send> will be called without any arguments.	673	>>, but that is not required. If no group callback was set, C<send> will
		674	be called without any arguments.
613		675
614	You can think of C<< $cv->send >> giving you an OR condition (one call	676	You can think of C<< $cv->send >> giving you an OR condition (one call
615	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	677	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
616	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	678	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
617		679
…		…
644	begung can potentially be zero:	706	begung can potentially be zero:
645		707
646	my $cv = AnyEvent->condvar;	708	my $cv = AnyEvent->condvar;
647		709
648	my %result;	710	my %result;
649	$cv->begin (sub { $cv->send (\%result) });	711	$cv->begin (sub { shift->send (\%result) });
650		712
651	for my $host (@list_of_hosts) {	713	for my $host (@list_of_hosts) {
652	$cv->begin;	714	$cv->begin;
653	ping_host_then_call_callback $host, sub {	715	ping_host_then_call_callback $host, sub {
654	$result{$host} = ...;	716	$result{$host} = ...;
…		…
729	=item $cb = $cv->cb ($cb->($cv))	791	=item $cb = $cv->cb ($cb->($cv))
730		792
731	This is a mutator function that returns the callback set and optionally	793	This is a mutator function that returns the callback set and optionally
732	replaces it before doing so.	794	replaces it before doing so.
733		795
734	The callback will be called when the condition becomes "true", i.e. when	796	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	797	"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	798	the only argument being the condition variable itself. Calling C<recv>
737	is guaranteed not to block.	799	inside the callback or at any later time is guaranteed not to block.
738		800
739	=back	801	=back
740		802
741	=head1 SUPPORTED EVENT LOOPS/BACKENDS	803	=head1 SUPPORTED EVENT LOOPS/BACKENDS
742		804
…		…
745	=over 4	807	=over 4
746		808
747	=item Backends that are autoprobed when no other event loop can be found.	809	=item Backends that are autoprobed when no other event loop can be found.
748		810
749	EV is the preferred backend when no other event loop seems to be in	811	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	812	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	813	pure-perl implementation, which is available everywhere as it comes with
752	available everywhere as it comes with AnyEvent itself.	814	AnyEvent itself.
753		815
754	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	816	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.	817	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
757		818
758	=item Backends that are transparently being picked up when they are used.	819	=item Backends that are transparently being picked up when they are used.
759		820
760	These will be used when they are currently loaded when the first watcher	821	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	822	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	823	them. This means that AnyEvent will automatically pick the right backend
763	when the main program loads an event module before anything starts to	824	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.	825	create watchers. Nothing special needs to be done by the main program.
765		826
		827	AnyEvent::Impl::Event based on Event, very stable, few glitches.
766	AnyEvent::Impl::Glib based on Glib, slow but very stable.	828	AnyEvent::Impl::Glib based on Glib, slow but very stable.
767	AnyEvent::Impl::Tk based on Tk, very broken.	829	AnyEvent::Impl::Tk based on Tk, very broken.
768	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	830	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
769	AnyEvent::Impl::POE based on POE, very slow, some limitations.	831	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		832	AnyEvent::Impl::Irssi used when running within irssi.
770		833
771	=item Backends with special needs.	834	=item Backends with special needs.
772		835
773	Qt requires the Qt::Application to be instantiated first, but will	836	Qt requires the Qt::Application to be instantiated first, but will
774	otherwise be picked up automatically. As long as the main program	837	otherwise be picked up automatically. As long as the main program
…		…
848	event module detection too early, for example, L<AnyEvent::AIO> creates	911	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	912	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
850	avoid autodetecting the event module at load time.	913	avoid autodetecting the event module at load time.
851		914
852	If called in scalar or list context, then it creates and returns an object	915	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	916	that automatically removes the callback again when it is destroyed (or
		917	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
854	L<Coro::BDB> for a case where this is useful.	918	a case where this is useful.
		919
		920	Example: Create a watcher for the IO::AIO module and store it in
		921	C<$WATCHER>. Only do so after the event loop is initialised, though.
		922
		923	our WATCHER;
		924
		925	my $guard = AnyEvent::post_detect {
		926	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		927	};
		928
		929	# the \|\|= is important in case post_detect immediately runs the block,
		930	# as to not clobber the newly-created watcher. assigning both watcher and
		931	# post_detect guard to the same variable has the advantage of users being
		932	# able to just C<undef $WATCHER> if the watcher causes them grief.
		933
		934	$WATCHER \|\|= $guard;
855		935
856	=item @AnyEvent::post_detect	936	=item @AnyEvent::post_detect
857		937
858	If there are any code references in this array (you can C<push> to it	938	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	939	before or after loading AnyEvent), then they will called directly after
…		…
1024		1104
1025	=cut	1105	=cut
1026		1106
1027	package AnyEvent;	1107	package AnyEvent;
1028		1108
		1109	# basically a tuned-down version of common::sense
		1110	sub common_sense {
1029	no warnings;	1111	# no warnings
		1112	${^WARNING_BITS} ^= ${^WARNING_BITS};
1030	use strict qw(vars subs);	1113	# use strict vars subs
		1114	$^H \|= 0x00000600;
		1115	}
		1116
		1117	BEGIN { AnyEvent::common_sense }
1031		1118
1032	use Carp ();	1119	use Carp ();
1033		1120
1034	our $VERSION = 4.83;	1121	our $VERSION = '5.1';
1035	our $MODEL;	1122	our $MODEL;
1036		1123
1037	our $AUTOLOAD;	1124	our $AUTOLOAD;
1038	our @ISA;	1125	our @ISA;
1039		1126
1040	our @REGISTRY;	1127	our @REGISTRY;
1041		1128
1042	our $WIN32;	1129	our $WIN32;
		1130
		1131	our $VERBOSE;
1043		1132
1044	BEGIN {	1133	BEGIN {
1045	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1134	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1046	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1135	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
1047		1136
1048	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1137	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1049	if ${^TAINT};	1138	if ${^TAINT};
1050	}
1051		1139
1052	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1140	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1141
		1142	}
		1143
		1144	our $MAX_SIGNAL_LATENCY = 10;
1053		1145
1054	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1146	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
1055		1147
1056	{	1148	{
1057	my $idx;	1149	my $idx;
…		…
1059	for reverse split /\s,\s/,	1151	for reverse split /\s,\s/,
1060	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1152	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1061	}	1153	}
1062		1154
1063	my @models = (	1155	my @models = (
1064	[EV:: => AnyEvent::Impl::EV::],	1156	[EV:: => AnyEvent::Impl::EV:: , 1],
1065	[Event:: => AnyEvent::Impl::Event::],
1066	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1157	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1067	# everything below here will not be autoprobed	1158	# everything below here will not (normally) be autoprobed
1068	# as the pureperl backend should work everywhere	1159	# as the pureperl backend should work everywhere
1069	# and is usually faster	1160	# and is usually faster
		1161	[Event:: => AnyEvent::Impl::Event::, 1],
1070	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1162	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1071	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1163	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1164	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1072	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1165	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1073	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1166	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1074	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1167	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1075	[Wx:: => AnyEvent::Impl::POE::],	1168	[Wx:: => AnyEvent::Impl::POE::],
1076	[Prima:: => AnyEvent::Impl::POE::],	1169	[Prima:: => AnyEvent::Impl::POE::],
1077	# IO::Async is just too broken - we would need workarounds for its	1170	# IO::Async is just too broken - we would need workarounds for its
1078	# byzantine signal and broken child handling, among others.	1171	# byzantine signal and broken child handling, among others.
1079	# IO::Async is rather hard to detect, as it doesn't have any	1172	# IO::Async is rather hard to detect, as it doesn't have any
1080	# obvious default class.	1173	# obvious default class.
1081	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1174	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1082	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1175	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1083	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1176	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1177	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1084	);	1178	);
1085		1179
1086	our %method = map +($_ => 1),	1180	our %method = map +($_ => 1),
1087	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1181	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1088		1182
…		…
1092	my ($cb) = @_;	1186	my ($cb) = @_;
1093		1187
1094	if ($MODEL) {	1188	if ($MODEL) {
1095	$cb->();	1189	$cb->();
1096		1190
1097	1	1191	undef
1098	} else {	1192	} else {
1099	push @post_detect, $cb;	1193	push @post_detect, $cb;
1100		1194
1101	defined wantarray	1195	defined wantarray
1102	? bless \$cb, "AnyEvent::Util::postdetect"	1196	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1108	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1202	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1109	}	1203	}
1110		1204
1111	sub detect() {	1205	sub detect() {
1112	unless ($MODEL) {	1206	unless ($MODEL) {
1113	no strict 'refs';
1114	local $SIG{__DIE__};	1207	local $SIG{__DIE__};
1115		1208
1116	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1209	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1117	my $model = "AnyEvent::Impl::$1";	1210	my $model = "AnyEvent::Impl::$1";
1118	if (eval "require $model") {	1211	if (eval "require $model") {
1119	$MODEL = $model;	1212	$MODEL = $model;
1120	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $verbose > 1;	1213	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1121	} else {	1214	} else {
1122	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $verbose;	1215	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1123	}	1216	}
1124	}	1217	}
1125		1218
1126	# check for already loaded models	1219	# check for already loaded models
1127	unless ($MODEL) {	1220	unless ($MODEL) {
1128	for (@REGISTRY, @models) {	1221	for (@REGISTRY, @models) {
1129	my ($package, $model) = @$_;	1222	my ($package, $model) = @$_;
1130	if (${"$package\::VERSION"} > 0) {	1223	if (${"$package\::VERSION"} > 0) {
1131	if (eval "require $model") {	1224	if (eval "require $model") {
1132	$MODEL = $model;	1225	$MODEL = $model;
1133	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1226	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1134	last;	1227	last;
1135	}	1228	}
1136	}	1229	}
1137	}	1230	}
1138		1231
1139	unless ($MODEL) {	1232	unless ($MODEL) {
1140	# try to load a model	1233	# try to autoload a model
1141
1142	for (@REGISTRY, @models) {	1234	for (@REGISTRY, @models) {
1143	my ($package, $model) = @$_;	1235	my ($package, $model, $autoload) = @$_;
		1236	if (
		1237	$autoload
1144	if (eval "require $package"	1238	and eval "require $package"
1145	and ${"$package\::VERSION"} > 0	1239	and ${"$package\::VERSION"} > 0
1146	and eval "require $model") {	1240	and eval "require $model"
		1241	) {
1147	$MODEL = $model;	1242	$MODEL = $model;
1148	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1243	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1149	last;	1244	last;
1150	}	1245	}
1151	}	1246	}
1152		1247
1153	$MODEL	1248	$MODEL
…		…
1194	# we assume CLOEXEC is already set by perl in all important cases	1289	# we assume CLOEXEC is already set by perl in all important cases
1195		1290
1196	($fh2, $rw)	1291	($fh2, $rw)
1197	}	1292	}
1198		1293
		1294	=head1 SIMPLIFIED AE API
		1295
		1296	Starting with version 5.0, AnyEvent officially supports a second, much
		1297	simpler, API that is designed to reduce the calling, typing and memory
		1298	overhead.
		1299
		1300	See the L<AE> manpage for details.
		1301
		1302	=cut
		1303
		1304	package AE;
		1305
		1306	our $VERSION = $AnyEvent::VERSION;
		1307
		1308	sub io($$$) {
		1309	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1310	}
		1311
		1312	sub timer($$$) {
		1313	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1314	}
		1315
		1316	sub signal($$) {
		1317	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1318	}
		1319
		1320	sub child($$) {
		1321	AnyEvent->child (pid => $_[0], cb => $_[1])
		1322	}
		1323
		1324	sub idle($) {
		1325	AnyEvent->idle (cb => $_[0])
		1326	}
		1327
		1328	sub cv(;&) {
		1329	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1330	}
		1331
		1332	sub now() {
		1333	AnyEvent->now
		1334	}
		1335
		1336	sub now_update() {
		1337	AnyEvent->now_update
		1338	}
		1339
		1340	sub time() {
		1341	AnyEvent->time
		1342	}
		1343
1199	package AnyEvent::Base;	1344	package AnyEvent::Base;
1200		1345
1201	# default implementations for many methods	1346	# default implementations for many methods
1202		1347
1203	BEGIN {	1348	sub _time {
		1349	# probe for availability of Time::HiRes
1204	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1350	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1351	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1205	*_time = \&Time::HiRes::time;	1352	*_time = \&Time::HiRes::time;
1206	# if (eval "use POSIX (); (POSIX::times())...	1353	# if (eval "use POSIX (); (POSIX::times())...
1207	} else {	1354	} else {
		1355	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1208	*_time = sub { time }; # epic fail	1356	*_time = sub { time }; # epic fail
1209	}	1357	}
		1358
		1359	&_time
1210	}	1360	}
1211		1361
1212	sub time { _time }	1362	sub time { _time }
1213	sub now { _time }	1363	sub now { _time }
1214	sub now_update { }	1364	sub now_update { }
…		…
1219	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1369	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1220	}	1370	}
1221		1371
1222	# default implementation for ->signal	1372	# default implementation for ->signal
1223		1373
		1374	our $HAVE_ASYNC_INTERRUPT;
		1375
		1376	sub _have_async_interrupt() {
		1377	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1378	&& eval "use Async::Interrupt 1.0 (); 1")
		1379	unless defined $HAVE_ASYNC_INTERRUPT;
		1380
		1381	$HAVE_ASYNC_INTERRUPT
		1382	}
		1383
1224	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1384	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1385	our (%SIG_ASY, %SIG_ASY_W);
		1386	our ($SIG_COUNT, $SIG_TW);
1225		1387
1226	sub _signal_exec {	1388	sub _signal_exec {
		1389	$HAVE_ASYNC_INTERRUPT
		1390	? $SIGPIPE_R->drain
1227	sysread $SIGPIPE_R, my $dummy, 4;	1391	: sysread $SIGPIPE_R, my $dummy, 9;
1228		1392
1229	while (%SIG_EV) {	1393	while (%SIG_EV) {
1230	for (keys %SIG_EV) {	1394	for (keys %SIG_EV) {
1231	delete $SIG_EV{$_};	1395	delete $SIG_EV{$_};
1232	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1396	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1233	}	1397	}
1234	}	1398	}
1235	}	1399	}
1236		1400
		1401	# install a dummy wakeup watcher to reduce signal catching latency
		1402	sub _sig_add() {
		1403	unless ($SIG_COUNT++) {
		1404	# try to align timer on a full-second boundary, if possible
		1405	my $NOW = AE::now;
		1406
		1407	$SIG_TW = AE::timer
		1408	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1409	$MAX_SIGNAL_LATENCY,
		1410	sub { } # just for the PERL_ASYNC_CHECK
		1411	;
		1412	}
		1413	}
		1414
		1415	sub _sig_del {
		1416	undef $SIG_TW
		1417	unless --$SIG_COUNT;
		1418	}
		1419
		1420	our $_sig_name_init; $_sig_name_init = sub {
		1421	eval q{ # poor man's autoloading
		1422	undef $_sig_name_init;
		1423
		1424	if (_have_async_interrupt) {
		1425	*sig2num = \&Async::Interrupt::sig2num;
		1426	*sig2name = \&Async::Interrupt::sig2name;
		1427	} else {
		1428	require Config;
		1429
		1430	my %signame2num;
		1431	@signame2num{ split ' ', $Config::Config{sig_name} }
		1432	= split ' ', $Config::Config{sig_num};
		1433
		1434	my @signum2name;
		1435	@signum2name[values %signame2num] = keys %signame2num;
		1436
		1437	*sig2num = sub($) {
		1438	$_[0] > 0 ? shift : $signame2num{+shift}
		1439	};
		1440	*sig2name = sub ($) {
		1441	$_[0] > 0 ? $signum2name[+shift] : shift
		1442	};
		1443	}
		1444	};
		1445	die if $@;
		1446	};
		1447
		1448	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1449	sub sig2name($) { &$_sig_name_init; &sig2name }
		1450
1237	sub signal {	1451	sub signal {
1238	my (undef, %arg) = @_;	1452	eval q{ # poor man's autoloading {}
		1453	# probe for availability of Async::Interrupt
		1454	if (_have_async_interrupt) {
		1455	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1239		1456
1240	unless ($SIGPIPE_R) {	1457	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1241	require Fcntl;	1458	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1242		1459
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 {	1460	} else {
		1461	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1462
		1463	require Fcntl;
		1464
		1465	if (AnyEvent::WIN32) {
		1466	require AnyEvent::Util;
		1467
		1468	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1470	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1471	} else {
1250	pipe $SIGPIPE_R, $SIGPIPE_W;	1472	pipe $SIGPIPE_R, $SIGPIPE_W;
1251	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1473	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	1474	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1253		1475
1254	# not strictly required, as $^F is normally 2, but let's make sure...	1476	# not strictly required, as $^F is normally 2, but let's make sure...
1255	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1477	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1256	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1478	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1479	}
		1480
		1481	$SIGPIPE_R
		1482	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1483
		1484	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1257	}	1485	}
1258		1486
1259	$SIGPIPE_R	1487	*signal = sub {
1260	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1488	my (undef, %arg) = @_;
1261		1489
1262	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1263	}
1264
1265	my $signal = uc $arg{signal}	1490	my $signal = uc $arg{signal}
1266	or Carp::croak "required option 'signal' is missing";	1491	or Carp::croak "required option 'signal' is missing";
1267		1492
		1493	if ($HAVE_ASYNC_INTERRUPT) {
		1494	# async::interrupt
		1495
		1496	$signal = sig2num $signal;
1268	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1497	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1498
		1499	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1500	cb => sub { undef $SIG_EV{$signal} },
		1501	signal => $signal,
		1502	pipe => [$SIGPIPE_R->filenos],
		1503	pipe_autodrain => 0,
		1504	;
		1505
		1506	} else {
		1507	# pure perl
		1508
		1509	# AE::Util has been loaded in signal
		1510	$signal = sig2name $signal;
		1511	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1512
1269	$SIG{$signal} \|\|= sub {	1513	$SIG{$signal} \|\|= sub {
1270	local $!;	1514	local $!;
1271	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1515	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1272	undef $SIG_EV{$signal};	1516	undef $SIG_EV{$signal};
		1517	};
		1518
		1519	# can't do signal processing without introducing races in pure perl,
		1520	# so limit the signal latency.
		1521	_sig_add;
		1522	}
		1523
		1524	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1525	};
		1526
		1527	*AnyEvent::Base::signal::DESTROY = sub {
		1528	my ($signal, $cb) = @{$_[0]};
		1529
		1530	_sig_del;
		1531
		1532	delete $SIG_CB{$signal}{$cb};
		1533
		1534	$HAVE_ASYNC_INTERRUPT
		1535	? delete $SIG_ASY{$signal}
		1536	: # delete doesn't work with older perls - they then
		1537	# print weird messages, or just unconditionally exit
		1538	# instead of getting the default action.
		1539	undef $SIG{$signal}
		1540	unless keys %{ $SIG_CB{$signal} };
		1541	};
1273	};	1542	};
1274		1543	die if $@;
1275	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1544	&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	}	1545	}
1288		1546
1289	# default implementation for ->child	1547	# default implementation for ->child
1290		1548
1291	our %PID_CB;	1549	our %PID_CB;
1292	our $CHLD_W;	1550	our $CHLD_W;
1293	our $CHLD_DELAY_W;	1551	our $CHLD_DELAY_W;
1294	our $WNOHANG;	1552	our $WNOHANG;
1295		1553
		1554	sub _emit_childstatus($$) {
		1555	my (undef, $rpid, $rstatus) = @_;
		1556
		1557	$_->($rpid, $rstatus)
		1558	for values %{ $PID_CB{$rpid} \|\| {} },
		1559	values %{ $PID_CB{0} \|\| {} };
		1560	}
		1561
1296	sub _sigchld {	1562	sub _sigchld {
		1563	my $pid;
		1564
		1565	AnyEvent->_emit_childstatus ($pid, $?)
1297	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1566	while ($pid = waitpid -1, $WNOHANG) > 0;
1298	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),
1299	(values %{ $PID_CB{0} \|\| {} });
1300	}
1301	}	1567	}
1302		1568
1303	sub child {	1569	sub child {
1304	my (undef, %arg) = @_;	1570	my (undef, %arg) = @_;
1305		1571
1306	defined (my $pid = $arg{pid} + 0)	1572	defined (my $pid = $arg{pid} + 0)
1307	or Carp::croak "required option 'pid' is missing";	1573	or Carp::croak "required option 'pid' is missing";
1308		1574
1309	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1575	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1310		1576
		1577	# WNOHANG is almost cetrainly 1 everywhere
		1578	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1579	? 1
1311	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1580	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1312		1581
1313	unless ($CHLD_W) {	1582	unless ($CHLD_W) {
1314	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1583	$CHLD_W = AE::signal CHLD => \&_sigchld;
1315	# child could be a zombie already, so make at least one round	1584	# child could be a zombie already, so make at least one round
1316	&_sigchld;	1585	&_sigchld;
1317	}	1586	}
1318		1587
1319	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1588	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1345	# never use more then 50% of the time for the idle watcher,	1614	# never use more then 50% of the time for the idle watcher,
1346	# within some limits	1615	# within some limits
1347	$w = 0.0001 if $w < 0.0001;	1616	$w = 0.0001 if $w < 0.0001;
1348	$w = 5 if $w > 5;	1617	$w = 5 if $w > 5;
1349		1618
1350	$w = AnyEvent->timer (after => $w, cb => $rcb);	1619	$w = AE::timer $w, 0, $rcb;
1351	} else {	1620	} else {
1352	# clean up...	1621	# clean up...
1353	undef $w;	1622	undef $w;
1354	undef $rcb;	1623	undef $rcb;
1355	}	1624	}
1356	};	1625	};
1357		1626
1358	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1627	$w = AE::timer 0.05, 0, $rcb;
1359		1628
1360	bless \\$cb, "AnyEvent::Base::idle"	1629	bless \\$cb, "AnyEvent::Base::idle"
1361	}	1630	}
1362		1631
1363	sub AnyEvent::Base::idle::DESTROY {	1632	sub AnyEvent::Base::idle::DESTROY {
…		…
1368		1637
1369	our @ISA = AnyEvent::CondVar::Base::;	1638	our @ISA = AnyEvent::CondVar::Base::;
1370		1639
1371	package AnyEvent::CondVar::Base;	1640	package AnyEvent::CondVar::Base;
1372		1641
1373	use overload	1642	#use overload
1374	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1643	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1375	fallback => 1;	1644	# fallback => 1;
		1645
		1646	# save 300+ kilobytes by dirtily hardcoding overloading
		1647	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1648	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1649	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1650	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1376		1651
1377	our $WAITING;	1652	our $WAITING;
1378		1653
1379	sub _send {	1654	sub _send {
1380	# nop	1655	# nop
…		…
1411	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1686	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1412	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1687	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1413	}	1688	}
1414		1689
1415	sub cb {	1690	sub cb {
1416	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1691	my $cv = shift;
		1692
		1693	@_
		1694	and $cv->{_ae_cb} = shift
		1695	and $cv->{_ae_sent}
		1696	and (delete $cv->{_ae_cb})->($cv);
		1697
1417	$_[0]{_ae_cb}	1698	$cv->{_ae_cb}
1418	}	1699	}
1419		1700
1420	sub begin {	1701	sub begin {
1421	++$_[0]{_ae_counter};	1702	++$_[0]{_ae_counter};
1422	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1703	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1471	C<PERL_ANYEVENT_MODEL>.	1752	C<PERL_ANYEVENT_MODEL>.
1472		1753
1473	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1754	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1474	model it chooses.	1755	model it chooses.
1475		1756
		1757	When set to C<8> or higher, then AnyEvent will report extra information on
		1758	which optional modules it loads and how it implements certain features.
		1759
1476	=item C<PERL_ANYEVENT_STRICT>	1760	=item C<PERL_ANYEVENT_STRICT>
1477		1761
1478	AnyEvent does not do much argument checking by default, as thorough	1762	AnyEvent does not do much argument checking by default, as thorough
1479	argument checking is very costly. Setting this variable to a true value	1763	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	1764	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,	1765	check the arguments passed to most method calls. If it finds any problems,
1482	it will croak.	1766	it will croak.
1483		1767
1484	In other words, enables "strict" mode.	1768	In other words, enables "strict" mode.
1485		1769
1486	Unlike C<use strict>, it is definitely recommended to keep it off in	1770	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	1771	>>, it is definitely recommended to keep it off in production. Keeping
1488	developing programs can be very useful, however.	1772	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1773	can be very useful, however.
1489		1774
1490	=item C<PERL_ANYEVENT_MODEL>	1775	=item C<PERL_ANYEVENT_MODEL>
1491		1776
1492	This can be used to specify the event model to be used by AnyEvent, before	1777	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	1778	auto detection and -probing kicks in. It must be a string consisting
…		…
1555		1840
1556	When neither C<ca_file> nor C<ca_path> was specified during	1841	When neither C<ca_file> nor C<ca_path> was specified during
1557	L<AnyEvent::TLS> context creation, and either of these environment	1842	L<AnyEvent::TLS> context creation, and either of these environment
1558	variables exist, they will be used to specify CA certificate locations	1843	variables exist, they will be used to specify CA certificate locations
1559	instead of a system-dependent default.	1844	instead of a system-dependent default.
		1845
		1846	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1847
		1848	When these are set to C<1>, then the respective modules are not
		1849	loaded. Mostly good for testing AnyEvent itself.
1560		1850
1561	=back	1851	=back
1562		1852
1563	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1853	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1564		1854
…		…
1772	through AnyEvent. The benchmark creates a lot of timers (with a zero	2062	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,	2063	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.	2064	which it is), lets them fire exactly once and destroys them again.
1775		2065
1776	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2066	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1777	distribution.	2067	distribution. It uses the L<AE> interface, which makes a real difference
		2068	for the EV and Perl backends only.
1778		2069
1779	=head3 Explanation of the columns	2070	=head3 Explanation of the columns
1780		2071
1781	I<watcher> is the number of event watchers created/destroyed. Since	2072	I<watcher> is the number of event watchers created/destroyed. Since
1782	different event models feature vastly different performances, each event	2073	different event models feature vastly different performances, each event
…		…
1803	watcher.	2094	watcher.
1804		2095
1805	=head3 Results	2096	=head3 Results
1806		2097
1807	name watchers bytes create invoke destroy comment	2098	name watchers bytes create invoke destroy comment
1808	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2099	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	2100	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	2101	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	2102	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	2103	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	2104	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	2105	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	2106	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	2107	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	2108	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	2109	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	2110	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1820		2111
1821	=head3 Discussion	2112	=head3 Discussion
1822		2113
1823	The benchmark does I<not> measure scalability of the event loop very	2114	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)	2115	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	2127	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	2128	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1838	cycles with POE.	2129	cycles with POE.
1839		2130
1840	C<EV> is the sole leader regarding speed and memory use, which are both	2131	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	2132	maximal/minimal, respectively. When using the L<AE> API there is zero
		2133	overhead (when going through the AnyEvent API create is about 5-6 times
		2134	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	2135	any other event loop and is still faster than Event natively).
1843	natively.
1844		2136
1845	The pure perl implementation is hit in a few sweet spots (both the	2137	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	2138	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	2139	interpreter and the backend itself). Nevertheless this shows that it
1848	adds very little overhead in itself. Like any select-based backend its	2140	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	2214	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	2215	(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.	2216	connections, most of which are idle at any one point in time.
1925		2217
1926	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2218	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1927	distribution.	2219	distribution. It uses the L<AE> interface, which makes a real difference
		2220	for the EV and Perl backends only.
1928		2221
1929	=head3 Explanation of the columns	2222	=head3 Explanation of the columns
1930		2223
1931	I<sockets> is the number of sockets, and twice the number of "servers" (as	2224	I<sockets> is the number of sockets, and twice the number of "servers" (as
1932	each server has a read and write socket end).	2225	each server has a read and write socket end).
…		…
1940	a new one that moves the timeout into the future.	2233	a new one that moves the timeout into the future.
1941		2234
1942	=head3 Results	2235	=head3 Results
1943		2236
1944	name sockets create request	2237	name sockets create request
1945	EV 20000 69.01 11.16	2238	EV 20000 62.66 7.99
1946	Perl 20000 73.32 35.87	2239	Perl 20000 68.32 32.64
1947	IOAsync 20000 157.00 98.14 epoll	2240	IOAsync 20000 174.06 101.15 epoll
1948	IOAsync 20000 159.31 616.06 poll	2241	IOAsync 20000 174.67 610.84 poll
1949	Event 20000 212.62 257.32	2242	Event 20000 202.69 242.91
1950	Glib 20000 651.16 1896.30	2243	Glib 20000 557.01 1689.52
1951	POE 20000 349.67 12317.24 uses POE::Loop::Event	2244	POE 20000 341.54 12086.32 uses POE::Loop::Event
1952		2245
1953	=head3 Discussion	2246	=head3 Discussion
1954		2247
1955	This benchmark I<does> measure scalability and overall performance of the	2248	This benchmark I<does> measure scalability and overall performance of the
1956	particular event loop.	2249	particular event loop.
…		…
2132	if $SIG{CHLD} eq 'IGNORE';	2425	if $SIG{CHLD} eq 'IGNORE';
2133		2426
2134	$SIG{PIPE} = sub { }	2427	$SIG{PIPE} = sub { }
2135	unless defined $SIG{PIPE};	2428	unless defined $SIG{PIPE};
2136		2429
		2430	=head1 RECOMMENDED/OPTIONAL MODULES
		2431
		2432	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2433	it's built-in modules) are required to use it.
		2434
		2435	That does not mean that AnyEvent won't take advantage of some additional
		2436	modules if they are installed.
		2437
		2438	This section epxlains which additional modules will be used, and how they
		2439	affect AnyEvent's operetion.
		2440
		2441	=over 4
		2442
		2443	=item L<Async::Interrupt>
		2444
		2445	This slightly arcane module is used to implement fast signal handling: To
		2446	my knowledge, there is no way to do completely race-free and quick
		2447	signal handling in pure perl. To ensure that signals still get
		2448	delivered, AnyEvent will start an interval timer to wake up perl (and
		2449	catch the signals) with some delay (default is 10 seconds, look for
		2450	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2451
		2452	If this module is available, then it will be used to implement signal
		2453	catching, which means that signals will not be delayed, and the event loop
		2454	will not be interrupted regularly, which is more efficient (And good for
		2455	battery life on laptops).
		2456
		2457	This affects not just the pure-perl event loop, but also other event loops
		2458	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2459
		2460	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2461	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2462	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2463	does nothing for those backends.
		2464
		2465	=item L<EV>
		2466
		2467	This module isn't really "optional", as it is simply one of the backend
		2468	event loops that AnyEvent can use. However, it is simply the best event
		2469	loop available in terms of features, speed and stability: It supports
		2470	the AnyEvent API optimally, implements all the watcher types in XS, does
		2471	automatic timer adjustments even when no monotonic clock is available,
		2472	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2473	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2474	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2475
		2476	=item L<Guard>
		2477
		2478	The guard module, when used, will be used to implement
		2479	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2480	lot less memory), but otherwise doesn't affect guard operation much. It is
		2481	purely used for performance.
		2482
		2483	=item L<JSON> and L<JSON::XS>
		2484
		2485	This module is required when you want to read or write JSON data via
		2486	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2487	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2488
		2489	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2490	installed.
		2491
		2492	=item L<Net::SSLeay>
		2493
		2494	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2495	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2496	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2497
		2498	=item L<Time::HiRes>
		2499
		2500	This module is part of perl since release 5.008. It will be used when the
		2501	chosen event library does not come with a timing source on it's own. The
		2502	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2503	try to use a monotonic clock for timing stability.
		2504
		2505	=back
		2506
		2507
2137	=head1 FORK	2508	=head1 FORK
2138		2509
2139	Most event libraries are not fork-safe. The ones who are usually are	2510	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>	2511	because they rely on inefficient but fork-safe C<select> or C<poll>
2141	calls. Only L<EV> is fully fork-aware.	2512	calls. Only L<EV> is fully fork-aware.
2142		2513
2143	If you have to fork, you must either do so I<before> creating your first	2514	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.	2515	watcher OR you must not use AnyEvent at all in the child OR you must do
		2516	something completely out of the scope of AnyEvent.
2145		2517
2146		2518
2147	=head1 SECURITY CONSIDERATIONS	2519	=head1 SECURITY CONSIDERATIONS
2148		2520
2149	AnyEvent can be forced to load any event model via	2521	AnyEvent can be forced to load any event model via
…		…
2187	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2559	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2188		2560
2189	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2561	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2190	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2562	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2191	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2563	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2192	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2564	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2193		2565
2194	Non-blocking file handles, sockets, TCP clients and	2566	Non-blocking file handles, sockets, TCP clients and
2195	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2567	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2196		2568
2197	Asynchronous DNS: L<AnyEvent::DNS>.	2569	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.282 by root, Tue Aug 11 01:18:27 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.282 by root, Tue Aug 11 01:18:27 2009 UTC