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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.165 by root, Tue Jul 8 23:07:26 2008 UTC vs.
Revision 1.173 by root, Mon Jul 21 03:47:22 2008 UTC

…		…
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	use AnyEvent;	9	use AnyEvent;
10		10
11	my $w = AnyEvent->io (fh => $fh, poll => "r\|w", cb => sub {	11	my $w = AnyEvent->io (fh => $fh, poll => "r\|w", cb => sub { ... });
12	...
13	});
14		12
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {	13	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
		14	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
		15
		16	print AnyEvent->now; # prints current event loop time
		17	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
		18
		19	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
		20
		21	my $w = AnyEvent->child (pid => $pid, cb => sub {
		22	my ($pid, $status) = @_;
16	...	23	...
17	});	24	});
18		25
19	my $w = AnyEvent->condvar; # stores whether a condition was flagged	26	my $w = AnyEvent->condvar; # stores whether a condition was flagged
20	$w->send; # wake up current and all future recv's	27	$w->send; # wake up current and all future recv's
21	$w->recv; # enters "main loop" till $condvar gets ->send	28	$w->recv; # enters "main loop" till $condvar gets ->send
		29	# use a condvar in callback mode:
		30	$w->cb (sub { $_[0]->recv });
22		31
23	=head1 INTRODUCTION/TUTORIAL	32	=head1 INTRODUCTION/TUTORIAL
24		33
25	This manpage is mainly a reference manual. If you are interested	34	This manpage is mainly a reference manual. If you are interested
26	in a tutorial or some gentle introduction, have a look at the	35	in a tutorial or some gentle introduction, have a look at the
…		…
33		42
34	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	43	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
35	policy> and AnyEvent is I<small and efficient>.	44	policy> and AnyEvent is I<small and efficient>.
36		45
37	First and foremost, I<AnyEvent is not an event model> itself, it only	46	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	47	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,	48	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,	49	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	50	only one event loop can be active at the same time in a process. AnyEvent
42	helps hiding the differences between those event loops.	51	cannot change this, but it can hide the differences between those event
		52	loops.
43		53
44	The goal of AnyEvent is to offer module authors the ability to do event	54	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	55	programming (waiting for I/O or timer events) without subscribing to a
46	religion, a way of living, and most importantly: without forcing your	56	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	57	module users into the same thing by forcing them to use the same event
48	model you use.	58	model you use.
49		59
50	For modules like POE or IO::Async (which is a total misnomer as it is	60	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	61	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	62	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	63	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	64	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.	65	module are I<also> forced to use the same event loop you use.
56		66
57	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	67	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
58	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	68	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	69	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,	70	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	71	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	72	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	73	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).	74	to AnyEvent, too, so it is future-proof).
65		75
66	In addition to being free of having to use I<the one and only true event	76	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	77	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	78	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	79	follow. AnyEvent, on the other hand, is lean and up to the point, by only
…		…
152	=head2 I/O WATCHERS	162	=head2 I/O WATCHERS
153		163
154	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	164	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
155	with the following mandatory key-value pairs as arguments:	165	with the following mandatory key-value pairs as arguments:
156		166
157	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch	167	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events
158	for events. C<poll> must be a string that is either C<r> or C<w>,	168	(AnyEvent might or might not keep a reference to this file handle). C<poll>
159	which creates a watcher waiting for "r"eadable or "w"ritable events,	169	must be a string that is either C<r> or C<w>, which creates a watcher
160	respectively. C<cb> is the callback to invoke each time the file handle	170	waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the
161	becomes ready.	171	callback to invoke each time the file handle becomes ready.
162		172
163	Although the callback might get passed parameters, their value and	173	Although the callback might get passed parameters, their value and
164	presence is undefined and you cannot rely on them. Portable AnyEvent	174	presence is undefined and you cannot rely on them. Portable AnyEvent
165	callbacks cannot use arguments passed to I/O watcher callbacks.	175	callbacks cannot use arguments passed to I/O watcher callbacks.
166		176
…		…
303	=back	313	=back
304		314
305	=head2 SIGNAL WATCHERS	315	=head2 SIGNAL WATCHERS
306		316
307	You can watch for signals using a signal watcher, C<signal> is the signal	317	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	318	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
309	be invoked whenever a signal occurs.	319	callback to be invoked whenever a signal occurs.
310		320
311	Although the callback might get passed parameters, their value and	321	Although the callback might get passed parameters, their value and
312	presence is undefined and you cannot rely on them. Portable AnyEvent	322	presence is undefined and you cannot rely on them. Portable AnyEvent
313	callbacks cannot use arguments passed to signal watcher callbacks.	323	callbacks cannot use arguments passed to signal watcher callbacks.
314		324
…		…
379		389
380	The instrument to do that is called a "condition variable", so called	390	The instrument to do that is called a "condition variable", so called
381	because they represent a condition that must become true.	391	because they represent a condition that must become true.
382		392
383	Condition variables can be created by calling the C<< AnyEvent->condvar	393	Condition variables can be created by calling the C<< AnyEvent->condvar
		394
