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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.159 by root, Fri Jun 6 16:19:19 2008 UTC vs.
Revision 1.205 by root, Sun Apr 19 12:09:46 2009 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
…		…
127	These watchers are normal Perl objects with normal Perl lifetime. After	137	These watchers are normal Perl objects with normal Perl lifetime. After
128	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
129	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
130	is in control).	140	is in control).
131		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
132	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
133	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
134	to it).	150	to it).
135		151
136	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.
…		…
152	=head2 I/O WATCHERS	168	=head2 I/O WATCHERS
153		169
154	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
155	with the following mandatory key-value pairs as arguments:	171	with the following mandatory key-value pairs as arguments:
156		172
157	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch	173	C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch
		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
158	for events. C<poll> must be a string that is either C<r> or C<w>,	180	C<poll> must be a string that is either C<r> or C<w>, which creates a
159	which creates a watcher waiting for "r"eadable or "w"ritable events,	181	watcher waiting for "r"eadable or "w"ritable events, respectively.
		182
160	respectively. C<cb> is the callback to invoke each time the file handle	183	C<cb> is the callback to invoke each time the file handle becomes ready.
161	becomes ready.
162		184
163	Although the callback might get passed parameters, their value and	185	Although the callback might get passed parameters, their value and
164	presence is undefined and you cannot rely on them. Portable AnyEvent	186	presence is undefined and you cannot rely on them. Portable AnyEvent
165	callbacks cannot use arguments passed to I/O watcher callbacks.	187	callbacks cannot use arguments passed to I/O watcher callbacks.
166		188
…		…
170		192
171	Some event loops issue spurious readyness notifications, so you should	193	Some event loops issue spurious readyness notifications, so you should
172	always use non-blocking calls when reading/writing from/to your file	194	always use non-blocking calls when reading/writing from/to your file
173	handles.	195	handles.
174		196
175	Example:
176
177	# wait for readability of STDIN, then read a line and disable the watcher	197	Example: wait for readability of STDIN, then read a line and disable the
		198	watcher.
		199
178	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	200	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
179	chomp (my $input = <STDIN>);	201	chomp (my $input = <STDIN>);
180	warn "read: $input\n";	202	warn "read: $input\n";
181	undef $w;	203	undef $w;
182	});	204	});
…		…
192		214
193	Although the callback might get passed parameters, their value and	215	Although the callback might get passed parameters, their value and
194	presence is undefined and you cannot rely on them. Portable AnyEvent	216	presence is undefined and you cannot rely on them. Portable AnyEvent
195	callbacks cannot use arguments passed to time watcher callbacks.	217	callbacks cannot use arguments passed to time watcher callbacks.
196		218
197	The timer callback will be invoked at most once: if you want a repeating	219	The callback will normally be invoked once only. If you specify another
198	timer you have to create a new watcher (this is a limitation by both Tk	220	parameter, C<interval>, as a strictly positive number (> 0), then the
199	and Glib).	221	callback will be invoked regularly at that interval (in fractional
		222	seconds) after the first invocation. If C<interval> is specified with a
		223	false value, then it is treated as if it were missing.
200		224
201	Example:	225	The callback will be rescheduled before invoking the callback, but no
		226	attempt is done to avoid timer drift in most backends, so the interval is
		227	only approximate.
202		228
203	# fire an event after 7.7 seconds	229	Example: fire an event after 7.7 seconds.
		230
