ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.99 by root, Sun Apr 27 17:09:33 2008 UTC vs.
Revision 1.173 by root, Mon Jul 21 03:47:22 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, Coro::EV, Coro::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	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) = @_;
12	...	23	...
13	});	24	});
14		25
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {
16	...
17	});
18
19	my $w = AnyEvent->condvar; # stores whether a condition was flagged	26	my $w = AnyEvent->condvar; # stores whether a condition was flagged
		27	$w->send; # wake up current and all future recv's
20	$w->wait; # enters "main loop" till $condvar gets ->broadcast	28	$w->recv; # enters "main loop" till $condvar gets ->send
21	$w->broadcast; # wake up current and all future wait's	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 enourmous 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
64	offering the functionality that is necessary, in as thin as a wrapper as	80	offering the functionality that is necessary, in as thin as a wrapper as
65	technically possible.	81	technically possible.
66		82
		83	Of course, AnyEvent comes with a big (and fully optional!) toolbox
		84	of useful functionality, such as an asynchronous DNS resolver, 100%
		85	non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
		86	such as Windows) and lots of real-world knowledge and workarounds for
		87	platform bugs and differences.
		88
67	Of course, if you want lots of policy (this can arguably be somewhat	89	Now, if you I<do want> lots of policy (this can arguably be somewhat
68	useful) and you want to force your users to use the one and only event	90	useful) and you want to force your users to use the one and only event
69	model, you should I<not> use this module.	91	model, you should I<not> use this module.
70
71	#TODO#
72
73	Net::IRC3
74	AnyEvent::HTTPD
75	AnyEvent::DNS
76	IO::AnyEvent
77	Net::FPing
78	Net::XMPP2
79	Coro
80
81	AnyEvent::IRC
82	AnyEvent::HTTPD
83	AnyEvent::DNS
84	AnyEvent::Handle
85	AnyEvent::Socket
86	AnyEvent::FPing
87	AnyEvent::XMPP
88	AnyEvent::SNMP
89	Coro
90		92
91	=head1 DESCRIPTION	93	=head1 DESCRIPTION
92		94
93	L<AnyEvent> provides an identical interface to multiple event loops. This	95	L<AnyEvent> provides an identical interface to multiple event loops. This
94	allows module authors to utilise an event loop without forcing module	96	allows module authors to utilise an event loop without forcing module
…		…
98	The interface itself is vaguely similar, but not identical to the L<Event>	100	The interface itself is vaguely similar, but not identical to the L<Event>
99	module.	101	module.
100		102
101	During the first call of any watcher-creation method, the module tries	103	During the first call of any watcher-creation method, the module tries
102	to detect the currently loaded event loop by probing whether one of the	104	to detect the currently loaded event loop by probing whether one of the
103	following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>,	105	following modules is already loaded: L<EV>,
104	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,	106	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,
105	L<POE>. The first one found is used. If none are found, the module tries	107	L<POE>. The first one found is used. If none are found, the module tries
106	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl	108	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl
107	adaptor should always succeed) in the order given. The first one that can	109	adaptor should always succeed) in the order given. The first one that can
108	be successfully loaded will be used. If, after this, still none could be	110	be successfully loaded will be used. If, after this, still none could be
…		…
122	starts using it, all bets are off. Maybe you should tell their authors to	124	starts using it, all bets are off. Maybe you should tell their authors to
123	use AnyEvent so their modules work together with others seamlessly...	125	use AnyEvent so their modules work together with others seamlessly...
124		126
125	The pure-perl implementation of AnyEvent is called	127	The pure-perl implementation of AnyEvent is called
126	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	128	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
127	explicitly.	129	explicitly and enjoy the high availability of that event loop :)
128		130
129	=head1 WATCHERS	131	=head1 WATCHERS
130		132
131	AnyEvent has the central concept of a I<watcher>, which is an object that	133	AnyEvent has the central concept of a I<watcher>, which is an object that
132	stores relevant data for each kind of event you are waiting for, such as	134	stores relevant data for each kind of event you are waiting for, such as
133	the callback to call, the filehandle to watch, etc.	135	the callback to call, the file handle to watch, etc.
134		136
135	These watchers are normal Perl objects with normal Perl lifetime. After	137	These watchers are normal Perl objects with normal Perl lifetime. After
136	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
137	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
138	is in control).	140	is in control).
…		…
146	Many watchers either are used with "recursion" (repeating timers for	148	Many watchers either are used with "recursion" (repeating timers for
147	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.
148		150
149	An any way to achieve that is this pattern:	151	An any way to achieve that is this pattern:
150		152
151	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {	153	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
152	# you can use $w here, for example to undef it	154	# you can use $w here, for example to undef it
153	undef $w;	155	undef $w;
154	});	156	});
155		157
156	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,
157	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
158	declared.	160	declared.
159		161
160	=head2 I/O WATCHERS	162	=head2 I/O WATCHERS
161		163
162	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
163	with the following mandatory key-value pairs as arguments:	165	with the following mandatory key-value pairs as arguments:
164		166
165	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
166	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>
167	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
168	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
169	becomes ready.	171	callback to invoke each time the file handle becomes ready.
170		172
171	Although the callback might get passed parameters, their value and	173	Although the callback might get passed parameters, their value and
172	presence is undefined and you cannot rely on them. Portable AnyEvent	174	presence is undefined and you cannot rely on them. Portable AnyEvent
173	callbacks cannot use arguments passed to I/O watcher callbacks.	175	callbacks cannot use arguments passed to I/O watcher callbacks.
174		176
…		…
178		180
179	Some event loops issue spurious readyness notifications, so you should	181	Some event loops issue spurious readyness notifications, so you should
180	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
181	handles.	183	handles.
182		184
183	Example:
184
185	# 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
186	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	188	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
187	chomp (my $input = <STDIN>);	189	chomp (my $input = <STDIN>);
188	warn "read: $input\n";	190	warn "read: $input\n";
189	undef $w;	191	undef $w;
190	});	192	});
…		…
200		202
201	Although the callback might get passed parameters, their value and	203	Although the callback might get passed parameters, their value and
202	presence is undefined and you cannot rely on them. Portable AnyEvent	204	presence is undefined and you cannot rely on them. Portable AnyEvent
203	callbacks cannot use arguments passed to time watcher callbacks.	205	callbacks cannot use arguments passed to time watcher callbacks.
204		206
205	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
206	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
207	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.
208		212
209	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.
210		216
211	# fire an event after 7.7 seconds	217	Example: fire an event after 7.7 seconds.
		218
