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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.180 by root, Sat Sep 6 07:00:45 2008 UTC vs.
Revision 1.198 by root, Thu Mar 26 20:17:44 2009 UTC

…		…
137	These watchers are normal Perl objects with normal Perl lifetime. After	137	These watchers are normal Perl objects with normal Perl lifetime. After
138	creating a watcher it will immediately "watch" for events and invoke the	138	creating a watcher it will immediately "watch" for events and invoke the
139	callback when the event occurs (of course, only when the event model	139	callback when the event occurs (of course, only when the event model
140	is in control).	140	is in control).
141		141
		142	Note that B<callbacks must not permanently change global variables>
		143	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
		144	callbacks must not C<die> >>. The former is good programming practise in
		145	Perl and the latter stems from the fact that exception handling differs
		146	widely between event loops.
		147
142	To disable the watcher you have to destroy it (e.g. by setting the	148	To disable the watcher you have to destroy it (e.g. by setting the
143	variable you store it in to C<undef> or otherwise deleting all references	149	variable you store it in to C<undef> or otherwise deleting all references
144	to it).	150	to it).
145		151
146	All watchers are created by calling a method on the C<AnyEvent> class.	152	All watchers are created by calling a method on the C<AnyEvent> class.
…		…
340	=head2 CHILD PROCESS WATCHERS	346	=head2 CHILD PROCESS WATCHERS
341		347
342	You can also watch on a child process exit and catch its exit status.	348	You can also watch on a child process exit and catch its exit status.
343		349
344	The child process is specified by the C<pid> argument (if set to C<0>, it	350	The child process is specified by the C<pid> argument (if set to C<0>, it
345	watches for any child process exit). The watcher will trigger as often	351	watches for any child process exit). The watcher will triggered only when
346	as status change for the child are received. This works by installing a	352	the child process has finished and an exit status is available, not on
347	signal handler for C<SIGCHLD>. The callback will be called with the pid	353	any trace events (stopped/continued).
348	and exit status (as returned by waitpid), so unlike other watcher types,	354
349	you I<can> rely on child watcher callback arguments.	355	The callback will be called with the pid and exit status (as returned by
		356	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		357	callback arguments.
		358
		359	This watcher type works by installing a signal handler for C<SIGCHLD>,
		360	and since it cannot be shared, nothing else should use SIGCHLD or reap
		361	random child processes (waiting for specific child processes, e.g. inside
		362	C<system>, is just fine).
350		363
351	There is a slight catch to child watchers, however: you usually start them	364	There is a slight catch to child watchers, however: you usually start them
352	I<after> the child process was created, and this means the process could	365	I<after> the child process was created, and this means the process could
353	have exited already (and no SIGCHLD will be sent anymore).	366	have exited already (and no SIGCHLD will be sent anymore).
354		367
…		…
818	=item L<AnyEvent::IGS>	831	=item L<AnyEvent::IGS>
819		832
820	A non-blocking interface to the Internet Go Server protocol (used by	833	A non-blocking interface to the Internet Go Server protocol (used by
821	L<App::IGS>).	834	L<App::IGS>).
822		835
823	=item L<Net::IRC3>	836	=item L<AnyEvent::IRC>
824		837
825	AnyEvent based IRC client module family.	838	AnyEvent based IRC client module family (replacing the older Net::IRC3).
826		839
827	=item L<Net::XMPP2>	840	=item L<Net::XMPP2>
828		841
829	AnyEvent based XMPP (Jabber protocol) module family.	842	AnyEvent based XMPP (Jabber protocol) module family.
830		843
…		…
854	no warnings;	867	no warnings;
855	use strict qw(vars subs);	868	use strict qw(vars subs);
856		869
857	use Carp;	870	use Carp;
858		871
859	our $VERSION = 4.233;	872	our $VERSION = 4.341;
860	our $MODEL;	873	our $MODEL;
861		874
862	our $AUTOLOAD;	875	our $AUTOLOAD;
863	our @ISA;	876	our @ISA;
864		877
…		…
997	# to support binding more than one watcher per filehandle (they usually	1010	# to support binding more than one watcher per filehandle (they usually
998	# allow only one watcher per fd, so we dup it to get a different one).	1011	# allow only one watcher per fd, so we dup it to get a different one).
999	sub _dupfh($$$$) {	1012	sub _dupfh($$$$) {
1000	my ($poll, $fh, $r, $w) = @_;	1013	my ($poll, $fh, $r, $w) = @_;
1001		1014
1002	require Fcntl;
1003
1004	# cygwin requires the fh mode to be matching, unix doesn't	1015	# cygwin requires the fh mode to be matching, unix doesn't
1005	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1016	my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1006	: $poll eq "w" ? ($w, ">")	1017	: $poll eq "w" ? ($w, ">")
1007	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";	1018	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1008		1019
…		…
1021	BEGIN {	1032	BEGIN {
1022	if (eval "use Time::HiRes (); time (); 1") {	1033	if (eval "use Time::HiRes (); time (); 1") {
1023	*_time = \&Time::HiRes::time;	1034	*_time = \&Time::HiRes::time;
1024	# if (eval "use POSIX (); (POSIX::times())...	1035	# if (eval "use POSIX (); (POSIX::times())...
1025	} else {	1036	} else {
1026	*_time = \&CORE::time; # epic fail	1037	*_time = sub { time }; # epic fail
1027	}	1038	}
1028	}	1039	}
1029		1040
1030	sub time { _time }	1041	sub time { _time }
1031	sub now { _time }	1042	sub now { _time }
…		…
1036	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1047	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
1037	}	1048	}
1038		1049
1039	# default implementation for ->signal	1050	# default implementation for ->signal
1040		1051
1041	our %SIG_CB;	1052	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1053
		1054	sub _signal_exec {
		1055	sysread $SIGPIPE_R, my $dummy, 4;
		1056
		1057	while (%SIG_EV) {
		1058	for (keys %SIG_EV) {
		1059	delete $SIG_EV{$_};
		1060	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1061	}
		1062	}
		1063	}
1042		1064
1043	sub signal {	1065	sub signal {
1044	my (undef, %arg) = @_;	1066	my (undef, %arg) = @_;
1045		1067
		1068	unless ($SIGPIPE_R) {
		1069	if (AnyEvent::WIN32) {
		1070	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1071	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
		1072	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
		1073	} else {
		1074	pipe $SIGPIPE_R, $SIGPIPE_W;
		1075	require Fcntl;
		1076	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1077	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1078	}
		1079
		1080	$SIGPIPE_R
		1081	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1082
		1083	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1084	}
		1085
1046	my $signal = uc $arg{signal}	1086	my $signal = uc $arg{signal}
1047	or Carp::croak "required option 'signal' is missing";	1087	or Carp::croak "required option 'signal' is missing";
1048		1088
1049	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1089	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1050	$SIG{$signal} \|\|= sub {	1090	$SIG{$signal} \|\|= sub {
1051	$_->() for values %{ $SIG_CB{$signal} \|\| {} };	1091	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1092	undef $SIG_EV{$signal};
1052	};	1093	};
1053		1094
1054	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1095	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
1055	}	1096	}
1056		1097
…		…
1256	used, and preference will be given to protocols mentioned earlier in the	1297	used, and preference will be given to protocols mentioned earlier in the
1257	list.	1298	list.
1258		1299
1259	This variable can effectively be used for denial-of-service attacks	1300	This variable can effectively be used for denial-of-service attacks
1260	against local programs (e.g. when setuid), although the impact is likely	1301	against local programs (e.g. when setuid), although the impact is likely
1261	small, as the program has to handle connection errors already-	1302	small, as the program has to handle conenction and other failures anyways.
1262		1303
1263	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,	1304	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1264	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>	1305	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1265	- only support IPv4, never try to resolve or contact IPv6	1306	- only support IPv4, never try to resolve or contact IPv6
1266	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	1307	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
…		…
1526	watcher.	1567	watcher.
1527		1568
1528	=head3 Results	1569	=head3 Results
1529		1570
1530	name watchers bytes create invoke destroy comment	1571	name watchers bytes create invoke destroy comment
1531	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	1572	EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1532	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	1573	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1533	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	1574	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1534	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	1575	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1535	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	1576	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1536	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	1577	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1537	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	1578	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1538	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	1579	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1539	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	1580	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1540	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	1581	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1541		1582
1542	=head3 Discussion	1583	=head3 Discussion
1543		1584
1544	The benchmark does I<not> measure scalability of the event loop very	1585	The benchmark does I<not> measure scalability of the event loop very
1545	well. For example, a select-based event loop (such as the pure perl one)	1586	well. For example, a select-based event loop (such as the pure perl one)
…		…
1747	watchers, as the management overhead dominates.	1788	watchers, as the management overhead dominates.
1748		1789
1749	=back	1790	=back
1750		1791
1751		1792
		1793	=head1 SIGNALS
		1794
		1795	AnyEvent currently installs handlers for these signals:
		1796
		1797	=over 4
		1798
		1799	=item SIGCHLD
		1800
		1801	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		1802	emulation for event loops that do not support them natively. Also, some
		1803	event loops install a similar handler.
		1804
		1805	=item SIGPIPE
		1806
		1807	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		1808	when AnyEvent gets loaded.
		1809
		1810	The rationale for this is that AnyEvent users usually do not really depend
		1811	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		1812	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		1813	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		1814	some random socket.
		1815
		1816	The rationale for installing a no-op handler as opposed to ignoring it is
		1817	that this way, the handler will be restored to defaults on exec.
		1818
		1819	Feel free to install your own handler, or reset it to defaults.
		1820
		1821	=back
		1822
		1823	=cut
		1824
		1825	$SIG{PIPE} = sub { }
		1826	unless defined $SIG{PIPE};
		1827
		1828
1752	=head1 FORK	1829	=head1 FORK
1753		1830
1754	Most event libraries are not fork-safe. The ones who are usually are	1831	Most event libraries are not fork-safe. The ones who are usually are
1755	because they rely on inefficient but fork-safe C<select> or C<poll>	1832	because they rely on inefficient but fork-safe C<select> or C<poll>
1756	calls. Only L<EV> is fully fork-aware.	1833	calls. Only L<EV> is fully fork-aware.
…		…
1784	=head1 BUGS	1861	=head1 BUGS
1785		1862
1786	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	1863	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1787	to work around. If you suffer from memleaks, first upgrade to Perl 5.10	1864	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1788	and check wether the leaks still show up. (Perl 5.10.0 has other annoying	1865	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1789	mamleaks, such as leaking on C<map> and C<grep> but it is usually not as	1866	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1790	pronounced).	1867	pronounced).
1791		1868
1792		1869
1793	=head1 SEE ALSO	1870	=head1 SEE ALSO
1794		1871

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.180 by root, Sat Sep 6 07:00:45 2008 UTC vs. Revision 1.198 by root, Thu Mar 26 20:17:44 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.180 by root, Sat Sep 6 07:00:45 2008 UTC vs.
Revision 1.198 by root, Thu Mar 26 20:17:44 2009 UTC