204	my $w = AnyEvent->timer (after => 7.7, cb => sub {	231	my $w = AnyEvent->timer (after => 7.7, cb => sub {
205	warn "timeout\n";	232	warn "timeout\n";
206	});	233	});
207		234
208	# to cancel the timer:	235	# to cancel the timer:
209	undef $w;	236	undef $w;
210		237
211	Example 2:
212
213	# fire an event after 0.5 seconds, then roughly every second	238	Example 2: fire an event after 0.5 seconds, then roughly every second.
214	my $w;
215		239
216	my $cb = sub {
217	# cancel the old timer while creating a new one
218	$w = AnyEvent->timer (after => 1, cb => $cb);	240	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
		241	warn "timeout\n";
219	};	242	};
220
221	# start the "loop" by creating the first watcher
222	$w = AnyEvent->timer (after => 0.5, cb => $cb);
223		243
224	=head3 TIMING ISSUES	244	=head3 TIMING ISSUES
225		245
226	There are two ways to handle timers: based on real time (relative, "fire	246	There are two ways to handle timers: based on real time (relative, "fire
227	in 10 seconds") and based on wallclock time (absolute, "fire at 12	247	in 10 seconds") and based on wallclock time (absolute, "fire at 12
…		…
300	In either case, if you care (and in most cases, you don't), then you	320	In either case, if you care (and in most cases, you don't), then you
301	can get whatever behaviour you want with any event loop, by taking the	321	can get whatever behaviour you want with any event loop, by taking the
302	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	322	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
303	account.	323	account.
304		324
		325	=item AnyEvent->now_update
		326
		327	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
		328	the current time for each loop iteration (see the discussion of L<<
		329	AnyEvent->now >>, above).
		330
		331	When a callback runs for a long time (or when the process sleeps), then
		332	this "current" time will differ substantially from the real time, which
		333	might affect timers and time-outs.
		334
		335	When this is the case, you can call this method, which will update the
		336	event loop's idea of "current time".
		337
		338	Note that updating the time I<might> cause some events to be handled.
		339
305	=back	340	=back
306		341
307	=head2 SIGNAL WATCHERS	342	=head2 SIGNAL WATCHERS
308		343
309	You can watch for signals using a signal watcher, C<signal> is the signal	344	You can watch for signals using a signal watcher, C<signal> is the signal
310	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to	345	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
311	be invoked whenever a signal occurs.	346	callback to be invoked whenever a signal occurs.
312		347
313	Although the callback might get passed parameters, their value and	348	Although the callback might get passed parameters, their value and
314	presence is undefined and you cannot rely on them. Portable AnyEvent	349	presence is undefined and you cannot rely on them. Portable AnyEvent
315	callbacks cannot use arguments passed to signal watcher callbacks.	350	callbacks cannot use arguments passed to signal watcher callbacks.
316		351
…		…
332	=head2 CHILD PROCESS WATCHERS	367	=head2 CHILD PROCESS WATCHERS
333		368
334	You can also watch on a child process exit and catch its exit status.	369	You can also watch on a child process exit and catch its exit status.
335		370
336	The child process is specified by the C<pid> argument (if set to C<0>, it	371	The child process is specified by the C<pid> argument (if set to C<0>, it
337	watches for any child process exit). The watcher will trigger as often	372	watches for any child process exit). The watcher will triggered only when
338	as status change for the child are received. This works by installing a	373	the child process has finished and an exit status is available, not on
339	signal handler for C<SIGCHLD>. The callback will be called with the pid	374	any trace events (stopped/continued).
340	and exit status (as returned by waitpid), so unlike other watcher types,	375
341	you I<can> rely on child watcher callback arguments.	376	The callback will be called with the pid and exit status (as returned by
		377	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		378	callback arguments.
		379
		380	This watcher type works by installing a signal handler for C<SIGCHLD>,
		381	and since it cannot be shared, nothing else should use SIGCHLD or reap
		382	random child processes (waiting for specific child processes, e.g. inside
		383	C<system>, is just fine).
342		384
343	There is a slight catch to child watchers, however: you usually start them	385	There is a slight catch to child watchers, however: you usually start them
344	I<after> the child process was created, and this means the process could	386	I<after> the child process was created, and this means the process could
345	have exited already (and no SIGCHLD will be sent anymore).	387	have exited already (and no SIGCHLD will be sent anymore).
346		388
…		…
382	The instrument to do that is called a "condition variable", so called	424	The instrument to do that is called a "condition variable", so called
383	because they represent a condition that must become true.	425	because they represent a condition that must become true.
384		426
385	Condition variables can be created by calling the C<< AnyEvent->condvar	427	Condition variables can be created by calling the C<< AnyEvent->condvar
386	>> method, usually without arguments. The only argument pair allowed is	428	>> method, usually without arguments. The only argument pair allowed is
		429
387	C<cb>, which specifies a callback to be called when the condition variable	430	C<cb>, which specifies a callback to be called when the condition variable
388	becomes true.	431	becomes true, with the condition variable as the first argument (but not
		432	the results).
389		433
390	After creation, the condition variable is "false" until it becomes "true"	434	After creation, the condition variable is "false" until it becomes "true"
391	by calling the C<send> method (or calling the condition variable as if it	435	by calling the C<send> method (or calling the condition variable as if it
392	were a callback, read about the caveats in the description for the C<<	436	were a callback, read about the caveats in the description for the C<<
393	->send >> method).	437	->send >> method).
…		…
449		493
450	my $done = AnyEvent->condvar;	494	my $done = AnyEvent->condvar;
451	my $delay = AnyEvent->timer (after => 5, cb => $done);	495	my $delay = AnyEvent->timer (after => 5, cb => $done);
452	$done->recv;	496	$done->recv;
453		497
		498	Example: Imagine an API that returns a condvar and doesn't support
		499	callbacks. This is how you make a synchronous call, for example from
		500	the main program:
		501
		502	use AnyEvent::CouchDB;
		503
		504	...
		505
		506	my @info = $couchdb->info->recv;
		507
		508	And this is how you would just ste a callback to be called whenever the
		509	results are available:
		510
		511	$couchdb->info->cb (sub {
		512	my @info = $_[0]->recv;
		513	});
		514
454	=head3 METHODS FOR PRODUCERS	515	=head3 METHODS FOR PRODUCERS
455		516
456	These methods should only be used by the producing side, i.e. the	517	These methods should only be used by the producing side, i.e. the
457	code/module that eventually sends the signal. Note that it is also	518	code/module that eventually sends the signal. Note that it is also
458	the producer side which creates the condvar in most cases, but it isn't	519	the producer side which creates the condvar in most cases, but it isn't
…		…
591	=item $bool = $cv->ready	652	=item $bool = $cv->ready
592		653
593	Returns true when the condition is "true", i.e. whether C<send> or	654	Returns true when the condition is "true", i.e. whether C<send> or
594	C<croak> have been called.	655	C<croak> have been called.
595		656
596	=item $cb = $cv->cb ([new callback])	657	=item $cb = $cv->cb ($cb->($cv))
597		658
598	This is a mutator function that returns the callback set and optionally	659	This is a mutator function that returns the callback set and optionally
599	replaces it before doing so.	660	replaces it before doing so.
600		661
601	The callback will be called when the condition becomes "true", i.e. when	662	The callback will be called when the condition becomes "true", i.e. when
…		…
738	=item L<AnyEvent::Util>	799	=item L<AnyEvent::Util>
739		800
740	Contains various utility functions that replace often-used but blocking	801	Contains various utility functions that replace often-used but blocking
741	functions such as C<inet_aton> by event-/callback-based versions.	802	functions such as C<inet_aton> by event-/callback-based versions.
742		803
743	=item L<AnyEvent::Handle>
744
745	Provide read and write buffers and manages watchers for reads and writes.
746
747	=item L<AnyEvent::Socket>	804	=item L<AnyEvent::Socket>
748		805
749	Provides various utility functions for (internet protocol) sockets,	806	Provides various utility functions for (internet protocol) sockets,
750	addresses and name resolution. Also functions to create non-blocking tcp	807	addresses and name resolution. Also functions to create non-blocking tcp
751	connections or tcp servers, with IPv6 and SRV record support and more.	808	connections or tcp servers, with IPv6 and SRV record support and more.
752		809
		810	=item L<AnyEvent::Handle>
		811
		812	Provide read and write buffers, manages watchers for reads and writes,
		813	supports raw and formatted I/O, I/O queued and fully transparent and
		814	non-blocking SSL/TLS.
		815
753	=item L<AnyEvent::DNS>	816	=item L<AnyEvent::DNS>
754		817
755	Provides rich asynchronous DNS resolver capabilities.	818	Provides rich asynchronous DNS resolver capabilities.
756		819
757	=item L<AnyEvent::HTTP>	820	=item L<AnyEvent::HTTP>
…		…
767		830
768	The fastest ping in the west.	831	The fastest ping in the west.
769		832
770	=item L<AnyEvent::DBI>	833	=item L<AnyEvent::DBI>
771		834
772	Executes DBI requests asynchronously in a proxy process.	835	Executes L<DBI> requests asynchronously in a proxy process.
773		836
		837	=item L<AnyEvent::AIO>
		838
		839	Truly asynchronous I/O, should be in the toolbox of every event
		840	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
		841	together.
		842
		843	=item L<AnyEvent::BDB>
		844
		845	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
		846	L<BDB> and AnyEvent together.
		847
		848	=item L<AnyEvent::GPSD>
		849
		850	A non-blocking interface to gpsd, a daemon delivering GPS information.
		851
		852	=item L<AnyEvent::IGS>
		853
		854	A non-blocking interface to the Internet Go Server protocol (used by
		855	L<App::IGS>).
		856
774	=item L<Net::IRC3>	857	=item L<AnyEvent::IRC>
775		858
776	AnyEvent based IRC client module family.	859	AnyEvent based IRC client module family (replacing the older Net::IRC3).
777		860
778	=item L<Net::XMPP2>	861	=item L<Net::XMPP2>
779		862
780	AnyEvent based XMPP (Jabber protocol) module family.	863	AnyEvent based XMPP (Jabber protocol) module family.
781		864
…		…
790		873
791	=item L<Coro>	874	=item L<Coro>
792		875
793	Has special support for AnyEvent via L<Coro::AnyEvent>.	876	Has special support for AnyEvent via L<Coro::AnyEvent>.
794		877
795	=item L<AnyEvent::AIO>, L<IO::AIO>
796
797	Truly asynchronous I/O, should be in the toolbox of every event
798	programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
799	together.
800
801	=item L<AnyEvent::BDB>, L<BDB>
802
803	Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
804	IO::AIO and AnyEvent together.
805
806	=item L<IO::Lambda>	878	=item L<IO::Lambda>
807		879
808	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.	880	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
809		881
810	=back	882	=back
…		…
812	=cut	884	=cut
813		885
814	package AnyEvent;	886	package AnyEvent;
815		887
816	no warnings;	888	no warnings;
817	use strict;	889	use strict qw(vars subs);
818		890
819	use Carp;	891	use Carp;
820		892
821	our $VERSION = 4.151;	893	our $VERSION = 4.351;
822	our $MODEL;	894	our $MODEL;
823		895
824	our $AUTOLOAD;	896	our $AUTOLOAD;
825	our @ISA;	897	our @ISA;
826		898
…		…
858	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	930	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
859	[Wx:: => AnyEvent::Impl::POE::],	931	[Wx:: => AnyEvent::Impl::POE::],
860	[Prima:: => AnyEvent::Impl::POE::],	932	[Prima:: => AnyEvent::Impl::POE::],
861	);	933	);
862		934
863	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);	935	our %method = map +($_ => 1),
		936	qw(io timer time now now_update signal child condvar one_event DESTROY);
