[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.276 by root, Sun Aug 9 10:53:33 2009 UTC

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