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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.166 by root, Tue Jul 8 23:10:20 2008 UTC vs.
Revision 1.172 by root, Thu Jul 17 15:21:02 2008 UTC

…		…
33		33
34	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	34	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
35	policy> and AnyEvent is I<small and efficient>.	35	policy> and AnyEvent is I<small and efficient>.
36		36
37	First and foremost, I<AnyEvent is not an event model> itself, it only	37	First and foremost, I<AnyEvent is not an event model> itself, it only
38	interfaces to whatever event model the main program happens to use in a	38	interfaces to whatever event model the main program happens to use, in a
39	pragmatic way. For event models and certain classes of immortals alike,	39	pragmatic way. For event models and certain classes of immortals alike,
40	the statement "there can only be one" is a bitter reality: In general,	40	the statement "there can only be one" is a bitter reality: In general,
41	only one event loop can be active at the same time in a process. AnyEvent	41	only one event loop can be active at the same time in a process. AnyEvent
42	helps hiding the differences between those event loops.	42	cannot change this, but it can hide the differences between those event
		43	loops.
43		44
44	The goal of AnyEvent is to offer module authors the ability to do event	45	The goal of AnyEvent is to offer module authors the ability to do event
45	programming (waiting for I/O or timer events) without subscribing to a	46	programming (waiting for I/O or timer events) without subscribing to a
46	religion, a way of living, and most importantly: without forcing your	47	religion, a way of living, and most importantly: without forcing your
47	module users into the same thing by forcing them to use the same event	48	module users into the same thing by forcing them to use the same event
48	model you use.	49	model you use.
49		50
50	For modules like POE or IO::Async (which is a total misnomer as it is	51	For modules like POE or IO::Async (which is a total misnomer as it is
51	actually doing all I/O I<synchronously>...), using them in your module is	52	actually doing all I/O I<synchronously>...), using them in your module is
52	like joining a cult: After you joined, you are dependent on them and you	53	like joining a cult: After you joined, you are dependent on them and you
53	cannot use anything else, as it is simply incompatible to everything that	54	cannot use anything else, as they are simply incompatible to everything
54	isn't itself. What's worse, all the potential users of your module are	55	that isn't them. What's worse, all the potential users of your
55	I<also> forced to use the same event loop you use.	56	module are I<also> forced to use the same event loop you use.
56		57
57	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	58	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
58	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	59	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
59	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	60	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
60	your module uses one of those, every user of your module has to use it,	61	your module uses one of those, every user of your module has to use it,
61	too. But if your module uses AnyEvent, it works transparently with all	62	too. But if your module uses AnyEvent, it works transparently with all
62	event models it supports (including stuff like POE and IO::Async, as long	63	event models it supports (including stuff like IO::Async, as long as those
63	as those use one of the supported event loops. It is trivial to add new	64	use one of the supported event loops. It is trivial to add new event loops
64	event loops to AnyEvent, too, so it is future-proof).	65	to AnyEvent, too, so it is future-proof).
65		66
66	In addition to being free of having to use I<the one and only true event	67	In addition to being free of having to use I<the one and only true event
67	model>, AnyEvent also is free of bloat and policy: with POE or similar	68	model>, AnyEvent also is free of bloat and policy: with POE or similar
68	modules, you get an enormous amount of code and strict rules you have to	69	modules, you get an enormous amount of code and strict rules you have to
69	follow. AnyEvent, on the other hand, is lean and up to the point, by only	70	follow. AnyEvent, on the other hand, is lean and up to the point, by only
…		…
303	=back	304	=back
304		305
305	=head2 SIGNAL WATCHERS	306	=head2 SIGNAL WATCHERS
306		307
307	You can watch for signals using a signal watcher, C<signal> is the signal	308	You can watch for signals using a signal watcher, C<signal> is the signal
308	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to	309	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
309	be invoked whenever a signal occurs.	310	callback to be invoked whenever a signal occurs.
310		311
311	Although the callback might get passed parameters, their value and	312	Although the callback might get passed parameters, their value and
312	presence is undefined and you cannot rely on them. Portable AnyEvent	313	presence is undefined and you cannot rely on them. Portable AnyEvent
313	callbacks cannot use arguments passed to signal watcher callbacks.	314	callbacks cannot use arguments passed to signal watcher callbacks.
314		315
…		…
825	no warnings;	826	no warnings;
826	use strict;	827	use strict;
827		828
828	use Carp;	829	use Carp;
829		830
830	our $VERSION = 4.2;	831	our $VERSION = 4.22;
831	our $MODEL;	832	our $MODEL;
832		833
833	our $AUTOLOAD;	834	our $AUTOLOAD;
834	our @ISA;	835	our @ISA;
835		836
…		…
938	$MODEL	939	$MODEL
939	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	940	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
940	}	941	}
941	}	942	}
942		943
		944	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		945
