[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.265 by root, Wed Jul 29 13:10:58 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?
…		…
368		376
369	This watcher might use C<%SIG> (depending on the event loop used),	377	This watcher might use C<%SIG> (depending on the event loop used),
370	so programs overwriting those signals directly will likely not work	378	so programs overwriting those signals directly will likely not work
371	correctly.	379	correctly.
372		380
		381	Example: exit on SIGINT
		382
		383	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		384
		385	=head3 Signal Races, Delays and Workarounds
		386
373	Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not	387	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	388	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	389	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	390	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	391	be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
378	seconds). This variable can be changed only before the first signal	392	seconds). This variable can be changed only before the first signal
379	watcher is created, and should be left alone otherwise. Higher values	393	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	394	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	395	saving. All these problems can be avoided by installing the optional
382	L<Async::Interrupt> module.	396	L<Async::Interrupt> module. This will not work with inherently broken
383		397	event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
384	Example: exit on SIGINT	398	currently, as POE does it's own workaround with one-second latency). With
385		399	those, you just have to suffer the delays.
386	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
387		400
388	=head2 CHILD PROCESS WATCHERS	401	=head2 CHILD PROCESS WATCHERS
389		402
390	You can also watch on a child process exit and catch its exit status.	403	You can also watch on a child process exit and catch its exit status.
391		404
392	The child process is specified by the C<pid> argument (if set to C<0>, it	405	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	406	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	407	croak). The watcher will be triggered only when the child process has
395	any trace events (stopped/continued).	408	finished and an exit status is available, not on any trace events
		409	(stopped/continued).
396		410
397	The callback will be called with the pid and exit status (as returned by	411	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	412	waitpid), so unlike other watcher types, you I<can> rely on child watcher
399	callback arguments.	413	callback arguments.
400		414
…		…
504	Condition variables are similar to callbacks, except that you can	518	Condition variables are similar to callbacks, except that you can
505	optionally wait for them. They can also be called merge points - points	519	optionally wait for them. They can also be called merge points - points
506	in time where multiple outstanding events have been processed. And yet	520	in time where multiple outstanding events have been processed. And yet
507	another way to call them is transactions - each condition variable can be	521	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	522	used to represent a transaction, which finishes at some point and delivers
509	a result.	523	a result. And yet some people know them as "futures" - a promise to
		524	compute/deliver something that you can wait for.
