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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.242 by root, Fri Jul 17 22:05:12 2009 UTC vs.
Revision 1.266 by root, Thu Jul 30 03:41:56 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
…		…
368		392
369	This watcher might use C<%SIG> (depending on the event loop used),	393	This watcher might use C<%SIG> (depending on the event loop used),
370	so programs overwriting those signals directly will likely not work	394	so programs overwriting those signals directly will likely not work
371	correctly.	395	correctly.
372		396
		397	Example: exit on SIGINT
		398
		399	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		400
		401	=head3 Signal Races, Delays and Workarounds
		402
373	Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not	403	Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
374	support attaching callbacks to signals, which is a pity, as you cannot do	404	callbacks to signals in a generic way, which is a pity, as you cannot do
375	race-free signal handling in perl. AnyEvent will try to do it's best, but	405	race-free signal handling in perl. AnyEvent will try to do it's best, but
376	in some cases, signals will be delayed. The maximum time a signal might	406	in some cases, signals will be delayed. The maximum time a signal might
377	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10	407	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
378	seconds). This variable can be changed only before the first signal	408	seconds). This variable can be changed only before the first signal
379	watcher is created, and should be left alone otherwise. Higher values	409	watcher is created, and should be left alone otherwise. Higher values
380	will cause fewer spurious wake-ups, which is better for power and CPU	410	will cause fewer spurious wake-ups, which is better for power and CPU
381	saving. All these problems can be avoided by installing the optional	411	saving. All these problems can be avoided by installing the optional
382	L<Async::Interrupt> module.	412	L<Async::Interrupt> module. This will not work with inherently broken
383		413	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
384	Example: exit on SIGINT	414	currently, as POE does it's own workaround with one-second latency). With
385		415	those, you just have to suffer the delays.
386	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
387		416
388	=head2 CHILD PROCESS WATCHERS	417	=head2 CHILD PROCESS WATCHERS
389		418
		419	$w = AnyEvent->child (pid => <process id>, cb => <callback>);
		420
390	You can also watch on a child process exit and catch its exit status.	421	You can also watch on a child process exit and catch its exit status.
391		422
392	The child process is specified by the C<pid> argument (if set to C<0>, it	423	The child process is specified by the C<pid> argument (one some backends,
393	watches for any child process exit). The watcher will triggered only when	424	using C<0> watches for any child process exit, on others this will
394	the child process has finished and an exit status is available, not on	425	croak). The watcher will be triggered only when the child process has
395	any trace events (stopped/continued).	426	finished and an exit status is available, not on any trace events
		427	(stopped/continued).
396		428
397	The callback will be called with the pid and exit status (as returned by	429	The callback will be called with the pid and exit status (as returned by
398	waitpid), so unlike other watcher types, you I<can> rely on child watcher	430	waitpid), so unlike other watcher types, you I<can> rely on child watcher
399	callback arguments.	431	callback arguments.
400		432
…		…
441	# do something else, then wait for process exit	473	# do something else, then wait for process exit
442	$done->recv;	474	$done->recv;
443		475
444	=head2 IDLE WATCHERS	476	=head2 IDLE WATCHERS
445		477
		478	$w = AnyEvent->idle (cb => <callback>);
		479
446	Sometimes there is a need to do something, but it is not so important	480	Sometimes there is a need to do something, but it is not so important
447	to do it instantly, but only when there is nothing better to do. This	481	to do it instantly, but only when there is nothing better to do. This
448	"nothing better to do" is usually defined to be "no other events need	482	"nothing better to do" is usually defined to be "no other events need
449	attention by the event loop".	483	attention by the event loop".
450		484
…		…
476	});	510	});
477	});	511	});
478		512
479	=head2 CONDITION VARIABLES	513	=head2 CONDITION VARIABLES
480		514
		515	$cv = AnyEvent->condvar;
		516
		517	$cv->send (<list>);
		518	my @res = $cv->recv;
		519