212	my $w = AnyEvent->timer (after => 7.7, cb => sub {	219	my $w = AnyEvent->timer (after => 7.7, cb => sub {
213	warn "timeout\n";	220	warn "timeout\n";
214	});	221	});
215		222
216	# to cancel the timer:	223	# to cancel the timer:
217	undef $w;	224	undef $w;
218		225
219	Example 2:
220
221	# 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.
222	my $w;
223		227
224	my $cb = sub {
225	# cancel the old timer while creating a new one
226	$w = AnyEvent->timer (after => 1, cb => $cb);	228	my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
		229	warn "timeout\n";
227	};	230	};
228
229	# start the "loop" by creating the first watcher
230	$w = AnyEvent->timer (after => 0.5, cb => $cb);
231		231
232	=head3 TIMING ISSUES	232	=head3 TIMING ISSUES
233		233
234	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
235	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
…		…
247	timers.	247	timers.
248		248
249	AnyEvent always prefers relative timers, if available, matching the	249	AnyEvent always prefers relative timers, if available, matching the
250	AnyEvent API.	250	AnyEvent API.
251		251
		252	AnyEvent has two additional methods that return the "current time":
		253
		254	=over 4
		255
		256	=item AnyEvent->time
		257
		258	This returns the "current wallclock time" as a fractional number of
		259	seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
		260	return, and the result is guaranteed to be compatible with those).
		261
		262	It progresses independently of any event loop processing, i.e. each call
		263	will check the system clock, which usually gets updated frequently.
		264
		265	=item AnyEvent->now
		266
		267	This also returns the "current wallclock time", but unlike C<time>, above,
		268	this value might change only once per event loop iteration, depending on
		269	the event loop (most return the same time as C<time>, above). This is the
		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.
		281
		282	For a practical example of when these times differ, consider L<Event::Lib>
		283	and L<EV> and the following set-up:
		284
		285	The event loop is running and has just invoked one of your callback at
		286	time=500 (assume no other callbacks delay processing). In your callback,
		287	you wait a second by executing C<sleep 1> (blocking the process for a
		288	second) and then (at time=501) you create a relative timer that fires
		289	after three seconds.
		290
		291	With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
		292	both return C<501>, because that is the current time, and the timer will
		293	be scheduled to fire at time=504 (C<501> + C<3>).
		294
		295	With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
		296	time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
		297	last event processing phase started. With L<EV>, your timer gets scheduled
		298	to run at time=503 (C<500> + C<3>).
		299
		300	In one sense, L<Event::Lib> is more exact, as it uses the current time
		301	regardless of any delays introduced by event processing. However, most
		302	callbacks do not expect large delays in processing, so this causes a
		303	higher drift (and a lot more system calls to get the current time).
		304
		305	In another sense, L<EV> is more exact, as your timer will be scheduled at
		306	the same time, regardless of how long event processing actually took.
		307
		308	In either case, if you care (and in most cases, you don't), then you
		309	can get whatever behaviour you want with any event loop, by taking the
		310	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
		311	account.
		312
		313	=back
		314
252	=head2 SIGNAL WATCHERS	315	=head2 SIGNAL WATCHERS
253		316
254	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
255	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
256	be invoked whenever a signal occurs.	319	callback to be invoked whenever a signal occurs.
257		320
258	Although the callback might get passed parameters, their value and	321	Although the callback might get passed parameters, their value and
259	presence is undefined and you cannot rely on them. Portable AnyEvent	322	presence is undefined and you cannot rely on them. Portable AnyEvent
260	callbacks cannot use arguments passed to signal watcher callbacks.	323	callbacks cannot use arguments passed to signal watcher callbacks.
261		324
262	Multiple signal occurances can be clumped together into one callback	325	Multiple signal occurrences can be clumped together into one callback
263	invocation, and callback invocation will be synchronous. synchronous means	326	invocation, and callback invocation will be synchronous. Synchronous means
264	that it might take a while until the signal gets handled by the process,	327	that it might take a while until the signal gets handled by the process,
265	but it is guarenteed not to interrupt any other callbacks.	328	but it is guaranteed not to interrupt any other callbacks.
266		329
267	The main advantage of using these watchers is that you can share a signal	330	The main advantage of using these watchers is that you can share a signal
268	between multiple watchers.	331	between multiple watchers.
269		332
270	This watcher might use C<%SIG>, so programs overwriting those signals	333	This watcher might use C<%SIG>, so programs overwriting those signals
…		…
297	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
298	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	361	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
299		362
300	Example: fork a process and wait for it	363	Example: fork a process and wait for it
301		364
302	my $done = AnyEvent->condvar;	365	my $done = AnyEvent->condvar;
303		366
304	AnyEvent::detect; # force event module to be initialised
305
306	my $pid = fork or exit 5;	367	my $pid = fork or exit 5;
307		368
308	my $w = AnyEvent->child (	369	my $w = AnyEvent->child (
309	pid => $pid,	370	pid => $pid,
310	cb => sub {	371	cb => sub {
311	my ($pid, $status) = @_;	372	my ($pid, $status) = @_;
312	warn "pid $pid exited with status $status";	373	warn "pid $pid exited with status $status";
313	$done->broadcast;	374	$done->send;
314	},	375	},
315	);	376	);
316		377
317	# do something else, then wait for process exit	378	# do something else, then wait for process exit
318	$done->wait;	379	$done->recv;
319		380
320	=head2 CONDITION VARIABLES	381	=head2 CONDITION VARIABLES
321		382
		383	If you are familiar with some event loops you will know that all of them
		384	require you to run some blocking "loop", "run" or similar function that
		385	will actively watch for new events and call your callbacks.
		386
		387	AnyEvent is different, it expects somebody else to run the event loop and
		388	will only block when necessary (usually when told by the user).
		389
		390	The instrument to do that is called a "condition variable", so called
		391	because they represent a condition that must become true.
		392
322	Condition variables can be created by calling the C<< AnyEvent->condvar >>	393	Condition variables can be created by calling the C<< AnyEvent->condvar
323	method without any arguments.
324		394
325	A condition variable waits for a condition - precisely that the C<<	395	>> method, usually without arguments. The only argument pair allowed is
326	->broadcast >> method has been called.
327		396
328	They are very useful to signal that a condition has been fulfilled, for	397	C<cb>, which specifies a callback to be called when the condition variable
		398	becomes true, with the condition variable as the first argument (but not
		399	the results).
		400
		401	After creation, the condition variable is "false" until it becomes "true"
		402	by calling the C<send> method (or calling the condition variable as if it
		403	were a callback, read about the caveats in the description for the C<<
		404	->send >> method).
		405
		406	Condition variables are similar to callbacks, except that you can
		407	optionally wait for them. They can also be called merge points - points
		408	in time where multiple outstanding events have been processed. And yet
		409	another way to call them is transactions - each condition variable can be
		410	used to represent a transaction, which finishes at some point and delivers
		411	a result.
		412
		413	Condition variables are very useful to signal that something has finished,
329	example, if you write a module that does asynchronous http requests,	414	for example, if you write a module that does asynchronous http requests,
330	then a condition variable would be the ideal candidate to signal the	415	then a condition variable would be the ideal candidate to signal the
331	availability of results.	416	availability of results. The user can either act when the callback is
		417	called or can synchronously C<< ->recv >> for the results.
332		418
333	You can also use condition variables to block your main program until	419	You can also use them to simulate traditional event loops - for example,
334	an event occurs - for example, you could C<< ->wait >> in your main	420	you can block your main program until an event occurs - for example, you
335	program until the user clicks the Quit button in your app, which would C<<	421	could C<< ->recv >> in your main program until the user clicks the Quit
336	->broadcast >> the "quit" event.	422	button of your app, which would C<< ->send >> the "quit" event.
337		423
338	Note that condition variables recurse into the event loop - if you have	424	Note that condition variables recurse into the event loop - if you have
339	two pirces of code that call C<< ->wait >> in a round-robbin fashion, you	425	two pieces of code that call C<< ->recv >> in a round-robin fashion, you
340	lose. Therefore, condition variables are good to export to your caller, but	426	lose. Therefore, condition variables are good to export to your caller, but
341	you should avoid making a blocking wait yourself, at least in callbacks,	427	you should avoid making a blocking wait yourself, at least in callbacks,
342	as this asks for trouble.	428	as this asks for trouble.
343		429
344	This object has two methods:	430	Condition variables are represented by hash refs in perl, and the keys
		431	used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
		432	easy (it is often useful to build your own transaction class on top of
		433	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
		434	it's C<new> method in your own C<new> method.
		435
		436	There are two "sides" to a condition variable - the "producer side" which
		437	eventually calls C<< -> send >>, and the "consumer side", which waits
		438	for the send to occur.
		439
		440	Example: wait for a timer.
		441
		442	# wait till the result is ready
		443	my $result_ready = AnyEvent->condvar;
		444
		445	# do something such as adding a timer
		446	# or socket watcher the calls $result_ready->send
		447	# when the "result" is ready.
		448	# in this case, we simply use a timer:
		449	my $w = AnyEvent->timer (
		450	after => 1,
		451	cb => sub { $result_ready->send },
		452	);
		453
		454	# this "blocks" (while handling events) till the callback
		455	# calls send
		456	$result_ready->recv;
		457
		458	Example: wait for a timer, but take advantage of the fact that
		459	condition variables are also code references.
		460
		461	my $done = AnyEvent->condvar;
		462	my $delay = AnyEvent->timer (after => 5, cb => $done);
		463	$done->recv;
		464
		465	Example: Imagine an API that returns a condvar and doesn't support
		466	callbacks. This is how you make a synchronous call, for example from
		467	the main program:
		468
		469	use AnyEvent::CouchDB;
		470
		471	...
		472
		473	my @info = $couchdb->info->recv;
		474
		475	And this is how you would just ste a callback to be called whenever the
		476	results are available:
		477
		478	$couchdb->info->cb (sub {
		479	my @info = $_[0]->recv;
		480	});
		481
		482	=head3 METHODS FOR PRODUCERS
		483
		484	These methods should only be used by the producing side, i.e. the
		485	code/module that eventually sends the signal. Note that it is also
		486	the producer side which creates the condvar in most cases, but it isn't
		487	uncommon for the consumer to create it as well.
345		488
346	=over 4	489	=over 4
347		490
		491	=item $cv->send (...)
		492
		493	Flag the condition as ready - a running C<< ->recv >> and all further
		494	calls to C<recv> will (eventually) return after this method has been
		495	called. If nobody is waiting the send will be remembered.
		496
		497	If a callback has been set on the condition variable, it is called
		498	immediately from within send.
		499
		500	Any arguments passed to the C<send> call will be returned by all
		501	future C<< ->recv >> calls.
		502
		503	Condition variables are overloaded so one can call them directly
		504	(as a code reference). Calling them directly is the same as calling
		505	C<send>. Note, however, that many C-based event loops do not handle
		506	overloading, so as tempting as it may be, passing a condition variable
		507	instead of a callback does not work. Both the pure perl and EV loops
		508	support overloading, however, as well as all functions that use perl to
		509	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
		510	example).
		511
		512	=item $cv->croak ($error)
		513
		514	Similar to send, but causes all call's to C<< ->recv >> to invoke
		515	C<Carp::croak> with the given error message/object/scalar.
		516
		517	This can be used to signal any errors to the condition variable
		518	user/consumer.
		519
		520	=item $cv->begin ([group callback])
		521
348	=item $cv->wait	522	=item $cv->end
349		523
350	Wait (blocking if necessary) until the C<< ->broadcast >> method has been	524	These two methods are EXPERIMENTAL and MIGHT CHANGE.
		525
		526	These two methods can be used to combine many transactions/events into
		527	one. For example, a function that pings many hosts in parallel might want
		528	to use a condition variable for the whole process.
		529
		530	Every call to C<< ->begin >> will increment a counter, and every call to
		531	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
		532	>>, the (last) callback passed to C<begin> will be executed. That callback
		533	is I<supposed> to call C<< ->send >>, but that is not required. If no
		534	callback was set, C<send> will be called without any arguments.
		535
		536	Let's clarify this with the ping example:
		537
		538	my $cv = AnyEvent->condvar;
		539
		540	my %result;
		541	$cv->begin (sub { $cv->send (\%result) });
		542
		543	for my $host (@list_of_hosts) {
		544	$cv->begin;
		545	ping_host_then_call_callback $host, sub {
		546	$result{$host} = ...;
		547	$cv->end;
		548	};
		549	}
		550
		551	$cv->end;
		552
		553	This code fragment supposedly pings a number of hosts and calls
		554	C<send> after results for all then have have been gathered - in any
		555	order. To achieve this, the code issues a call to C<begin> when it starts
		556	each ping request and calls C<end> when it has received some result for
		557	it. Since C<begin> and C<end> only maintain a counter, the order in which
		558	results arrive is not relevant.
		559
		560	There is an additional bracketing call to C<begin> and C<end> outside the
		561	loop, which serves two important purposes: first, it sets the callback
		562	to be called once the counter reaches C<0>, and second, it ensures that
		563	C<send> is called even when C<no> hosts are being pinged (the loop
		564	doesn't execute once).
		565
		566	This is the general pattern when you "fan out" into multiple subrequests:
		567	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
		568	is called at least once, and then, for each subrequest you start, call
		569	C<begin> and for each subrequest you finish, call C<end>.
		570
		571	=back
		572
		573	=head3 METHODS FOR CONSUMERS
		574
		575	These methods should only be used by the consuming side, i.e. the
		576	code awaits the condition.
		577
		578	=over 4
		579
		580	=item $cv->recv
		581
		582	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
351	called on c<$cv>, while servicing other watchers normally.	583	>> methods have been called on c<$cv>, while servicing other watchers
		584	normally.
352		585
353	You can only wait once on a condition - additional calls will return	586	You can only wait once on a condition - additional calls are valid but
354	immediately.	587	will return immediately.
		588
		589	If an error condition has been set by calling C<< ->croak >>, then this
		590	function will call C<croak>.
		591
		592	In list context, all parameters passed to C<send> will be returned,
		593	in scalar context only the first one will be returned.
355		594
356	Not all event models support a blocking wait - some die in that case	595	Not all event models support a blocking wait - some die in that case
357	(programs might want to do that to stay interactive), so I<if you are	596	(programs might want to do that to stay interactive), so I<if you are
358	using this from a module, never require a blocking wait>, but let the	597	using this from a module, never require a blocking wait>, but let the
359	caller decide whether the call will block or not (for example, by coupling	598	caller decide whether the call will block or not (for example, by coupling
360	condition variables with some kind of request results and supporting	599	condition variables with some kind of request results and supporting
361	callbacks so the caller knows that getting the result will not block,	600	callbacks so the caller knows that getting the result will not block,
362	while still suppporting blocking waits if the caller so desires).	601	while still supporting blocking waits if the caller so desires).
363		602
364	Another reason I<never> to C<< ->wait >> in a module is that you cannot	603	Another reason I<never> to C<< ->recv >> in a module is that you cannot
365	sensibly have two C<< ->wait >>'s in parallel, as that would require	604	sensibly have two C<< ->recv >>'s in parallel, as that would require
366	multiple interpreters or coroutines/threads, none of which C<AnyEvent>	605	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
367	can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and	606	can supply.
368	L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
369	from different coroutines, however).
370		607
371	=item $cv->broadcast	608	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
		609	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
		610	versions and also integrates coroutines into AnyEvent, making blocking
		611	C<< ->recv >> calls perfectly safe as long as they are done from another
		612	coroutine (one that doesn't run the event loop).
372		613
373	Flag the condition as ready - a running C<< ->wait >> and all further	614	You can ensure that C<< -recv >> never blocks by setting a callback and
374	calls to C<wait> will (eventually) return after this method has been	615	only calling C<< ->recv >> from within that callback (or at a later
375	called. If nobody is waiting the broadcast will be remembered..	616	time). This will work even when the event loop does not support blocking
		617	waits otherwise.
		618
		619	=item $bool = $cv->ready
		620
		621	Returns true when the condition is "true", i.e. whether C<send> or
		622	C<croak> have been called.
		623
		624	=item $cb = $cv->cb ($cb->($cv))
		625
		626	This is a mutator function that returns the callback set and optionally
		627	replaces it before doing so.
		628
		629	The callback will be called when the condition becomes "true", i.e. when
		630	C<send> or C<croak> are called, with the only argument being the condition
		631	variable itself. Calling C<recv> inside the callback or at any later time
		632	is guaranteed not to block.
376		633
377	=back	634	=back
378
379	Example:
380
381	# wait till the result is ready
382	my $result_ready = AnyEvent->condvar;
383
384	# do something such as adding a timer
385	# or socket watcher the calls $result_ready->broadcast
386	# when the "result" is ready.
387	# in this case, we simply use a timer:
388	my $w = AnyEvent->timer (
389	after => 1,
390	cb => sub { $result_ready->broadcast },
391	);
392
393	# this "blocks" (while handling events) till the watcher
394	# calls broadcast
395	$result_ready->wait;
396		635
397	=head1 GLOBAL VARIABLES AND FUNCTIONS	636	=head1 GLOBAL VARIABLES AND FUNCTIONS
398		637
399	=over 4	638	=over 4
400		639
…		…
406	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	645	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case
407	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	646	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
408		647
409	The known classes so far are:	648	The known classes so far are:
410		649
411	AnyEvent::Impl::CoroEV based on Coro::EV, best choice.
412	AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice.
413	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).	650	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
414	AnyEvent::Impl::Event based on Event, second best choice.	651	AnyEvent::Impl::Event based on Event, second best choice.
		652	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
415	AnyEvent::Impl::Glib based on Glib, third-best choice.	653	AnyEvent::Impl::Glib based on Glib, third-best choice.
416	AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable.
417	AnyEvent::Impl::Tk based on Tk, very bad choice.	654	AnyEvent::Impl::Tk based on Tk, very bad choice.
418	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).	655	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
419	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.	656	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
420	AnyEvent::Impl::POE based on POE, not generic enough for full support.	657	AnyEvent::Impl::POE based on POE, not generic enough for full support.
421		658
…		…
434	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	671	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
435	if necessary. You should only call this function right before you would	672	if necessary. You should only call this function right before you would
436	have created an AnyEvent watcher anyway, that is, as late as possible at	673	have created an AnyEvent watcher anyway, that is, as late as possible at
437	runtime.	674	runtime.
438		675
		676	=item $guard = AnyEvent::post_detect { BLOCK }
		677
		678	Arranges for the code block to be executed as soon as the event model is
		679	autodetected (or immediately if this has already happened).
		680
		681	If called in scalar or list context, then it creates and returns an object
		682	that automatically removes the callback again when it is destroyed. See
		683	L<Coro::BDB> for a case where this is useful.
		684
		685	=item @AnyEvent::post_detect
		686
		687	If there are any code references in this array (you can C<push> to it
		688	before or after loading AnyEvent), then they will called directly after
		689	the event loop has been chosen.
		690
		691	You should check C<$AnyEvent::MODEL> before adding to this array, though:
		692	if it contains a true value then the event loop has already been detected,
		693	and the array will be ignored.
		694
		695	Best use C<AnyEvent::post_detect { BLOCK }> instead.
		696
