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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.143 by root, Wed May 28 23:57:38 2008 UTC vs.
Revision 1.175 by root, Sun Jul 27 08:43:32 2008 UTC

…		…
1	=head1 => NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - provide framework for multiple event loops
4		4
5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops	5	EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops
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 });
		31
		32	=head1 INTRODUCTION/TUTORIAL
		33
		34	This manpage is mainly a reference manual. If you are interested
		35	in a tutorial or some gentle introduction, have a look at the
		36	L<AnyEvent::Intro> manpage.
22		37
23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	38	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24		39
25	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	40	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26	nowadays. So what is different about AnyEvent?	41	nowadays. So what is different about AnyEvent?
27		42
28	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	43	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29	policy> and AnyEvent is I<small and efficient>.	44	policy> and AnyEvent is I<small and efficient>.
30		45
31	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
32	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
33	pragmatic way. For event models and certain classes of immortals alike,	48	pragmatic way. For event models and certain classes of immortals alike,
34	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,
35	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
36	helps hiding the differences between those event loops.	51	cannot change this, but it can hide the differences between those event
		52	loops.
37		53
38	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
39	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
40	religion, a way of living, and most importantly: without forcing your	56	religion, a way of living, and most importantly: without forcing your
41	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
42	model you use.	58	model you use.
43		59
44	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
45	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
46	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
47	cannot use anything else, as it is simply incompatible to everything that	63	cannot use anything else, as they are simply incompatible to everything
48	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
49	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.
50		66
51	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	67	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52	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
53	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
54	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,
55	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
56	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
57	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
58	event loops to AnyEvent, too, so it is future-proof).	74	to AnyEvent, too, so it is future-proof).
59		75
60	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
61	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
62	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
63	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
132	Many watchers either are used with "recursion" (repeating timers for	148	Many watchers either are used with "recursion" (repeating timers for
133	example), or need to refer to their watcher object in other ways.	149	example), or need to refer to their watcher object in other ways.
134		150
135	An any way to achieve that is this pattern:	151	An any way to achieve that is this pattern:
136		152
137	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	153	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
138	# you can use $w here, for example to undef it	154	# you can use $w here, for example to undef it
139	undef $w;	155	undef $w;
140	});	156	});
141		157
142	Note that C<my $w; $w => combination. This is necessary because in Perl,	158	Note that C<my $w; $w => combination. This is necessary because in Perl,
143	my variables are only visible after the statement in which they are	159	my variables are only visible after the statement in which they are
144	declared.	160	declared.
145		161
146	=head2 I/O WATCHERS	162	=head2 I/O WATCHERS
147		163
148	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
149	with the following mandatory key-value pairs as arguments:	165	with the following mandatory key-value pairs as arguments:
150		166
151	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
152	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>
153	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
154	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
155	becomes ready.	171	callback to invoke each time the file handle becomes ready.
156		172
157	Although the callback might get passed parameters, their value and	173	Although the callback might get passed parameters, their value and
158	presence is undefined and you cannot rely on them. Portable AnyEvent	174	presence is undefined and you cannot rely on them. Portable AnyEvent
159	callbacks cannot use arguments passed to I/O watcher callbacks.	175	callbacks cannot use arguments passed to I/O watcher callbacks.
160		176
…		…
164		180
165	Some event loops issue spurious readyness notifications, so you should	181	Some event loops issue spurious readyness notifications, so you should
166	always use non-blocking calls when reading/writing from/to your file	182	always use non-blocking calls when reading/writing from/to your file
167	handles.	183	handles.
168		184
169	Example:
170
171	# wait for readability of STDIN, then read a line and disable the watcher	185	Example: wait for readability of STDIN, then read a line and disable the
		186	watcher.
		187