864		937
865	our @post_detect;	938	our @post_detect;
866		939
867	sub post_detect(&) {	940	sub post_detect(&) {
868	my ($cb) = @_;	941	my ($cb) = @_;
…		…
925	last;	998	last;
926	}	999	}
927	}	1000	}
928		1001
929	$MODEL	1002	$MODEL
930	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1003	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
931	}	1004	}
932	}	1005	}
933		1006
		1007	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1008
934	unshift @ISA, $MODEL;	1009	unshift @ISA, $MODEL;
935	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1010
		1011	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
936		1012
937	(shift @post_detect)->() while @post_detect;	1013	(shift @post_detect)->() while @post_detect;
938	}	1014	}
939		1015
940	$MODEL	1016	$MODEL
…		…
950		1026
951	my $class = shift;	1027	my $class = shift;
952	$class->$func (@_);	1028	$class->$func (@_);
953	}	1029	}
954		1030
		1031	# utility function to dup a filehandle. this is used by many backends
		1032	# to support binding more than one watcher per filehandle (they usually
		1033	# allow only one watcher per fd, so we dup it to get a different one).
		1034	sub _dupfh($$$$) {
		1035	my ($poll, $fh, $r, $w) = @_;
		1036
		1037	# cygwin requires the fh mode to be matching, unix doesn't
		1038	my ($rw, $mode) = $poll eq "r" ? ($r, "<")
		1039	: $poll eq "w" ? ($w, ">")
		1040	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
		1041
		1042	open my $fh2, "$mode&" . fileno $fh
		1043	or die "cannot dup() filehandle: $!,";
		1044
		1045	# we assume CLOEXEC is already set by perl in all important cases
		1046
		1047	($fh2, $rw)
		1048	}
		1049