510		525
511	Condition variables are very useful to signal that something has finished,	526	Condition variables are very useful to signal that something has finished,
512	for example, if you write a module that does asynchronous http requests,	527	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	528	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	529	availability of results. The user can either act when the callback is
…		…
782		797
783	AnyEvent::Impl::Glib based on Glib, slow but very stable.	798	AnyEvent::Impl::Glib based on Glib, slow but very stable.
784	AnyEvent::Impl::Tk based on Tk, very broken.	799	AnyEvent::Impl::Tk based on Tk, very broken.
785	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	800	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786	AnyEvent::Impl::POE based on POE, very slow, some limitations.	801	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		802	AnyEvent::Impl::Irssi used when running within irssi.
787		803
788	=item Backends with special needs.	804	=item Backends with special needs.
789		805
790	Qt requires the Qt::Application to be instantiated first, but will	806	Qt requires the Qt::Application to be instantiated first, but will
791	otherwise be picked up automatically. As long as the main program	807	otherwise be picked up automatically. As long as the main program
…		…
865	event module detection too early, for example, L<AnyEvent::AIO> creates	881	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	882	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867	avoid autodetecting the event module at load time.	883	avoid autodetecting the event module at load time.
868		884
869	If called in scalar or list context, then it creates and returns an object	885	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	886	that automatically removes the callback again when it is destroyed (or
		887	C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
871	L<Coro::BDB> for a case where this is useful.	888	a case where this is useful.
		889
		890	Example: Create a watcher for the IO::AIO module and store it in
		891	C<$WATCHER>. Only do so after the event loop is initialised, though.
		892
		893	our WATCHER;
		894
		895	my $guard = AnyEvent::post_detect {
		896	$WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
		897	};
		898
		899	# the \|\|= is important in case post_detect immediately runs the block,
		900	# as to not clobber the newly-created watcher. assigning both watcher and
		901	# post_detect guard to the same variable has the advantage of users being
		902	# able to just C<undef $WATCHER> if the watcher causes them grief.
		903
		904	$WATCHER \|\|= $guard;
872		905
873	=item @AnyEvent::post_detect	906	=item @AnyEvent::post_detect
874		907
875	If there are any code references in this array (you can C<push> to it	908	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	909	before or after loading AnyEvent), then they will called directly after
…		…
1041		1074
1042	=cut	1075	=cut
1043		1076
1044	package AnyEvent;	1077	package AnyEvent;
1045		1078
		1079	# basically a tuned-down version of common::sense
		1080	sub common_sense {
1046	no warnings;	1081	# no warnings
		1082	${^WARNING_BITS} ^= ${^WARNING_BITS};
1047	use strict qw(vars subs);	1083	# use strict vars subs
		1084	$^H \|= 0x00000600;
		1085	}
		1086
		1087	BEGIN { AnyEvent::common_sense }
1048		1088
1049	use Carp ();	1089	use Carp ();
1050		1090
1051	our $VERSION = 4.83;	1091	our $VERSION = 4.881;
1052	our $MODEL;	1092	our $MODEL;
1053		1093
1054	our $AUTOLOAD;	1094	our $AUTOLOAD;
1055	our @ISA;	1095	our @ISA;
1056		1096
…		…
1081	for reverse split /\s,\s/,	1121	for reverse split /\s,\s/,
1082	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";	1122	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
1083	}	1123	}
1084		1124
1085	my @models = (	1125	my @models = (
1086	[EV:: => AnyEvent::Impl::EV::],	1126	[EV:: => AnyEvent::Impl::EV:: , 1],
1087	[Event:: => AnyEvent::Impl::Event::],	1127	[Event:: => AnyEvent::Impl::Event::, 1],
1088	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1128	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1089	# everything below here will not be autoprobed	1129	# everything below here will not (normally) be autoprobed
1090	# as the pureperl backend should work everywhere	1130	# as the pureperl backend should work everywhere
1091	# and is usually faster	1131	# and is usually faster
1092	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1132	[Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1093	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1133	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1134	[Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1094	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles	1135	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1095	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1136	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1096	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1137	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1097	[Wx:: => AnyEvent::Impl::POE::],	1138	[Wx:: => AnyEvent::Impl::POE::],
1098	[Prima:: => AnyEvent::Impl::POE::],	1139	[Prima:: => AnyEvent::Impl::POE::],
1099	# IO::Async is just too broken - we would need workarounds for its	1140	# IO::Async is just too broken - we would need workarounds for its
1100	# byzantine signal and broken child handling, among others.	1141	# byzantine signal and broken child handling, among others.
1101	# IO::Async is rather hard to detect, as it doesn't have any	1142	# IO::Async is rather hard to detect, as it doesn't have any
1102	# obvious default class.	1143	# obvious default class.
1103	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1144	# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1104	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1145	# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1105	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program	1146	# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1106	);	1147	);
1107		1148
1108	our %method = map +($_ => 1),	1149	our %method = map +($_ => 1),
1109	qw(io timer time now now_update signal child idle condvar one_event DESTROY);	1150	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1110		1151
…		…
1114	my ($cb) = @_;	1155	my ($cb) = @_;
1115		1156
1116	if ($MODEL) {	1157	if ($MODEL) {
1117	$cb->();	1158	$cb->();
1118		1159
1119	1	1160	undef
1120	} else {	1161	} else {
1121	push @post_detect, $cb;	1162	push @post_detect, $cb;
1122		1163
1123	defined wantarray	1164	defined wantarray
1124	? bless \$cb, "AnyEvent::Util::postdetect"	1165	? bless \$cb, "AnyEvent::Util::postdetect"
…		…
1130	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1171	@post_detect = grep $_ != ${$_[0]}, @post_detect;
1131	}	1172	}
1132		1173
1133	sub detect() {	1174	sub detect() {
1134	unless ($MODEL) {	1175	unless ($MODEL) {
1135	no strict 'refs';
1136	local $SIG{__DIE__};	1176	local $SIG{__DIE__};
1137		1177
1138	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1178	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1139	my $model = "AnyEvent::Impl::$1";	1179	my $model = "AnyEvent::Impl::$1";
1140	if (eval "require $model") {	1180	if (eval "require $model") {
…		…
1157	}	1197	}
1158	}	1198	}
1159	}	1199	}
1160		1200
1161	unless ($MODEL) {	1201	unless ($MODEL) {
1162	# try to load a model	1202	# try to autoload a model
1163
1164	for (@REGISTRY, @models) {	1203	for (@REGISTRY, @models) {
1165	my ($package, $model) = @$_;	1204	my ($package, $model, $autoload) = @$_;
		1205	if (
		1206	$autoload
1166	if (eval "require $package"	1207	and eval "require $package"
1167	and ${"$package\::VERSION"} > 0	1208	and ${"$package\::VERSION"} > 0
1168	and eval "require $model") {	1209	and eval "require $model"
		1210	) {
1169	$MODEL = $model;	1211	$MODEL = $model;
1170	warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2;	1212	warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1171	last;	1213	last;
1172	}	1214	}
1173	}	1215	}
1174		1216
1175	$MODEL	1217	$MODEL
…		…
1247	}	1289	}
1248		1290
1249	# default implementation for ->signal	1291	# default implementation for ->signal
1250		1292
1251	our $HAVE_ASYNC_INTERRUPT;	1293	our $HAVE_ASYNC_INTERRUPT;
		1294
		1295	sub _have_async_interrupt() {
		1296	$HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
		1297	&& eval "use Async::Interrupt 1.0 (); 1")
		1298	unless defined $HAVE_ASYNC_INTERRUPT;
		1299
		1300	$HAVE_ASYNC_INTERRUPT
		1301	}
		1302
1252	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);	1303	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1253	our (%SIG_ASY, %SIG_ASY_W);	1304	our (%SIG_ASY, %SIG_ASY_W);
1254	our ($SIG_COUNT, $SIG_TW);	1305	our ($SIG_COUNT, $SIG_TW);
1255		1306
1256	sub _signal_exec {	1307	sub _signal_exec {
…		…
1264	$_->() for values %{ $SIG_CB{$_} \|\| {} };	1315	$_->() for values %{ $SIG_CB{$_} \|\| {} };
1265	}	1316	}
1266	}	1317	}
1267	}	1318	}
1268		1319
		1320	# install a dummy wakeup watcher to reduce signal catching latency
