[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.199 by root, Fri Mar 27 10:49:50 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.
…		…
162	=head2 I/O WATCHERS	168	=head2 I/O WATCHERS
163		169
164	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	170	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
165	with the following mandatory key-value pairs as arguments:	171	with the following mandatory key-value pairs as arguments:
166		172
167	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events	173	C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch
168	(AnyEvent might or might not keep a reference to this file handle). C<poll>	174	for events (AnyEvent might or might not keep a reference to this file
		175	handle). Note that only file handles pointing to things for which
		176	non-blocking operation makes sense are allowed. This includes sockets,
		177	most character devices, pipes, fifos and so on, but not for example files
		178	or block devices.
		179
169	must be a string that is either C<r> or C<w>, which creates a watcher	180	C<poll> must be a string that is either C<r> or C<w>, which creates a
170	waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the	181	watcher waiting for "r"eadable or "w"ritable events, respectively.
		182
171	callback to invoke each time the file handle becomes ready.	183	C<cb> is the callback to invoke each time the file handle becomes ready.
172		184
173	Although the callback might get passed parameters, their value and	185	Although the callback might get passed parameters, their value and
174	presence is undefined and you cannot rely on them. Portable AnyEvent	186	presence is undefined and you cannot rely on them. Portable AnyEvent
175	callbacks cannot use arguments passed to I/O watcher callbacks.	187	callbacks cannot use arguments passed to I/O watcher callbacks.
176		188
…		…
340	=head2 CHILD PROCESS WATCHERS	352	=head2 CHILD PROCESS WATCHERS
341		353
342	You can also watch on a child process exit and catch its exit status.	354	You can also watch on a child process exit and catch its exit status.
343		355
344	The child process is specified by the C<pid> argument (if set to C<0>, it	356	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	357	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	358	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	359	any trace events (stopped/continued).
348	and exit status (as returned by waitpid), so unlike other watcher types,	360
349	you I<can> rely on child watcher callback arguments.	361	The callback will be called with the pid and exit status (as returned by
		362	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		363	callback arguments.
		364
		365	This watcher type works by installing a signal handler for C<SIGCHLD>,
		366	and since it cannot be shared, nothing else should use SIGCHLD or reap
		367	random child processes (waiting for specific child processes, e.g. inside
		368	C<system>, is just fine).
350		369
351	There is a slight catch to child watchers, however: you usually start them	370	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	371	I<after> the child process was created, and this means the process could
353	have exited already (and no SIGCHLD will be sent anymore).	372	have exited already (and no SIGCHLD will be sent anymore).
354		373
…		…
818	=item L<AnyEvent::IGS>	837	=item L<AnyEvent::IGS>
819		838
820	A non-blocking interface to the Internet Go Server protocol (used by	839	A non-blocking interface to the Internet Go Server protocol (used by
821	L<App::IGS>).	840	L<App::IGS>).
822		841
823	=item L<Net::IRC3>	842	=item L<AnyEvent::IRC>
824		843
825	AnyEvent based IRC client module family.	844	AnyEvent based IRC client module family (replacing the older Net::IRC3).
826		845
827	=item L<Net::XMPP2>	846	=item L<Net::XMPP2>
828		847
829	AnyEvent based XMPP (Jabber protocol) module family.	848	AnyEvent based XMPP (Jabber protocol) module family.
830		849
…		…
854	no warnings;	873	no warnings;
855	use strict qw(vars subs);	874	use strict qw(vars subs);
856		875
857	use Carp;	876	use Carp;
858		877
859	our $VERSION = 4.233;	878	our $VERSION = 4.35;
860	our $MODEL;	879	our $MODEL;
861		880
862	our $AUTOLOAD;	881	our $AUTOLOAD;
863	our @ISA;	882	our @ISA;
864		883
…		…
997	# to support binding more than one watcher per filehandle (they usually	1016	# 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).	1017	# allow only one watcher per fd, so we dup it to get a different one).
999	sub _dupfh($$$$) {	1018	sub _dupfh($$$$) {
1000	my ($poll, $fh, $r, $w) = @_;	1019	my ($poll, $fh, $r, $w) = @_;
1001		1020
1002	require Fcntl;
1003
1004	# cygwin requires the fh mode to be matching, unix doesn't	1021	# cygwin requires the fh mode to be matching, unix doesn't
1005	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1022	my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1006	: $poll eq "w" ? ($w, ">")	1023	: $poll eq "w" ? ($w, ">")
1007	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";	1024	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1008		1025
…		…
1021	BEGIN {	1038	BEGIN {
1022	if (eval "use Time::HiRes (); time (); 1") {	1039	if (eval "use Time::HiRes (); time (); 1") {
1023	*_time = \&Time::HiRes::time;	1040	*_time = \&Time::HiRes::time;
1024	# if (eval "use POSIX (); (POSIX::times())...	1041	# if (eval "use POSIX (); (POSIX::times())...
1025	} else {	1042	} else {
1026	*_time = \&CORE::time; # epic fail	1043	*_time = sub { time }; # epic fail
1027	}	1044	}
1028	}	1045	}
1029		1046
1030	sub time { _time }	1047	sub time { _time }
1031	sub now { _time }	1048	sub now { _time }
…		…
1036	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1053	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
1037	}	1054	}
1038		1055
1039	# default implementation for ->signal	1056	# default implementation for ->signal
1040		1057
1041	our %SIG_CB;	1058	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1059
		1060	sub _signal_exec {
		1061	sysread $SIGPIPE_R, my $dummy, 4;
		1062
		1063	while (%SIG_EV) {
		1064	for (keys %SIG_EV) {
		1065	delete $SIG_EV{$_};
		1066	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1067	}
		1068	}
		1069	}
1042		1070
1043	sub signal {	1071	sub signal {
1044	my (undef, %arg) = @_;	1072	my (undef, %arg) = @_;
1045		1073
		1074	unless ($SIGPIPE_R) {
		1075	if (AnyEvent::WIN32) {
		1076	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1077	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
		1078	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
		1079	} else {
		1080	pipe $SIGPIPE_R, $SIGPIPE_W;
		1081	require Fcntl;
		1082	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1083	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1084	}
		1085
		1086	$SIGPIPE_R
		1087	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1088
		1089	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1090	}
		1091
1046	my $signal = uc $arg{signal}	1092	my $signal = uc $arg{signal}
1047	or Carp::croak "required option 'signal' is missing";	1093	or Carp::croak "required option 'signal' is missing";
1048		1094
1049	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1095	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1050	$SIG{$signal} \|\|= sub {	1096	$SIG{$signal} \|\|= sub {
1051	$_->() for values %{ $SIG_CB{$signal} \|\| {} };	1097	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1098	undef $SIG_EV{$signal};
1052	};	1099	};
1053		1100
1054	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1101	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
1055	}	1102	}
1056		1103
…		…
1256	used, and preference will be given to protocols mentioned earlier in the	1303	used, and preference will be given to protocols mentioned earlier in the
1257	list.	1304	list.
1258		1305
1259	This variable can effectively be used for denial-of-service attacks	1306	This variable can effectively be used for denial-of-service attacks
1260	against local programs (e.g. when setuid), although the impact is likely	1307	against local programs (e.g. when setuid), although the impact is likely
1261	small, as the program has to handle connection errors already-	1308	small, as the program has to handle conenction and other failures anyways.
1262		1309
1263	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,	1310	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>	1311	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1265	- only support IPv4, never try to resolve or contact IPv6	1312	- only support IPv4, never try to resolve or contact IPv6
1266	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or	1313	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
…		…
1526	watcher.	1573	watcher.
1527		1574
1528	=head3 Results	1575	=head3 Results
1529		1576
1530	name watchers bytes create invoke destroy comment	1577	name watchers bytes create invoke destroy comment
1531	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	1578	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	1579	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	1580	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	1581	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	1582	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	1583	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	1584	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	1585	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	1586	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	1587	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1541		1588
1542	=head3 Discussion	1589	=head3 Discussion
1543		1590
1544	The benchmark does I<not> measure scalability of the event loop very	1591	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)	1592	well. For example, a select-based event loop (such as the pure perl one)
…		…
1747	watchers, as the management overhead dominates.	1794	watchers, as the management overhead dominates.
1748		1795
1749	=back	1796	=back
1750		1797
1751		1798
		1799	=head1 SIGNALS
		1800
		1801	AnyEvent currently installs handlers for these signals:
		1802
		1803	=over 4
		1804
		1805	=item SIGCHLD
		1806
		1807	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		1808	emulation for event loops that do not support them natively. Also, some
		1809	event loops install a similar handler.
		1810
		1811	=item SIGPIPE
		1812
		1813	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		1814	when AnyEvent gets loaded.
		1815
		1816	The rationale for this is that AnyEvent users usually do not really depend
		1817	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		1818	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		1819	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		1820	some random socket.
		1821
		1822	The rationale for installing a no-op handler as opposed to ignoring it is
		1823	that this way, the handler will be restored to defaults on exec.
		1824
		1825	Feel free to install your own handler, or reset it to defaults.
		1826
		1827	=back
		1828
		1829	=cut
		1830
		1831	$SIG{PIPE} = sub { }
		1832	unless defined $SIG{PIPE};
		1833
		1834
1752	=head1 FORK	1835	=head1 FORK
1753		1836
1754	Most event libraries are not fork-safe. The ones who are usually are	1837	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>	1838	because they rely on inefficient but fork-safe C<select> or C<poll>
1756	calls. Only L<EV> is fully fork-aware.	1839	calls. Only L<EV> is fully fork-aware.
…		…
1784	=head1 BUGS	1867	=head1 BUGS
1785		1868
1786	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	1869	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	1870	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	1871	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	1872	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1790	pronounced).	1873	pronounced).
1791		1874
1792		1875
1793	=head1 SEE ALSO	1876	=head1 SEE ALSO
1794		1877

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.199 by root, Fri Mar 27 10:49:50 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.199 by root, Fri Mar 27 10:49:50 2009 UTC