481	If you are familiar with some event loops you will know that all of them	520	If you are familiar with some event loops you will know that all of them
482	require you to run some blocking "loop", "run" or similar function that	521	require you to run some blocking "loop", "run" or similar function that
483	will actively watch for new events and call your callbacks.	522	will actively watch for new events and call your callbacks.
484		523
485	AnyEvent is slightly different: it expects somebody else to run the event	524	AnyEvent is slightly different: it expects somebody else to run the event
…		…
504	Condition variables are similar to callbacks, except that you can	543	Condition variables are similar to callbacks, except that you can
505	optionally wait for them. They can also be called merge points - points	544	optionally wait for them. They can also be called merge points - points
506	in time where multiple outstanding events have been processed. And yet	545	in time where multiple outstanding events have been processed. And yet
507	another way to call them is transactions - each condition variable can be	546	another way to call them is transactions - each condition variable can be
508	used to represent a transaction, which finishes at some point and delivers	547	used to represent a transaction, which finishes at some point and delivers
509	a result.	548	a result. And yet some people know them as "futures" - a promise to
		549	compute/deliver something that you can wait for.
510		550
511	Condition variables are very useful to signal that something has finished,	551	Condition variables are very useful to signal that something has finished,
512	for example, if you write a module that does asynchronous http requests,	552	for example, if you write a module that does asynchronous http requests,
513	then a condition variable would be the ideal candidate to signal the	553	then a condition variable would be the ideal candidate to signal the
514	availability of results. The user can either act when the callback is	554	availability of results. The user can either act when the callback is
…		…
782		822
783	AnyEvent::Impl::Glib based on Glib, slow but very stable.	823	AnyEvent::Impl::Glib based on Glib, slow but very stable.
784	AnyEvent::Impl::Tk based on Tk, very broken.	824	AnyEvent::Impl::Tk based on Tk, very broken.
785	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	825	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786	AnyEvent::Impl::POE based on POE, very slow, some limitations.	826	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		827	AnyEvent::Impl::Irssi used when running within irssi.
787		828
788	=item Backends with special needs.	829	=item Backends with special needs.
789		830
790	Qt requires the Qt::Application to be instantiated first, but will	831	Qt requires the Qt::Application to be instantiated first, but will
791	otherwise be picked up automatically. As long as the main program	832	otherwise be picked up automatically. As long as the main program
…		…
865	event module detection too early, for example, L<AnyEvent::AIO> creates	906	event module detection too early, for example, L<AnyEvent::AIO> creates
866	and installs the global L<IO::AIO> watcher in a C<post_detect> block to	907	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867	avoid autodetecting the event module at load time.	908	avoid autodetecting the event module at load time.
868		909
869	If called in scalar or list context, then it creates and returns an object	910	If called in scalar or list context, then it creates and returns an object
870	that automatically removes the callback again when it is destroyed. See	911	that automatically removes the callback again when it is destroyed (or
		912	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
871	L<Coro::BDB> for a case where this is useful.	913	a case where this is useful.
		914
		915	Example: Create a watcher for the IO::AIO module and store it in
		916	C<$WATCHER>. Only do so after the event loop is initialised, though.
		917
		918	our WATCHER;
		919
		920	my $guard = AnyEvent::post_detect {
		921	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		922	};
		923
		924	# the \|\|= is important in case post_detect immediately runs the block,
		925	# as to not clobber the newly-created watcher. assigning both watcher and
		926	# post_detect guard to the same variable has the advantage of users being
		927	# able to just C<undef $WATCHER> if the watcher causes them grief.
		928
		929	$WATCHER \|\|= $guard;
872		930
873	=item @AnyEvent::post_detect	931	=item @AnyEvent::post_detect
874		932
875	If there are any code references in this array (you can C<push> to it	933	If there are any code references in this array (you can C<push> to it
876	before or after loading AnyEvent), then they will called directly after	934	before or after loading AnyEvent), then they will called directly after
…		…
1041		1099
1042	=cut	1100	=cut
1043		1101
1044	package AnyEvent;	1102	package AnyEvent;
1045		1103
		1104	# basically a tuned-down version of common::sense
		1105	sub common_sense {
1046	no warnings;	1106	# no warnings
		1107	${^WARNING_BITS} ^= ${^WARNING_BITS};
1047	use strict qw(vars subs);	1108	# use strict vars subs
		1109	$^H \|= 0x00000600;
		1110	}
		1111
		1112	BEGIN { AnyEvent::common_sense }
1048		1113
1049	use Carp ();	1114	use Carp ();
1050		1115
1051	our $VERSION = 4.83;	1116	our $VERSION = 4.881;
1052	our $MODEL;	1117	our $MODEL;
1053		1118
1054	our $AUTOLOAD;	1119	our $AUTOLOAD;
1055	our @ISA;	1120	our @ISA;
1056		1121
…		…
1081	for reverse split /\s,\s/,	1146	for reverse split /\s,\s/,
1082	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1147	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1083	}	1148	}
1084		1149
1085	my @models = (	1150	my @models = (
1086	[EV:: => AnyEvent::Impl::EV::],	1151	[EV:: => AnyEvent::Impl::EV:: , 1],
1087	[Event:: => AnyEvent::Impl::Event::],	1152	[Event:: => AnyEvent::Impl::Event::, 1],
1088	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1153	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1089	# everything below here will not be autoprobed	1154	# everything below here will not (normally) be autoprobed
1090	# as the pureperl backend should work everywhere	1155	# as the pureperl backend should work everywhere
1091	# and is usually faster	1156	# and is usually faster
1092	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1157	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1093	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1158	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1159	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1094	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1160	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1095	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1161	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1096	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1162	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1097	[Wx:: => AnyEvent::Impl::POE::],	1163	[Wx:: => AnyEvent::Impl::POE::],
1098	[Prima:: => AnyEvent::Impl::POE::],	1164	[Prima:: => AnyEvent::Impl::POE::],
1099	# IO::Async is just too broken - we would need workarounds for its	1165	# IO::Async is just too broken - we would need workarounds for its
1100	# byzantine signal and broken child handling, among others.	1166	# byzantine signal and broken child handling, among others.
1101	# IO::Async is rather hard to detect, as it doesn't have any	1167	# IO::Async is rather hard to detect, as it doesn't have any
1102	# obvious default class.	1168	# obvious default class.
1103	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1169	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1104	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1170	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1105	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1171	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1106	);	1172	);
1107		1173
1108	our %method = map +($_ => 1),	1174	our %method = map +($_ => 1),
1109	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1175	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1110		1176
…		…
1114	my ($cb) = @_;	1180	my ($cb) = @_;
1115		1181
1116	if ($MODEL) {	1182	if ($MODEL) {
1117	$cb->();	1183	$cb->();
1118		1184
1119	1	1185	undef
1120	} else {	1186	} else {
1121	push @post_detect, $cb;	1187	push @post_detect, $cb;
1122		1188
1123	defined wantarray	1189	defined wantarray
1124	? bless \$cb, "AnyEvent::Util::postdetect"	1190	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1130	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1196	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1131	}	1197	}
1132		1198
1133	sub detect() {	1199	sub detect() {
1134	unless ($MODEL) {	1200	unless ($MODEL) {
1135	no strict 'refs';
1136	local $SIG{__DIE__};	1201	local $SIG{__DIE__};
1137		1202
1138	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1203	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1139	my $model = "AnyEvent::Impl::$1";	1204	my $model = "AnyEvent::Impl::$1";
1140	if (eval "require $model") {	1205	if (eval "require $model") {
…		…
1157	}	1222	}
1158	}	1223	}
1159	}	1224	}
1160		1225
1161	unless ($MODEL) {	1226	unless ($MODEL) {
1162	# try to load a model	1227	# try to autoload a model
1163
1164	for (@REGISTRY, @models) {	1228	for (@REGISTRY, @models) {
1165	my ($package, $model) = @$_;	1229	my ($package, $model, $autoload) = @$_;
		1230	if (
		1231	$autoload
1166	if (eval "require $package"	1232	and eval "require $package"
1167	and ${"$package\::VERSION"} > 0	1233	and ${"$package\::VERSION"} > 0
1168	and eval "require $model") {	1234	and eval "require $model"
		1235	) {
1169	$MODEL = $model;	1236	$MODEL = $model;
1170	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1237	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1171	last;	1238	last;
1172	}	1239	}
1173	}	1240	}
1174		1241
1175	$MODEL	1242	$MODEL
…		…
1247	}	1314	}
1248		1315
1249	# default implementation for ->signal	1316	# default implementation for ->signal
1250		1317
1251	our $HAVE_ASYNC_INTERRUPT;	1318	our $HAVE_ASYNC_INTERRUPT;
		1319
		1320	sub _have_async_interrupt() {
		1321	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1322	&& eval "use Async::Interrupt 1.0 (); 1")
		1323	unless defined $HAVE_ASYNC_INTERRUPT;
		1324
		1325	$HAVE_ASYNC_INTERRUPT
		1326	}
		1327
