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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.282 by root, Tue Aug 11 01:18:27 2009 UTC vs.
Revision 1.326 by root, Sun Jun 6 10:11:56 2010 UTC

…		…
7		7
8	=head1 SYNOPSIS	8	=head1 SYNOPSIS
9		9
10	use AnyEvent;	10	use AnyEvent;
11		11
		12	# if you prefer function calls, look at the AE manpage for
		13	# an alternative API.
		14
12	# file descriptor readable	15	# file handle or descriptor readable
13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });	16	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14		17
15	# one-shot or repeating timers	18	# one-shot or repeating timers
16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });	19	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...	20	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
…		…
363	might affect timers and time-outs.	366	might affect timers and time-outs.
364		367
365	When this is the case, you can call this method, which will update the	368	When this is the case, you can call this method, which will update the
366	event loop's idea of "current time".	369	event loop's idea of "current time".
367		370
		371	A typical example would be a script in a web server (e.g. C<mod_perl>) -
		372	when mod_perl executes the script, then the event loop will have the wrong
		373	idea about the "current time" (being potentially far in the past, when the
		374	script ran the last time). In that case you should arrange a call to C<<
		375	AnyEvent->now_update >> each time the web server process wakes up again
		376	(e.g. at the start of your script, or in a handler).
		377
368	Note that updating the time I<might> cause some events to be handled.	378	Note that updating the time I<might> cause some events to be handled.
369		379
370	=back	380	=back
371		381
372	=head2 SIGNAL WATCHERS	382	=head2 SIGNAL WATCHERS
…		…
395	correctly.	405	correctly.
396		406
397	Example: exit on SIGINT	407	Example: exit on SIGINT
398		408
399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });	409	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		410
		411	=head3 Restart Behaviour
		412
		413	While restart behaviour is up to the event loop implementation, most will
		414	not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
		415	pure perl implementation).
		416
		417	=head3 Safe/Unsafe Signals
		418
		419	Perl signals can be either "safe" (synchronous to opcode handling) or
		420	"unsafe" (asynchronous) - the former might get delayed indefinitely, the
		421	latter might corrupt your memory.
		422
		423	AnyEvent signal handlers are, in addition, synchronous to the event loop,
		424	i.e. they will not interrupt your running perl program but will only be
		425	called as part of the normal event handling (just like timer, I/O etc.
		426	callbacks, too).
400		427
401	=head3 Signal Races, Delays and Workarounds	428	=head3 Signal Races, Delays and Workarounds
402		429
403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching	430	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	431	callbacks to signals in a generic way, which is a pity, as you cannot
…		…
479		506
480	=head2 IDLE WATCHERS	507	=head2 IDLE WATCHERS
481		508
482	$w = AnyEvent->idle (cb => <callback>);	509	$w = AnyEvent->idle (cb => <callback>);
483		510
484	Sometimes there is a need to do something, but it is not so important	511	Repeatedly invoke the callback after the process becomes idle, until
485	to do it instantly, but only when there is nothing better to do. This	512	either the watcher is destroyed or new events have been detected.
486	"nothing better to do" is usually defined to be "no other events need
487	attention by the event loop".
488		513
489	Idle watchers ideally get invoked when the event loop has nothing	514	Idle watchers are useful when there is a need to do something, but it
490	better to do, just before it would block the process to wait for new	515	is not so important (or wise) to do it instantly. The callback will be
491	events. Instead of blocking, the idle watcher is invoked.	516	invoked only when there is "nothing better to do", which is usually
		517	defined as "all outstanding events have been handled and no new events
		518	have been detected". That means that idle watchers ideally get invoked
		519	when the event loop has just polled for new events but none have been
		520	detected. Instead of blocking to wait for more events, the idle watchers
		521	will be invoked.