1269	sub _signal {	1321	sub _sig_add() {
1270	my (undef, %arg) = @_;	1322	unless ($SIG_COUNT++) {
		1323	# try to align timer on a full-second boundary, if possible
		1324	my $NOW = AnyEvent->now;
1271		1325
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 (	1326	$SIG_TW = AnyEvent->timer (
1304	after => $MAX_SIGNAL_LATENCY,	1327	after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1305	interval => $MAX_SIGNAL_LATENCY,	1328	interval => $MAX_SIGNAL_LATENCY,
1306	cb => sub { }, # just for the PERL_ASYNC_CHECK	1329	cb => sub { }, # just for the PERL_ASYNC_CHECK
1307	);	1330	);
1308	}	1331	}
1309
1310	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1311	}	1332	}
1312		1333
1313	sub signal {	1334	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	1335	undef $SIG_TW
1357	unless --$SIG_COUNT;	1336	unless --$SIG_COUNT;
		1337	}
1358		1338
		1339	our $_sig_name_init; $_sig_name_init = sub {
		1340	eval q{ # poor man's autoloading
		1341	undef $_sig_name_init;
		1342
		1343	if (_have_async_interrupt) {
		1344	*sig2num = \&Async::Interrupt::sig2num;
		1345	*sig2name = \&Async::Interrupt::sig2name;
		1346	} else {
		1347	require Config;
		1348
		1349	my %signame2num;
		1350	@signame2num{ split ' ', $Config::Config{sig_name} }
		1351	= split ' ', $Config::Config{sig_num};
		1352
		1353	my @signum2name;
		1354	@signum2name[values %signame2num] = keys %signame2num;
		1355
		1356	*sig2num = sub($) {
		1357	$_[0] > 0 ? shift : $signame2num{+shift}
		1358	};
		1359	*sig2name = sub ($) {
		1360	$_[0] > 0 ? $signum2name[+shift] : shift
		1361	};
		1362	}
		1363	};
		1364	die if $@;
		1365	};
		1366
		1367	sub sig2num ($) { &$_sig_name_init; &sig2num }
		1368	sub sig2name($) { &$_sig_name_init; &sig2name }
		1369
		1370	sub signal {
		1371	eval q{ # poor man's autoloading {}
		1372	# probe for availability of Async::Interrupt
		1373	if (_have_async_interrupt) {
		1374	warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
		1375
		1376	$SIGPIPE_R = new Async::Interrupt::EventPipe;
		1377	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec);
		1378
		1379	} else {
		1380	warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
		1381
		1382	require Fcntl;
		1383
		1384	if (AnyEvent::WIN32) {
		1385	require AnyEvent::Util;
		1386
		1387	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1388	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
		1389	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
		1390	} else {
		1391	pipe $SIGPIPE_R, $SIGPIPE_W;
		1392	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1393	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1394
		1395	# not strictly required, as $^F is normally 2, but let's make sure...
		1396	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1397	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1398	}
		1399
		1400	$SIGPIPE_R
		1401	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1402
		1403	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1404	}
		1405
		1406	*signal = sub {
		1407	my (undef, %arg) = @_;
		1408
		1409	my $signal = uc $arg{signal}
		1410	or Carp::croak "required option 'signal' is missing";
		1411
		1412	if ($HAVE_ASYNC_INTERRUPT) {
		1413	# async::interrupt
		1414
		1415	$signal = sig2num $signal;
		1416	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1417
		1418	$SIG_ASY{$signal} \|\|= new Async::Interrupt
		1419	cb => sub { undef $SIG_EV{$signal} },
		1420	signal => $signal,
		1421	pipe => [$SIGPIPE_R->filenos],
		1422	pipe_autodrain => 0,
		1423	;
		1424
		1425	} else {
		1426	# pure perl
		1427
		1428	# AE::Util has been loaded in signal
		1429	$signal = sig2name $signal;
		1430	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		1431
		1432	$SIG{$signal} \|\|= sub {
		1433	local $!;
		1434	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1435	undef $SIG_EV{$signal};
		1436	};
		1437
		1438	# can't do signal processing without introducing races in pure perl,
		1439	# so limit the signal latency.
		1440	_sig_add;
		1441	}
		1442
		1443	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
		1444	};
		1445
		1446	*AnyEvent::Base::signal::DESTROY = sub {
		1447	my ($signal, $cb) = @{$_[0]};
		1448
		1449	_sig_del;
		1450
1359	delete $SIG_CB{$signal}{$cb};	1451	delete $SIG_CB{$signal}{$cb};
1360		1452
		1453	$HAVE_ASYNC_INTERRUPT
		1454	? delete $SIG_ASY{$signal}
1361	# delete doesn't work with older perls - they then	1455	: # delete doesn't work with older perls - they then
1362	# print weird messages, or just unconditionally exit	1456	# print weird messages, or just unconditionally exit
1363	# instead of getting the default action.	1457	# instead of getting the default action.
1364	undef $SIG{$signal}	1458	undef $SIG{$signal}
1365	unless keys %{ $SIG_CB{$signal} };	1459	unless keys %{ $SIG_CB{$signal} };
		1460	};
		1461	};
		1462	die if $@;
		1463	&signal