955	package AnyEvent::Base;	1050	package AnyEvent::Base;
956		1051
957	# default implementation for now and time	1052	# default implementations for many methods
958		1053
959	use Time::HiRes ();	1054	BEGIN {
		1055	if (eval "use Time::HiRes (); time (); 1") {
		1056	*_time = \&Time::HiRes::time;
		1057	# if (eval "use POSIX (); (POSIX::times())...
		1058	} else {
		1059	*_time = sub { time }; # epic fail
		1060	}
		1061	}
960		1062
961	sub time { Time::HiRes::time }	1063	sub time { _time }
962	sub now { Time::HiRes::time }	1064	sub now { _time }
		1065	sub now_update { }
963		1066
964	# default implementation for ->condvar	1067	# default implementation for ->condvar
965		1068
966	sub condvar {	1069	sub condvar {
967	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1070	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
968	}	1071	}
969		1072
970	# default implementation for ->signal	1073	# default implementation for ->signal
971		1074
972	our %SIG_CB;	1075	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1076
		1077	sub _signal_exec {
		1078	sysread $SIGPIPE_R, my $dummy, 4;
		1079
		1080	while (%SIG_EV) {
		1081	for (keys %SIG_EV) {
		1082	delete $SIG_EV{$_};
		1083	$_->() for values %{ $SIG_CB{$_} \|\| {} };
		1084	}
		1085	}
		1086	}