172	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	188	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
173	chomp (my $input = <STDIN>);	189	chomp (my $input = <STDIN>);
174	warn "read: $input\n";	190	warn "read: $input\n";
175	undef $w;	191	undef $w;
176	});	192	});
…		…
186		202
187	Although the callback might get passed parameters, their value and	203	Although the callback might get passed parameters, their value and
188	presence is undefined and you cannot rely on them. Portable AnyEvent	204	presence is undefined and you cannot rely on them. Portable AnyEvent
189	callbacks cannot use arguments passed to time watcher callbacks.	205	callbacks cannot use arguments passed to time watcher callbacks.
190		206
191	The timer callback will be invoked at most once: if you want a repeating	207	The callback will normally be invoked once only. If you specify another
192	timer you have to create a new watcher (this is a limitation by both Tk	208	parameter, C<interval>, as a strictly positive number (> 0), then the
193	and Glib).	209	callback will be invoked regularly at that interval (in fractional
		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.
194		212
195	Example:	213	The callback will be rescheduled before invoking the callback, but no
		214	attempt is done to avoid timer drift in most backends, so the interval is
		215	only approximate.
196		216
197	# fire an event after 7.7 seconds	217	Example: fire an event after 7.7 seconds.
		218
198	my $w = AnyEvent->timer (after => 7.7, cb => sub {	219	my $w = AnyEvent->timer (after => 7.7, cb => sub {
199	warn "timeout\n";	220	warn "timeout\n";
200	});	221	});
201		222
202	# to cancel the timer:	223	# to cancel the timer:
203	undef $w;	224	undef $w;
204		225
205	Example 2:
206
207	# fire an event after 0.5 seconds, then roughly every second	226	Example 2: fire an event after 0.5 seconds, then roughly every second.
208	my $w;
209		227
210	my $cb = sub {
211	# cancel the old timer while creating a new one
212	$w = AnyEvent->timer (after => 1, cb => $cb);	228	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
		229	warn "timeout\n";
213	};	230	};
214
215	# start the "loop" by creating the first watcher
216	$w = AnyEvent->timer (after => 0.5, cb => $cb);
217		231
218	=head3 TIMING ISSUES	232	=head3 TIMING ISSUES
219		233
220	There are two ways to handle timers: based on real time (relative, "fire	234	There are two ways to handle timers: based on real time (relative, "fire
221	in 10 seconds") and based on wallclock time (absolute, "fire at 12	235	in 10 seconds") and based on wallclock time (absolute, "fire at 12
…		…
243		257
244	This returns the "current wallclock time" as a fractional number of	258	This returns the "current wallclock time" as a fractional number of
245	seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>	259	seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
246	return, and the result is guaranteed to be compatible with those).	260	return, and the result is guaranteed to be compatible with those).
247		261
248	It progresses independently of any event loop processing.	262	It progresses independently of any event loop processing, i.e. each call
249		263	will check the system clock, which usually gets updated frequently.
250	In almost all cases (in all cases if you don't care), this is the function
251	to call when you want to know the current time.
252		264
253	=item AnyEvent->now	265	=item AnyEvent->now
254		266
255	This also returns the "current wallclock time", but unlike C<time>, above,	267	This also returns the "current wallclock time", but unlike C<time>, above,
256	this value might change only once per event loop iteration, depending on	268	this value might change only once per event loop iteration, depending on
257	the event loop (most return the same time as C<time>, above). This is the	269	the event loop (most return the same time as C<time>, above). This is the
258	time that AnyEvent timers get scheduled against.	270	time that AnyEvent's timers get scheduled against.
		271
		272	I<In almost all cases (in all cases if you don't care), this is the
		273	function to call when you want to know the current time.>
		274
		275	This function is also often faster then C<< AnyEvent->time >>, and
		276	thus the preferred method if you want some timestamp (for example,
		277	L<AnyEvent::Handle> uses this to update it's activity timeouts).
		278
		279	The rest of this section is only of relevance if you try to be very exact
		280	with your timing, you can skip it without bad conscience.
259		281
260	For a practical example of when these times differ, consider L<Event::Lib>	282	For a practical example of when these times differ, consider L<Event::Lib>
261	and L<EV> and the following set-up:	283	and L<EV> and the following set-up:
262		284
263	The event loop is running and has just invoked one of your callback at	285	The event loop is running and has just invoked one of your callback at
…		…
268		290
269	With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will	291	With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
270	both return C<501>, because that is the current time, and the timer will	292	both return C<501>, because that is the current time, and the timer will
271	be scheduled to fire at time=504 (C<501> + C<3>).	293	be scheduled to fire at time=504 (C<501> + C<3>).
272		294
273	With L<EV>m C<< AnyEvent->time >> returns C<501> (as that is the current	295	With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
274	time), but C<< AnyEvent->now >> returns C<500>, as that is the time the	296	time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
275	last event processing phase started. With L<EV>, your timer gets scheduled	297	last event processing phase started. With L<EV>, your timer gets scheduled
276	to run at time=503 (C<500> + C<3>).	298	to run at time=503 (C<500> + C<3>).
277		299
278	In one sense, L<Event::Lib> is more exact, as it uses the current time	300	In one sense, L<Event::Lib> is more exact, as it uses the current time
279	regardless of any delays introduced by event processing. However, most	301	regardless of any delays introduced by event processing. However, most
280	callbacks do not expect large delays in processing, so this causes a	302	callbacks do not expect large delays in processing, so this causes a
281	higher drift (and a lot more syscalls to get the current time).	303	higher drift (and a lot more system calls to get the current time).
282		304
283	In another sense, L<EV> is more exact, as your timer will be scheduled at	305	In another sense, L<EV> is more exact, as your timer will be scheduled at
284	the same time, regardless of how long event processing actually took.	306	the same time, regardless of how long event processing actually took.
285		307
286	In either case, if you care (and in most cases, you don't), then you	308	In either case, if you care (and in most cases, you don't), then you
…		…
291	=back	313	=back
292		314
293	=head2 SIGNAL WATCHERS	315	=head2 SIGNAL WATCHERS
294		316
295	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
296	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
297	be invoked whenever a signal occurs.	319	callback to be invoked whenever a signal occurs.
298		320
299	Although the callback might get passed parameters, their value and	321	Although the callback might get passed parameters, their value and
300	presence is undefined and you cannot rely on them. Portable AnyEvent	322	presence is undefined and you cannot rely on them. Portable AnyEvent
301	callbacks cannot use arguments passed to signal watcher callbacks.	323	callbacks cannot use arguments passed to signal watcher callbacks.
302		324
…		…
338	AnyEvent program, you I<have> to create at least one watcher before you	360	AnyEvent program, you I<have> to create at least one watcher before you
339	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	361	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
340		362
341	Example: fork a process and wait for it	363	Example: fork a process and wait for it
342		364
343	my $done = AnyEvent->condvar;	365	my $done = AnyEvent->condvar;
344		366
345	my $pid = fork or exit 5;	367	my $pid = fork or exit 5;
346		368
347	my $w = AnyEvent->child (	369	my $w = AnyEvent->child (
348	pid => $pid,	370	pid => $pid,
349	cb => sub {	371	cb => sub {
350	my ($pid, $status) = @_;	372	my ($pid, $status) = @_;
351	warn "pid $pid exited with status $status";	373	warn "pid $pid exited with status $status";
352	$done->send;	374	$done->send;
353	},	375	},
354	);	376	);
355		377
356	# do something else, then wait for process exit	378	# do something else, then wait for process exit
357	$done->recv;	379	$done->recv;
358		380
359	=head2 CONDITION VARIABLES	381	=head2 CONDITION VARIABLES
360		382
361	If you are familiar with some event loops you will know that all of them	383	If you are familiar with some event loops you will know that all of them
362	require you to run some blocking "loop", "run" or similar function that	384	require you to run some blocking "loop", "run" or similar function that
…		…
368	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
369	because they represent a condition that must become true.	391	because they represent a condition that must become true.
370		392
371	Condition variables can be created by calling the C<< AnyEvent->condvar	393	Condition variables can be created by calling the C<< AnyEvent->condvar
372	>> method, usually without arguments. The only argument pair allowed is	394	>> method, usually without arguments. The only argument pair allowed is
		395
373	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
374	becomes true.	397	becomes true, with the condition variable as the first argument (but not
		398	the results).
375		399
376	After creation, the condition variable is "false" until it becomes "true"	400	After creation, the condition variable is "false" until it becomes "true"
377	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
378	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<<
379	->send >> method).	403	->send >> method).
…		…
435		459
436	my $done = AnyEvent->condvar;	460	my $done = AnyEvent->condvar;
437	my $delay = AnyEvent->timer (after => 5, cb => $done);	461	my $delay = AnyEvent->timer (after => 5, cb => $done);
438	$done->recv;	462	$done->recv;
439		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
440	=head3 METHODS FOR PRODUCERS	481	=head3 METHODS FOR PRODUCERS
441		482
442	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
443	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
444	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
…		…
577	=item $bool = $cv->ready	618	=item $bool = $cv->ready
578		619
579	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
580	C<croak> have been called.	621	C<croak> have been called.
581		622
582	=item $cb = $cv->cb ([new callback])	623	=item $cb = $cv->cb ($cb->($cv))
583		624
584	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
585	replaces it before doing so.	626	replaces it before doing so.
586		627
587	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
588	C<send> or C<croak> are called. Calling C<recv> inside the callback	629	C<send> or C<croak> are called, with the only argument being the condition
589	or at any later time is guaranteed not to block.	630	variable itself. Calling C<recv> inside the callback or at any later time
		631	is guaranteed not to block.
590		632
591	=back	633	=back
592		634
593	=head1 GLOBAL VARIABLES AND FUNCTIONS	635	=head1 GLOBAL VARIABLES AND FUNCTIONS
594		636
…		…
723	=item L<AnyEvent::Util>	765	=item L<AnyEvent::Util>
724		766
725	Contains various utility functions that replace often-used but blocking	767	Contains various utility functions that replace often-used but blocking
726	functions such as C<inet_aton> by event-/callback-based versions.	768	functions such as C<inet_aton> by event-/callback-based versions.
727		769
728	=item L<AnyEvent::Handle>
729
730	Provide read and write buffers and manages watchers for reads and writes.
731
732	=item L<AnyEvent::Socket>	770	=item L<AnyEvent::Socket>
733		771
734	Provides various utility functions for (internet protocol) sockets,	772	Provides various utility functions for (internet protocol) sockets,
735	addresses and name resolution. Also functions to create non-blocking tcp	773	addresses and name resolution. Also functions to create non-blocking tcp
736	connections or tcp servers, with IPv6 and SRV record support and more.	774	connections or tcp servers, with IPv6 and SRV record support and more.
737		775
		776	=item L<AnyEvent::Handle>
		777
		778	Provide read and write buffers, manages watchers for reads and writes,
		779	supports raw and formatted I/O, I/O queued and fully transparent and
		780	non-blocking SSL/TLS.
		781
738	=item L<AnyEvent::DNS>	782	=item L<AnyEvent::DNS>
739		783
740	Provides rich asynchronous DNS resolver capabilities.	784	Provides rich asynchronous DNS resolver capabilities.
741		785
		786	=item L<AnyEvent::HTTP>
		787
		788	A simple-to-use HTTP library that is capable of making a lot of concurrent
		789	HTTP requests.
		790
742	=item L<AnyEvent::HTTPD>	791	=item L<AnyEvent::HTTPD>
743		792
744	Provides a simple web application server framework.	793	Provides a simple web application server framework.
745		794
746	=item L<AnyEvent::FastPing>	795	=item L<AnyEvent::FastPing>
747		796
748	The fastest ping in the west.	797	The fastest ping in the west.
		798
		799	=item L<AnyEvent::DBI>
		800
		801	Executes L<DBI> requests asynchronously in a proxy process.
		802
		803	=item L<AnyEvent::AIO>
		804
		805	Truly asynchronous I/O, should be in the toolbox of every event
		806	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
		807	together.
		808
		809	=item L<AnyEvent::BDB>
		810
		811	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
		812	L<BDB> and AnyEvent together.
		813
		814	=item L<AnyEvent::GPSD>
		815
		816	A non-blocking interface to gpsd, a daemon delivering GPS information.
		817
		818	=item L<AnyEvent::IGS>
		819
		820	A non-blocking interface to the Internet Go Server protocol (used by
		821	L<App::IGS>).
749		822
750	=item L<Net::IRC3>	823	=item L<Net::IRC3>
751		824
752	AnyEvent based IRC client module family.	825	AnyEvent based IRC client module family.
753		826
…		…
766		839
767	=item L<Coro>	840	=item L<Coro>
768		841
769	Has special support for AnyEvent via L<Coro::AnyEvent>.	842	Has special support for AnyEvent via L<Coro::AnyEvent>.
770		843
771	=item L<AnyEvent::AIO>, L<IO::AIO>
772
773	Truly asynchronous I/O, should be in the toolbox of every event
774	programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
775	together.
776
777	=item L<AnyEvent::BDB>, L<BDB>
778
779	Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
780	IO::AIO and AnyEvent together.
781
782	=item L<IO::Lambda>	844	=item L<IO::Lambda>
783		845
784	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.	846	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
785		847
786	=back	848	=back
…		…
792	no warnings;	854	no warnings;
793	use strict;	855	use strict;
794		856
795	use Carp;	857	use Carp;
796		858
797	our $VERSION = '4.05';	859	our $VERSION = 4.23;
798	our $MODEL;	860	our $MODEL;
799		861
800	our $AUTOLOAD;	862	our $AUTOLOAD;
801	our @ISA;	863	our @ISA;
802		864
…		…
905	$MODEL	967	$MODEL
906	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.";
907	}	969	}
908	}	970	}
909		971
		972	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		973