439	=back	697	=back
440		698
441	=head1 WHAT TO DO IN A MODULE	699	=head1 WHAT TO DO IN A MODULE
442		700
443	As a module author, you should C<use AnyEvent> and call AnyEvent methods	701	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
446	Be careful when you create watchers in the module body - AnyEvent will	704	Be careful when you create watchers in the module body - AnyEvent will
447	decide which event module to use as soon as the first method is called, so	705	decide which event module to use as soon as the first method is called, so
448	by calling AnyEvent in your module body you force the user of your module	706	by calling AnyEvent in your module body you force the user of your module
449	to load the event module first.	707	to load the event module first.
450		708
451	Never call C<< ->wait >> on a condition variable unless you I<know> that	709	Never call C<< ->recv >> on a condition variable unless you I<know> that
452	the C<< ->broadcast >> method has been called on it already. This is	710	the C<< ->send >> method has been called on it already. This is
453	because it will stall the whole program, and the whole point of using	711	because it will stall the whole program, and the whole point of using
454	events is to stay interactive.	712	events is to stay interactive.
455		713
456	It is fine, however, to call C<< ->wait >> when the user of your module	714	It is fine, however, to call C<< ->recv >> when the user of your module
457	requests it (i.e. if you create a http request object ad have a method	715	requests it (i.e. if you create a http request object ad have a method
458	called C<results> that returns the results, it should call C<< ->wait >>	716	called C<results> that returns the results, it should call C<< ->recv >>
459	freely, as the user of your module knows what she is doing. always).	717	freely, as the user of your module knows what she is doing. always).
460		718
461	=head1 WHAT TO DO IN THE MAIN PROGRAM	719	=head1 WHAT TO DO IN THE MAIN PROGRAM
462		720
463	There will always be a single main program - the only place that should	721	There will always be a single main program - the only place that should
…		…
465		723
466	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	724	If it doesn't care, it can just "use AnyEvent" and use it itself, or not
467	do anything special (it does not need to be event-based) and let AnyEvent	725	do anything special (it does not need to be event-based) and let AnyEvent
468	decide which implementation to chose if some module relies on it.	726	decide which implementation to chose if some module relies on it.
469		727
470	If the main program relies on a specific event model. For example, in	728	If the main program relies on a specific event model - for example, in
471	Gtk2 programs you have to rely on the Glib module. You should load the	729	Gtk2 programs you have to rely on the Glib module - you should load the
472	event module before loading AnyEvent or any module that uses it: generally	730	event module before loading AnyEvent or any module that uses it: generally
473	speaking, you should load it as early as possible. The reason is that	731	speaking, you should load it as early as possible. The reason is that
474	modules might create watchers when they are loaded, and AnyEvent will	732	modules might create watchers when they are loaded, and AnyEvent will
475	decide on the event model to use as soon as it creates watchers, and it	733	decide on the event model to use as soon as it creates watchers, and it
476	might chose the wrong one unless you load the correct one yourself.	734	might chose the wrong one unless you load the correct one yourself.
477		735
478	You can chose to use a rather inefficient pure-perl implementation by	736	You can chose to use a pure-perl implementation by loading the
479	loading the C<AnyEvent::Impl::Perl> module, which gives you similar	737	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
480	behaviour everywhere, but letting AnyEvent chose is generally better.	738	everywhere, but letting AnyEvent chose the model is generally better.
		739
		740	=head2 MAINLOOP EMULATION
		741
		742	Sometimes (often for short test scripts, or even standalone programs who
		743	only want to use AnyEvent), you do not want to run a specific event loop.
		744
		745	In that case, you can use a condition variable like this:
		746
		747	AnyEvent->condvar->recv;
		748
		749	This has the effect of entering the event loop and looping forever.
		750
		751	Note that usually your program has some exit condition, in which case
		752	it is better to use the "traditional" approach of storing a condition
		753	variable somewhere, waiting for it, and sending it when the program should
		754	exit cleanly.
		755
		756
		757	=head1 OTHER MODULES
		758
		759	The following is a non-exhaustive list of additional modules that use
		760	AnyEvent and can therefore be mixed easily with other AnyEvent modules
		761	in the same program. Some of the modules come with AnyEvent, some are
		762	available via CPAN.
		763
		764	=over 4
		765
		766	=item L<AnyEvent::Util>
		767
		768	Contains various utility functions that replace often-used but blocking
		769	functions such as C<inet_aton> by event-/callback-based versions.
		770
		771	=item L<AnyEvent::Socket>
		772
		773	Provides various utility functions for (internet protocol) sockets,
		774	addresses and name resolution. Also functions to create non-blocking tcp
		775	connections or tcp servers, with IPv6 and SRV record support and more.
		776
		777	=item L<AnyEvent::Handle>
		778
		779	Provide read and write buffers, manages watchers for reads and writes,
		780	supports raw and formatted I/O, I/O queued and fully transparent and
		781	non-blocking SSL/TLS.
		782
		783	=item L<AnyEvent::DNS>
		784
		785	Provides rich asynchronous DNS resolver capabilities.
		786
		787	=item L<AnyEvent::HTTP>
		788
		789	A simple-to-use HTTP library that is capable of making a lot of concurrent
		790	HTTP requests.
		791
		792	=item L<AnyEvent::HTTPD>
		793
		794	Provides a simple web application server framework.
		795
		796	=item L<AnyEvent::FastPing>
		797
		798	The fastest ping in the west.
		799
		800	=item L<AnyEvent::DBI>
		801
		802	Executes L<DBI> requests asynchronously in a proxy process.
		803
		804	=item L<AnyEvent::AIO>
		805
		806	Truly asynchronous I/O, should be in the toolbox of every event
		807	programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
		808	together.
		809
		810	=item L<AnyEvent::BDB>
		811
		812	Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
		813	L<BDB> and AnyEvent together.
		814
		815	=item L<AnyEvent::GPSD>
		816
		817	A non-blocking interface to gpsd, a daemon delivering GPS information.
		818
		819	=item L<AnyEvent::IGS>
		820
		821	A non-blocking interface to the Internet Go Server protocol (used by
		822	L<App::IGS>).
		823
		824	=item L<Net::IRC3>
		825
		826	AnyEvent based IRC client module family.
		827
		828	=item L<Net::XMPP2>
		829
		830	AnyEvent based XMPP (Jabber protocol) module family.
		831
		832	=item L<Net::FCP>
		833
		834	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
		835	of AnyEvent.
		836
		837	=item L<Event::ExecFlow>
		838
		839	High level API for event-based execution flow control.
		840
		841	=item L<Coro>
		842
		843	Has special support for AnyEvent via L<Coro::AnyEvent>.
		844
		845	=item L<IO::Lambda>
		846
		847	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
		848
		849	=back