384	>> method, usually without arguments. The only argument pair allowed is	395	>> method, usually without arguments. The only argument pair allowed is
		396
385	C<cb>, which specifies a callback to be called when the condition variable	397	C<cb>, which specifies a callback to be called when the condition variable
386	becomes true.	398	becomes true, with the condition variable as the first argument (but not
		399	the results).
387		400
388	After creation, the condition variable is "false" until it becomes "true"	401	After creation, the condition variable is "false" until it becomes "true"
389	by calling the C<send> method (or calling the condition variable as if it	402	by calling the C<send> method (or calling the condition variable as if it
390	were a callback, read about the caveats in the description for the C<<	403	were a callback, read about the caveats in the description for the C<<
391	->send >> method).	404	->send >> method).
…		…
447		460
448	my $done = AnyEvent->condvar;	461	my $done = AnyEvent->condvar;
449	my $delay = AnyEvent->timer (after => 5, cb => $done);	462	my $delay = AnyEvent->timer (after => 5, cb => $done);
450	$done->recv;	463	$done->recv;
451		464
		465	Example: Imagine an API that returns a condvar and doesn't support
		466	callbacks. This is how you make a synchronous call, for example from
		467	the main program:
		468
		469	use AnyEvent::CouchDB;
		470
		471	...
		472
		473	my @info = $couchdb->info->recv;
		474
		475	And this is how you would just ste a callback to be called whenever the
		476	results are available:
		477
		478	$couchdb->info->cb (sub {
		479	my @info = $_[0]->recv;
		480	});
		481
452	=head3 METHODS FOR PRODUCERS	482	=head3 METHODS FOR PRODUCERS
453		483
454	These methods should only be used by the producing side, i.e. the	484	These methods should only be used by the producing side, i.e. the
455	code/module that eventually sends the signal. Note that it is also	485	code/module that eventually sends the signal. Note that it is also
456	the producer side which creates the condvar in most cases, but it isn't	486	the producer side which creates the condvar in most cases, but it isn't
…		…
589	=item $bool = $cv->ready	619	=item $bool = $cv->ready
590		620
591	Returns true when the condition is "true", i.e. whether C<send> or	621	Returns true when the condition is "true", i.e. whether C<send> or
592	C<croak> have been called.	622	C<croak> have been called.
593		623
594	=item $cb = $cv->cb ([new callback])	624	=item $cb = $cv->cb ($cb->($cv))
595		625
596	This is a mutator function that returns the callback set and optionally	626	This is a mutator function that returns the callback set and optionally
597	replaces it before doing so.	627	replaces it before doing so.
598		628
599	The callback will be called when the condition becomes "true", i.e. when	629	The callback will be called when the condition becomes "true", i.e. when
…		…
825	no warnings;	855	no warnings;
826	use strict;	856	use strict;
827		857
828	use Carp;	858	use Carp;
829		859
830	our $VERSION = 4.2;	860	our $VERSION = 4.22;
831	our $MODEL;	861	our $MODEL;
832		862
833	our $AUTOLOAD;	863	our $AUTOLOAD;
834	our @ISA;	864	our @ISA;
835		865
…		…
938	$MODEL	968	$MODEL
939	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	969	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
940	}	970	}
941	}	971	}
942		972
		973	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		974