910	unshift @ISA, $MODEL;	974	unshift @ISA, $MODEL;
911	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	975
		976	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
912		977
913	(shift @post_detect)->() while @post_detect;	978	(shift @post_detect)->() while @post_detect;
914	}	979	}
915		980
916	$MODEL	981	$MODEL
…		…
924		989
925	detect unless $MODEL;	990	detect unless $MODEL;
926		991
927	my $class = shift;	992	my $class = shift;
928	$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)
929	}	1015	}
930		1016
931	package AnyEvent::Base;	1017	package AnyEvent::Base;
932		1018
933	# default implementation for now and time	1019	# default implementation for now and time
…		…
964	sub AnyEvent::Base::Signal::DESTROY {	1050	sub AnyEvent::Base::Signal::DESTROY {
965	my ($signal, $cb) = @{$_[0]};	1051	my ($signal, $cb) = @{$_[0]};
966		1052
967	delete $SIG_CB{$signal}{$cb};	1053	delete $SIG_CB{$signal}{$cb};
968		1054
969	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };	1055	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
970	}	1056	}
971		1057
972	# default implementation for ->child	1058	# default implementation for ->child
973		1059
974	our %PID_CB;	1060	our %PID_CB;
…		…
1144	C<PERL_ANYEVENT_MODEL>.	1230	C<PERL_ANYEVENT_MODEL>.
1145		1231
1146	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
1147	model it chooses.	1233	model it chooses.
1148		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.
		1247
