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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.167 by root, Tue Jul 8 23:44:51 2008 UTC vs.
Revision 1.177 by root, Thu Aug 21 18:45:16 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
…		…
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
384	>> method, usually without arguments. The only argument pair allowed is	394	>> method, usually without arguments. The only argument pair allowed is
		395
385	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
386	becomes true.	397	becomes true, with the condition variable as the first argument (but not
		398	the results).
387		399
388	After creation, the condition variable is "false" until it becomes "true"	400	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	401	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<<	402	were a callback, read about the caveats in the description for the C<<
391	->send >> method).	403	->send >> method).
…		…
447		459
448	my $done = AnyEvent->condvar;	460	my $done = AnyEvent->condvar;
449	my $delay = AnyEvent->timer (after => 5, cb => $done);	461	my $delay = AnyEvent->timer (after => 5, cb => $done);
450	$done->recv;	462	$done->recv;
451		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
452	=head3 METHODS FOR PRODUCERS	481	=head3 METHODS FOR PRODUCERS
453		482
454	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
455	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
456	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
…		…
589	=item $bool = $cv->ready	618	=item $bool = $cv->ready
590		619
591	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
592	C<croak> have been called.	621	C<croak> have been called.
593		622
594	=item $cb = $cv->cb ([new callback])	623	=item $cb = $cv->cb ($cb->($cv))
595		624
596	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
597	replaces it before doing so.	626	replaces it before doing so.
598		627
599	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
…		…
825	no warnings;	854	no warnings;
826	use strict;	855	use strict;
827		856
828	use Carp;	857	use Carp;
829		858
830	our $VERSION = 4.2;	859	our $VERSION = 4.232;
831	our $MODEL;	860	our $MODEL;
832		861
833	our $AUTOLOAD;	862	our $AUTOLOAD;
834	our @ISA;	863	our @ISA;
835		864
…		…
940	}	969	}
941	}	970	}
942		971
943	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	972	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
944		973
945	if ($ENV{PERL_ANYEVENT_STRICT}) {
946	unshift @AnyEvent::Base::Strict::ISA, $MODEL;
947	unshift @ISA, AnyEvent::Base::Strict::
948	} else {
949	unshift @ISA, $MODEL;	974	unshift @ISA, $MODEL;
950	}	975
		976	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