973		1087
974	sub signal {	1088	sub signal {
975	my (undef, %arg) = @_;	1089	my (undef, %arg) = @_;
976		1090
		1091	unless ($SIGPIPE_R) {
		1092	require Fcntl;
		1093
		1094	if (AnyEvent::WIN32) {
		1095	require AnyEvent::Util;
		1096
		1097	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1098	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
		1099	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
		1100	} else {
		1101	pipe $SIGPIPE_R, $SIGPIPE_W;
		1102	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1103	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1104	}
		1105
		1106	$SIGPIPE_R
		1107	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1108
		1109	# not strictly required, as $^F is normally 2, but let's make sure...
		1110	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1111	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1112
		1113	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1114	}
		1115
977	my $signal = uc $arg{signal}	1116	my $signal = uc $arg{signal}
978	or Carp::croak "required option 'signal' is missing";	1117	or Carp::croak "required option 'signal' is missing";
979		1118
980	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1119	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
981	$SIG{$signal} \|\|= sub {	1120	$SIG{$signal} \|\|= sub {
982	$_->() for values %{ $SIG_CB{$signal} \|\| {} };	1121	local $!;
		1122	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1123	undef $SIG_EV{$signal};
983	};	1124	};
984		1125
985	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1126	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
986	}	1127	}
987		1128
988	sub AnyEvent::Base::Signal::DESTROY {	1129	sub AnyEvent::Base::Signal::DESTROY {
989	my ($signal, $cb) = @{$_[0]};	1130	my ($signal, $cb) = @{$_[0]};
990		1131
991	delete $SIG_CB{$signal}{$cb};	1132	delete $SIG_CB{$signal}{$cb};
992		1133
993	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };	1134	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
994	}	1135	}
995		1136
996	# default implementation for ->child	1137	# default implementation for ->child
997		1138
998	our %PID_CB;	1139	our %PID_CB;
…		…
1106		1247
1107	# undocumented/compatibility with pre-3.4	1248	# undocumented/compatibility with pre-3.4
1108	*broadcast = \&send;	1249	*broadcast = \&send;
1109	*wait = \&_wait;	1250	*wait = \&_wait;
1110		1251
		1252	=head1 ERROR AND EXCEPTION HANDLING
		1253
		1254	In general, AnyEvent does not do any error handling - it relies on the
		1255	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1256	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1257	checking of all AnyEvent methods, however, which is highly useful during
		1258	development.
		1259
		1260	As for exception handling (i.e. runtime errors and exceptions thrown while
		1261	executing a callback), this is not only highly event-loop specific, but
		1262	also not in any way wrapped by this module, as this is the job of the main
		1263	program.
		1264
		1265	The pure perl event loop simply re-throws the exception (usually
		1266	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1267	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1268	so on.
		1269
		1270	=head1 ENVIRONMENT VARIABLES
		1271
		1272	The following environment variables are used by this module or its
		1273	submodules:
		1274
		1275	=over 4
		1276
		1277	=item C<PERL_ANYEVENT_VERBOSE>
		1278
		1279	By default, AnyEvent will be completely silent except in fatal
		1280	conditions. You can set this environment variable to make AnyEvent more
		1281	talkative.
		1282
		1283	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1284	conditions, such as not being able to load the event model specified by
		1285	C<PERL_ANYEVENT_MODEL>.
		1286
		1287	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1288	model it chooses.
		1289
		1290	=item C<PERL_ANYEVENT_STRICT>
		1291
		1292	AnyEvent does not do much argument checking by default, as thorough
		1293	argument checking is very costly. Setting this variable to a true value
		1294	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1295	check the arguments passed to most method calls. If it finds any problems
		1296	it will croak.
		1297
		1298	In other words, enables "strict" mode.
		1299
		1300	Unlike C<use strict>, it is definitely recommended ot keep it off in
		1301	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
		1302	developing programs can be very useful, however.
		1303
		1304	=item C<PERL_ANYEVENT_MODEL>
		1305
		1306	This can be used to specify the event model to be used by AnyEvent, before
		1307	auto detection and -probing kicks in. It must be a string consisting
		1308	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		1309	and the resulting module name is loaded and if the load was successful,
		1310	used as event model. If it fails to load AnyEvent will proceed with
		1311	auto detection and -probing.
		1312
		1313	This functionality might change in future versions.
		1314
		1315	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		1316	could start your program like this:
		1317
		1318	PERL_ANYEVENT_MODEL=Perl perl ...
		1319
		1320	=item C<PERL_ANYEVENT_PROTOCOLS>
		1321
		1322	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1323	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1324	of auto probing).
		1325
		1326	Must be set to a comma-separated list of protocols or address families,
		1327	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1328	used, and preference will be given to protocols mentioned earlier in the
		1329	list.
		1330
		1331	This variable can effectively be used for denial-of-service attacks
		1332	against local programs (e.g. when setuid), although the impact is likely
		1333	small, as the program has to handle conenction and other failures anyways.
		1334
		1335	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1336	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1337	- only support IPv4, never try to resolve or contact IPv6
		1338	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1339	IPv6, but prefer IPv6 over IPv4.
		1340
		1341	=item C<PERL_ANYEVENT_EDNS0>
		1342
		1343	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1344	for DNS. This extension is generally useful to reduce DNS traffic, but
		1345	some (broken) firewalls drop such DNS packets, which is why it is off by
		1346	default.
		1347
		1348	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1349	EDNS0 in its DNS requests.
		1350
		1351	=item C<PERL_ANYEVENT_MAX_FORKS>
		1352
		1353	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1354	will create in parallel.
		1355
		1356	=back
		1357