1149	=item C<PERL_ANYEVENT_MODEL>	1248	=item C<PERL_ANYEVENT_MODEL>
1150		1249
1151	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
1152	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
1153	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	1252	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
…		…
1158	This functionality might change in future versions.	1257	This functionality might change in future versions.
1159		1258
1160	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	1259	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1161	could start your program like this:	1260	could start your program like this:
1162		1261
1163	PERL_ANYEVENT_MODEL=Perl perl ...	1262	PERL_ANYEVENT_MODEL=Perl perl ...
1164		1263
1165	=item C<PERL_ANYEVENT_PROTOCOLS>	1264	=item C<PERL_ANYEVENT_PROTOCOLS>
1166		1265
1167	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences	1266	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1168	for IPv4 or IPv6. The default is unspecified (and might change, or be the result	1267	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
…		…
1643	specified in the variable.	1742	specified in the variable.
1644		1743
1645	You can make AnyEvent completely ignore this variable by deleting it	1744	You can make AnyEvent completely ignore this variable by deleting it
1646	before the first watcher gets created, e.g. with a C<BEGIN> block:	1745	before the first watcher gets created, e.g. with a C<BEGIN> block:
1647		1746
1648	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }	1747	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1649		1748
1650	use AnyEvent;	1749	use AnyEvent;
1651		1750
1652	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	1751	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1653	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
1654	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}.
		1755
		1756
		1757	=head1 BUGS
		1758
		1759	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
		1760	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
		1761	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
		1762	mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
		1763	pronounced).
1655		1764
1656		1765
1657	=head1 SEE ALSO	1766	=head1 SEE ALSO
1658		1767
1659	Utility functions: L<AnyEvent::Util>.	1768	Utility functions: L<AnyEvent::Util>.
…		…
1676	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	1785	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1677		1786
1678		1787
1679	=head1 AUTHOR	1788	=head1 AUTHOR
1680		1789
1681	Marc Lehmann <schmorp@schmorp.de>	1790	Marc Lehmann <schmorp@schmorp.de>
1682	http://home.schmorp.de/	1791	http://home.schmorp.de/
1683		1792
1684	=cut	1793	=cut
1685		1794
1686	1	1795	1
1687		1796

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.143 by root, Wed May 28 23:57:38 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.143 by root, Wed May 28 23:57:38 2008 UTC vs.
Revision 1.175 by root, Sun Jul 27 08:43:32 2008 UTC