951		977
952	(shift @post_detect)->() while @post_detect;	978	(shift @post_detect)->() while @post_detect;
953	}	979	}
954		980
955	$MODEL	981	$MODEL
…		…
963		989
964	detect unless $MODEL;	990	detect unless $MODEL;
965		991
966	my $class = shift;	992	my $class = shift;
967	$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)
968	}	1015	}
969		1016
970	package AnyEvent::Base;	1017	package AnyEvent::Base;
971		1018
972	# default implementation for now and time	1019	# default implementation for now and time
…		…
1121		1168
1122	# undocumented/compatibility with pre-3.4	1169	# undocumented/compatibility with pre-3.4
1123	*broadcast = \&send;	1170	*broadcast = \&send;
1124	*wait = \&_wait;	1171	*wait = \&_wait;
1125		1172
1126	package AnyEvent::Base::Strict;
1127
1128	use Carp qw(croak);
1129
1130	# supply checks for argument validity for many functions
1131
1132	sub io {
1133	my $class = shift;
1134	my %arg = @_;
1135
1136	ref $arg{cb}
1137	or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'";
1138	delete $arg{cb};
1139
1140	fileno $arg{fh}
1141	or croak "AnyEvent->io called with illegal fh argument '$arg{fh}'";
1142	delete $arg{fh};
1143
1144	$arg{poll} =~ /^[rw]$/
1145	or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'";
1146	delete $arg{poll};
1147
1148	croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg
1149	if keys %arg;
1150
1151	$class->SUPER::io (@_)
1152	}
1153
1154	sub timer {
1155	my $class = shift;
1156	my %arg = @_;
1157
1158	ref $arg{cb}
1159	or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'";
1160	delete $arg{cb};
1161
1162	exists $arg{after}
1163	or croak "AnyEvent->timer called without mandatory 'after' parameter";
1164	delete $arg{after};
1165
1166	$arg{interval} > 0 \|\| !$arg{interval}
1167	or croak "AnyEvent->timer called with illegal interval argument '$arg{interval}'";
1168	delete $arg{interval};
1169
1170	croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg
1171	if keys %arg;
1172
1173	$class->SUPER::timer (@_)
1174	}
1175
1176	sub signal {
1177	my $class = shift;
1178	my %arg = @_;
1179
1180	ref $arg{cb}
1181	or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
1182	delete $arg{cb};
1183
1184	eval "require POSIX; defined &POSIX::SIG$arg{signal}"
1185	or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'";
1186	delete $arg{signal};
1187
1188	croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
1189	if keys %arg;
1190
1191	$class->SUPER::signal (@_)
1192	}
1193
1194	sub child {
1195	my $class = shift;
1196	my %arg = @_;
1197
1198	ref $arg{cb}
1199	or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
1200	delete $arg{cb};
1201
1202	$arg{pid} =~ /^-?\d+$/
1203	or croak "AnyEvent->signal called with illegal pid value '$arg{pid}'";
1204	delete $arg{pid};
1205
1206	croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
1207	if keys %arg;
1208
1209	$class->SUPER::child (@_)
1210	}
1211
1212	sub condvar {
1213	my $class = shift;
1214	my %arg = @_;
1215
1216	!exists $arg{cb} or ref $arg{cb}
1217	or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'";
1218	delete $arg{cb};
1219
1220	croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg
1221	if keys %arg;
1222
1223	$class->SUPER::condvar (@_)
1224	}
1225
1226	sub time {
1227	my $class = shift;
1228
1229	@_
1230	and croak "AnyEvent->time wrongly called with paramaters";
1231
1232	$class->SUPER::time (@_)
1233	}
1234
1235	sub now {
1236	my $class = shift;
1237
1238	@_
1239	and croak "AnyEvent->now wrongly called with paramaters";
1240
1241	$class->SUPER::now (@_)
1242	}
1243
1244	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1173	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1245		1174
1246	This is an advanced topic that you do not normally need to use AnyEvent in	1175	This is an advanced topic that you do not normally need to use AnyEvent in
1247	a module. This section is only of use to event loop authors who want to	1176	a module. This section is only of use to event loop authors who want to
1248	provide AnyEvent compatibility.	1177	provide AnyEvent compatibility.
…		…
1305		1234
1306	=item C<PERL_ANYEVENT_STRICT>	1235	=item C<PERL_ANYEVENT_STRICT>
1307		1236
1308	AnyEvent does not do much argument checking by default, as thorough	1237	AnyEvent does not do much argument checking by default, as thorough
1309	argument checking is very costly. Setting this variable to a true value	1238	argument checking is very costly. Setting this variable to a true value
1310	will cause AnyEvent to thoroughly check the arguments passed to most	1239	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1311	method calls and croaks if it finds any problems. In other words, enables	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
1312	"strict" mode. Unlike C<use strict> it is definitely recommended ot keep	1245	Unlike C<use strict> it is definitely recommended ot keep it off in
1313	it off in production.	1246	production.
1314		1247
1315	=item C<PERL_ANYEVENT_MODEL>	1248	=item C<PERL_ANYEVENT_MODEL>
1316		1249
1317	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
1318	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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.167 by root, Tue Jul 8 23:44:51 2008 UTC vs. Revision 1.177 by root, Thu Aug 21 18:45:16 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.167 by root, Tue Jul 8 23:44:51 2008 UTC vs.
Revision 1.177 by root, Thu Aug 21 18:45:16 2008 UTC