481		850
482	=cut	851	=cut
483		852
484	package AnyEvent;	853	package AnyEvent;
485		854
486	no warnings;	855	no warnings;
487	use strict;	856	use strict;
488		857
489	use Carp;	858	use Carp;
490		859
491	our $VERSION = '3.3';	860	our $VERSION = 4.22;
492	our $MODEL;	861	our $MODEL;
493		862
494	our $AUTOLOAD;	863	our $AUTOLOAD;
495	our @ISA;	864	our @ISA;
496		865
		866	our @REGISTRY;
		867
		868	our $WIN32;
		869
		870	BEGIN {
		871	my $win32 = ! ! ($^O =~ /mswin32/i);
		872	eval "sub WIN32(){ $win32 }";
		873	}
		874
497	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	875	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
498		876
499	our @REGISTRY;	877	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
		878
		879	{
		880	my $idx;
		881	$PROTOCOL{$_} = ++$idx
		882	for reverse split /\s*,\s*/,
		883	$ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
		884	}
500		885
501	my @models = (	886	my @models = (
502	[Coro::EV:: => AnyEvent::Impl::CoroEV::],
503	[Coro::Event:: => AnyEvent::Impl::CoroEvent::],
504	[EV:: => AnyEvent::Impl::EV::],	887	[EV:: => AnyEvent::Impl::EV::],
505	[Event:: => AnyEvent::Impl::Event::],	888	[Event:: => AnyEvent::Impl::Event::],
506	[Glib:: => AnyEvent::Impl::Glib::],
507	[Tk:: => AnyEvent::Impl::Tk::],
508	[Wx:: => AnyEvent::Impl::POE::],
509	[Prima:: => AnyEvent::Impl::POE::],
510	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	889	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
511	# everything below here will not be autoprobed as the pureperl backend should work everywhere	890	# everything below here will not be autoprobed
		891	# as the pureperl backend should work everywhere
		892	# and is usually faster
		893	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		894	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
512	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	895	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
513	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	896	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
514	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	897	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
		898	[Wx:: => AnyEvent::Impl::POE::],
		899	[Prima:: => AnyEvent::Impl::POE::],
515	);	900	);
516		901
517	our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY);	902	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);
		903
		904	our @post_detect;
		905
		906	sub post_detect(&) {
		907	my ($cb) = @_;
		908
		909	if ($MODEL) {
		910	$cb->();
		911
		912	1
		913	} else {
		914	push @post_detect, $cb;
		915
		916	defined wantarray
		917	? bless \$cb, "AnyEvent::Util::PostDetect"
		918	: ()
		919	}
		920	}
		921
		922	sub AnyEvent::Util::PostDetect::DESTROY {
		923	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		924	}
