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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.164 by root, Tue Jul 8 19:50:25 2008 UTC vs.
Revision 1.175 by root, Sun Jul 27 08:43:32 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
…		…
193	Although the callback might get passed parameters, their value and	203	Although the callback might get passed parameters, their value and
194	presence is undefined and you cannot rely on them. Portable AnyEvent	204	presence is undefined and you cannot rely on them. Portable AnyEvent
195	callbacks cannot use arguments passed to time watcher callbacks.	205	callbacks cannot use arguments passed to time watcher callbacks.
196		206
197	The callback will normally be invoked once only. If you specify another	207	The callback will normally be invoked once only. If you specify another
198	parameter, C<interval>, as a positive number, then the callback will be	208	parameter, C<interval>, as a strictly positive number (> 0), then the
199	invoked regularly at that interval (in fractional seconds) after the first	209	callback will be invoked regularly at that interval (in fractional
200	invocation.	210	seconds) after the first invocation. If C<interval> is specified with a
		211	false value, then it is treated as if it were missing.
201		212
202	The callback will be rescheduled before invoking the callback, but no	213	The callback will be rescheduled before invoking the callback, but no
203	attempt is done to avoid timer drift in most backends, so the interval is	214	attempt is done to avoid timer drift in most backends, so the interval is
204	only approximate.	215	only approximate.
205		216
…		…
302	=back	313	=back
303		314
304	=head2 SIGNAL WATCHERS	315	=head2 SIGNAL WATCHERS
305		316
306	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
307	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
308	be invoked whenever a signal occurs.	319	callback to be invoked whenever a signal occurs.
309		320
310	Although the callback might get passed parameters, their value and	321	Although the callback might get passed parameters, their value and
311	presence is undefined and you cannot rely on them. Portable AnyEvent	322	presence is undefined and you cannot rely on them. Portable AnyEvent
312	callbacks cannot use arguments passed to signal watcher callbacks.	323	callbacks cannot use arguments passed to signal watcher callbacks.
313		324
…		…
379	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
380	because they represent a condition that must become true.	391	because they represent a condition that must become true.
381		392
382	Condition variables can be created by calling the C<< AnyEvent->condvar	393	Condition variables can be created by calling the C<< AnyEvent->condvar
383	>> method, usually without arguments. The only argument pair allowed is	394	>> method, usually without arguments. The only argument pair allowed is
		395
384	C<cb>, which specifies a callback to be called when the condition variable	396	C<cb>, which specifies a callback to be called when the condition variable
385	becomes true.	397	becomes true, with the condition variable as the first argument (but not
		398	the results).
386		399
387	After creation, the condition variable is "false" until it becomes "true"	400	After creation, the condition variable is "false" until it becomes "true"
388	by calling the C<send> method (or calling the condition variable as if it	401	by calling the C<send> method (or calling the condition variable as if it
389	were a callback, read about the caveats in the description for the C<<	402	were a callback, read about the caveats in the description for the C<<
390	->send >> method).	403	->send >> method).
…		…
446		459
447	my $done = AnyEvent->condvar;	460	my $done = AnyEvent->condvar;
448	my $delay = AnyEvent->timer (after => 5, cb => $done);	461	my $delay = AnyEvent->timer (after => 5, cb => $done);
449	$done->recv;	462	$done->recv;
450		463
		464	Example: Imagine an API that returns a condvar and doesn't support
		465	callbacks. This is how you make a synchronous call, for example from
		466	the main program:
		467
		468	use AnyEvent::CouchDB;
		469
		470	...
		471
		472	my @info = $couchdb->info->recv;
		473
		474	And this is how you would just ste a callback to be called whenever the
		475	results are available:
		476
		477	$couchdb->info->cb (sub {
		478	my @info = $_[0]->recv;
		479	});
		480