492		522
493	Most event loops unfortunately do not really support idle watchers (only	523	Unfortunately, most event loops do not really support idle watchers (only
494	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent	524	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
495	will simply call the callback "from time to time".	525	will simply call the callback "from time to time".
496		526
497	Example: read lines from STDIN, but only process them when the	527	Example: read lines from STDIN, but only process them when the
498	program is otherwise idle:	528	program is otherwise idle:
…		…
526	will actively watch for new events and call your callbacks.	556	will actively watch for new events and call your callbacks.
527		557
528	AnyEvent is slightly different: it expects somebody else to run the event	558	AnyEvent is slightly different: it expects somebody else to run the event
529	loop and will only block when necessary (usually when told by the user).	559	loop and will only block when necessary (usually when told by the user).
530		560
531	The instrument to do that is called a "condition variable", so called	561	The tool to do that is called a "condition variable", so called because
532	because they represent a condition that must become true.	562	they represent a condition that must become true.
533		563
534	Now is probably a good time to look at the examples further below.	564	Now is probably a good time to look at the examples further below.
535		565
536	Condition variables can be created by calling the C<< AnyEvent->condvar	566	Condition variables can be created by calling the C<< AnyEvent->condvar
537	>> method, usually without arguments. The only argument pair allowed is	567	>> method, usually without arguments. The only argument pair allowed is
…		…
542	After creation, the condition variable is "false" until it becomes "true"	572	After creation, the condition variable is "false" until it becomes "true"
543	by calling the C<send> method (or calling the condition variable as if it	573	by calling the C<send> method (or calling the condition variable as if it
544	were a callback, read about the caveats in the description for the C<<	574	were a callback, read about the caveats in the description for the C<<
545	->send >> method).	575	->send >> method).
546		576
547	Condition variables are similar to callbacks, except that you can	577	Since condition variables are the most complex part of the AnyEvent API, here are
548	optionally wait for them. They can also be called merge points - points	578	some different mental models of what they are - pick the ones you can connect to:
549	in time where multiple outstanding events have been processed. And yet	579
550	another way to call them is transactions - each condition variable can be	580	=over 4
551	used to represent a transaction, which finishes at some point and delivers	581
552	a result. And yet some people know them as "futures" - a promise to	582	=item * Condition variables are like callbacks - you can call them (and pass them instead
553	compute/deliver something that you can wait for.	583	of callbacks). Unlike callbacks however, you can also wait for them to be called.
		584
		585	=item * Condition variables are signals - one side can emit or send them,
		586	the other side can wait for them, or install a handler that is called when
		587	the signal fires.
		588
		589	=item * Condition variables are like "Merge Points" - points in your program
		590	where you merge multiple independent results/control flows into one.
		591
		592	=item * Condition variables represent a transaction - function that start
		593	some kind of transaction can return them, leaving the caller the choice
		594	between waiting in a blocking fashion, or setting a callback.
		595
		596	=item * Condition variables represent future values, or promises to deliver
		597	some result, long before the result is available.
		598
		599	=back
554		600
555	Condition variables are very useful to signal that something has finished,	601	Condition variables are very useful to signal that something has finished,
556	for example, if you write a module that does asynchronous http requests,	602	for example, if you write a module that does asynchronous http requests,
557	then a condition variable would be the ideal candidate to signal the	603	then a condition variable would be the ideal candidate to signal the
558	availability of results. The user can either act when the callback is	604	availability of results. The user can either act when the callback is
…		…
579	eventually calls C<< -> send >>, and the "consumer side", which waits	625	eventually calls C<< -> send >>, and the "consumer side", which waits
580	for the send to occur.	626	for the send to occur.
581		627
582	Example: wait for a timer.	628	Example: wait for a timer.
583		629
584	# wait till the result is ready	630	# condition: "wait till the timer is fired"
585	my $result_ready = AnyEvent->condvar;	631	my $timer_fired = AnyEvent->condvar;
586		632
587	# do something such as adding a timer	633	# create the timer - we could wait for, say
588	# or socket watcher the calls $result_ready->send	634	# a handle becomign ready, or even an
589	# when the "result" is ready.	635	# AnyEvent::HTTP request to finish, but
590	# in this case, we simply use a timer:	636	# in this case, we simply use a timer:
591	my $w = AnyEvent->timer (	637	my $w = AnyEvent->timer (
592	after => 1,	638	after => 1,
593	cb => sub { $result_ready->send },	639	cb => sub { $timer_fired->send },
594	);	640	);
595		641
596	# this "blocks" (while handling events) till the callback	642	# this "blocks" (while handling events) till the callback
597	# calls -<send	643	# calls ->send
598	$result_ready->recv;	644	$timer_fired->recv;
599		645
600	Example: wait for a timer, but take advantage of the fact that condition	646	Example: wait for a timer, but take advantage of the fact that condition
601	variables are also callable directly.	647	variables are also callable directly.
602		648
603	my $done = AnyEvent->condvar;	649	my $done = AnyEvent->condvar;
…		…
942	You should check C<$AnyEvent::MODEL> before adding to this array, though:	988	You should check C<$AnyEvent::MODEL> before adding to this array, though:
943	if it is defined then the event loop has already been detected, and the	989	if it is defined then the event loop has already been detected, and the
944	array will be ignored.	990	array will be ignored.
945		991
946	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows	992	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
947	it,as it takes care of these details.	993	it, as it takes care of these details.
948		994
949	This variable is mainly useful for modules that can do something useful	995	This variable is mainly useful for modules that can do something useful
950	when AnyEvent is used and thus want to know when it is initialised, but do	996	when AnyEvent is used and thus want to know when it is initialised, but do
951	not need to even load it by default. This array provides the means to hook	997	not need to even load it by default. This array provides the means to hook
952	into AnyEvent passively, without loading it.	998	into AnyEvent passively, without loading it.
		999
		1000	Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
		1001	together, you could put this into Coro (this is the actual code used by
		1002	Coro to accomplish this):
		1003
		1004	if (defined $AnyEvent::MODEL) {
		1005	# AnyEvent already initialised, so load Coro::AnyEvent
		1006	require Coro::AnyEvent;
		1007	} else {
		1008	# AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
		1009	# as soon as it is
		1010	push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
		1011	}
953		1012
954	=back	1013	=back
955		1014
956	=head1 WHAT TO DO IN A MODULE	1015	=head1 WHAT TO DO IN A MODULE
957		1016
…		…
1014	=head1 OTHER MODULES	1073	=head1 OTHER MODULES
1015		1074
1016	The following is a non-exhaustive list of additional modules that use	1075	The following is a non-exhaustive list of additional modules that use
1017	AnyEvent as a client and can therefore be mixed easily with other AnyEvent	1076	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
1018	modules and other event loops in the same program. Some of the modules	1077	modules and other event loops in the same program. Some of the modules
1019	come with AnyEvent, most are available via CPAN.	1078	come as part of AnyEvent, the others are available via CPAN.
1020		1079
1021	=over 4	1080	=over 4
1022		1081
1023	=item L<AnyEvent::Util>	1082	=item L<AnyEvent::Util>
1024		1083
…		…
1039		1098
1040	=item L<AnyEvent::DNS>	1099	=item L<AnyEvent::DNS>
1041		1100
1042	Provides rich asynchronous DNS resolver capabilities.	1101	Provides rich asynchronous DNS resolver capabilities.
1043		1102
		1103	=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
		1104
		1105	Implement event-based interfaces to the protocols of the same name (for
		1106	the curious, IGS is the International Go Server and FCP is the Freenet
		1107	Client Protocol).
		1108
		1109	=item L<AnyEvent::Handle::UDP>
		1110
		1111	Here be danger!
		1112
		1113	As Pauli would put it, "Not only is it not right, it's not even wrong!" -
		1114	there are so many things wrong with AnyEvent::Handle::UDP, most notably
		1115	it's use of a stream-based API with a protocol that isn't streamable, that
		1116	the only way to improve it is to delete it.
		1117
		1118	It features data corruption (but typically only under load) and general
		1119	confusion. On top, the author is not only clueless about UDP but also
		1120	fact-resistant - some gems of his understanding: "connect doesn't work
		1121	with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
		1122	packets", "I don't need to implement proper error checking as UDP doesn't
		1123	support error checking" and so on - he doesn't even understand what's
		1124	wrong with his module when it is explained to him.
		1125
1044	=item L<AnyEvent::HTTP>	1126	=item L<AnyEvent::DBI>
1045		1127
1046	A simple-to-use HTTP library that is capable of making a lot of concurrent	1128	Executes L<DBI> requests asynchronously in a proxy process for you,
1047	HTTP requests.	1129	notifying you in an event-bnased way when the operation is finished.
		1130
		1131	=item L<AnyEvent::AIO>
		1132
		1133	Truly asynchronous (as opposed to non-blocking) I/O, should be in the
		1134	toolbox of every event programmer. AnyEvent::AIO transparently fuses
		1135	L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
		1136	file I/O, and much more.
1048		1137
1049	=item L<AnyEvent::HTTPD>	1138	=item L<AnyEvent::HTTPD>
1050		1139
1051	Provides a simple web application server framework.	1140	A simple embedded webserver.
1052		1141
1053	=item L<AnyEvent::FastPing>	1142	=item L<AnyEvent::FastPing>
1054		1143
1055	The fastest ping in the west.	1144	The fastest ping in the west.
1056
1057	=item L<AnyEvent::DBI>
1058
1059	Executes L<DBI> requests asynchronously in a proxy process.
1060
1061	=item L<AnyEvent::AIO>
1062
1063	Truly asynchronous I/O, should be in the toolbox of every event
1064	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1065	together.
1066
1067	=item L<AnyEvent::BDB>
1068
1069	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1070	L<BDB> and AnyEvent together.
1071
1072	=item L<AnyEvent::GPSD>
1073
1074	A non-blocking interface to gpsd, a daemon delivering GPS information.
1075
1076	=item L<AnyEvent::IRC>
1077
1078	AnyEvent based IRC client module family (replacing the older Net::IRC3).
1079
1080	=item L<AnyEvent::XMPP>
1081
1082	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1083	Net::XMPP2>.
1084
1085	=item L<AnyEvent::IGS>
1086
1087	A non-blocking interface to the Internet Go Server protocol (used by
1088	L<App::IGS>).
1089
1090	=item L<Net::FCP>
1091
1092	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
1093	of AnyEvent.
1094
1095	=item L<Event::ExecFlow>
1096
1097	High level API for event-based execution flow control.
1098		1145
1099	=item L<Coro>	1146	=item L<Coro>
1100		1147
1101	Has special support for AnyEvent via L<Coro::AnyEvent>.	1148	Has special support for AnyEvent via L<Coro::AnyEvent>.
1102		1149
…		…
1106		1153
1107	package AnyEvent;	1154	package AnyEvent;
1108		1155
1109	# basically a tuned-down version of common::sense	1156	# basically a tuned-down version of common::sense
1110	sub common_sense {	1157	sub common_sense {
1111	# no warnings	1158	# from common:.sense 1.0
1112	${^WARNING_BITS} ^= ${^WARNING_BITS};	1159	${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1113	# use strict vars subs	1160	# use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1114	$^H \|= 0x00000600;	1161	$^H \|= 0x00000600;
1115	}	1162	}
1116		1163
1117	BEGIN { AnyEvent::common_sense }	1164	BEGIN { AnyEvent::common_sense }
1118		1165
1119	use Carp ();	1166	use Carp ();
1120		1167
1121	our $VERSION = '5.1';	1168	our $VERSION = '5.261';
1122	our $MODEL;	1169	our $MODEL;
1123		1170
1124	our $AUTOLOAD;	1171	our $AUTOLOAD;
1125	our @ISA;	1172	our @ISA;
1126		1173
1127	our @REGISTRY;	1174	our @REGISTRY;
1128		1175
1129	our $WIN32;
1130
1131	our $VERBOSE;	1176	our $VERBOSE;
1132		1177
1133	BEGIN {	1178	BEGIN {
1134	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";	1179	require "AnyEvent/constants.pl";
		1180
1135	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";	1181	eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1136		1182
1137	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}	1183	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1138	if ${^TAINT};	1184	if ${^TAINT};
1139		1185
1140	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1186	$VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
…		…
1183	our @post_detect;	1229	our @post_detect;
1184		1230
1185	sub post_detect(&) {	1231	sub post_detect(&) {
1186	my ($cb) = @_;	1232	my ($cb) = @_;
1187		1233
1188	if ($MODEL) {
1189	$cb->();
1190
1191	undef
1192	} else {
1193	push @post_detect, $cb;	1234	push @post_detect, $cb;
1194		1235
1195	defined wantarray	1236	defined wantarray
1196	? bless \$cb, "AnyEvent::Util::postdetect"	1237	? bless \$cb, "AnyEvent::Util::postdetect"
1197	: ()	1238	: ()
1198	}
1199	}	1239	}
1200		1240
1201	sub AnyEvent::Util::postdetect::DESTROY {	1241	sub AnyEvent::Util::postdetect::DESTROY {
1202	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1242	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1203	}	1243	}
1204		1244
1205	sub detect() {	1245	sub detect() {
		1246	# free some memory
		1247	*detect = sub () { $MODEL };
		1248
		1249	local $!; # for good measure
		1250	local $SIG{__DIE__};
		1251
		1252	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		1253	my $model = "AnyEvent::Impl::$1";
		1254	if (eval "require $model") {
		1255	$MODEL = $model;
		1256	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
		1257	} else {
		1258	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
		1259	}
		1260	}
		1261
		1262	# check for already loaded models
1206	unless ($MODEL) {	1263	unless ($MODEL) {
1207	local $SIG{__DIE__};	1264	for (@REGISTRY, @models) {
1208		1265	my ($package, $model) = @$_;
1209	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1266	if (${"$package\::VERSION"} > 0) {
1210	my $model = "AnyEvent::Impl::$1";
1211	if (eval "require $model") {	1267	if (eval "require $model") {
1212	$MODEL = $model;	1268	$MODEL = $model;
1213	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;	1269	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1214	} else {	1270	last;
1215	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;	1271	}
1216	}	1272	}
1217	}	1273	}
1218		1274
1219	# check for already loaded models
1220	unless ($MODEL) {	1275	unless ($MODEL) {
		1276	# try to autoload a model
1221	for (@REGISTRY, @models) {	1277	for (@REGISTRY, @models) {
1222	my ($package, $model) = @$_;	1278	my ($package, $model, $autoload) = @$_;
		1279	if (
		1280	$autoload
		1281	and eval "require $package"
1223	if (${"$package\::VERSION"} > 0) {	1282	and ${"$package\::VERSION"} > 0
1224	if (eval "require $model") {	1283	and eval "require $model"
		1284	) {
1225	$MODEL = $model;	1285	$MODEL = $model;
1226	warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;	1286	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1227	last;	1287	last;
1228	}
1229	}	1288	}
1230	}	1289	}
1231		1290
1232	unless ($MODEL) {
1233	# try to autoload a model
1234	for (@REGISTRY, @models) {
1235	my ($package, $model, $autoload) = @$_;
1236	if (
1237	$autoload
1238	and eval "require $package"
1239	and ${"$package\::VERSION"} > 0
1240	and eval "require $model"
1241	) {
1242	$MODEL = $model;
1243	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1244	last;
1245	}
1246	}
1247
1248	$MODEL	1291	$MODEL
1249	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";	1292	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1250	}
1251	}	1293	}
1252
1253	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1254
1255	unshift @ISA, $MODEL;
1256
1257	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1258
1259	(shift @post_detect)->() while @post_detect;
1260	}	1294	}
		1295
		1296	@models = (); # free probe data
		1297
		1298	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1299	unshift @ISA, $MODEL;
		1300
		1301	# now nuke some methods that are overriden by the backend.
		1302	# SUPER is not allowed.
		1303	for (qw(time signal child idle)) {
		1304	undef &{"AnyEvent::Base::$_"}
		1305	if defined &{"$MODEL\::$_"};
		1306	}
		1307
		1308	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		1309
		1310	(shift @post_detect)->() while @post_detect;
		1311
		1312	*post_detect = sub(&) {
		1313	shift->();
		1314
		1315	undef
		1316	};
1261		1317
1262	$MODEL	1318	$MODEL
1263	}	1319	}
1264		1320
1265	sub AUTOLOAD {	1321	sub AUTOLOAD {
1266	(my $func = $AUTOLOAD) =~ s/.*://;	1322	(my $func = $AUTOLOAD) =~ s/.*://;
1267		1323
1268	$method{$func}	1324	$method{$func}
1269	or Carp::croak "$func: not a valid method for AnyEvent objects";	1325	or Carp::croak "$func: not a valid AnyEvent class method";
1270		1326
1271	detect unless $MODEL;	1327	detect;
1272		1328
1273	my $class = shift;	1329	my $class = shift;
1274	$class->$func (@_);	1330	$class->$func (@_);
1275	}	1331	}
1276		1332
…		…
1293		1349
1294	=head1 SIMPLIFIED AE API	1350	=head1 SIMPLIFIED AE API
1295		1351
1296	Starting with version 5.0, AnyEvent officially supports a second, much	1352	Starting with version 5.0, AnyEvent officially supports a second, much
1297	simpler, API that is designed to reduce the calling, typing and memory	1353	simpler, API that is designed to reduce the calling, typing and memory
1298	overhead.	1354	overhead by using function call syntax and a fixed number of parameters.
1299		1355
1300	See the L<AE> manpage for details.	1356	See the L<AE> manpage for details.
1301		1357
1302	=cut	1358	=cut
1303		1359
1304	package AE;	1360	package AE;
1305		1361
1306	our $VERSION = $AnyEvent::VERSION;	1362	our $VERSION = $AnyEvent::VERSION;
		1363
		1364	# fall back to the main API by default - backends and AnyEvent::Base
		1365	# implementations can overwrite these.
1307		1366
1308	sub io($$$) {	1367	sub io($$$) {
1309	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])	1368	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1310	}	1369	}
1311		1370
…		…
1343		1402
1344	package AnyEvent::Base;	1403	package AnyEvent::Base;
1345		1404
1346	# default implementations for many methods	1405	# default implementations for many methods
1347		1406
1348	sub _time {	1407	sub time {
		1408	eval q{ # poor man's autoloading {}
1349	# probe for availability of Time::HiRes	1409	# probe for availability of Time::HiRes
1350	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {	1410	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1351	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;	1411	warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1352	*_time = \&Time::HiRes::time;	1412	*AE::time = \&Time::HiRes::time;
1353	# if (eval "use POSIX (); (POSIX::times())...	1413	# if (eval "use POSIX (); (POSIX::times())...
1354	} else {	1414	} else {
1355	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;	1415	warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1356	*_time = sub { time }; # epic fail	1416	*AE::time = sub (){ time }; # epic fail
		1417	}
		1418
		1419	*time = sub { AE::time }; # different prototypes
1357	}	1420	};
		1421	die if $@;
1358		1422
1359	&_time	1423	&time
1360	}	1424	}
1361		1425
1362	sub time { _time }	1426	*now = \&time;
1363	sub now { _time }	1427
1364	sub now_update { }	1428	sub now_update { }
1365		1429
1366	# default implementation for ->condvar	1430	# default implementation for ->condvar
1367		1431
1368	sub condvar {	1432	sub condvar {
		1433	eval q{ # poor man's autoloading {}
		1434	*condvar = sub {
1369	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"	1435	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
		1436	};
		1437
		1438	*AE::cv = sub (;&) {
		1439	bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
		1440	};
		1441	};
		1442	die if $@;
		1443
		1444	&condvar
1370	}	1445	}
1371		1446
1372	# default implementation for ->signal	1447	# default implementation for ->signal
1373		1448
1374	our $HAVE_ASYNC_INTERRUPT;	1449	our $HAVE_ASYNC_INTERRUPT;
1375		1450
1376	sub _have_async_interrupt() {	1451	sub _have_async_interrupt() {
1377	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}	1452	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1378	&& eval "use Async::Interrupt 1.0 (); 1")	1453	&& eval "use Async::Interrupt 1.02 (); 1")
1379	unless defined $HAVE_ASYNC_INTERRUPT;	1454	unless defined $HAVE_ASYNC_INTERRUPT;
1380		1455
1381	$HAVE_ASYNC_INTERRUPT	1456	$HAVE_ASYNC_INTERRUPT
1382	}	1457	}
1383		1458
1384	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1459	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1385	our (%SIG_ASY, %SIG_ASY_W);	1460	our (%SIG_ASY, %SIG_ASY_W);
1386	our ($SIG_COUNT, $SIG_TW);	1461	our ($SIG_COUNT, $SIG_TW);
1387		1462
1388	sub _signal_exec {
1389	$HAVE_ASYNC_INTERRUPT
1390	? $SIGPIPE_R->drain
1391	: sysread $SIGPIPE_R, my $dummy, 9;
1392
1393	while (%SIG_EV) {
1394	for (keys %SIG_EV) {
1395	delete $SIG_EV{$_};
1396	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1397	}
1398	}
1399	}
1400
1401	# install a dummy wakeup watcher to reduce signal catching latency	1463	# install a dummy wakeup watcher to reduce signal catching latency
		1464	# used by Impls