1366	}	1464	}
1367		1465
1368	# default implementation for ->child	1466	# default implementation for ->child
1369		1467
1370	our %PID_CB;	1468	our %PID_CB;
1371	our $CHLD_W;	1469	our $CHLD_W;
1372	our $CHLD_DELAY_W;	1470	our $CHLD_DELAY_W;
1373	our $WNOHANG;	1471	our $WNOHANG;
1374		1472
		1473	sub _emit_childstatus($$) {
		1474	my (undef, $rpid, $rstatus) = @_;
		1475
		1476	$_->($rpid, $rstatus)
		1477	for values %{ $PID_CB{$rpid} \|\| {} },
		1478	values %{ $PID_CB{0} \|\| {} };
		1479	}
		1480
1375	sub _sigchld {	1481	sub _sigchld {
		1482	my $pid;
		1483
		1484	AnyEvent->_emit_childstatus ($pid, $?)
1376	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1485	while ($pid = waitpid -1, $WNOHANG) > 0;
1377	$_->($pid, $?)
1378	for values %{ $PID_CB{$pid} \|\| {} },
1379	values %{ $PID_CB{0} \|\| {} };
1380	}
1381	}	1486	}
1382		1487
1383	sub child {	1488	sub child {
1384	my (undef, %arg) = @_;	1489	my (undef, %arg) = @_;
1385		1490
1386	defined (my $pid = $arg{pid} + 0)	1491	defined (my $pid = $arg{pid} + 0)
1387	or Carp::croak "required option 'pid' is missing";	1492	or Carp::croak "required option 'pid' is missing";
1388		1493
1389	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1494	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1390		1495
		1496	# WNOHANG is almost cetrainly 1 everywhere
		1497	$WNOHANG \|\|= $^O =~ /^(?:openbsd\|netbsd\|linux\|freebsd\|cygwin\|MSWin32)$/
		1498	? 1
1391	$WNOHANG \|\|= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;	1499	: eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
1392		1500
1393	unless ($CHLD_W) {	1501	unless ($CHLD_W) {
1394	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1502	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1395	# child could be a zombie already, so make at least one round	1503	# child could be a zombie already, so make at least one round
1396	&_sigchld;	1504	&_sigchld;
…		…
1448		1556
1449	our @ISA = AnyEvent::CondVar::Base::;	1557	our @ISA = AnyEvent::CondVar::Base::;
1450		1558
1451	package AnyEvent::CondVar::Base;	1559	package AnyEvent::CondVar::Base;
1452		1560
1453	use overload	1561	#use overload
1454	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1562	# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1455	fallback => 1;	1563	# fallback => 1;
		1564
		1565	# save 300+ kilobytes by dirtily hardcoding overloading
		1566	${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
		1567	*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
		1568	*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
		1569	${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1456		1570
1457	our $WAITING;	1571	our $WAITING;
1458		1572
1459	sub _send {	1573	sub _send {
1460	# nop	1574	# nop
…		…
1551	C<PERL_ANYEVENT_MODEL>.	1665	C<PERL_ANYEVENT_MODEL>.
1552		1666
1553	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1667	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1554	model it chooses.	1668	model it chooses.
1555		1669
		1670	When set to C<8> or higher, then AnyEvent will report extra information on
		1671	which optional modules it loads and how it implements certain features.
		1672
1556	=item C<PERL_ANYEVENT_STRICT>	1673	=item C<PERL_ANYEVENT_STRICT>
1557		1674
1558	AnyEvent does not do much argument checking by default, as thorough	1675	AnyEvent does not do much argument checking by default, as thorough
1559	argument checking is very costly. Setting this variable to a true value	1676	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	1677	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,	1678	check the arguments passed to most method calls. If it finds any problems,
1562	it will croak.	1679	it will croak.
1563		1680
1564	In other words, enables "strict" mode.	1681	In other words, enables "strict" mode.
1565		1682
1566	Unlike C<use strict>, it is definitely recommended to keep it off in	1683	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	1684	>>, it is definitely recommended to keep it off in production. Keeping
1568	developing programs can be very useful, however.	1685	C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
		1686	can be very useful, however.
1569		1687
1570	=item C<PERL_ANYEVENT_MODEL>	1688	=item C<PERL_ANYEVENT_MODEL>
1571		1689
1572	This can be used to specify the event model to be used by AnyEvent, before	1690	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	1691	auto detection and -probing kicks in. It must be a string consisting
…		…
1635		1753
1636	When neither C<ca_file> nor C<ca_path> was specified during	1754	When neither C<ca_file> nor C<ca_path> was specified during
1637	L<AnyEvent::TLS> context creation, and either of these environment	1755	L<AnyEvent::TLS> context creation, and either of these environment
1638	variables exist, they will be used to specify CA certificate locations	1756	variables exist, they will be used to specify CA certificate locations
1639	instead of a system-dependent default.	1757	instead of a system-dependent default.
		1758
		1759	=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
		1760
		1761	When these are set to C<1>, then the respective modules are not
		1762	loaded. Mostly good for testing AnyEvent itself.
1640		1763
1641	=back	1764	=back
1642		1765
1643	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1766	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1644		1767
…		…
2231		2354
2232	This slightly arcane module is used to implement fast signal handling: To	2355	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	2356	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	2357	signal handling in pure perl. To ensure that signals still get
2235	delivered, AnyEvent will start an interval timer to wake up perl (and	2358	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	2359	catch the signals) with some delay (default is 10 seconds, look for
2237	C<$AnyEvent::MAX_SIGNAL_LATENCY>).	2360	C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2238		2361
2239	If this module is available, then it will be used to implement signal	2362	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	2363	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	2364	will not be interrupted regularly, which is more efficient (And good for
2242	battery life on laptops).	2365	battery life on laptops).
2243		2366
2244	This affects not just the pure-perl event loop, but also other event loops	2367	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).	2368	that have no signal handling on their own (e.g. Glib, Tk, Qt).
		2369
		2370	Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
		2371	and either employ their own workarounds (POE) or use AnyEvent's workaround
		2372	(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
		2373	does nothing for those backends.
2246		2374
2247	=item L<EV>	2375	=item L<EV>
2248		2376
2249	This module isn't really "optional", as it is simply one of the backend	2377	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	2378	event loops that AnyEvent can use. However, it is simply the best event
…		…
2264		2392
2265	=item L<JSON> and L<JSON::XS>	2393	=item L<JSON> and L<JSON::XS>
2266		2394
2267	This module is required when you want to read or write JSON data via	2395	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	2396	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.	2397	advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2270		2398
2271	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is	2399	In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2272	installed.	2400	installed.
2273		2401
2274	=item L<Net::SSLeay>	2402	=item L<Net::SSLeay>
…		…
2341	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2469	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2342		2470
2343	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2471	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2344	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2472	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2345	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2473	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2346	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.	2474	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2347		2475
2348	Non-blocking file handles, sockets, TCP clients and	2476	Non-blocking file handles, sockets, TCP clients and
2349	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.	2477	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2350		2478
2351	Asynchronous DNS: L<AnyEvent::DNS>.	2479	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.265 by root, Wed Jul 29 13:10:58 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.265 by root, Wed Jul 29 13:10:58 2009 UTC