943	unshift @ISA, $MODEL;	975	unshift @ISA, $MODEL;
944	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	976
		977	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
945		978
946	(shift @post_detect)->() while @post_detect;	979	(shift @post_detect)->() while @post_detect;
947	}	980	}
948		981
949	$MODEL	982	$MODEL
…		…
957		990
958	detect unless $MODEL;	991	detect unless $MODEL;
959		992
960	my $class = shift;	993	my $class = shift;
961	$class->$func (@_);	994	$class->$func (@_);
		995	}
		996
		997	# utility function to dup a filehandle. this is used by many backends
		998	# to support binding more than one watcher per filehandle (they usually
		999	# allow only one watcher per fd, so we dup it to get a different one).
		1000	sub _dupfh($$$$) {
		1001	my ($poll, $fh, $r, $w) = @_;
		1002
		1003	require Fcntl;
		1004
		1005	# cygwin requires the fh mode to be matching, unix doesn't
		1006	my ($rw, $mode) = $poll eq "r" ? ($r, "<")
		1007	: $poll eq "w" ? ($w, ">")
		1008	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
		1009
		1010	open my $fh2, "$mode&" . fileno $fh
		1011	or die "cannot dup() filehandle: $!";
		1012
		1013	# we assume CLOEXEC is already set by perl in all important cases
		1014
		1015	($fh2, $rw)
962	}	1016	}
963		1017
964	package AnyEvent::Base;	1018	package AnyEvent::Base;
965		1019
966	# default implementation for now and time	1020	# default implementation for now and time
…		…
1176	conditions, such as not being able to load the event model specified by	1230	conditions, such as not being able to load the event model specified by
1177	C<PERL_ANYEVENT_MODEL>.	1231	C<PERL_ANYEVENT_MODEL>.
1178		1232
1179	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1233	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1180	model it chooses.	1234	model it chooses.
		1235
		1236	=item C<PERL_ANYEVENT_STRICT>
		1237
		1238	AnyEvent does not do much argument checking by default, as thorough
		1239	argument checking is very costly. Setting this variable to a true value
		1240	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1241	check the arguments passed to most method calls. If it finds any problems
		1242	it will croak.
		1243
		1244	In other words, enables "strict" mode.
		1245
		1246	Unlike C<use strict> it is definitely recommended ot keep it off in
		1247	production.
1181		1248
1182	=item C<PERL_ANYEVENT_MODEL>	1249	=item C<PERL_ANYEVENT_MODEL>
1183		1250
1184	This can be used to specify the event model to be used by AnyEvent, before	1251	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	1252	auto detection and -probing kicks in. It must be a string consisting
…		…
1682		1749
1683	use AnyEvent;	1750	use AnyEvent;
1684		1751
1685	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	1752	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	1753	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).	1754	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		1755	$ENV{PERL_ANYEGENT_STRICT}.
1688		1756
1689		1757
1690	=head1 BUGS	1758	=head1 BUGS
1691		1759
1692	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	1760	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.165 by root, Tue Jul 8 23:07:26 2008 UTC vs. Revision 1.173 by root, Mon Jul 21 03:47:22 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.165 by root, Tue Jul 8 23:07:26 2008 UTC vs.
Revision 1.173 by root, Mon Jul 21 03:47:22 2008 UTC