1402	sub _sig_add() {	1465	sub _sig_add() {
1403	unless ($SIG_COUNT++) {	1466	unless ($SIG_COUNT++) {
1404	# try to align timer on a full-second boundary, if possible	1467	# try to align timer on a full-second boundary, if possible
1405	my $NOW = AE::now;	1468	my $NOW = AE::now;
1406		1469
…		…
1416	undef $SIG_TW	1479	undef $SIG_TW
1417	unless --$SIG_COUNT;	1480	unless --$SIG_COUNT;
1418	}	1481	}
1419		1482
1420	our $_sig_name_init; $_sig_name_init = sub {	1483	our $_sig_name_init; $_sig_name_init = sub {
1421	eval q{ # poor man's autoloading	1484	eval q{ # poor man's autoloading {}
1422	undef $_sig_name_init;	1485	undef $_sig_name_init;
1423		1486
1424	if (_have_async_interrupt) {	1487	if (_have_async_interrupt) {
1425	*sig2num = \&Async::Interrupt::sig2num;	1488	*sig2num = \&Async::Interrupt::sig2num;
1426	*sig2name = \&Async::Interrupt::sig2name;	1489	*sig2name = \&Async::Interrupt::sig2name;
…		…
1458	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;	1521	$SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1459		1522
1460	} else {	1523	} else {
1461	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;	1524	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1462		1525
1463	require Fcntl;
1464
1465	if (AnyEvent::WIN32) {	1526	if (AnyEvent::WIN32) {
1466	require AnyEvent::Util;	1527	require AnyEvent::Util;
1467		1528
1468	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();	1529	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1469	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;	1530	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1470	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case	1531	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1471	} else {	1532	} else {
1472	pipe $SIGPIPE_R, $SIGPIPE_W;	1533	pipe $SIGPIPE_R, $SIGPIPE_W;
1473	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;	1534	fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1474	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case	1535	fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1475		1536
1476	# not strictly required, as $^F is normally 2, but let's make sure...	1537	# not strictly required, as $^F is normally 2, but let's make sure...
1477	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1538	fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1478	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;	1539	fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1479	}	1540	}
1480		1541
1481	$SIGPIPE_R	1542	$SIGPIPE_R
1482	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";	1543	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1483		1544
1484	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;	1545	$SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1485	}	1546	}
1486		1547
1487	*signal = sub {	1548	*signal = $HAVE_ASYNC_INTERRUPT
		1549	? sub {
1488	my (undef, %arg) = @_;	1550	my (undef, %arg) = @_;
1489		1551
1490	my $signal = uc $arg{signal}
1491	or Carp::croak "required option 'signal' is missing";
1492
1493	if ($HAVE_ASYNC_INTERRUPT) {
1494	# async::interrupt	1552	# async::interrupt
1495
1496	$signal = sig2num $signal;	1553	my $signal = sig2num $arg{signal};
1497	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1554	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1498		1555
1499	$SIG_ASY{$signal} \|\|= new Async::Interrupt	1556	$SIG_ASY{$signal} \|\|= new Async::Interrupt
1500	cb => sub { undef $SIG_EV{$signal} },	1557	cb => sub { undef $SIG_EV{$signal} },
1501	signal => $signal,	1558	signal => $signal,
1502	pipe => [$SIGPIPE_R->filenos],	1559	pipe => [$SIGPIPE_R->filenos],
1503	pipe_autodrain => 0,	1560	pipe_autodrain => 0,
1504	;	1561	;
1505		1562
1506	} else {	1563	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1564	}
		1565	: sub {
		1566	my (undef, %arg) = @_;
		1567
1507	# pure perl	1568	# pure perl
1508
1509	# AE::Util has been loaded in signal
1510	$signal = sig2name $signal;	1569	my $signal = sig2name $arg{signal};
1511	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1570	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1512		1571
1513	$SIG{$signal} \|\|= sub {	1572	$SIG{$signal} \|\|= sub {
1514	local $!;	1573	local $!;
1515	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;	1574	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1516	undef $SIG_EV{$signal};	1575	undef $SIG_EV{$signal};
1517	};	1576	};
1518		1577
1519	# can't do signal processing without introducing races in pure perl,	1578	# can't do signal processing without introducing races in pure perl,
1520	# so limit the signal latency.	1579	# so limit the signal latency.
1521	_sig_add;	1580	_sig_add;
1522	}
1523		1581
1524	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"	1582	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1583	}
1525	};	1584	;
1526		1585
1527	*AnyEvent::Base::signal::DESTROY = sub {	1586	*AnyEvent::Base::signal::DESTROY = sub {
1528	my ($signal, $cb) = @{$_[0]};	1587	my ($signal, $cb) = @{$_[0]};
1529		1588
1530	_sig_del;	1589	_sig_del;
…		…
1537	# print weird messages, or just unconditionally exit	1596	# print weird messages, or just unconditionally exit
1538	# instead of getting the default action.	1597	# instead of getting the default action.
1539	undef $SIG{$signal}	1598	undef $SIG{$signal}
1540	unless keys %{ $SIG_CB{$signal} };	1599	unless keys %{ $SIG_CB{$signal} };
1541	};	1600	};
		1601
		1602	*_signal_exec = sub {
		1603	$HAVE_ASYNC_INTERRUPT
		1604	? $SIGPIPE_R->drain
		1605	: sysread $SIGPIPE_R, (my $dummy), 9;
		1606
		1607	while (%SIG_EV) {
		1608	for (keys %SIG_EV) {
		1609	delete $SIG_EV{$_};
		1610	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1611	}
		1612	}
		1613	};
1542	};	1614	};
1543	die if $@;	1615	die if $@;
		1616
1544	&signal	1617	&signal
1545	}	1618	}
1546		1619
1547	# default implementation for ->child	1620	# default implementation for ->child
1548		1621
1549	our %PID_CB;	1622	our %PID_CB;
1550	our $CHLD_W;	1623	our $CHLD_W;
1551	our $CHLD_DELAY_W;	1624	our $CHLD_DELAY_W;
1552	our $WNOHANG;	1625	our $WNOHANG;
1553		1626
		1627	# used by many Impl's
1554	sub _emit_childstatus($$) {	1628	sub _emit_childstatus($$) {
1555	my (undef, $rpid, $rstatus) = @_;	1629	my (undef, $rpid, $rstatus) = @_;
1556		1630
1557	$_->($rpid, $rstatus)	1631	$_->($rpid, $rstatus)
1558	for values %{ $PID_CB{$rpid} \|\| {} },	1632	for values %{ $PID_CB{$rpid} \|\| {} },
1559	values %{ $PID_CB{0} \|\| {} };	1633	values %{ $PID_CB{0} \|\| {} };
1560	}	1634	}
1561		1635
1562	sub _sigchld {
1563	my $pid;
1564
1565	AnyEvent->_emit_childstatus ($pid, $?)
1566	while ($pid = waitpid -1, $WNOHANG) > 0;
1567	}
1568
1569	sub child {	1636	sub child {
		1637	eval q{ # poor man's autoloading {}
		1638	*_sigchld = sub {
		1639	my $pid;
		1640
		1641	AnyEvent->_emit_childstatus ($pid, $?)
		1642	while ($pid = waitpid -1, $WNOHANG) > 0;
		1643	};
		1644
		1645	*child = sub {
1570	my (undef, %arg) = @_;	1646	my (undef, %arg) = @_;
1571		1647
1572	defined (my $pid = $arg{pid} + 0)	1648	defined (my $pid = $arg{pid} + 0)
1573	or Carp::croak "required option 'pid' is missing";	1649	or Carp::croak "required option 'pid' is missing";
1574		1650
1575	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1651	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1576		1652
1577	# WNOHANG is almost cetrainly 1 everywhere	1653	# WNOHANG is almost cetrainly 1 everywhere
1578	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/	1654	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
1579	? 1	1655	? 1
1580	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1656	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1581		1657
1582	unless ($CHLD_W) {	1658	unless ($CHLD_W) {
1583	$CHLD_W = AE::signal CHLD => \&_sigchld;	1659	$CHLD_W = AE::signal CHLD => \&_sigchld;
1584	# child could be a zombie already, so make at least one round	1660	# child could be a zombie already, so make at least one round
1585	&_sigchld;	1661	&_sigchld;
1586	}	1662	}
1587		1663
1588	bless [$pid, $arg{cb}], "AnyEvent::Base::child"	1664	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1589	}	1665	};
1590		1666
1591	sub AnyEvent::Base::child::DESTROY {	1667	*AnyEvent::Base::child::DESTROY = sub {
1592	my ($pid, $cb) = @{$_[0]};	1668	my ($pid, $cb) = @{$_[0]};
1593		1669
1594	delete $PID_CB{$pid}{$cb};	1670	delete $PID_CB{$pid}{$cb};
1595	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1671	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1596		1672
1597	undef $CHLD_W unless keys %PID_CB;	1673	undef $CHLD_W unless keys %PID_CB;
		1674	};
		1675	};
		1676	die if $@;
		1677
		1678	&child
1598	}	1679	}
1599		1680
1600	# idle emulation is done by simply using a timer, regardless	1681	# idle emulation is done by simply using a timer, regardless
1601	# of whether the process is idle or not, and not letting	1682	# of whether the process is idle or not, and not letting
1602	# the callback use more than 50% of the time.	1683	# the callback use more than 50% of the time.
1603	sub idle {	1684	sub idle {
		1685	eval q{ # poor man's autoloading {}
		1686	*idle = sub {
1604	my (undef, %arg) = @_;	1687	my (undef, %arg) = @_;
1605		1688
1606	my ($cb, $w, $rcb) = $arg{cb};	1689	my ($cb, $w, $rcb) = $arg{cb};
1607		1690
1608	$rcb = sub {	1691	$rcb = sub {
1609	if ($cb) {	1692	if ($cb) {
1610	$w = _time;	1693	$w = _time;
1611	&$cb;	1694	&$cb;
1612	$w = _time - $w;	1695	$w = _time - $w;
1613		1696
1614	# never use more then 50% of the time for the idle watcher,	1697	# never use more then 50% of the time for the idle watcher,
1615	# within some limits	1698	# within some limits
1616	$w = 0.0001 if $w < 0.0001;	1699	$w = 0.0001 if $w < 0.0001;
1617	$w = 5 if $w > 5;	1700	$w = 5 if $w > 5;
1618		1701
1619	$w = AE::timer $w, 0, $rcb;	1702	$w = AE::timer $w, 0, $rcb;
1620	} else {	1703	} else {
1621	# clean up...	1704	# clean up...
1622	undef $w;	1705	undef $w;
1623	undef $rcb;	1706	undef $rcb;
		1707	}
		1708	};
		1709
		1710	$w = AE::timer 0.05, 0, $rcb;
		1711
		1712	bless \\$cb, "AnyEvent::Base::idle"
1624	}	1713	};
		1714
		1715	*AnyEvent::Base::idle::DESTROY = sub {
		1716	undef $${$_[0]};
		1717	};
1625	};	1718	};
		1719	die if $@;
1626		1720
1627	$w = AE::timer 0.05, 0, $rcb;	1721	&idle
1628
1629	bless \\$cb, "AnyEvent::Base::idle"
1630	}
1631
1632	sub AnyEvent::Base::idle::DESTROY {
1633	undef $${$_[0]};
1634	}	1722	}
1635		1723
1636	package AnyEvent::CondVar;	1724	package AnyEvent::CondVar;
1637		1725
1638	our @ISA = AnyEvent::CondVar::Base::;	1726	our @ISA = AnyEvent::CondVar::Base::;
…		…
1912	warn "read: $input\n"; # output what has been read	2000	warn "read: $input\n"; # output what has been read
1913	$cv->send if $input =~ /^q/i; # quit program if /^q/i	2001	$cv->send if $input =~ /^q/i; # quit program if /^q/i
1914	},	2002	},
1915	);	2003	);
1916		2004
1917	my $time_watcher; # can only be used once
1918
1919	sub new_timer {
1920	$timer = AnyEvent->timer (after => 1, cb => sub {	2005	my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1921	warn "timeout\n"; # print 'timeout' about every second	2006	warn "timeout\n"; # print 'timeout' at most every second
1922	&new_timer; # and restart the time
1923	});	2007	});
1924	}
1925
1926	new_timer; # create first timer
1927		2008
1928	$cv->recv; # wait until user enters /^q/i	2009	$cv->recv; # wait until user enters /^q/i
1929		2010
1930	=head1 REAL-WORLD EXAMPLE	2011	=head1 REAL-WORLD EXAMPLE
1931		2012
…		…
2004		2085
2005	The actual code goes further and collects all errors (C<die>s, exceptions)	2086	The actual code goes further and collects all errors (C<die>s, exceptions)
2006	that occurred during request processing. The C<result> method detects	2087	that occurred during request processing. The C<result> method detects
2007	whether an exception as thrown (it is stored inside the $txn object)	2088	whether an exception as thrown (it is stored inside the $txn object)
2008	and just throws the exception, which means connection errors and other	2089	and just throws the exception, which means connection errors and other
2009	problems get reported tot he code that tries to use the result, not in a	2090	problems get reported to the code that tries to use the result, not in a
2010	random callback.	2091	random callback.
2011		2092
2012	All of this enables the following usage styles:	2093	All of this enables the following usage styles:
2013		2094
2014	1. Blocking:	2095	1. Blocking:
…		…
2375	As you can see, the AnyEvent + EV combination even beats the	2456	As you can see, the AnyEvent + EV combination even beats the
2376	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl	2457	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2377	backend easily beats IO::Lambda and POE.	2458	backend easily beats IO::Lambda and POE.
2378		2459
2379	And even the 100% non-blocking version written using the high-level (and	2460	And even the 100% non-blocking version written using the high-level (and
2380	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a	2461	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2381	large margin, even though it does all of DNS, tcp-connect and socket I/O	2462	higher level ("unoptimised") abstractions by a large margin, even though
2382	in a non-blocking way.	2463	it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2383		2464
2384	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and	2465	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2385	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are	2466	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2386	part of the IO::lambda distribution and were used without any changes.	2467	part of the IO::Lambda distribution and were used without any changes.
2387		2468
2388		2469
2389	=head1 SIGNALS	2470	=head1 SIGNALS
2390		2471
2391	AnyEvent currently installs handlers for these signals:	2472	AnyEvent currently installs handlers for these signals:
…		…
2433	it's built-in modules) are required to use it.	2514	it's built-in modules) are required to use it.
2434		2515
2435	That does not mean that AnyEvent won't take advantage of some additional	2516	That does not mean that AnyEvent won't take advantage of some additional
2436	modules if they are installed.	2517	modules if they are installed.
2437		2518
2438	This section epxlains which additional modules will be used, and how they	2519	This section explains which additional modules will be used, and how they
2439	affect AnyEvent's operetion.	2520	affect AnyEvent's operation.
2440		2521
2441	=over 4	2522	=over 4
2442		2523
2443	=item L<Async::Interrupt>	2524	=item L<Async::Interrupt>
2444		2525
…		…
2449	catch the signals) with some delay (default is 10 seconds, look for	2530	catch the signals) with some delay (default is 10 seconds, look for
2450	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2531	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2451		2532
2452	If this module is available, then it will be used to implement signal	2533	If this module is available, then it will be used to implement signal
2453	catching, which means that signals will not be delayed, and the event loop	2534	catching, which means that signals will not be delayed, and the event loop
2454	will not be interrupted regularly, which is more efficient (And good for	2535	will not be interrupted regularly, which is more efficient (and good for
2455	battery life on laptops).	2536	battery life on laptops).
2456		2537
2457	This affects not just the pure-perl event loop, but also other event loops	2538	This affects not just the pure-perl event loop, but also other event loops
2458	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2539	that have no signal handling on their own (e.g. Glib, Tk, Qt).
2459		2540
…		…
2471	automatic timer adjustments even when no monotonic clock is available,	2552	automatic timer adjustments even when no monotonic clock is available,
2472	can take avdantage of advanced kernel interfaces such as C<epoll> and	2553	can take avdantage of advanced kernel interfaces such as C<epoll> and
2473	C<kqueue>, and is the fastest backend I<by far>. You can even embed	2554	C<kqueue>, and is the fastest backend I<by far>. You can even embed
2474	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).	2555	L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2475		2556
		2557	If you only use backends that rely on another event loop (e.g. C<Tk>),
		2558	then this module will do nothing for you.
		2559