1252	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1328	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1253	our (%SIG_ASY, %SIG_ASY_W);	1329	our (%SIG_ASY, %SIG_ASY_W);
1254	our ($SIG_COUNT, $SIG_TW);	1330	our ($SIG_COUNT, $SIG_TW);
1255		1331
1256	sub _signal_exec {	1332	sub _signal_exec {
…		…
1264	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1340	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1265	}	1341	}
1266	}	1342	}
1267	}	1343	}
1268		1344
		1345	# install a dummy wakeup watcher to reduce signal catching latency
1269	sub _signal {	1346	sub _sig_add() {
1270	my (undef, %arg) = @_;	1347	unless ($SIG_COUNT++) {
		1348	# try to align timer on a full-second boundary, if possible
		1349	my $NOW = AnyEvent->now;
1271		1350
1272	my $signal = uc $arg{signal}
1273	or Carp::croak "required option 'signal' is missing";
1274
1275	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1276
1277	if ($HAVE_ASYNC_INTERRUPT) {
1278	# async::interrupt
1279
1280	$SIG_ASY{$signal} \|\|= do {
1281	my $asy = new Async::Interrupt
1282	cb => sub { undef $SIG_EV{$signal} },
1283	signal => $signal,
1284	pipe => [$SIGPIPE_R->filenos],
1285	;
1286	$asy->pipe_autodrain (0);
1287
1288	$asy
1289	};
1290
1291	} else {
1292	# pure perl
1293
1294	$SIG{$signal} \|\|= sub {
1295	local $!;
1296	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1297	undef $SIG_EV{$signal};
1298	};
1299
1300	# can't do signal processing without introducing races in pure perl,
1301	# so limit the signal latency.
1302	++$SIG_COUNT;
1303	$SIG_TW \|\|= AnyEvent->timer (	1351	$SIG_TW = AnyEvent->timer (
1304	after => $MAX_SIGNAL_LATENCY,	1352	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1305	interval => $MAX_SIGNAL_LATENCY,	1353	interval => $MAX_SIGNAL_LATENCY,
1306	cb => sub { }, # just for the PERL_ASYNC_CHECK	1354	cb => sub { }, # just for the PERL_ASYNC_CHECK
1307	);	1355	);
1308	}	1356	}
1309
1310	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1311	}	1357	}
1312		1358
1313	sub signal {	1359	sub _sig_del {
1314	# probe for availability of Async::Interrupt
1315	if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") {
1316	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1317
1318	$HAVE_ASYNC_INTERRUPT = 1;
1319	$SIGPIPE_R = new Async::Interrupt::EventPipe;
1320	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
1321
1322	} else {
1323	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1324
1325	require Fcntl;
1326
1327	if (AnyEvent::WIN32) {
1328	require AnyEvent::Util;
1329
1330	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1331	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1332	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1333	} else {
1334	pipe $SIGPIPE_R, $SIGPIPE_W;
1335	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1336	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1337
1338	# not strictly required, as $^F is normally 2, but let's make sure...
1339	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1340	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1341	}
1342
1343	$SIGPIPE_R
1344	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1345
1346	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1347	}
1348
1349	*signal = \&_signal;
1350	&signal
1351	}
1352
1353	sub AnyEvent::Base::signal::DESTROY {
1354	my ($signal, $cb) = @{$_[0]};
1355
1356	undef $SIG_TW	1360	undef $SIG_TW
1357	unless --$SIG_COUNT;	1361	unless --$SIG_COUNT;
		1362	}