518		925
519	sub detect() {	926	sub detect() {
520	unless ($MODEL) {	927	unless ($MODEL) {
521	no strict 'refs';	928	no strict 'refs';
		929	local $SIG{__DIE__};
522		930
523	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	931	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
524	my $model = "AnyEvent::Impl::$1";	932	my $model = "AnyEvent::Impl::$1";
525	if (eval "require $model") {	933	if (eval "require $model") {
526	$MODEL = $model;	934	$MODEL = $model;
…		…
556	last;	964	last;
557	}	965	}
558	}	966	}
559		967
560	$MODEL	968	$MODEL
561	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV (or Coro+EV), Event (or Coro+Event) or Glib.";	969	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
562	}	970	}
563	}	971	}
564		972
		973	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		974
565	unshift @ISA, $MODEL;	975	unshift @ISA, $MODEL;
566	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	976
		977	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
		978
		979	(shift @post_detect)->() while @post_detect;
567	}	980	}
568		981
569	$MODEL	982	$MODEL
570	}	983	}
571		984
…		…
579		992
580	my $class = shift;	993	my $class = shift;
581	$class->$func (@_);	994	$class->$func (@_);
582	}	995	}
583		996
		997	# utility function to dup a filehandle. this is used by many backends
		998	# to support binding more than one watcher per filehandle (they usually
		999	# allow only one watcher per fd, so we dup it to get a different one).
		1000	sub _dupfh($$$$) {
		1001	my ($poll, $fh, $r, $w) = @_;
		1002
		1003	require Fcntl;
		1004
		1005	# cygwin requires the fh mode to be matching, unix doesn't
		1006	my ($rw, $mode) = $poll eq "r" ? ($r, "<")
		1007	: $poll eq "w" ? ($w, ">")
		1008	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
		1009
		1010	open my $fh2, "$mode&" . fileno $fh
		1011	or die "cannot dup() filehandle: $!";
		1012
		1013	# we assume CLOEXEC is already set by perl in all important cases
		1014
		1015	($fh2, $rw)
		1016	}
		1017