2476	=item L<Guard>	2560	=item L<Guard>
2477		2561
2478	The guard module, when used, will be used to implement	2562	The guard module, when used, will be used to implement
2479	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a	2563	C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2480	lot less memory), but otherwise doesn't affect guard operation much. It is	2564	lot less memory), but otherwise doesn't affect guard operation much. It is
2481	purely used for performance.	2565	purely used for performance.
2482		2566
2483	=item L<JSON> and L<JSON::XS>	2567	=item L<JSON> and L<JSON::XS>
2484		2568
2485	This module is required when you want to read or write JSON data via	2569	One of these modules is required when you want to read or write JSON data
2486	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2570	via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2487	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.	2571	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2488
2489	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2490	installed.
2491		2572
2492	=item L<Net::SSLeay>	2573	=item L<Net::SSLeay>
2493		2574
2494	Implementing TLS/SSL in Perl is certainly interesting, but not very	2575	Implementing TLS/SSL in Perl is certainly interesting, but not very
2495	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with	2576	worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
…		…
2506		2587
2507		2588
2508	=head1 FORK	2589	=head1 FORK
2509		2590
2510	Most event libraries are not fork-safe. The ones who are usually are	2591	Most event libraries are not fork-safe. The ones who are usually are
2511	because they rely on inefficient but fork-safe C<select> or C<poll>	2592	because they rely on inefficient but fork-safe C<select> or C<poll> calls
2512	calls. Only L<EV> is fully fork-aware.	2593	- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
		2594	are usually badly thought-out hacks that are incompatible with fork in
		2595	one way or another. Only L<EV> is fully fork-aware and ensures that you
		2596	continue event-processing in both parent and child (or both, if you know
		2597	what you are doing).
		2598
		2599	This means that, in general, you cannot fork and do event processing in
		2600	the child if the event library was initialised before the fork (which
		2601	usually happens when the first AnyEvent watcher is created, or the library
		2602	is loaded).