1111	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1358	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1112		1359
1113	This is an advanced topic that you do not normally need to use AnyEvent in	1360	This is an advanced topic that you do not normally need to use AnyEvent in
1114	a module. This section is only of use to event loop authors who want to	1361	a module. This section is only of use to event loop authors who want to
1115	provide AnyEvent compatibility.	1362	provide AnyEvent compatibility.
…		…
1148		1395
1149	I<rxvt-unicode> also cheats a bit by not providing blocking access to	1396	I<rxvt-unicode> also cheats a bit by not providing blocking access to
1150	condition variables: code blocking while waiting for a condition will	1397	condition variables: code blocking while waiting for a condition will
1151	C<die>. This still works with most modules/usages, and blocking calls must	1398	C<die>. This still works with most modules/usages, and blocking calls must
1152	not be done in an interactive application, so it makes sense.	1399	not be done in an interactive application, so it makes sense.
1153
1154	=head1 ENVIRONMENT VARIABLES
1155
1156	The following environment variables are used by this module:
1157
1158	=over 4
1159
1160	=item C<PERL_ANYEVENT_VERBOSE>
1161
1162	By default, AnyEvent will be completely silent except in fatal
1163	conditions. You can set this environment variable to make AnyEvent more
1164	talkative.
1165
1166	When set to C<1> or higher, causes AnyEvent to warn about unexpected
1167	conditions, such as not being able to load the event model specified by
1168	C<PERL_ANYEVENT_MODEL>.
1169
1170	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1171	model it chooses.
1172
1173	=item C<PERL_ANYEVENT_MODEL>
1174
1175	This can be used to specify the event model to be used by AnyEvent, before
1176	auto detection and -probing kicks in. It must be a string consisting
1177	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1178	and the resulting module name is loaded and if the load was successful,
1179	used as event model. If it fails to load AnyEvent will proceed with
1180	auto detection and -probing.
1181
1182	This functionality might change in future versions.
1183
1184	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1185	could start your program like this:
1186
1187	PERL_ANYEVENT_MODEL=Perl perl ...
1188
1189	=item C<PERL_ANYEVENT_PROTOCOLS>
1190
1191	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1192	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1193	of auto probing).
1194
1195	Must be set to a comma-separated list of protocols or address families,
1196	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1197	used, and preference will be given to protocols mentioned earlier in the
1198	list.
1199
1200	This variable can effectively be used for denial-of-service attacks
1201	against local programs (e.g. when setuid), although the impact is likely
1202	small, as the program has to handle connection errors already-
1203
1204	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1205	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1206	- only support IPv4, never try to resolve or contact IPv6
1207	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1208	IPv6, but prefer IPv6 over IPv4.
1209
1210	=item C<PERL_ANYEVENT_EDNS0>
1211
1212	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1213	for DNS. This extension is generally useful to reduce DNS traffic, but
1214	some (broken) firewalls drop such DNS packets, which is why it is off by
1215	default.
1216
1217	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1218	EDNS0 in its DNS requests.
1219
1220	=item C<PERL_ANYEVENT_MAX_FORKS>
1221
1222	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1223	will create in parallel.
1224
1225	=back
1226		1400
1227	=head1 EXAMPLE PROGRAM	1401	=head1 EXAMPLE PROGRAM
1228		1402
1229	The following program uses an I/O watcher to read data from STDIN, a timer	1403	The following program uses an I/O watcher to read data from STDIN, a timer
1230	to display a message once per second, and a condition variable to quit the	1404	to display a message once per second, and a condition variable to quit the
…		…
1424	watcher.	1598	watcher.
1425		1599
1426	=head3 Results	1600	=head3 Results
1427		1601
1428	name watchers bytes create invoke destroy comment	1602	name watchers bytes create invoke destroy comment
1429	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	1603	EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1430	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	1604	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1431	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	1605	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1432	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	1606	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1433	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	1607	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1434	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	1608	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1435	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	1609	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1436	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	1610	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1437	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	1611	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1438	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	1612	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1439		1613
1440	=head3 Discussion	1614	=head3 Discussion
1441		1615
1442	The benchmark does I<not> measure scalability of the event loop very	1616	The benchmark does I<not> measure scalability of the event loop very
1443	well. For example, a select-based event loop (such as the pure perl one)	1617	well. For example, a select-based event loop (such as the pure perl one)
…		…
1645	watchers, as the management overhead dominates.	1819	watchers, as the management overhead dominates.
1646		1820
1647	=back	1821	=back
1648		1822
1649		1823
		1824	=head1 SIGNALS
		1825
		1826	AnyEvent currently installs handlers for these signals:
		1827
		1828	=over 4
		1829
		1830	=item SIGCHLD
		1831
		1832	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		1833	emulation for event loops that do not support them natively. Also, some
		1834	event loops install a similar handler.
		1835
		1836	=item SIGPIPE
		1837
		1838	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		1839	when AnyEvent gets loaded.
		1840
		1841	The rationale for this is that AnyEvent users usually do not really depend
		1842	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		1843	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		1844	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		1845	some random socket.
		1846
		1847	The rationale for installing a no-op handler as opposed to ignoring it is
		1848	that this way, the handler will be restored to defaults on exec.
		1849
		1850	Feel free to install your own handler, or reset it to defaults.
		1851
		1852	=back
		1853
		1854	=cut
		1855
		1856	$SIG{PIPE} = sub { }
		1857	unless defined $SIG{PIPE};
		1858
		1859
