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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.240 by root, Fri Jul 17 14:57:03 2009 UTC vs.
Revision 1.302 by root, Fri Dec 4 16:31:57 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
…		…
341	might affect timers and time-outs.	363	might affect timers and time-outs.
342		364
343	When this is the case, you can call this method, which will update the	365	When this is the case, you can call this method, which will update the
344	event loop's idea of "current time".	366	event loop's idea of "current time".
345		367
		368	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		369	when mod_perl executes the script, then the event loop will have the wrong
		370	idea about the "current time" (being potentially far in the past, when the
		371	script ran the last time). In that case you should arrange a call to C<<
		372	AnyEvent->now_update >> each time the web server process wakes up again
		373	(e.g. at the start of your script, or in a handler).
		374
346	Note that updating the time I<might> cause some events to be handled.	375	Note that updating the time I<might> cause some events to be handled.
347		376
348	=back	377	=back
349		378
350	=head2 SIGNAL WATCHERS	379	=head2 SIGNAL WATCHERS
		380
		381	$w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
351		382
352	You can watch for signals using a signal watcher, C<signal> is the signal	383	You can watch for signals using a signal watcher, C<signal> is the signal
353	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl	384	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
354	callback to be invoked whenever a signal occurs.	385	callback to be invoked whenever a signal occurs.
355		386
…		…
361	invocation, and callback invocation will be synchronous. Synchronous means	392	invocation, and callback invocation will be synchronous. Synchronous means
362	that it might take a while until the signal gets handled by the process,	393	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.	394	but it is guaranteed not to interrupt any other callbacks.
364		395
365	The main advantage of using these watchers is that you can share a signal	396	The main advantage of using these watchers is that you can share a signal
366	between multiple watchers.	397	between multiple watchers, and AnyEvent will ensure that signals will not
		398	interrupt your program at bad times.
367		399
368	This watcher might use C<%SIG>, so programs overwriting those signals	400	This watcher might use C<%SIG> (depending on the event loop used),
369	directly will likely not work correctly.	401	so programs overwriting those signals directly will likely not work
		402	correctly.
370		403
371	Example: exit on SIGINT	404	Example: exit on SIGINT
372		405
373	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	406	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
374		407
		408	=head3 Restart Behaviour
		409
		410	While restart behaviour is up to the event loop implementation, most will
		411	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		412	pure perl implementation).
		413
		414	=head3 Safe/Unsafe Signals
		415
		416	Perl signals can be either "safe" (synchronous to opcode handling) or
		417	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		418	latter might corrupt your memory.
		419
		420	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		421	i.e. they will not interrupt your running perl program but will only be
		422	called as part of the normal event handling (just like timer, I/O etc.
		423	callbacks, too).
		424
		425	=head3 Signal Races, Delays and Workarounds
		426
		427	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
		428	callbacks to signals in a generic way, which is a pity, as you cannot
		429	do race-free signal handling in perl, requiring C libraries for
		430	this. AnyEvent will try to do it's best, which means in some cases,
		431	signals will be delayed. The maximum time a signal might be delayed is
		432	specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
		433	variable can be changed only before the first signal watcher is created,
		434	and should be left alone otherwise. This variable determines how often
		435	AnyEvent polls for signals (in case a wake-up was missed). Higher values
		436	will cause fewer spurious wake-ups, which is better for power and CPU
		437	saving.
		438
		439	All these problems can be avoided by installing the optional
		440	L<Async::Interrupt> module, which works with most event loops. It will not
		441	work with inherently broken event loops such as L<Event> or L<Event::Lib>
		442	(and not with L<POE> currently, as POE does it's own workaround with
		443	one-second latency). For those, you just have to suffer the delays.
		444
375	=head2 CHILD PROCESS WATCHERS	445	=head2 CHILD PROCESS WATCHERS
376		446
		447	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		448
377	You can also watch on a child process exit and catch its exit status.	449	You can also watch on a child process exit and catch its exit status.
378		450
379	The child process is specified by the C<pid> argument (if set to C<0>, it	451	The child process is specified by the C<pid> argument (one some backends,
380	watches for any child process exit). The watcher will triggered only when	452	using C<0> watches for any child process exit, on others this will
381	the child process has finished and an exit status is available, not on	453	croak). The watcher will be triggered only when the child process has
382	any trace events (stopped/continued).	454	finished and an exit status is available, not on any trace events
		455	(stopped/continued).
383		456
384	The callback will be called with the pid and exit status (as returned by	457	The callback will be called with the pid and exit status (as returned by
385	waitpid), so unlike other watcher types, you I<can> rely on child watcher	458	waitpid), so unlike other watcher types, you I<can> rely on child watcher
386	callback arguments.	459	callback arguments.
387		460
…		…
403		476
404	This means you cannot create a child watcher as the very first	477	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	478	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	479	watcher before you C<fork> the child (alternatively, you can call
407	C<AnyEvent::detect>).	480	C<AnyEvent::detect>).
		481
		482	As most event loops do not support waiting for child events, they will be
		483	emulated by AnyEvent in most cases, in which the latency and race problems
		484	mentioned in the description of signal watchers apply.
408		485
409	Example: fork a process and wait for it	486	Example: fork a process and wait for it
410		487
411	my $done = AnyEvent->condvar;	488	my $done = AnyEvent->condvar;
412		489
…		…
424	# do something else, then wait for process exit	501	# do something else, then wait for process exit
425	$done->recv;	502	$done->recv;
426		503
427	=head2 IDLE WATCHERS	504	=head2 IDLE WATCHERS
428		505
		506	$w = AnyEvent->idle (cb => <callback>);
		507
429	Sometimes there is a need to do something, but it is not so important	508	Sometimes there is a need to do something, but it is not so important
430	to do it instantly, but only when there is nothing better to do. This	509	to do it instantly, but only when there is nothing better to do. This
431	"nothing better to do" is usually defined to be "no other events need	510	"nothing better to do" is usually defined to be "no other events need
432	attention by the event loop".	511	attention by the event loop".
433		512
…		…
459	});	538	});
460	});	539	});
461		540
462	=head2 CONDITION VARIABLES	541	=head2 CONDITION VARIABLES
463		542
		543	$cv = AnyEvent->condvar;
		544
		545	$cv->send (<list>);
		546	my @res = $cv->recv;
		547