451	=head3 METHODS FOR PRODUCERS	481	=head3 METHODS FOR PRODUCERS
452		482
453	These methods should only be used by the producing side, i.e. the	483	These methods should only be used by the producing side, i.e. the
454	code/module that eventually sends the signal. Note that it is also	484	code/module that eventually sends the signal. Note that it is also
455	the producer side which creates the condvar in most cases, but it isn't	485	the producer side which creates the condvar in most cases, but it isn't
…		…
588	=item $bool = $cv->ready	618	=item $bool = $cv->ready
589		619
590	Returns true when the condition is "true", i.e. whether C<send> or	620	Returns true when the condition is "true", i.e. whether C<send> or
591	C<croak> have been called.	621	C<croak> have been called.
592		622
593	=item $cb = $cv->cb ([new callback])	623	=item $cb = $cv->cb ($cb->($cv))
594		624
595	This is a mutator function that returns the callback set and optionally	625	This is a mutator function that returns the callback set and optionally
596	replaces it before doing so.	626	replaces it before doing so.
597		627
598	The callback will be called when the condition becomes "true", i.e. when	628	The callback will be called when the condition becomes "true", i.e. when
…		…
824	no warnings;	854	no warnings;
825	use strict;	855	use strict;
826		856
827	use Carp;	857	use Carp;
828		858
829	our $VERSION = 4.2;	859	our $VERSION = 4.23;
830	our $MODEL;	860	our $MODEL;
831		861
832	our $AUTOLOAD;	862	our $AUTOLOAD;
833	our @ISA;	863	our @ISA;
834		864
…		…
937	$MODEL	967	$MODEL
938	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	968	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
939	}	969	}
940	}	970	}
941		971
		972	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		973
942	unshift @ISA, $MODEL;	974	unshift @ISA, $MODEL;
943	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	975
		976	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
944		977
945	(shift @post_detect)->() while @post_detect;	978	(shift @post_detect)->() while @post_detect;
946	}	979	}
947		980
948	$MODEL	981	$MODEL
…		…
956		989
957	detect unless $MODEL;	990	detect unless $MODEL;
958		991
959	my $class = shift;	992	my $class = shift;
960	$class->$func (@_);	993	$class->$func (@_);
		994	}
		995
		996	# utility function to dup a filehandle. this is used by many backends
		997	# 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).
		999	sub _dupfh($$$$) {
		1000	my ($poll, $fh, $r, $w) = @_;
		1001
		1002	require Fcntl;
		1003
		1004	# cygwin requires the fh mode to be matching, unix doesn't
		1005	my ($rw, $mode) = $poll eq "r" ? ($r, "<")
		1006	: $poll eq "w" ? ($w, ">")
		1007	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
		1008
		1009	open my $fh2, "$mode&" . fileno $fh
		1010	or die "cannot dup() filehandle: $!";
		1011
		1012	# we assume CLOEXEC is already set by perl in all important cases
		1013
		1014	($fh2, $rw)
961	}	1015	}
962		1016
963	package AnyEvent::Base;	1017	package AnyEvent::Base;
964		1018
965	# default implementation for now and time	1019	# default implementation for now and time
…		…
1175	conditions, such as not being able to load the event model specified by	1229	conditions, such as not being able to load the event model specified by
1176	C<PERL_ANYEVENT_MODEL>.	1230	C<PERL_ANYEVENT_MODEL>.
1177		1231
1178	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1232	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1179	model it chooses.	1233	model it chooses.
		1234
		1235	=item C<PERL_ANYEVENT_STRICT>
		1236
		1237	AnyEvent does not do much argument checking by default, as thorough
		1238	argument checking is very costly. Setting this variable to a true value
		1239	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1240	check the arguments passed to most method calls. If it finds any problems
		1241	it will croak.
		1242
		1243	In other words, enables "strict" mode.
		1244
		1245	Unlike C<use strict> it is definitely recommended ot keep it off in
		1246	production.
1180		1247
1181	=item C<PERL_ANYEVENT_MODEL>	1248	=item C<PERL_ANYEVENT_MODEL>
1182		1249
1183	This can be used to specify the event model to be used by AnyEvent, before	1250	This can be used to specify the event model to be used by AnyEvent, before
1184	auto detection and -probing kicks in. It must be a string consisting	1251	auto detection and -probing kicks in. It must be a string consisting
…		…
1681		1748
1682	use AnyEvent;	1749	use AnyEvent;
1683		1750
1684	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	1751	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1685	be used to probe what backend is used and gain other information (which is	1752	be used to probe what backend is used and gain other information (which is
1686	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	1753	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		1754	$ENV{PERL_ANYEGENT_STRICT}.
1687		1755
1688		1756
1689	=head1 BUGS	1757	=head1 BUGS
1690		1758
1691	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	1759	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.164 by root, Tue Jul 8 19:50:25 2008 UTC vs. Revision 1.175 by root, Sun Jul 27 08:43:32 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.164 by root, Tue Jul 8 19:50:25 2008 UTC vs.
Revision 1.175 by root, Sun Jul 27 08:43:32 2008 UTC