1650	=head1 FORK	1860	=head1 FORK
1651		1861
1652	Most event libraries are not fork-safe. The ones who are usually are	1862	Most event libraries are not fork-safe. The ones who are usually are
1653	because they rely on inefficient but fork-safe C<select> or C<poll>	1863	because they rely on inefficient but fork-safe C<select> or C<poll>
1654	calls. Only L<EV> is fully fork-aware.	1864	calls. Only L<EV> is fully fork-aware.
…		…
1673		1883
1674	use AnyEvent;	1884	use AnyEvent;
1675		1885
1676	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	1886	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1677	be used to probe what backend is used and gain other information (which is	1887	be used to probe what backend is used and gain other information (which is
1678	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	1888	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		1889	$ENV{PERL_ANYEGENT_STRICT}.
1679		1890
1680		1891
1681	=head1 BUGS	1892	=head1 BUGS
1682		1893
1683	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	1894	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1684	to work around. If you suffer from memleaks, first upgrade to Perl 5.10	1895	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1685	and check wether the leaks still show up. (Perl 5.10.0 has other annoying	1896	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1686	mamleaks, such as leaking on C<map> and C<grep> but it is usually not as	1897	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1687	pronounced).	1898	pronounced).
1688		1899
1689		1900
1690	=head1 SEE ALSO	1901	=head1 SEE ALSO
1691		1902

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.159 by root, Fri Jun 6 16:19:19 2008 UTC vs. Revision 1.205 by root, Sun Apr 19 12:09:46 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.159 by root, Fri Jun 6 16:19:19 2008 UTC vs.
Revision 1.205 by root, Sun Apr 19 12:09:46 2009 UTC