584	package AnyEvent::Base;	1018	package AnyEvent::Base;
585		1019
		1020	# default implementation for now and time
		1021
		1022	use Time::HiRes ();
		1023
		1024	sub time { Time::HiRes::time }
		1025	sub now { Time::HiRes::time }
		1026
586	# default implementation for ->condvar, ->wait, ->broadcast	1027	# default implementation for ->condvar
587		1028
588	sub condvar {	1029	sub condvar {
589	bless \my $flag, "AnyEvent::Base::CondVar"	1030	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
590	}
591
592	sub AnyEvent::Base::CondVar::broadcast {
593	${$_[0]}++;
594	}
595
596	sub AnyEvent::Base::CondVar::wait {
597	AnyEvent->one_event while !${$_[0]};
598	}	1031	}
599		1032
600	# default implementation for ->signal	1033	# default implementation for ->signal
601		1034
602	our %SIG_CB;	1035	our %SIG_CB;
…		…
618	sub AnyEvent::Base::Signal::DESTROY {	1051	sub AnyEvent::Base::Signal::DESTROY {
619	my ($signal, $cb) = @{$_[0]};	1052	my ($signal, $cb) = @{$_[0]};
620		1053
621	delete $SIG_CB{$signal}{$cb};	1054	delete $SIG_CB{$signal}{$cb};
622		1055
623	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };	1056	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
624	}	1057	}
625		1058
626	# default implementation for ->child	1059	# default implementation for ->child
627		1060
628	our %PID_CB;	1061	our %PID_CB;
…		…
655	or Carp::croak "required option 'pid' is missing";	1088	or Carp::croak "required option 'pid' is missing";
656		1089
657	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1090	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
658		1091
659	unless ($WNOHANG) {	1092	unless ($WNOHANG) {
660	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1;	1093	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
661	}	1094	}
662		1095
663	unless ($CHLD_W) {	1096	unless ($CHLD_W) {
664	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1097	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
665	# child could be a zombie already, so make at least one round	1098	# child could be a zombie already, so make at least one round
…		…
675	delete $PID_CB{$pid}{$cb};	1108	delete $PID_CB{$pid}{$cb};
676	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1109	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
677		1110
678	undef $CHLD_W unless keys %PID_CB;	1111	undef $CHLD_W unless keys %PID_CB;
679	}	1112	}
		1113
		1114	package AnyEvent::CondVar;
		1115
		1116	our @ISA = AnyEvent::CondVar::Base::;
		1117
		1118	package AnyEvent::CondVar::Base;
		1119
		1120	use overload
		1121	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },
		1122	fallback => 1;
		1123
		1124	sub _send {
		1125	# nop
		1126	}
		1127
		1128	sub send {
		1129	my $cv = shift;
		1130	$cv->{_ae_sent} = [@_];
		1131	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
		1132	$cv->_send;
		1133	}
		1134
		1135	sub croak {
		1136	$_[0]{_ae_croak} = $_[1];
		1137	$_[0]->send;
		1138	}
		1139
		1140	sub ready {
		1141	$_[0]{_ae_sent}
		1142	}
		1143
		1144	sub _wait {
		1145	AnyEvent->one_event while !$_[0]{_ae_sent};
		1146	}
		1147
		1148	sub recv {
		1149	$_[0]->_wait;
		1150
		1151	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
		1152	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
		1153	}
		1154
		1155	sub cb {
		1156	$_[0]{_ae_cb} = $_[1] if @_ > 1;
		1157	$_[0]{_ae_cb}
		1158	}
		1159
		1160	sub begin {
		1161	++$_[0]{_ae_counter};
		1162	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
		1163	}
		1164
		1165	sub end {
		1166	return if --$_[0]{_ae_counter};
		1167	&{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
		1168	}
		1169
		1170	# undocumented/compatibility with pre-3.4
		1171	*broadcast = \&send;
		1172	*wait = \&_wait;
680		1173
681	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1174	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
682		1175
683	This is an advanced topic that you do not normally need to use AnyEvent in	1176	This is an advanced topic that you do not normally need to use AnyEvent in
684	a module. This section is only of use to event loop authors who want to	1177	a module. This section is only of use to event loop authors who want to
…		…
738	C<PERL_ANYEVENT_MODEL>.	1231	C<PERL_ANYEVENT_MODEL>.
739		1232
740	When set to C<2> or higher, cause AnyEvent to report to STDERR which event	1233	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
741	model it chooses.	1234	model it chooses.
742		1235
		1236	=item C<PERL_ANYEVENT_STRICT>
		1237
		1238	AnyEvent does not do much argument checking by default, as thorough
		1239	argument checking is very costly. Setting this variable to a true value
		1240	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1241	check the arguments passed to most method calls. If it finds any problems
		1242	it will croak.
		1243
		1244	In other words, enables "strict" mode.
		1245
		1246	Unlike C<use strict> it is definitely recommended ot keep it off in
		1247	production.
		1248
743	=item C<PERL_ANYEVENT_MODEL>	1249	=item C<PERL_ANYEVENT_MODEL>
744		1250
745	This can be used to specify the event model to be used by AnyEvent, before	1251	This can be used to specify the event model to be used by AnyEvent, before
746	autodetection and -probing kicks in. It must be a string consisting	1252	auto detection and -probing kicks in. It must be a string consisting
747	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	1253	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
748	and the resulting module name is loaded and if the load was successful,	1254	and the resulting module name is loaded and if the load was successful,
749	used as event model. If it fails to load AnyEvent will proceed with	1255	used as event model. If it fails to load AnyEvent will proceed with
750	autodetection and -probing.	1256	auto detection and -probing.
751		1257
752	This functionality might change in future versions.	1258	This functionality might change in future versions.
753		1259
754	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	1260	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
755	could start your program like this:	1261	could start your program like this:
756		1262
757	PERL_ANYEVENT_MODEL=Perl perl ...	1263	PERL_ANYEVENT_MODEL=Perl perl ...
		1264
		1265	=item C<PERL_ANYEVENT_PROTOCOLS>
		1266
		1267	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1268	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1269	of auto probing).
		1270
		1271	Must be set to a comma-separated list of protocols or address families,
		1272	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1273	used, and preference will be given to protocols mentioned earlier in the
		1274	list.
		1275
		1276	This variable can effectively be used for denial-of-service attacks
		1277	against local programs (e.g. when setuid), although the impact is likely
		1278	small, as the program has to handle connection errors already-
		1279
		1280	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1281	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1282	- only support IPv4, never try to resolve or contact IPv6
		1283	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1284	IPv6, but prefer IPv6 over IPv4.
		1285
		1286	=item C<PERL_ANYEVENT_EDNS0>
		1287
		1288	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1289	for DNS. This extension is generally useful to reduce DNS traffic, but
		1290	some (broken) firewalls drop such DNS packets, which is why it is off by
		1291	default.
		1292
		1293	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1294	EDNS0 in its DNS requests.
		1295
		1296	=item C<PERL_ANYEVENT_MAX_FORKS>
		1297
		1298	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1299	will create in parallel.