464	If you are familiar with some event loops you will know that all of them	548	If you are familiar with some event loops you will know that all of them
465	require you to run some blocking "loop", "run" or similar function that	549	require you to run some blocking "loop", "run" or similar function that
466	will actively watch for new events and call your callbacks.	550	will actively watch for new events and call your callbacks.
467		551
468	AnyEvent is slightly different: it expects somebody else to run the event	552	AnyEvent is slightly different: it expects somebody else to run the event
…		…
487	Condition variables are similar to callbacks, except that you can	571	Condition variables are similar to callbacks, except that you can
488	optionally wait for them. They can also be called merge points - points	572	optionally wait for them. They can also be called merge points - points
489	in time where multiple outstanding events have been processed. And yet	573	in time where multiple outstanding events have been processed. And yet
490	another way to call them is transactions - each condition variable can be	574	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	575	used to represent a transaction, which finishes at some point and delivers
492	a result.	576	a result. And yet some people know them as "futures" - a promise to
		577	compute/deliver something that you can wait for.
493		578
494	Condition variables are very useful to signal that something has finished,	579	Condition variables are very useful to signal that something has finished,
495	for example, if you write a module that does asynchronous http requests,	580	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	581	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	582	availability of results. The user can either act when the callback is
…		…
531	after => 1,	616	after => 1,
532	cb => sub { $result_ready->send },	617	cb => sub { $result_ready->send },
533	);	618	);
534		619
535	# this "blocks" (while handling events) till the callback	620	# this "blocks" (while handling events) till the callback
536	# calls -<send	621	# calls ->send
537	$result_ready->recv;	622	$result_ready->recv;
538		623
539	Example: wait for a timer, but take advantage of the fact that condition	624	Example: wait for a timer, but take advantage of the fact that condition
540	variables are also callable directly.	625	variables are also callable directly.
541		626
…		…
605	one. For example, a function that pings many hosts in parallel might want	690	one. For example, a function that pings many hosts in parallel might want
606	to use a condition variable for the whole process.	691	to use a condition variable for the whole process.
607		692
608	Every call to C<< ->begin >> will increment a counter, and every call to	693	Every call to C<< ->begin >> will increment a counter, and every call to
609	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	694	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
610	>>, the (last) callback passed to C<begin> will be executed. That callback	695	>>, the (last) callback passed to C<begin> will be executed, passing the
611	is I<supposed> to call C<< ->send >>, but that is not required. If no	696	condvar as first argument. That callback is I<supposed> to call C<< ->send
612	callback was set, C<send> will be called without any arguments.	697	>>, but that is not required. If no group callback was set, C<send> will
		698	be called without any arguments.