943	unshift @ISA, $MODEL;	946	unshift @ISA, $MODEL;
944	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	947
		948	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
945		949
946	(shift @post_detect)->() while @post_detect;	950	(shift @post_detect)->() while @post_detect;
947	}	951	}
948		952
949	$MODEL	953	$MODEL
…		…
957		961
958	detect unless $MODEL;	962	detect unless $MODEL;
959		963
960	my $class = shift;	964	my $class = shift;
961	$class->$func (@_);	965	$class->$func (@_);
		966	}
		967
		968	# utility function to dup a filehandle. this is used by many backends
		969	# to support binding more than one watcher per filehandle (they usually
		970	# allow only one watcher per fd, so we dup it to get a different one).
		971	sub _dupfh($$$$) {
		972	my ($poll, $fh, $r, $w) = @_;
		973
		974	require Fcntl;
		975
		976	# cygwin requires the fh mode to be matching, unix doesn't
		977	my ($rw, $mode) = $poll eq "r" ? ($r, "<")
		978	: $poll eq "w" ? ($w, ">")
		979	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
		980
		981	open my $fh2, "$mode&" . fileno $fh
		982	or die "cannot dup() filehandle: $!";
		983
		984	# we assume CLOEXEC is already set by perl in all important cases
		985
		986	($fh2, $rw)
962	}	987	}
963		988
964	package AnyEvent::Base;	989	package AnyEvent::Base;
965		990
966	# default implementation for now and time	991	# default implementation for now and time
…		…
1176	conditions, such as not being able to load the event model specified by	1201	conditions, such as not being able to load the event model specified by
1177	C<PERL_ANYEVENT_MODEL>.	1202	C<PERL_ANYEVENT_MODEL>.
1178		1203
1179	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1204	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1180	model it chooses.	1205	model it chooses.
		1206
		1207	=item C<PERL_ANYEVENT_STRICT>
		1208
		1209	AnyEvent does not do much argument checking by default, as thorough
		1210	argument checking is very costly. Setting this variable to a true value
		1211	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1212	check the arguments passed to most method calls. If it finds any problems
		1213	it will croak.
		1214
		1215	In other words, enables "strict" mode.
		1216
		1217	Unlike C<use strict> it is definitely recommended ot keep it off in
		1218	production.
1181		1219
1182	=item C<PERL_ANYEVENT_MODEL>	1220	=item C<PERL_ANYEVENT_MODEL>
1183		1221
1184	This can be used to specify the event model to be used by AnyEvent, before	1222	This can be used to specify the event model to be used by AnyEvent, before
1185	auto detection and -probing kicks in. It must be a string consisting	1223	auto detection and -probing kicks in. It must be a string consisting
…		…
1682		1720
1683	use AnyEvent;	1721	use AnyEvent;
1684		1722
1685	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	1723	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1686	be used to probe what backend is used and gain other information (which is	1724	be used to probe what backend is used and gain other information (which is
1687	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	1725	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		1726	$ENV{PERL_ANYEGENT_STRICT}.
1688		1727
1689		1728
1690	=head1 BUGS	1729	=head1 BUGS
1691		1730
1692	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	1731	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.166 by root, Tue Jul 8 23:10:20 2008 UTC vs. Revision 1.172 by root, Thu Jul 17 15:21:02 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.166 by root, Tue Jul 8 23:10:20 2008 UTC vs.
Revision 1.172 by root, Thu Jul 17 15:21:02 2008 UTC