758		1300
759	=back	1301	=back
760		1302
761	=head1 EXAMPLE PROGRAM	1303	=head1 EXAMPLE PROGRAM
762		1304
…		…
773	poll => 'r',	1315	poll => 'r',
774	cb => sub {	1316	cb => sub {
775	warn "io event <$_[0]>\n"; # will always output <r>	1317	warn "io event <$_[0]>\n"; # will always output <r>
776	chomp (my $input = <STDIN>); # read a line	1318	chomp (my $input = <STDIN>); # read a line
777	warn "read: $input\n"; # output what has been read	1319	warn "read: $input\n"; # output what has been read
778	$cv->broadcast if $input =~ /^q/i; # quit program if /^q/i	1320	$cv->send if $input =~ /^q/i; # quit program if /^q/i
779	},	1321	},
780	);	1322	);
781		1323
782	my $time_watcher; # can only be used once	1324	my $time_watcher; # can only be used once
783		1325
…		…
788	});	1330	});
789	}	1331	}
790		1332
791	new_timer; # create first timer	1333	new_timer; # create first timer
792		1334
793	$cv->wait; # wait until user enters /^q/i	1335	$cv->recv; # wait until user enters /^q/i
794		1336
795	=head1 REAL-WORLD EXAMPLE	1337	=head1 REAL-WORLD EXAMPLE
796		1338
797	Consider the L<Net::FCP> module. It features (among others) the following	1339	Consider the L<Net::FCP> module. It features (among others) the following
798	API calls, which are to freenet what HTTP GET requests are to http:	1340	API calls, which are to freenet what HTTP GET requests are to http:
…		…
848	syswrite $txn->{fh}, $txn->{request}	1390	syswrite $txn->{fh}, $txn->{request}
849	or die "connection or write error";	1391	or die "connection or write error";
850	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });	1392	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
851		1393
852	Again, C<fh_ready_r> waits till all data has arrived, and then stores the	1394	Again, C<fh_ready_r> waits till all data has arrived, and then stores the
853	result and signals any possible waiters that the request ahs finished:	1395	result and signals any possible waiters that the request has finished:
854		1396
855	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};	1397	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
856		1398
857	if (end-of-file or data complete) {	1399	if (end-of-file or data complete) {
858	$txn->{result} = $txn->{buf};	1400	$txn->{result} = $txn->{buf};
859	$txn->{finished}->broadcast;	1401	$txn->{finished}->send;
860	$txb->{cb}->($txn) of $txn->{cb}; # also call callback	1402	$txb->{cb}->($txn) of $txn->{cb}; # also call callback
861	}	1403	}
862		1404
863	The C<result> method, finally, just waits for the finished signal (if the	1405	The C<result> method, finally, just waits for the finished signal (if the
864	request was already finished, it doesn't wait, of course, and returns the	1406	request was already finished, it doesn't wait, of course, and returns the
865	data:	1407	data:
866		1408
867	$txn->{finished}->wait;	1409	$txn->{finished}->recv;
868	return $txn->{result};	1410	return $txn->{result};
869		1411
870	The actual code goes further and collects all errors (C<die>s, exceptions)	1412	The actual code goes further and collects all errors (C<die>s, exceptions)
871	that occured during request processing. The C<result> method detects	1413	that occurred during request processing. The C<result> method detects
872	whether an exception as thrown (it is stored inside the $txn object)	1414	whether an exception as thrown (it is stored inside the $txn object)
873	and just throws the exception, which means connection errors and other	1415	and just throws the exception, which means connection errors and other
874	problems get reported tot he code that tries to use the result, not in a	1416	problems get reported tot he code that tries to use the result, not in a
875	random callback.	1417	random callback.
876		1418
…		…
907		1449
908	my $quit = AnyEvent->condvar;	1450	my $quit = AnyEvent->condvar;
909		1451
910	$fcp->txn_client_get ($url)->cb (sub {	1452	$fcp->txn_client_get ($url)->cb (sub {
911	...	1453	...
912	$quit->broadcast;	1454	$quit->send;
913	});	1455	});
914		1456
915	$quit->wait;	1457	$quit->recv;
916		1458
917		1459
918	=head1 BENCHMARKS	1460	=head1 BENCHMARKS
919		1461
920	To give you an idea of the performance and overheads that AnyEvent adds	1462	To give you an idea of the performance and overheads that AnyEvent adds
…		…
922	of various event loops I prepared some benchmarks.	1464	of various event loops I prepared some benchmarks.
923		1465
924	=head2 BENCHMARKING ANYEVENT OVERHEAD	1466	=head2 BENCHMARKING ANYEVENT OVERHEAD
925		1467
926	Here is a benchmark of various supported event models used natively and	1468	Here is a benchmark of various supported event models used natively and
927	through anyevent. The benchmark creates a lot of timers (with a zero	1469	through AnyEvent. The benchmark creates a lot of timers (with a zero
928	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	1470	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
929	which it is), lets them fire exactly once and destroys them again.	1471	which it is), lets them fire exactly once and destroys them again.
930		1472
931	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	1473	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
932	distribution.	1474	distribution.
…		…
949	all watchers, to avoid adding memory overhead. That means closure creation	1491	all watchers, to avoid adding memory overhead. That means closure creation
950	and memory usage is not included in the figures.	1492	and memory usage is not included in the figures.
951		1493
952	I<invoke> is the time, in microseconds, used to invoke a simple	1494	I<invoke> is the time, in microseconds, used to invoke a simple
953	callback. The callback simply counts down a Perl variable and after it was	1495	callback. The callback simply counts down a Perl variable and after it was
954	invoked "watcher" times, it would C<< ->broadcast >> a condvar once to	1496	invoked "watcher" times, it would C<< ->send >> a condvar once to
955	signal the end of this phase.	1497	signal the end of this phase.
956		1498
957	I<destroy> is the time, in microseconds, that it takes to destroy a single	1499	I<destroy> is the time, in microseconds, that it takes to destroy a single
958	watcher.	1500	watcher.
959		1501
…		…
1019	file descriptor is dup()ed for each watcher. This shows that the dup()	1561	file descriptor is dup()ed for each watcher. This shows that the dup()
1020	employed by some adaptors is not a big performance issue (it does incur a	1562	employed by some adaptors is not a big performance issue (it does incur a
1021	hidden memory cost inside the kernel which is not reflected in the figures	1563	hidden memory cost inside the kernel which is not reflected in the figures
1022	above).	1564	above).
1023		1565
1024	C<POE>, regardless of underlying event loop (whether using its pure	1566	C<POE>, regardless of underlying event loop (whether using its pure perl
1025	perl select-based backend or the Event module, the POE-EV backend	1567	select-based backend or the Event module, the POE-EV backend couldn't
1026	couldn't be tested because it wasn't working) shows abysmal performance	1568	be tested because it wasn't working) shows abysmal performance and
1027	and memory usage: Watchers use almost 30 times as much memory as	1569	memory usage with AnyEvent: Watchers use almost 30 times as much memory
1028	EV watchers, and 10 times as much memory as Event (the high memory	1570	as EV watchers, and 10 times as much memory as Event (the high memory
1029	requirements are caused by requiring a session for each watcher). Watcher	1571	requirements are caused by requiring a session for each watcher). Watcher
1030	invocation speed is almost 900 times slower than with AnyEvent's pure perl	1572	invocation speed is almost 900 times slower than with AnyEvent's pure perl
		1573	implementation.
		1574
1031	implementation. The design of the POE adaptor class in AnyEvent can not	1575	The design of the POE adaptor class in AnyEvent can not really account
1032	really account for this, as session creation overhead is small compared	1576	for the performance issues, though, as session creation overhead is
1033	to execution of the state machine, which is coded pretty optimally within	1577	small compared to execution of the state machine, which is coded pretty
1034	L<AnyEvent::Impl::POE>. POE simply seems to be abysmally slow.	1578	optimally within L<AnyEvent::Impl::POE> (and while everybody agrees that
		1579	using multiple sessions is not a good approach, especially regarding
		1580	memory usage, even the author of POE could not come up with a faster
		1581	design).
1035		1582
1036	=head3 Summary	1583	=head3 Summary
1037		1584
1038	=over 4	1585	=over 4
1039		1586
…		…
1050		1597
1051	=back	1598	=back
1052		1599
1053	=head2 BENCHMARKING THE LARGE SERVER CASE	1600	=head2 BENCHMARKING THE LARGE SERVER CASE
1054		1601
1055	This benchmark atcually benchmarks the event loop itself. It works by	1602	This benchmark actually benchmarks the event loop itself. It works by
1056	creating a number of "servers": each server consists of a socketpair, a	1603	creating a number of "servers": each server consists of a socket pair, a
1057	timeout watcher that gets reset on activity (but never fires), and an I/O	1604	timeout watcher that gets reset on activity (but never fires), and an I/O
1058	watcher waiting for input on one side of the socket. Each time the socket	1605	watcher waiting for input on one side of the socket. Each time the socket
1059	watcher reads a byte it will write that byte to a random other "server".	1606	watcher reads a byte it will write that byte to a random other "server".
1060		1607
1061	The effect is that there will be a lot of I/O watchers, only part of which	1608	The effect is that there will be a lot of I/O watchers, only part of which
1062	are active at any one point (so there is a constant number of active	1609	are active at any one point (so there is a constant number of active
1063	fds for each loop iterstaion, but which fds these are is random). The	1610	fds for each loop iteration, but which fds these are is random). The
1064	timeout is reset each time something is read because that reflects how	1611	timeout is reset each time something is read because that reflects how
1065	most timeouts work (and puts extra pressure on the event loops).	1612	most timeouts work (and puts extra pressure on the event loops).
1066		1613
1067	In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100	1614	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1068	(1%) are active. This mirrors the activity of large servers with many	1615	(1%) are active. This mirrors the activity of large servers with many
1069	connections, most of which are idle at any one point in time.	1616	connections, most of which are idle at any one point in time.
1070		1617
1071	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	1618	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1072	distribution.	1619	distribution.
…		…
1074	=head3 Explanation of the columns	1621	=head3 Explanation of the columns
1075		1622
1076	I<sockets> is the number of sockets, and twice the number of "servers" (as	1623	I<sockets> is the number of sockets, and twice the number of "servers" (as
1077	each server has a read and write socket end).	1624	each server has a read and write socket end).
1078		1625
1079	I<create> is the time it takes to create a socketpair (which is	1626	I<create> is the time it takes to create a socket pair (which is
1080	nontrivial) and two watchers: an I/O watcher and a timeout watcher.	1627	nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1081		1628
1082	I<request>, the most important value, is the time it takes to handle a	1629	I<request>, the most important value, is the time it takes to handle a
1083	single "request", that is, reading the token from the pipe and forwarding	1630	single "request", that is, reading the token from the pipe and forwarding
1084	it to another server. This includes deleting the old timeout and creating	1631	it to another server. This includes deleting the old timeout and creating
…		…
1118		1665
1119	=head3 Summary	1666	=head3 Summary
1120		1667
1121	=over 4	1668	=over 4
1122		1669
1123	=item * The pure perl implementation performs extremely well, considering	1670	=item * The pure perl implementation performs extremely well.
1124	that it uses select.
1125		1671
1126	=item * Avoid Glib or POE in large projects where performance matters.	1672	=item * Avoid Glib or POE in large projects where performance matters.
1127		1673
1128	=back	1674	=back
1129		1675
…		…
1158	speed most when you have lots of watchers, not when you only have a few of	1704	speed most when you have lots of watchers, not when you only have a few of
1159	them).	1705	them).
1160		1706
1161	EV is again fastest.	1707	EV is again fastest.
1162		1708
1163	The C-based event loops Event and Glib come in second this time, as the	1709	Perl again comes second. It is noticeably faster than the C-based event
1164	overhead of running an iteration is much smaller in C than in Perl (little	1710	loops Event and Glib, although the difference is too small to really
1165	code to execute in the inner loop, and perl's function calling overhead is	1711	matter.
1166	high, and updating all the data structures is costly).
1167
1168	The pure perl event loop is much slower, but still competitive.
1169		1712
1170	POE also performs much better in this case, but is is still far behind the	1713	POE also performs much better in this case, but is is still far behind the
1171	others.	1714	others.
1172		1715
1173	=head3 Summary	1716	=head3 Summary
…		…
1181		1724
1182		1725
1183	=head1 FORK	1726	=head1 FORK
1184		1727
1185	Most event libraries are not fork-safe. The ones who are usually are	1728	Most event libraries are not fork-safe. The ones who are usually are
1186	because they are so inefficient. Only L<EV> is fully fork-aware.	1729	because they rely on inefficient but fork-safe C<select> or C<poll>
		1730	calls. Only L<EV> is fully fork-aware.
1187		1731
1188	If you have to fork, you must either do so I<before> creating your first	1732	If you have to fork, you must either do so I<before> creating your first
1189	watcher OR you must not use AnyEvent at all in the child.	1733	watcher OR you must not use AnyEvent at all in the child.
1190		1734
1191		1735
…		…
1199	specified in the variable.	1743	specified in the variable.
1200		1744
1201	You can make AnyEvent completely ignore this variable by deleting it	1745	You can make AnyEvent completely ignore this variable by deleting it
1202	before the first watcher gets created, e.g. with a C<BEGIN> block:	1746	before the first watcher gets created, e.g. with a C<BEGIN> block:
1203		1747
1204	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }	1748	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1205		1749
1206	use AnyEvent;	1750	use AnyEvent;
		1751
		1752	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
		1753	be used to probe what backend is used and gain other information (which is
		1754	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		1755	$ENV{PERL_ANYEGENT_STRICT}.
		1756
		1757
		1758	=head1 BUGS
		1759
		1760	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
		1761	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
		1762	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
		1763	mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
		1764	pronounced).
1207		1765
1208		1766
1209	=head1 SEE ALSO	1767	=head1 SEE ALSO
1210		1768
1211	Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>,	1769	Utility functions: L<AnyEvent::Util>.
1212	L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>,	1770
		1771	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1213	L<Event::Lib>, L<Qt>, L<POE>.	1772	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1214		1773
1215	Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>,	1774	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1216	L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>,	1775	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1217	L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>,	1776	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1218	L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>.	1777	L<AnyEvent::Impl::POE>.
1219		1778
		1779	Non-blocking file handles, sockets, TCP clients and
		1780	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.
		1781
		1782	Asynchronous DNS: L<AnyEvent::DNS>.
		1783
		1784	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
		1785
1220	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.	1786	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1221		1787
1222		1788
1223	=head1 AUTHOR	1789	=head1 AUTHOR
1224		1790
1225	Marc Lehmann <schmorp@schmorp.de>	1791	Marc Lehmann <schmorp@schmorp.de>
1226	http://home.schmorp.de/	1792	http://home.schmorp.de/
1227		1793
1228	=cut	1794	=cut
1229		1795
1230	1	1796	1
1231		1797

Diff Legend

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