1358		1363
		1364	our $_sig_name_init; $_sig_name_init = sub {
		1365	eval q{ # poor man's autoloading
		1366	undef $_sig_name_init;
		1367
		1368	if (_have_async_interrupt) {
		1369	*sig2num = \&Async::Interrupt::sig2num;
		1370	*sig2name = \&Async::Interrupt::sig2name;
		1371	} else {
		1372	require Config;
		1373
		1374	my %signame2num;
		1375	@signame2num{ split ' ', $Config::Config{sig_name} }
		1376	= split ' ', $Config::Config{sig_num};
		1377
		1378	my @signum2name;
		1379	@signum2name[values %signame2num] = keys %signame2num;
		1380
		1381	*sig2num = sub($) {
		1382	$_[0] > 0 ? shift : $signame2num{+shift}
		1383	};
		1384	*sig2name = sub ($) {
		1385	$_[0] > 0 ? $signum2name[+shift] : shift
		1386	};
		1387	}
		1388	};
		1389	die if $@;
		1390	};
		1391
		1392	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1393	sub sig2name($) { &$_sig_name_init; &sig2name }
		1394
		1395	sub signal {
		1396	eval q{ # poor man's autoloading {}
		1397	# probe for availability of Async::Interrupt
		1398	if (_have_async_interrupt) {
		1399	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1400
		1401	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1402	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
		1403
		1404	} else {
		1405	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1406
		1407	require Fcntl;
		1408
		1409	if (AnyEvent::WIN32) {
		1410	require AnyEvent::Util;
		1411
		1412	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1413	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1414	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1415	} else {
		1416	pipe $SIGPIPE_R, $SIGPIPE_W;
		1417	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1418	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1419
		1420	# not strictly required, as $^F is normally 2, but let's make sure...
		1421	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1422	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1423	}
		1424
		1425	$SIGPIPE_R
		1426	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1427
		1428	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1429	}
		1430
		1431	*signal = sub {
		1432	my (undef, %arg) = @_;
		1433
		1434	my $signal = uc $arg{signal}
		1435	or Carp::croak "required option 'signal' is missing";
		1436
		1437	if ($HAVE_ASYNC_INTERRUPT) {
		1438	# async::interrupt
		1439
		1440	$signal = sig2num $signal;
		1441	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1442
		1443	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1444	cb => sub { undef $SIG_EV{$signal} },
		1445	signal => $signal,
		1446	pipe => [$SIGPIPE_R->filenos],
		1447	pipe_autodrain => 0,
		1448	;
		1449
		1450	} else {
		1451	# pure perl
		1452
		1453	# AE::Util has been loaded in signal
		1454	$signal = sig2name $signal;
		1455	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1456
		1457	$SIG{$signal} \|\|= sub {
		1458	local $!;
		1459	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1460	undef $SIG_EV{$signal};
		1461	};
		1462
		1463	# can't do signal processing without introducing races in pure perl,
		1464	# so limit the signal latency.
		1465	_sig_add;
		1466	}
		1467
		1468	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1469	};
		1470
		1471	*AnyEvent::Base::signal::DESTROY = sub {
		1472	my ($signal, $cb) = @{$_[0]};
		1473
		1474	_sig_del;
		1475
1359	delete $SIG_CB{$signal}{$cb};	1476	delete $SIG_CB{$signal}{$cb};
1360		1477
		1478	$HAVE_ASYNC_INTERRUPT
		1479	? delete $SIG_ASY{$signal}
1361	# delete doesn't work with older perls - they then	1480	: # delete doesn't work with older perls - they then
1362	# print weird messages, or just unconditionally exit	1481	# print weird messages, or just unconditionally exit
1363	# instead of getting the default action.	1482	# instead of getting the default action.
1364	undef $SIG{$signal}	1483	undef $SIG{$signal}
1365	unless keys %{ $SIG_CB{$signal} };	1484	unless keys %{ $SIG_CB{$signal} };
		1485	};
		1486	};
		1487	die if $@;
		1488	&signal
1366	}	1489	}
1367		1490
1368	# default implementation for ->child	1491	# default implementation for ->child
1369		1492
1370	our %PID_CB;	1493	our %PID_CB;
1371	our $CHLD_W;	1494	our $CHLD_W;
1372	our $CHLD_DELAY_W;	1495	our $CHLD_DELAY_W;
1373	our $WNOHANG;	1496	our $WNOHANG;
1374		1497
		1498	sub _emit_childstatus($$) {
		1499	my (undef, $rpid, $rstatus) = @_;
		1500
		1501	$_->($rpid, $rstatus)
		1502	for values %{ $PID_CB{$rpid} \|\| {} },
		1503	values %{ $PID_CB{0} \|\| {} };
		1504	}
		1505