613		699
614	You can think of C<< $cv->send >> giving you an OR condition (one call	700	You can think of C<< $cv->send >> giving you an OR condition (one call
615	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND	701	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
616	condition (all C<begin> calls must be C<end>'ed before the condvar sends).	702	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
617		703
…		…
644	begung can potentially be zero:	730	begung can potentially be zero:
645		731
646	my $cv = AnyEvent->condvar;	732	my $cv = AnyEvent->condvar;
647		733
648	my %result;	734	my %result;
649	$cv->begin (sub { $cv->send (\%result) });	735	$cv->begin (sub { shift->send (\%result) });
650		736
651	for my $host (@list_of_hosts) {	737	for my $host (@list_of_hosts) {
652	$cv->begin;	738	$cv->begin;
653	ping_host_then_call_callback $host, sub {	739	ping_host_then_call_callback $host, sub {
654	$result{$host} = ...;	740	$result{$host} = ...;
…		…
729	=item $cb = $cv->cb ($cb->($cv))	815	=item $cb = $cv->cb ($cb->($cv))
730		816
731	This is a mutator function that returns the callback set and optionally	817	This is a mutator function that returns the callback set and optionally
732	replaces it before doing so.	818	replaces it before doing so.
733		819
734	The callback will be called when the condition becomes "true", i.e. when	820	The callback will be called when the condition becomes (or already was)
735	C<send> or C<croak> are called, with the only argument being the condition	821	"true", i.e. when C<send> or C<croak> are called (or were called), with
736	variable itself. Calling C<recv> inside the callback or at any later time	822	the only argument being the condition variable itself. Calling C<recv>
737	is guaranteed not to block.	823	inside the callback or at any later time is guaranteed not to block.
738		824
739	=back	825	=back
740		826
741	=head1 SUPPORTED EVENT LOOPS/BACKENDS	827	=head1 SUPPORTED EVENT LOOPS/BACKENDS
742		828
…		…
745	=over 4	831	=over 4
746		832
747	=item Backends that are autoprobed when no other event loop can be found.	833	=item Backends that are autoprobed when no other event loop can be found.
748		834
749	EV is the preferred backend when no other event loop seems to be in	835	EV is the preferred backend when no other event loop seems to be in
750	use. If EV is not installed, then AnyEvent will try Event, and, failing	836	use. If EV is not installed, then AnyEvent will fall back to its own
751	that, will fall back to its own pure-perl implementation, which is	837	pure-perl implementation, which is available everywhere as it comes with
752	available everywhere as it comes with AnyEvent itself.	838	AnyEvent itself.
753		839
754	AnyEvent::Impl::EV based on EV (interface to libev, best choice).	840	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.	841	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
757		842
758	=item Backends that are transparently being picked up when they are used.	843	=item Backends that are transparently being picked up when they are used.
759		844
760	These will be used when they are currently loaded when the first watcher	845	These will be used when they are currently loaded when the first watcher
761	is created, in which case it is assumed that the application is using	846	is created, in which case it is assumed that the application is using
762	them. This means that AnyEvent will automatically pick the right backend	847	them. This means that AnyEvent will automatically pick the right backend
763	when the main program loads an event module before anything starts to	848	when the main program loads an event module before anything starts to
764	create watchers. Nothing special needs to be done by the main program.	849	create watchers. Nothing special needs to be done by the main program.
765		850
		851	AnyEvent::Impl::Event based on Event, very stable, few glitches.
766	AnyEvent::Impl::Glib based on Glib, slow but very stable.	852	AnyEvent::Impl::Glib based on Glib, slow but very stable.
767	AnyEvent::Impl::Tk based on Tk, very broken.	853	AnyEvent::Impl::Tk based on Tk, very broken.
768	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	854	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
769	AnyEvent::Impl::POE based on POE, very slow, some limitations.	855	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		856	AnyEvent::Impl::Irssi used when running within irssi.
770		857
771	=item Backends with special needs.	858	=item Backends with special needs.
772		859
773	Qt requires the Qt::Application to be instantiated first, but will	860	Qt requires the Qt::Application to be instantiated first, but will
774	otherwise be picked up automatically. As long as the main program	861	otherwise be picked up automatically. As long as the main program
…		…
848	event module detection too early, for example, L<AnyEvent::AIO> creates	935	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	936	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
850	avoid autodetecting the event module at load time.	937	avoid autodetecting the event module at load time.
851		938
852	If called in scalar or list context, then it creates and returns an object	939	If called in scalar or list context, then it creates and returns an object
853	that automatically removes the callback again when it is destroyed. See	940	that automatically removes the callback again when it is destroyed (or
		941	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
854	L<Coro::BDB> for a case where this is useful.	942	a case where this is useful.
		943
		944	Example: Create a watcher for the IO::AIO module and store it in
		945	C<$WATCHER>. Only do so after the event loop is initialised, though.
		946
		947	our WATCHER;
		948
		949	my $guard = AnyEvent::post_detect {
		950	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		951	};
		952
		953	# the \|\|= is important in case post_detect immediately runs the block,
		954	# as to not clobber the newly-created watcher. assigning both watcher and
		955	# post_detect guard to the same variable has the advantage of users being
		956	# able to just C<undef $WATCHER> if the watcher causes them grief.
		957
		958	$WATCHER \|\|= $guard;
855		959
856	=item @AnyEvent::post_detect	960	=item @AnyEvent::post_detect
857		961
858	If there are any code references in this array (you can C<push> to it	962	If there are any code references in this array (you can C<push> to it
859	before or after loading AnyEvent), then they will called directly after	963	before or after loading AnyEvent), then they will called directly after
…		…
1024		1128
1025	=cut	1129	=cut
1026		1130
1027	package AnyEvent;	1131	package AnyEvent;
1028		1132
1029	no warnings;	1133	# basically a tuned-down version of common::sense
		1134	sub common_sense {
		1135	# from common:.sense 1.0
		1136	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1030	use strict qw(vars subs);	1137	# use strict vars subs
		1138	$^H \|= 0x00000600;
		1139	}
		1140
		1141	BEGIN { AnyEvent::common_sense }
1031		1142
1032	use Carp ();	1143	use Carp ();
1033		1144
1034	our $VERSION = 4.83;	1145	our $VERSION = '5.21';
1035	our $MODEL;	1146	our $MODEL;
1036		1147
1037	our $AUTOLOAD;	1148	our $AUTOLOAD;
1038	our @ISA;	1149	our @ISA;
1039		1150
1040	our @REGISTRY;	1151	our @REGISTRY;
1041		1152
1042	our $WIN32;	1153	our $VERBOSE;
1043		1154
1044	BEGIN {	1155	BEGIN {
1045	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1156	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1046	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1157	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
1047		1158
1048	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1159	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1049	if ${^TAINT};	1160	if ${^TAINT};
1050	}
1051		1161
1052	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1162	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
		1163
		1164	}
		1165
		1166	our $MAX_SIGNAL_LATENCY = 10;
1053		1167
1054	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred	1168	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
1055		1169
1056	{	1170	{
1057	my $idx;	1171	my $idx;
…		…
1059	for reverse split /\s,\s/,	1173	for reverse split /\s,\s/,
1060	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1174	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1061	}	1175	}
1062		1176
1063	my @models = (	1177	my @models = (
1064	[EV:: => AnyEvent::Impl::EV::],	1178	[EV:: => AnyEvent::Impl::EV:: , 1],
1065	[Event:: => AnyEvent::Impl::Event::],
1066	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1179	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1067	# everything below here will not be autoprobed	1180	# everything below here will not (normally) be autoprobed
1068	# as the pureperl backend should work everywhere	1181	# as the pureperl backend should work everywhere
1069	# and is usually faster	1182	# and is usually faster
		1183	[Event:: => AnyEvent::Impl::Event::, 1],
1070	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1184	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1071	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1185	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1186	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1072	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1187	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1073	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1188	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1074	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1189	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1075	[Wx:: => AnyEvent::Impl::POE::],	1190	[Wx:: => AnyEvent::Impl::POE::],
1076	[Prima:: => AnyEvent::Impl::POE::],	1191	[Prima:: => AnyEvent::Impl::POE::],
1077	# IO::Async is just too broken - we would need workarounds for its	1192	# IO::Async is just too broken - we would need workarounds for its
1078	# byzantine signal and broken child handling, among others.	1193	# byzantine signal and broken child handling, among others.
1079	# IO::Async is rather hard to detect, as it doesn't have any	1194	# IO::Async is rather hard to detect, as it doesn't have any
1080	# obvious default class.	1195	# obvious default class.
1081	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1196	[IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1082	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1197	[IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1083	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1198	[IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1199	[AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1084	);	1200	);
1085		1201
1086	our %method = map +($_ => 1),	1202	our %method = map +($_ => 1),
1087	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1203	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1088		1204
…		…
1092	my ($cb) = @_;	1208	my ($cb) = @_;
1093		1209
1094	if ($MODEL) {	1210	if ($MODEL) {
1095	$cb->();	1211	$cb->();
1096		1212
1097	1	1213	undef
1098	} else {	1214	} else {
1099	push @post_detect, $cb;	1215	push @post_detect, $cb;
1100		1216
1101	defined wantarray	1217	defined wantarray
1102	? bless \$cb, "AnyEvent::Util::postdetect"	1218	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1108	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1224	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1109	}	1225	}
1110		1226
1111	sub detect() {	1227	sub detect() {
1112	unless ($MODEL) {	1228	unless ($MODEL) {
1113	no strict 'refs';
1114	local $SIG{__DIE__};	1229	local $SIG{__DIE__};
1115		1230
1116	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1231	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1117	my $model = "AnyEvent::Impl::$1";	1232	my $model = "AnyEvent::Impl::$1";
1118	if (eval "require $model") {	1233	if (eval "require $model") {
1119	$MODEL = $model;	1234	$MODEL = $model;
1120	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $verbose > 1;	1235	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1121	} else {	1236	} else {
1122	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $verbose;	1237	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1123	}	1238	}
1124	}	1239	}
1125		1240
1126	# check for already loaded models	1241	# check for already loaded models
1127	unless ($MODEL) {	1242	unless ($MODEL) {
1128	for (@REGISTRY, @models) {	1243	for (@REGISTRY, @models) {
1129	my ($package, $model) = @$_;	1244	my ($package, $model) = @$_;
1130	if (${"$package\::VERSION"} > 0) {	1245	if (${"$package\::VERSION"} > 0) {
1131	if (eval "require $model") {	1246	if (eval "require $model") {
1132	$MODEL = $model;	1247	$MODEL = $model;
1133	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;	1248	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1134	last;	1249	last;
1135	}	1250	}
1136	}	1251	}
1137	}	1252	}
1138		1253
1139	unless ($MODEL) {	1254	unless ($MODEL) {
1140	# try to load a model	1255	# try to autoload a model
1141
1142	for (@REGISTRY, @models) {	1256	for (@REGISTRY, @models) {
1143	my ($package, $model) = @$_;	1257	my ($package, $model, $autoload) = @$_;
		1258	if (
		1259	$autoload
1144	if (eval "require $package"	1260	and eval "require $package"
1145	and ${"$package\::VERSION"} > 0	1261	and ${"$package\::VERSION"} > 0
1146	and eval "require $model") {	1262	and eval "require $model"
		1263	) {
1147	$MODEL = $model;	1264	$MODEL = $model;
1148	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;	1265	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1149	last;	1266	last;
1150	}	1267	}
1151	}	1268	}
1152		1269
1153	$MODEL	1270	$MODEL
…		…
1184	# allow only one watcher per fd, so we dup it to get a different one).	1301	# allow only one watcher per fd, so we dup it to get a different one).
1185	sub _dupfh($$;$$) {	1302	sub _dupfh($$;$$) {
1186	my ($poll, $fh, $r, $w) = @_;	1303	my ($poll, $fh, $r, $w) = @_;
1187		1304
1188	# cygwin requires the fh mode to be matching, unix doesn't	1305	# cygwin requires the fh mode to be matching, unix doesn't
1189	my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">");	1306	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1190		1307
1191	open my $fh2, "$mode&", $fh	1308	open my $fh2, $mode, $fh
1192	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";	1309	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1193		1310
1194	# we assume CLOEXEC is already set by perl in all important cases	1311	# we assume CLOEXEC is already set by perl in all important cases
1195		1312
1196	($fh2, $rw)	1313	($fh2, $rw)
1197	}	1314	}
1198		1315
		1316	=head1 SIMPLIFIED AE API
		1317
		1318	Starting with version 5.0, AnyEvent officially supports a second, much
		1319	simpler, API that is designed to reduce the calling, typing and memory
		1320	overhead.
		1321
		1322	See the L<AE> manpage for details.
		1323
		1324	=cut
		1325
		1326	package AE;
		1327
		1328	our $VERSION = $AnyEvent::VERSION;
		1329
		1330	sub io($$$) {
		1331	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1332	}
		1333
		1334	sub timer($$$) {
		1335	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
		1336	}
		1337
		1338	sub signal($$) {
		1339	AnyEvent->signal (signal => $_[0], cb => $_[1])
		1340	}
		1341
		1342	sub child($$) {
		1343	AnyEvent->child (pid => $_[0], cb => $_[1])
		1344	}
		1345
		1346	sub idle($) {
		1347	AnyEvent->idle (cb => $_[0])
		1348	}
		1349
		1350	sub cv(;&) {
		1351	AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
		1352	}
		1353
		1354	sub now() {
		1355	AnyEvent->now
		1356	}
		1357
		1358	sub now_update() {
		1359	AnyEvent->now_update
		1360	}
		1361
		1362	sub time() {
		1363	AnyEvent->time
		1364	}
		1365
1199	package AnyEvent::Base;	1366	package AnyEvent::Base;
1200		1367
1201	# default implementations for many methods	1368	# default implementations for many methods
1202		1369
1203	BEGIN {	1370	sub _time() {
		1371	# probe for availability of Time::HiRes
1204	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1372	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1373	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1205	*_time = \&Time::HiRes::time;	1374	*_time = \&Time::HiRes::time;
1206	# if (eval "use POSIX (); (POSIX::times())...	1375	# if (eval "use POSIX (); (POSIX::times())...
1207	} else {	1376	} else {
		1377	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1208	*_time = sub { time }; # epic fail	1378	*_time = sub { time }; # epic fail
1209	}	1379	}
		1380
		1381	&_time
1210	}	1382	}
1211		1383
1212	sub time { _time }	1384	sub time { _time }
1213	sub now { _time }	1385	sub now { _time }
1214	sub now_update { }	1386	sub now_update { }
…		…
1219	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1391	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1220	}	1392	}
1221		1393
1222	# default implementation for ->signal	1394	# default implementation for ->signal
1223		1395
		1396	our $HAVE_ASYNC_INTERRUPT;
		1397
		1398	sub _have_async_interrupt() {
		1399	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1400	&& eval "use Async::Interrupt 1.02 (); 1")
		1401	unless defined $HAVE_ASYNC_INTERRUPT;
		1402
		1403	$HAVE_ASYNC_INTERRUPT
		1404	}
		1405
1224	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1406	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1407	our (%SIG_ASY, %SIG_ASY_W);
		1408	our ($SIG_COUNT, $SIG_TW);
1225		1409
1226	sub _signal_exec {	1410	sub _signal_exec {
		1411	$HAVE_ASYNC_INTERRUPT
		1412	? $SIGPIPE_R->drain
1227	sysread $SIGPIPE_R, my $dummy, 4;	1413	: sysread $SIGPIPE_R, (my $dummy), 9;
1228		1414
1229	while (%SIG_EV) {	1415	while (%SIG_EV) {
1230	for (keys %SIG_EV) {	1416	for (keys %SIG_EV) {
1231	delete $SIG_EV{$_};	1417	delete $SIG_EV{$_};
1232	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1418	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1233	}	1419	}
1234	}	1420	}
1235	}	1421	}
1236		1422
		1423	# install a dummy wakeup watcher to reduce signal catching latency
		1424	sub _sig_add() {
		1425	unless ($SIG_COUNT++) {
		1426	# try to align timer on a full-second boundary, if possible
		1427	my $NOW = AE::now;
		1428
		1429	$SIG_TW = AE::timer
		1430	$MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
		1431	$MAX_SIGNAL_LATENCY,
		1432	sub { } # just for the PERL_ASYNC_CHECK
		1433	;
		1434	}
		1435	}
		1436
		1437	sub _sig_del {
		1438	undef $SIG_TW
		1439	unless --$SIG_COUNT;
		1440	}
		1441
		1442	our $_sig_name_init; $_sig_name_init = sub {
		1443	eval q{ # poor man's autoloading
		1444	undef $_sig_name_init;
		1445
		1446	if (_have_async_interrupt) {
		1447	*sig2num = \&Async::Interrupt::sig2num;
		1448	*sig2name = \&Async::Interrupt::sig2name;
		1449	} else {
		1450	require Config;
		1451
		1452	my %signame2num;
		1453	@signame2num{ split ' ', $Config::Config{sig_name} }
		1454	= split ' ', $Config::Config{sig_num};
		1455
		1456	my @signum2name;
		1457	@signum2name[values %signame2num] = keys %signame2num;
		1458
		1459	*sig2num = sub($) {
		1460	$_[0] > 0 ? shift : $signame2num{+shift}
		1461	};
		1462	*sig2name = sub ($) {
		1463	$_[0] > 0 ? $signum2name[+shift] : shift
		1464	};
		1465	}
		1466	};
		1467	die if $@;
		1468	};
		1469
		1470	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1471	sub sig2name($) { &$_sig_name_init; &sig2name }
		1472
1237	sub signal {	1473	sub signal {
1238	my (undef, %arg) = @_;	1474	eval q{ # poor man's autoloading {}
		1475	# probe for availability of Async::Interrupt
		1476	if (_have_async_interrupt) {
		1477	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1239		1478
1240	unless ($SIGPIPE_R) {	1479	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1241	require Fcntl;	1480	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1242		1481
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 {	1482	} else {
		1483	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1484
		1485	require Fcntl;
		1486
		1487	if (AnyEvent::WIN32) {
		1488	require AnyEvent::Util;
		1489
		1490	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1491	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1492	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1493	} else {
1250	pipe $SIGPIPE_R, $SIGPIPE_W;	1494	pipe $SIGPIPE_R, $SIGPIPE_W;
1251	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1495	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	1496	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1253		1497
1254	# not strictly required, as $^F is normally 2, but let's make sure...	1498	# not strictly required, as $^F is normally 2, but let's make sure...
1255	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1499	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1256	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1500	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1501	}
		1502
		1503	$SIGPIPE_R
		1504	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1505
		1506	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1257	}	1507	}
1258		1508
1259	$SIGPIPE_R	1509	*signal = sub {
1260	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1510	my (undef, %arg) = @_;
1261		1511
1262	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1263	}
1264
1265	my $signal = uc $arg{signal}	1512	my $signal = uc $arg{signal}
1266	or Carp::croak "required option 'signal' is missing";	1513	or Carp::croak "required option 'signal' is missing";
1267		1514
		1515	if ($HAVE_ASYNC_INTERRUPT) {
		1516	# async::interrupt
		1517
		1518	$signal = sig2num $signal;
1268	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1519	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1520
		1521	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1522	cb => sub { undef $SIG_EV{$signal} },
		1523	signal => $signal,
		1524	pipe => [$SIGPIPE_R->filenos],
		1525	pipe_autodrain => 0,
		1526	;
		1527
		1528	} else {
		1529	# pure perl
		1530
		1531	# AE::Util has been loaded in signal
		1532	$signal = sig2name $signal;
		1533	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1534
1269	$SIG{$signal} \|\|= sub {	1535	$SIG{$signal} \|\|= sub {
1270	local $!;	1536	local $!;
1271	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1537	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1272	undef $SIG_EV{$signal};	1538	undef $SIG_EV{$signal};
		1539	};
		1540
		1541	# can't do signal processing without introducing races in pure perl,
		1542	# so limit the signal latency.
		1543	_sig_add;
		1544	}
		1545
		1546	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1547	};
		1548
		1549	*AnyEvent::Base::signal::DESTROY = sub {
		1550	my ($signal, $cb) = @{$_[0]};
		1551
		1552	_sig_del;
		1553
		1554	delete $SIG_CB{$signal}{$cb};
		1555
		1556	$HAVE_ASYNC_INTERRUPT
		1557	? delete $SIG_ASY{$signal}
		1558	: # delete doesn't work with older perls - they then
		1559	# print weird messages, or just unconditionally exit
		1560	# instead of getting the default action.
		1561	undef $SIG{$signal}
		1562	unless keys %{ $SIG_CB{$signal} };
		1563	};
1273	};	1564	};
1274		1565	die if $@;
1275	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1566	&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	}	1567	}
1288		1568
1289	# default implementation for ->child	1569	# default implementation for ->child
1290		1570
1291	our %PID_CB;	1571	our %PID_CB;
1292	our $CHLD_W;	1572	our $CHLD_W;
1293	our $CHLD_DELAY_W;	1573	our $CHLD_DELAY_W;
1294	our $WNOHANG;	1574	our $WNOHANG;
1295		1575
		1576	sub _emit_childstatus($$) {
		1577	my (undef, $rpid, $rstatus) = @_;
		1578
		1579	$_->($rpid, $rstatus)
		1580	for values %{ $PID_CB{$rpid} \|\| {} },
		1581	values %{ $PID_CB{0} \|\| {} };
		1582	}
		1583
1296	sub _sigchld {	1584	sub _sigchld {
		1585	my $pid;
		1586
		1587	AnyEvent->_emit_childstatus ($pid, $?)
1297	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1588	while ($pid = waitpid -1, $WNOHANG) > 0;
1298	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),
1299	(values %{ $PID_CB{0} \|\| {} });
1300	}
1301	}	1589	}
1302		1590
1303	sub child {	1591	sub child {
1304	my (undef, %arg) = @_;	1592	my (undef, %arg) = @_;
1305		1593
1306	defined (my $pid = $arg{pid} + 0)	1594	defined (my $pid = $arg{pid} + 0)
1307	or Carp::croak "required option 'pid' is missing";	1595	or Carp::croak "required option 'pid' is missing";
1308		1596
1309	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1597	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1310		1598
		1599	# WNOHANG is almost cetrainly 1 everywhere
		1600	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1601	? 1
1311	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1602	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1312		1603
1313	unless ($CHLD_W) {	1604	unless ($CHLD_W) {
1314	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1605	$CHLD_W = AE::signal CHLD => \&_sigchld;
1315	# child could be a zombie already, so make at least one round	1606	# child could be a zombie already, so make at least one round
1316	&_sigchld;	1607	&_sigchld;
1317	}	1608	}
1318		1609
1319	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1610	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
…		…
1345	# never use more then 50% of the time for the idle watcher,	1636	# never use more then 50% of the time for the idle watcher,
1346	# within some limits	1637	# within some limits
1347	$w = 0.0001 if $w < 0.0001;	1638	$w = 0.0001 if $w < 0.0001;
1348	$w = 5 if $w > 5;	1639	$w = 5 if $w > 5;
1349		1640
1350	$w = AnyEvent->timer (after => $w, cb => $rcb);	1641	$w = AE::timer $w, 0, $rcb;
1351	} else {	1642	} else {
1352	# clean up...	1643	# clean up...
1353	undef $w;	1644	undef $w;
1354	undef $rcb;	1645	undef $rcb;
1355	}	1646	}
1356	};	1647	};
1357		1648
1358	$w = AnyEvent->timer (after => 0.05, cb => $rcb);	1649	$w = AE::timer 0.05, 0, $rcb;
1359		1650
1360	bless \\$cb, "AnyEvent::Base::idle"	1651	bless \\$cb, "AnyEvent::Base::idle"
1361	}	1652	}
1362		1653
1363	sub AnyEvent::Base::idle::DESTROY {	1654	sub AnyEvent::Base::idle::DESTROY {
…		…
1368		1659
1369	our @ISA = AnyEvent::CondVar::Base::;	1660	our @ISA = AnyEvent::CondVar::Base::;
1370		1661
1371	package AnyEvent::CondVar::Base;	1662	package AnyEvent::CondVar::Base;
1372		1663
1373	use overload	1664	#use overload
1374	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1665	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1375	fallback => 1;	1666	# fallback => 1;
		1667
		1668	# save 300+ kilobytes by dirtily hardcoding overloading
		1669	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1670	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1671	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1672	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1376		1673
1377	our $WAITING;	1674	our $WAITING;
1378		1675
1379	sub _send {	1676	sub _send {
1380	# nop	1677	# nop
…		…
1411	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};	1708	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1412	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]	1709	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1413	}	1710	}
1414		1711
1415	sub cb {	1712	sub cb {
1416	$_[0]{_ae_cb} = $_[1] if @_ > 1;	1713	my $cv = shift;
		1714
		1715	@_
		1716	and $cv->{_ae_cb} = shift
		1717	and $cv->{_ae_sent}
		1718	and (delete $cv->{_ae_cb})->($cv);
		1719
1417	$_[0]{_ae_cb}	1720	$cv->{_ae_cb}
1418	}	1721	}
1419		1722
1420	sub begin {	1723	sub begin {
1421	++$_[0]{_ae_counter};	1724	++$_[0]{_ae_counter};
1422	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;	1725	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
…		…
1471	C<PERL_ANYEVENT_MODEL>.	1774	C<PERL_ANYEVENT_MODEL>.
1472		1775
1473	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1776	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1474	model it chooses.	1777	model it chooses.
1475		1778
		1779	When set to C<8> or higher, then AnyEvent will report extra information on
		1780	which optional modules it loads and how it implements certain features.
		1781
1476	=item C<PERL_ANYEVENT_STRICT>	1782	=item C<PERL_ANYEVENT_STRICT>
1477		1783
1478	AnyEvent does not do much argument checking by default, as thorough	1784	AnyEvent does not do much argument checking by default, as thorough
1479	argument checking is very costly. Setting this variable to a true value	1785	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	1786	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,	1787	check the arguments passed to most method calls. If it finds any problems,
1482	it will croak.	1788	it will croak.
1483		1789
1484	In other words, enables "strict" mode.	1790	In other words, enables "strict" mode.
1485		1791
1486	Unlike C<use strict>, it is definitely recommended to keep it off in	1792	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	1793	>>, it is definitely recommended to keep it off in production. Keeping
1488	developing programs can be very useful, however.	1794	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1795	can be very useful, however.
1489		1796
1490	=item C<PERL_ANYEVENT_MODEL>	1797	=item C<PERL_ANYEVENT_MODEL>
1491		1798
1492	This can be used to specify the event model to be used by AnyEvent, before	1799	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	1800	auto detection and -probing kicks in. It must be a string consisting
…		…
1555		1862
1556	When neither C<ca_file> nor C<ca_path> was specified during	1863	When neither C<ca_file> nor C<ca_path> was specified during
1557	L<AnyEvent::TLS> context creation, and either of these environment	1864	L<AnyEvent::TLS> context creation, and either of these environment
1558	variables exist, they will be used to specify CA certificate locations	1865	variables exist, they will be used to specify CA certificate locations
1559	instead of a system-dependent default.	1866	instead of a system-dependent default.
		1867
		1868	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1869
		1870	When these are set to C<1>, then the respective modules are not
		1871	loaded. Mostly good for testing AnyEvent itself.
1560		1872
1561	=back	1873	=back
1562		1874
1563	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1875	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1564		1876
…		…
1622	warn "read: $input\n"; # output what has been read	1934	warn "read: $input\n"; # output what has been read
1623	$cv->send if $input =~ /^q/i; # quit program if /^q/i	1935	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1624	},	1936	},
1625	);	1937	);
1626		1938
1627	my $time_watcher; # can only be used once
1628
1629	sub new_timer {
1630	$timer = AnyEvent->timer (after => 1, cb => sub {	1939	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1631	warn "timeout\n"; # print 'timeout' about every second	1940	warn "timeout\n"; # print 'timeout' at most every second
1632	&new_timer; # and restart the time
1633	});	1941	});
1634	}
1635
1636	new_timer; # create first timer
1637		1942
1638	$cv->recv; # wait until user enters /^q/i	1943	$cv->recv; # wait until user enters /^q/i
1639		1944
1640	=head1 REAL-WORLD EXAMPLE	1945	=head1 REAL-WORLD EXAMPLE
1641		1946
…		…
1772	through AnyEvent. The benchmark creates a lot of timers (with a zero	2077	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,	2078	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.	2079	which it is), lets them fire exactly once and destroys them again.
1775		2080
1776	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	2081	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1777	distribution.	2082	distribution. It uses the L<AE> interface, which makes a real difference
		2083	for the EV and Perl backends only.
1778		2084
1779	=head3 Explanation of the columns	2085	=head3 Explanation of the columns
1780		2086
1781	I<watcher> is the number of event watchers created/destroyed. Since	2087	I<watcher> is the number of event watchers created/destroyed. Since
1782	different event models feature vastly different performances, each event	2088	different event models feature vastly different performances, each event
…		…
1803	watcher.	2109	watcher.
1804		2110
1805	=head3 Results	2111	=head3 Results
1806		2112
1807	name watchers bytes create invoke destroy comment	2113	name watchers bytes create invoke destroy comment
1808	EV/EV 400000 224 0.47 0.35 0.27 EV native interface	2114	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	2115	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	2116	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	2117	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	2118	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	2119	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	2120	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	2121	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	2122	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	2123	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	2124	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	2125	POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1820		2126
1821	=head3 Discussion	2127	=head3 Discussion
1822		2128
1823	The benchmark does I<not> measure scalability of the event loop very	2129	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)	2130	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	2142	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	2143	EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1838	cycles with POE.	2144	cycles with POE.
1839		2145
1840	C<EV> is the sole leader regarding speed and memory use, which are both	2146	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	2147	maximal/minimal, respectively. When using the L<AE> API there is zero
		2148	overhead (when going through the AnyEvent API create is about 5-6 times
		2149	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	2150	any other event loop and is still faster than Event natively).
1843	natively.
1844		2151
1845	The pure perl implementation is hit in a few sweet spots (both the	2152	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	2153	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	2154	interpreter and the backend itself). Nevertheless this shows that it
1848	adds very little overhead in itself. Like any select-based backend its	2155	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	2229	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	2230	(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.	2231	connections, most of which are idle at any one point in time.
1925		2232
1926	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	2233	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1927	distribution.	2234	distribution. It uses the L<AE> interface, which makes a real difference
		2235	for the EV and Perl backends only.
1928		2236
1929	=head3 Explanation of the columns	2237	=head3 Explanation of the columns
1930		2238
1931	I<sockets> is the number of sockets, and twice the number of "servers" (as	2239	I<sockets> is the number of sockets, and twice the number of "servers" (as
1932	each server has a read and write socket end).	2240	each server has a read and write socket end).
…		…
1940	a new one that moves the timeout into the future.	2248	a new one that moves the timeout into the future.
1941		2249
1942	=head3 Results	2250	=head3 Results
1943		2251
1944	name sockets create request	2252	name sockets create request
1945	EV 20000 69.01 11.16	2253	EV 20000 62.66 7.99
1946	Perl 20000 73.32 35.87	2254	Perl 20000 68.32 32.64
1947	IOAsync 20000 157.00 98.14 epoll	2255	IOAsync 20000 174.06 101.15 epoll
1948	IOAsync 20000 159.31 616.06 poll	2256	IOAsync 20000 174.67 610.84 poll
1949	Event 20000 212.62 257.32	2257	Event 20000 202.69 242.91
1950	Glib 20000 651.16 1896.30	2258	Glib 20000 557.01 1689.52
1951	POE 20000 349.67 12317.24 uses POE::Loop::Event	2259	POE 20000 341.54 12086.32 uses POE::Loop::Event
1952		2260
1953	=head3 Discussion	2261	=head3 Discussion
1954		2262
1955	This benchmark I<does> measure scalability and overall performance of the	2263	This benchmark I<does> measure scalability and overall performance of the
1956	particular event loop.	2264	particular event loop.
…		…
2082	As you can see, the AnyEvent + EV combination even beats the	2390	As you can see, the AnyEvent + EV combination even beats the
2083	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2391	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2084	backend easily beats IO::Lambda and POE.	2392	backend easily beats IO::Lambda and POE.
2085		2393
2086	And even the 100% non-blocking version written using the high-level (and	2394	And even the 100% non-blocking version written using the high-level (and
2087	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2395	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2088	large margin, even though it does all of DNS, tcp-connect and socket I/O	2396	higher level ("unoptimised") abstractions by a large margin, even though
2089	in a non-blocking way.	2397	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2090		2398
2091	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2399	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2092	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2400	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2093	part of the IO::lambda distribution and were used without any changes.	2401	part of the IO::Lambda distribution and were used without any changes.
2094		2402
2095		2403
2096	=head1 SIGNALS	2404	=head1 SIGNALS
2097		2405
2098	AnyEvent currently installs handlers for these signals:	2406	AnyEvent currently installs handlers for these signals:
…		…
2132	if $SIG{CHLD} eq 'IGNORE';	2440	if $SIG{CHLD} eq 'IGNORE';
2133		2441
2134	$SIG{PIPE} = sub { }	2442	$SIG{PIPE} = sub { }
2135	unless defined $SIG{PIPE};	2443	unless defined $SIG{PIPE};
2136		2444
		2445	=head1 RECOMMENDED/OPTIONAL MODULES
		2446
		2447	One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
		2448	it's built-in modules) are required to use it.
		2449
		2450	That does not mean that AnyEvent won't take advantage of some additional
		2451	modules if they are installed.
		2452
		2453	This section explains which additional modules will be used, and how they
		2454	affect AnyEvent's operation.
		2455
		2456	=over 4
		2457
		2458	=item L<Async::Interrupt>
		2459
		2460	This slightly arcane module is used to implement fast signal handling: To
		2461	my knowledge, there is no way to do completely race-free and quick
		2462	signal handling in pure perl. To ensure that signals still get
		2463	delivered, AnyEvent will start an interval timer to wake up perl (and
		2464	catch the signals) with some delay (default is 10 seconds, look for
		2465	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
		2466
		2467	If this module is available, then it will be used to implement signal
		2468	catching, which means that signals will not be delayed, and the event loop
		2469	will not be interrupted regularly, which is more efficient (and good for
		2470	battery life on laptops).
		2471
		2472	This affects not just the pure-perl event loop, but also other event loops
		2473	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2474
		2475	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2476	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2477	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2478	does nothing for those backends.
		2479
		2480	=item L<EV>
		2481
		2482	This module isn't really "optional", as it is simply one of the backend
		2483	event loops that AnyEvent can use. However, it is simply the best event
		2484	loop available in terms of features, speed and stability: It supports
		2485	the AnyEvent API optimally, implements all the watcher types in XS, does
		2486	automatic timer adjustments even when no monotonic clock is available,
		2487	can take avdantage of advanced kernel interfaces such as C<epoll> and
		2488	C<kqueue>, and is the fastest backend I<by far>. You can even embed
		2489	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
		2490
		2491	=item L<Guard>
		2492
		2493	The guard module, when used, will be used to implement
		2494	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
		2495	lot less memory), but otherwise doesn't affect guard operation much. It is
		2496	purely used for performance.
		2497
		2498	=item L<JSON> and L<JSON::XS>
		2499
		2500	One of these modules is required when you want to read or write JSON data
		2501	via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
		2502	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
		2503
		2504	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
		2505	installed.
		2506
		2507	=item L<Net::SSLeay>
		2508
		2509	Implementing TLS/SSL in Perl is certainly interesting, but not very
		2510	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
		2511	the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
		2512
		2513	=item L<Time::HiRes>
		2514
		2515	This module is part of perl since release 5.008. It will be used when the
		2516	chosen event library does not come with a timing source on it's own. The
		2517	pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
		2518	try to use a monotonic clock for timing stability.
		2519
		2520	=back
		2521
		2522
2137	=head1 FORK	2523	=head1 FORK
2138		2524
2139	Most event libraries are not fork-safe. The ones who are usually are	2525	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>	2526	because they rely on inefficient but fork-safe C<select> or C<poll>
2141	calls. Only L<EV> is fully fork-aware.	2527	calls. Only L<EV> is fully fork-aware.
2142		2528
		2529	This means that, in general, you cannot fork and do event processing
		2530	in the child if a watcher was created before the fork (which in turn
		2531	initialises the event library).
		2532
2143	If you have to fork, you must either do so I<before> creating your first	2533	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.	2534	watcher OR you must not use AnyEvent at all in the child OR you must do
		2535	something completely out of the scope of AnyEvent.
		2536
		2537	The problem of doing event processing in the parent I<and> the child
		2538	is much more complicated: even for backends that I<are> fork-aware or
		2539	fork-safe, their behaviour is not usually what you want: fork clones all
		2540	watchers, that means all timers, I/O watchers etc. are active in both
		2541	parent and child, which is almost never what you want.
2145		2542
2146		2543
2147	=head1 SECURITY CONSIDERATIONS	2544	=head1 SECURITY CONSIDERATIONS
2148		2545
2149	AnyEvent can be forced to load any event model via	2546	AnyEvent can be forced to load any event model via
…		…
2187	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2584	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2188		2585
2189	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2586	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2190	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2587	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2191	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2588	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2192	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2589	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2193		2590
2194	Non-blocking file handles, sockets, TCP clients and	2591	Non-blocking file handles, sockets, TCP clients and
2195	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2592	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2196		2593
2197	Asynchronous DNS: L<AnyEvent::DNS>.	2594	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.240 by root, Fri Jul 17 14:57:03 2009 UTC vs. Revision 1.302 by root, Fri Dec 4 16:31:57 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.240 by root, Fri Jul 17 14:57:03 2009 UTC vs.
Revision 1.302 by root, Fri Dec 4 16:31:57 2009 UTC