2513		2603
2514	If you have to fork, you must either do so I<before> creating your first	2604	If you have to fork, you must either do so I<before> creating your first
2515	watcher OR you must not use AnyEvent at all in the child OR you must do	2605	watcher OR you must not use AnyEvent at all in the child OR you must do
2516	something completely out of the scope of AnyEvent.	2606	something completely out of the scope of AnyEvent.
		2607
		2608	The problem of doing event processing in the parent I<and> the child
		2609	is much more complicated: even for backends that I<are> fork-aware or
		2610	fork-safe, their behaviour is not usually what you want: fork clones all
		2611	watchers, that means all timers, I/O watchers etc. are active in both
		2612	parent and child, which is almost never what you want. USing C<exec>
		2613	to start worker children from some kind of manage rprocess is usually
		2614	preferred, because it is much easier and cleaner, at the expense of having
		2615	to have another binary.
2517		2616
2518		2617
2519	=head1 SECURITY CONSIDERATIONS	2618	=head1 SECURITY CONSIDERATIONS
2520		2619
2521	AnyEvent can be forced to load any event model via	2620	AnyEvent can be forced to load any event model via

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.282 by root, Tue Aug 11 01:18:27 2009 UTC vs. Revision 1.326 by root, Sun Jun 6 10:11:56 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.282 by root, Tue Aug 11 01:18:27 2009 UTC vs.
Revision 1.326 by root, Sun Jun 6 10:11:56 2010 UTC