1375	sub _sigchld {	1506	sub _sigchld {
		1507	my $pid;
		1508
		1509	AnyEvent->_emit_childstatus ($pid, $?)
1376	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1510	while ($pid = waitpid -1, $WNOHANG) > 0;
1377	$_->($pid, $?)
1378	for values %{ $PID_CB{$pid} \|\| {} },
1379	values %{ $PID_CB{0} \|\| {} };
1380	}
1381	}	1511	}
1382		1512
1383	sub child {	1513	sub child {
1384	my (undef, %arg) = @_;	1514	my (undef, %arg) = @_;
1385		1515
1386	defined (my $pid = $arg{pid} + 0)	1516	defined (my $pid = $arg{pid} + 0)
1387	or Carp::croak "required option 'pid' is missing";	1517	or Carp::croak "required option 'pid' is missing";
1388		1518
1389	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1519	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1390		1520
		1521	# WNOHANG is almost cetrainly 1 everywhere
		1522	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1523	? 1
1391	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1524	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1392		1525
1393	unless ($CHLD_W) {	1526	unless ($CHLD_W) {
1394	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1527	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1395	# child could be a zombie already, so make at least one round	1528	# child could be a zombie already, so make at least one round
1396	&_sigchld;	1529	&_sigchld;
…		…
1448		1581
1449	our @ISA = AnyEvent::CondVar::Base::;	1582	our @ISA = AnyEvent::CondVar::Base::;
1450		1583
1451	package AnyEvent::CondVar::Base;	1584	package AnyEvent::CondVar::Base;
1452		1585
1453	use overload	1586	#use overload
1454	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1587	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1455	fallback => 1;	1588	# fallback => 1;
		1589
		1590	# save 300+ kilobytes by dirtily hardcoding overloading
		1591	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1592	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1593	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1594	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1456		1595
1457	our $WAITING;	1596	our $WAITING;
1458		1597
1459	sub _send {	1598	sub _send {
1460	# nop	1599	# nop
…		…
1509		1648
1510	# undocumented/compatibility with pre-3.4	1649	# undocumented/compatibility with pre-3.4
1511	*broadcast = \&send;	1650	*broadcast = \&send;
1512	*wait = \&_wait;	1651	*wait = \&_wait;
1513		1652
		1653	#############################################################################
		1654	# "new" API, currently only emulation of it
		1655	#############################################################################
		1656
		1657	package AE;
		1658
		1659	sub io($$$) {
		1660	AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
		1661	}
		1662
		1663	sub timer($$$) {
		1664	AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
		1665	}
		1666
		1667	sub signal($$) {
		1668	AnyEvent->signal (signal => $_[0], cb => $_[1]);
		1669	}
		1670
		1671	sub child($$) {
		1672	AnyEvent->child (pid => $_[0], cb => $_[1]);
		1673	}
		1674
		1675	sub idle($) {
		1676	AnyEvent->idle (cb => $_[0]);
		1677	}
		1678
		1679	sub cv() {
		1680	AnyEvent->condvar
		1681	}
		1682
		1683	sub now() {
		1684	AnyEvent->now
		1685	}
		1686
		1687	sub now_update() {
		1688	AnyEvent->now_update
		1689	}
		1690
		1691	sub time() {
		1692	AnyEvent->time
		1693	}
		1694
1514	=head1 ERROR AND EXCEPTION HANDLING	1695	=head1 ERROR AND EXCEPTION HANDLING
1515		1696
1516	In general, AnyEvent does not do any error handling - it relies on the	1697	In general, AnyEvent does not do any error handling - it relies on the
1517	caller to do that if required. The L<AnyEvent::Strict> module (see also	1698	caller to do that if required. The L<AnyEvent::Strict> module (see also
1518	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict	1699	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
…		…
1551	C<PERL_ANYEVENT_MODEL>.	1732	C<PERL_ANYEVENT_MODEL>.
1552		1733
1553	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1734	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1554	model it chooses.	1735	model it chooses.
1555		1736
		1737	When set to C<8> or higher, then AnyEvent will report extra information on
		1738	which optional modules it loads and how it implements certain features.
		1739
1556	=item C<PERL_ANYEVENT_STRICT>	1740	=item C<PERL_ANYEVENT_STRICT>
1557		1741
1558	AnyEvent does not do much argument checking by default, as thorough	1742	AnyEvent does not do much argument checking by default, as thorough
1559	argument checking is very costly. Setting this variable to a true value	1743	argument checking is very costly. Setting this variable to a true value
1560	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly	1744	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1561	check the arguments passed to most method calls. If it finds any problems,	1745	check the arguments passed to most method calls. If it finds any problems,
1562	it will croak.	1746	it will croak.
1563		1747
1564	In other words, enables "strict" mode.	1748	In other words, enables "strict" mode.
1565		1749
1566	Unlike C<use strict>, it is definitely recommended to keep it off in	1750	Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1567	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while	1751	>>, it is definitely recommended to keep it off in production. Keeping
1568	developing programs can be very useful, however.	1752	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1753	can be very useful, however.
1569		1754
1570	=item C<PERL_ANYEVENT_MODEL>	1755	=item C<PERL_ANYEVENT_MODEL>
1571		1756
1572	This can be used to specify the event model to be used by AnyEvent, before	1757	This can be used to specify the event model to be used by AnyEvent, before
1573	auto detection and -probing kicks in. It must be a string consisting	1758	auto detection and -probing kicks in. It must be a string consisting
…		…
1635		1820
1636	When neither C<ca_file> nor C<ca_path> was specified during	1821	When neither C<ca_file> nor C<ca_path> was specified during
1637	L<AnyEvent::TLS> context creation, and either of these environment	1822	L<AnyEvent::TLS> context creation, and either of these environment
1638	variables exist, they will be used to specify CA certificate locations	1823	variables exist, they will be used to specify CA certificate locations
1639	instead of a system-dependent default.	1824	instead of a system-dependent default.
		1825
		1826	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1827
		1828	When these are set to C<1>, then the respective modules are not
		1829	loaded. Mostly good for testing AnyEvent itself.
1640		1830
1641	=back	1831	=back
1642		1832
1643	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1833	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1644		1834
…		…
2231		2421
2232	This slightly arcane module is used to implement fast signal handling: To	2422	This slightly arcane module is used to implement fast signal handling: To
2233	my knowledge, there is no way to do completely race-free and quick	2423	my knowledge, there is no way to do completely race-free and quick
2234	signal handling in pure perl. To ensure that signals still get	2424	signal handling in pure perl. To ensure that signals still get
2235	delivered, AnyEvent will start an interval timer to wake up perl (and	2425	delivered, AnyEvent will start an interval timer to wake up perl (and
2236	catch the signals) with soemd elay (default is 10 seconds, look for	2426	catch the signals) with some delay (default is 10 seconds, look for
2237	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2427	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2238		2428
2239	If this module is available, then it will be used to implement signal	2429	If this module is available, then it will be used to implement signal
2240	catching, which means that signals will not be delayed, and the event loop	2430	catching, which means that signals will not be delayed, and the event loop
2241	will not be interrupted regularly, which is more efficient (And good for	2431	will not be interrupted regularly, which is more efficient (And good for
2242	battery life on laptops).	2432	battery life on laptops).
2243		2433
2244	This affects not just the pure-perl event loop, but also other event loops	2434	This affects not just the pure-perl event loop, but also other event loops
2245	that have no signal handling on their own (e.g. Glib, Tk, Qt).	2435	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2436
		2437	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2438	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2439	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2440	does nothing for those backends.
2246		2441
2247	=item L<EV>	2442	=item L<EV>
2248		2443
2249	This module isn't really "optional", as it is simply one of the backend	2444	This module isn't really "optional", as it is simply one of the backend
2250	event loops that AnyEvent can use. However, it is simply the best event	2445	event loops that AnyEvent can use. However, it is simply the best event
…		…
2264		2459
2265	=item L<JSON> and L<JSON::XS>	2460	=item L<JSON> and L<JSON::XS>
2266		2461
2267	This module is required when you want to read or write JSON data via	2462	This module is required when you want to read or write JSON data via
2268	L<AnyEvent::Handle>. It is also written in pure-perl, but can take	2463	L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2269	advantage of the ulta-high-speed L<JSON::XS> module when it is installed.	2464	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2270		2465
2271	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2466	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2272	installed.	2467	installed.
2273		2468
2274	=item L<Net::SSLeay>	2469	=item L<Net::SSLeay>
…		…
2341	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2536	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2342		2537
2343	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2538	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2344	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2539	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2345	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2540	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2346	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2541	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2347		2542
2348	Non-blocking file handles, sockets, TCP clients and	2543	Non-blocking file handles, sockets, TCP clients and
2349	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2544	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2350		2545
2351	Asynchronous DNS: L<AnyEvent::DNS>.	2546	Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.242 by root, Fri Jul 17 22:05:12 2009 UTC vs. Revision 1.266 by root, Thu Jul 30 03:41:56 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.242 by root, Fri Jul 17 22:05:12 2009 UTC vs.
Revision 1.266 by root, Thu Jul 30 03:41:56 2009 UTC