ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.164 by root, Tue Jul 8 19:50:25 2008 UTC vs.
Revision 1.241 by root, Fri Jul 17 18:08:35 2009 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 and POE are various supported
		6	event loops.
6		7
7	=head1 SYNOPSIS	8	=head1 SYNOPSIS
8		9
9	use AnyEvent;	10	use AnyEvent;
10		11
		12	# file descriptor readable
11	my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub {	13	my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
		14
		15	# one-shot or repeating timers
		16	my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
		17	my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
		18
		19	print AnyEvent->now; # prints current event loop time
		20	print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
		21
		22	# POSIX signal
		23	my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
		24
		25	# child process exit
		26	my $w = AnyEvent->child (pid => $pid, cb => sub {
		27	my ($pid, $status) = @_;
12	...	28	...
13	});	29	});
14		30
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {	31	# called when event loop idle (if applicable)
16	...	32	my $w = AnyEvent->idle (cb => sub { ... });
17	});
18		33
19	my $w = AnyEvent->condvar; # stores whether a condition was flagged	34	my $w = AnyEvent->condvar; # stores whether a condition was flagged
20	$w->send; # wake up current and all future recv's	35	$w->send; # wake up current and all future recv's
21	$w->recv; # enters "main loop" till $condvar gets ->send	36	$w->recv; # enters "main loop" till $condvar gets ->send
		37	# use a condvar in callback mode:
		38	$w->cb (sub { $_[0]->recv });
22		39
23	=head1 INTRODUCTION/TUTORIAL	40	=head1 INTRODUCTION/TUTORIAL
24		41
25	This manpage is mainly a reference manual. If you are interested	42	This manpage is mainly a reference manual. If you are interested
26	in a tutorial or some gentle introduction, have a look at the	43	in a tutorial or some gentle introduction, have a look at the
…		…
33		50
34	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of	51	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
35	policy> and AnyEvent is I<small and efficient>.	52	policy> and AnyEvent is I<small and efficient>.
36		53
37	First and foremost, I<AnyEvent is not an event model> itself, it only	54	First and foremost, I<AnyEvent is not an event model> itself, it only
38	interfaces to whatever event model the main program happens to use in a	55	interfaces to whatever event model the main program happens to use, in a
39	pragmatic way. For event models and certain classes of immortals alike,	56	pragmatic way. For event models and certain classes of immortals alike,
40	the statement "there can only be one" is a bitter reality: In general,	57	the statement "there can only be one" is a bitter reality: In general,
41	only one event loop can be active at the same time in a process. AnyEvent	58	only one event loop can be active at the same time in a process. AnyEvent
42	helps hiding the differences between those event loops.	59	cannot change this, but it can hide the differences between those event
		60	loops.
43		61
44	The goal of AnyEvent is to offer module authors the ability to do event	62	The goal of AnyEvent is to offer module authors the ability to do event
45	programming (waiting for I/O or timer events) without subscribing to a	63	programming (waiting for I/O or timer events) without subscribing to a
46	religion, a way of living, and most importantly: without forcing your	64	religion, a way of living, and most importantly: without forcing your
47	module users into the same thing by forcing them to use the same event	65	module users into the same thing by forcing them to use the same event
48	model you use.	66	model you use.
49		67
50	For modules like POE or IO::Async (which is a total misnomer as it is	68	For modules like POE or IO::Async (which is a total misnomer as it is
51	actually doing all I/O I<synchronously>...), using them in your module is	69	actually doing all I/O I<synchronously>...), using them in your module is
52	like joining a cult: After you joined, you are dependent on them and you	70	like joining a cult: After you joined, you are dependent on them and you
53	cannot use anything else, as it is simply incompatible to everything that	71	cannot use anything else, as they are simply incompatible to everything
54	isn't itself. What's worse, all the potential users of your module are	72	that isn't them. What's worse, all the potential users of your
55	I<also> forced to use the same event loop you use.	73	module are I<also> forced to use the same event loop you use.
56		74
57	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	75	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
58	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	76	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
59	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if	77	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
60	your module uses one of those, every user of your module has to use it,	78	your module uses one of those, every user of your module has to use it,
61	too. But if your module uses AnyEvent, it works transparently with all	79	too. But if your module uses AnyEvent, it works transparently with all
62	event models it supports (including stuff like POE and IO::Async, as long	80	event models it supports (including stuff like IO::Async, as long as those
63	as those use one of the supported event loops. It is trivial to add new	81	use one of the supported event loops. It is trivial to add new event loops
64	event loops to AnyEvent, too, so it is future-proof).	82	to AnyEvent, too, so it is future-proof).
65		83
66	In addition to being free of having to use I<the one and only true event	84	In addition to being free of having to use I<the one and only true event
67	model>, AnyEvent also is free of bloat and policy: with POE or similar	85	model>, AnyEvent also is free of bloat and policy: with POE or similar
68	modules, you get an enormous amount of code and strict rules you have to	86	modules, you get an enormous amount of code and strict rules you have to
69	follow. AnyEvent, on the other hand, is lean and up to the point, by only	87	follow. AnyEvent, on the other hand, is lean and up to the point, by only
…		…
127	These watchers are normal Perl objects with normal Perl lifetime. After	145	These watchers are normal Perl objects with normal Perl lifetime. After
128	creating a watcher it will immediately "watch" for events and invoke the	146	creating a watcher it will immediately "watch" for events and invoke the
129	callback when the event occurs (of course, only when the event model	147	callback when the event occurs (of course, only when the event model
130	is in control).	148	is in control).
131		149
		150	Note that B<callbacks must not permanently change global variables>
		151	potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
		152	callbacks must not C<die> >>. The former is good programming practise in
		153	Perl and the latter stems from the fact that exception handling differs
		154	widely between event loops.
		155
132	To disable the watcher you have to destroy it (e.g. by setting the	156	To disable the watcher you have to destroy it (e.g. by setting the
133	variable you store it in to C<undef> or otherwise deleting all references	157	variable you store it in to C<undef> or otherwise deleting all references
134	to it).	158	to it).
135		159
136	All watchers are created by calling a method on the C<AnyEvent> class.	160	All watchers are created by calling a method on the C<AnyEvent> class.
…		…
152	=head2 I/O WATCHERS	176	=head2 I/O WATCHERS
153		177
154	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
155	with the following mandatory key-value pairs as arguments:	179	with the following mandatory key-value pairs as arguments:
156		180
157	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch	181	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
		182	for events (AnyEvent might or might not keep a reference to this file
		183	handle). Note that only file handles pointing to things for which
		184	non-blocking operation makes sense are allowed. This includes sockets,
		185	most character devices, pipes, fifos and so on, but not for example files
		186	or block devices.
		187
158	for events. C<poll> must be a string that is either C<r> or C<w>,	188	C<poll> must be a string that is either C<r> or C<w>, which creates a
159	which creates a watcher waiting for "r"eadable or "w"ritable events,	189	watcher waiting for "r"eadable or "w"ritable events, respectively.
		190
160	respectively. C<cb> is the callback to invoke each time the file handle	191	C<cb> is the callback to invoke each time the file handle becomes ready.
161	becomes ready.
162		192
163	Although the callback might get passed parameters, their value and	193	Although the callback might get passed parameters, their value and
164	presence is undefined and you cannot rely on them. Portable AnyEvent	194	presence is undefined and you cannot rely on them. Portable AnyEvent
165	callbacks cannot use arguments passed to I/O watcher callbacks.	195	callbacks cannot use arguments passed to I/O watcher callbacks.
166		196
…		…
193	Although the callback might get passed parameters, their value and	223	Although the callback might get passed parameters, their value and
194	presence is undefined and you cannot rely on them. Portable AnyEvent	224	presence is undefined and you cannot rely on them. Portable AnyEvent
195	callbacks cannot use arguments passed to time watcher callbacks.	225	callbacks cannot use arguments passed to time watcher callbacks.
196		226
197	The callback will normally be invoked once only. If you specify another	227	The callback will normally be invoked once only. If you specify another
198	parameter, C<interval>, as a positive number, then the callback will be	228	parameter, C<interval>, as a strictly positive number (> 0), then the
199	invoked regularly at that interval (in fractional seconds) after the first	229	callback will be invoked regularly at that interval (in fractional
200	invocation.	230	seconds) after the first invocation. If C<interval> is specified with a
		231	false value, then it is treated as if it were missing.
201		232
202	The callback will be rescheduled before invoking the callback, but no	233	The callback will be rescheduled before invoking the callback, but no
203	attempt is done to avoid timer drift in most backends, so the interval is	234	attempt is done to avoid timer drift in most backends, so the interval is
204	only approximate.	235	only approximate.
205		236
…		…
297	In either case, if you care (and in most cases, you don't), then you	328	In either case, if you care (and in most cases, you don't), then you
298	can get whatever behaviour you want with any event loop, by taking the	329	can get whatever behaviour you want with any event loop, by taking the
299	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into	330	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
300	account.	331	account.
301		332
		333	=item AnyEvent->now_update
		334
		335	Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
		336	the current time for each loop iteration (see the discussion of L<<
		337	AnyEvent->now >>, above).
		338
		339	When a callback runs for a long time (or when the process sleeps), then
		340	this "current" time will differ substantially from the real time, which
		341	might affect timers and time-outs.
		342
		343	When this is the case, you can call this method, which will update the
		344	event loop's idea of "current time".
		345
		346	Note that updating the time I<might> cause some events to be handled.
		347
302	=back	348	=back
303		349
304	=head2 SIGNAL WATCHERS	350	=head2 SIGNAL WATCHERS
305		351
306	You can watch for signals using a signal watcher, C<signal> is the signal	352	You can watch for signals using a signal watcher, C<signal> is the signal
307	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to	353	I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
308	be invoked whenever a signal occurs.	354	callback to be invoked whenever a signal occurs.
309		355
310	Although the callback might get passed parameters, their value and	356	Although the callback might get passed parameters, their value and
311	presence is undefined and you cannot rely on them. Portable AnyEvent	357	presence is undefined and you cannot rely on them. Portable AnyEvent
312	callbacks cannot use arguments passed to signal watcher callbacks.	358	callbacks cannot use arguments passed to signal watcher callbacks.
313		359
…		…
329	=head2 CHILD PROCESS WATCHERS	375	=head2 CHILD PROCESS WATCHERS
330		376
331	You can also watch on a child process exit and catch its exit status.	377	You can also watch on a child process exit and catch its exit status.
332		378
333	The child process is specified by the C<pid> argument (if set to C<0>, it	379	The child process is specified by the C<pid> argument (if set to C<0>, it
334	watches for any child process exit). The watcher will trigger as often	380	watches for any child process exit). The watcher will triggered only when
335	as status change for the child are received. This works by installing a	381	the child process has finished and an exit status is available, not on
336	signal handler for C<SIGCHLD>. The callback will be called with the pid	382	any trace events (stopped/continued).
337	and exit status (as returned by waitpid), so unlike other watcher types,	383
338	you I<can> rely on child watcher callback arguments.	384	The callback will be called with the pid and exit status (as returned by
		385	waitpid), so unlike other watcher types, you I<can> rely on child watcher
		386	callback arguments.
		387
		388	This watcher type works by installing a signal handler for C<SIGCHLD>,
		389	and since it cannot be shared, nothing else should use SIGCHLD or reap
		390	random child processes (waiting for specific child processes, e.g. inside
		391	C<system>, is just fine).
339		392
340	There is a slight catch to child watchers, however: you usually start them	393	There is a slight catch to child watchers, however: you usually start them
341	I<after> the child process was created, and this means the process could	394	I<after> the child process was created, and this means the process could
342	have exited already (and no SIGCHLD will be sent anymore).	395	have exited already (and no SIGCHLD will be sent anymore).
343		396
344	Not all event models handle this correctly (POE doesn't), but even for	397	Not all event models handle this correctly (neither POE nor IO::Async do,
		398	see their AnyEvent::Impl manpages for details), but even for event models
345	event models that I<do> handle this correctly, they usually need to be	399	that I<do> handle this correctly, they usually need to be loaded before
346	loaded before the process exits (i.e. before you fork in the first place).	400	the process exits (i.e. before you fork in the first place). AnyEvent's
		401	pure perl event loop handles all cases correctly regardless of when you
		402	start the watcher.
347		403
348	This means you cannot create a child watcher as the very first thing in an	404	This means you cannot create a child watcher as the very first
349	AnyEvent program, you I<have> to create at least one watcher before you	405	thing in an AnyEvent program, you I<have> to create at least one
350	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	406	watcher before you C<fork> the child (alternatively, you can call
		407	C<AnyEvent::detect>).
351		408
352	Example: fork a process and wait for it	409	Example: fork a process and wait for it
353		410
354	my $done = AnyEvent->condvar;	411	my $done = AnyEvent->condvar;
355		412
…		…
365	);	422	);
366		423
367	# do something else, then wait for process exit	424	# do something else, then wait for process exit
368	$done->recv;	425	$done->recv;
369		426
		427	=head2 IDLE WATCHERS
		428
		429	Sometimes there is a need to do something, but it is not so important
		430	to do it instantly, but only when there is nothing better to do. This
		431	"nothing better to do" is usually defined to be "no other events need
		432	attention by the event loop".
		433
		434	Idle watchers ideally get invoked when the event loop has nothing
		435	better to do, just before it would block the process to wait for new
		436	events. Instead of blocking, the idle watcher is invoked.
		437
		438	Most event loops unfortunately do not really support idle watchers (only
		439	EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
		440	will simply call the callback "from time to time".
		441
		442	Example: read lines from STDIN, but only process them when the
		443	program is otherwise idle:
		444
		445	my @lines; # read data
		446	my $idle_w;
		447	my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
		448	push @lines, scalar <STDIN>;
		449
		450	# start an idle watcher, if not already done
		451	$idle_w ||= AnyEvent->idle (cb => sub {
		452	# handle only one line, when there are lines left
		453	if (my $line = shift @lines) {
		454	print "handled when idle: $line";
		455	} else {
		456	# otherwise disable the idle watcher again
		457	undef $idle_w;
		458	}
		459	});
		460	});
		461
370	=head2 CONDITION VARIABLES	462	=head2 CONDITION VARIABLES
371		463
372	If you are familiar with some event loops you will know that all of them	464	If you are familiar with some event loops you will know that all of them
373	require you to run some blocking "loop", "run" or similar function that	465	require you to run some blocking "loop", "run" or similar function that
374	will actively watch for new events and call your callbacks.	466	will actively watch for new events and call your callbacks.
375		467
376	AnyEvent is different, it expects somebody else to run the event loop and	468	AnyEvent is slightly different: it expects somebody else to run the event
377	will only block when necessary (usually when told by the user).	469	loop and will only block when necessary (usually when told by the user).
378		470
379	The instrument to do that is called a "condition variable", so called	471	The instrument to do that is called a "condition variable", so called
380	because they represent a condition that must become true.	472	because they represent a condition that must become true.
		473
		474	Now is probably a good time to look at the examples further below.
381		475
382	Condition variables can be created by calling the C<< AnyEvent->condvar	476	Condition variables can be created by calling the C<< AnyEvent->condvar
383	>> method, usually without arguments. The only argument pair allowed is	477	>> method, usually without arguments. The only argument pair allowed is
384	C<cb>, which specifies a callback to be called when the condition variable	478	C<cb>, which specifies a callback to be called when the condition variable
385	becomes true.	479	becomes true, with the condition variable as the first argument (but not
		480	the results).
386		481
387	After creation, the condition variable is "false" until it becomes "true"	482	After creation, the condition variable is "false" until it becomes "true"
388	by calling the C<send> method (or calling the condition variable as if it	483	by calling the C<send> method (or calling the condition variable as if it
389	were a callback, read about the caveats in the description for the C<<	484	were a callback, read about the caveats in the description for the C<<
390	->send >> method).	485	->send >> method).
…		…
436	after => 1,	531	after => 1,
437	cb => sub { $result_ready->send },	532	cb => sub { $result_ready->send },
438	);	533	);
439		534
440	# this "blocks" (while handling events) till the callback	535	# this "blocks" (while handling events) till the callback
441	# calls send	536	# calls -<send
442	$result_ready->recv;	537	$result_ready->recv;
443		538
444	Example: wait for a timer, but take advantage of the fact that	539	Example: wait for a timer, but take advantage of the fact that condition
445	condition variables are also code references.	540	variables are also callable directly.
446		541
447	my $done = AnyEvent->condvar;	542	my $done = AnyEvent->condvar;
448	my $delay = AnyEvent->timer (after => 5, cb => $done);	543	my $delay = AnyEvent->timer (after => 5, cb => $done);
449	$done->recv;	544	$done->recv;
		545
		546	Example: Imagine an API that returns a condvar and doesn't support
		547	callbacks. This is how you make a synchronous call, for example from
		548	the main program:
		549
		550	use AnyEvent::CouchDB;
		551
		552	...
		553
		554	my @info = $couchdb->info->recv;
		555
		556	And this is how you would just set a callback to be called whenever the
		557	results are available:
		558
		559	$couchdb->info->cb (sub {
		560	my @info = $_[0]->recv;
		561	});
450		562
451	=head3 METHODS FOR PRODUCERS	563	=head3 METHODS FOR PRODUCERS
452		564
453	These methods should only be used by the producing side, i.e. the	565	These methods should only be used by the producing side, i.e. the
454	code/module that eventually sends the signal. Note that it is also	566	code/module that eventually sends the signal. Note that it is also
…		…
467	immediately from within send.	579	immediately from within send.
468		580
469	Any arguments passed to the C<send> call will be returned by all	581	Any arguments passed to the C<send> call will be returned by all
470	future C<< ->recv >> calls.	582	future C<< ->recv >> calls.
471		583
472	Condition variables are overloaded so one can call them directly	584	Condition variables are overloaded so one can call them directly (as if
473	(as a code reference). Calling them directly is the same as calling	585	they were a code reference). Calling them directly is the same as calling
474	C<send>. Note, however, that many C-based event loops do not handle	586	C<send>.
475	overloading, so as tempting as it may be, passing a condition variable
476	instead of a callback does not work. Both the pure perl and EV loops
477	support overloading, however, as well as all functions that use perl to
478	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
479	example).
480		587
481	=item $cv->croak ($error)	588	=item $cv->croak ($error)
482		589
483	Similar to send, but causes all call's to C<< ->recv >> to invoke	590	Similar to send, but causes all call's to C<< ->recv >> to invoke
484	C<Carp::croak> with the given error message/object/scalar.	591	C<Carp::croak> with the given error message/object/scalar.
485		592
486	This can be used to signal any errors to the condition variable	593	This can be used to signal any errors to the condition variable
487	user/consumer.	594	user/consumer. Doing it this way instead of calling C<croak> directly
		595	delays the error detetcion, but has the overwhelmign advantage that it
		596	diagnoses the error at the place where the result is expected, and not
		597	deep in some event clalback without connection to the actual code causing
		598	the problem.
488		599
489	=item $cv->begin ([group callback])	600	=item $cv->begin ([group callback])
490		601
491	=item $cv->end	602	=item $cv->end
492
493	These two methods are EXPERIMENTAL and MIGHT CHANGE.
494		603
495	These two methods can be used to combine many transactions/events into	604	These two methods can be used to combine many transactions/events into
496	one. For example, a function that pings many hosts in parallel might want	605	one. For example, a function that pings many hosts in parallel might want
497	to use a condition variable for the whole process.	606	to use a condition variable for the whole process.
498		607
…		…
500	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	609	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
501	>>, the (last) callback passed to C<begin> will be executed. That callback	610	>>, the (last) callback passed to C<begin> will be executed. That callback
502	is I<supposed> to call C<< ->send >>, but that is not required. If no	611	is I<supposed> to call C<< ->send >>, but that is not required. If no
503	callback was set, C<send> will be called without any arguments.	612	callback was set, C<send> will be called without any arguments.
504		613
505	Let's clarify this with the ping example:	614	You can think of C<< $cv->send >> giving you an OR condition (one call
		615	sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
		616	condition (all C<begin> calls must be C<end>'ed before the condvar sends).
		617
		618	Let's start with a simple example: you have two I/O watchers (for example,
		619	STDOUT and STDERR for a program), and you want to wait for both streams to
		620	close before activating a condvar:
		621
		622	my $cv = AnyEvent->condvar;
		623
		624	$cv->begin; # first watcher
		625	my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
		626	defined sysread $fh1, my $buf, 4096
		627	or $cv->end;
		628	});
		629
		630	$cv->begin; # second watcher
		631	my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
		632	defined sysread $fh2, my $buf, 4096
		633	or $cv->end;
		634	});
		635
		636	$cv->recv;
		637
		638	This works because for every event source (EOF on file handle), there is
		639	one call to C<begin>, so the condvar waits for all calls to C<end> before
		640	sending.
		641
		642	The ping example mentioned above is slightly more complicated, as the
		643	there are results to be passwd back, and the number of tasks that are
		644	begung can potentially be zero:
506		645
507	my $cv = AnyEvent->condvar;	646	my $cv = AnyEvent->condvar;
508		647
509	my %result;	648	my %result;
510	$cv->begin (sub { $cv->send (\%result) });	649	$cv->begin (sub { $cv->send (\%result) });
…		…
530	loop, which serves two important purposes: first, it sets the callback	669	loop, which serves two important purposes: first, it sets the callback
531	to be called once the counter reaches C<0>, and second, it ensures that	670	to be called once the counter reaches C<0>, and second, it ensures that
532	C<send> is called even when C<no> hosts are being pinged (the loop	671	C<send> is called even when C<no> hosts are being pinged (the loop
533	doesn't execute once).	672	doesn't execute once).
534		673
535	This is the general pattern when you "fan out" into multiple subrequests:	674	This is the general pattern when you "fan out" into multiple (but
536	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	675	potentially none) subrequests: use an outer C<begin>/C<end> pair to set
537	is called at least once, and then, for each subrequest you start, call	676	the callback and ensure C<end> is called at least once, and then, for each
538	C<begin> and for each subrequest you finish, call C<end>.	677	subrequest you start, call C<begin> and for each subrequest you finish,
		678	call C<end>.
539		679
540	=back	680	=back
541		681
542	=head3 METHODS FOR CONSUMERS	682	=head3 METHODS FOR CONSUMERS
543		683
…		…
559	function will call C<croak>.	699	function will call C<croak>.
560		700
561	In list context, all parameters passed to C<send> will be returned,	701	In list context, all parameters passed to C<send> will be returned,
562	in scalar context only the first one will be returned.	702	in scalar context only the first one will be returned.
563		703
		704	Note that doing a blocking wait in a callback is not supported by any
		705	event loop, that is, recursive invocation of a blocking C<< ->recv
		706	>> is not allowed, and the C<recv> call will C<croak> if such a
		707	condition is detected. This condition can be slightly loosened by using
		708	L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
		709	any thread that doesn't run the event loop itself.
		710
564	Not all event models support a blocking wait - some die in that case	711	Not all event models support a blocking wait - some die in that case
565	(programs might want to do that to stay interactive), so I<if you are	712	(programs might want to do that to stay interactive), so I<if you are
566	using this from a module, never require a blocking wait>, but let the	713	using this from a module, never require a blocking wait>. Instead, let the
567	caller decide whether the call will block or not (for example, by coupling	714	caller decide whether the call will block or not (for example, by coupling
568	condition variables with some kind of request results and supporting	715	condition variables with some kind of request results and supporting
569	callbacks so the caller knows that getting the result will not block,	716	callbacks so the caller knows that getting the result will not block,
570	while still supporting blocking waits if the caller so desires).	717	while still supporting blocking waits if the caller so desires).
571		718
572	Another reason I<never> to C<< ->recv >> in a module is that you cannot
573	sensibly have two C<< ->recv >>'s in parallel, as that would require
574	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
575	can supply.
576
577	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
578	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
579	versions and also integrates coroutines into AnyEvent, making blocking
580	C<< ->recv >> calls perfectly safe as long as they are done from another
581	coroutine (one that doesn't run the event loop).
582
583	You can ensure that C<< -recv >> never blocks by setting a callback and	719	You can ensure that C<< -recv >> never blocks by setting a callback and
584	only calling C<< ->recv >> from within that callback (or at a later	720	only calling C<< ->recv >> from within that callback (or at a later
585	time). This will work even when the event loop does not support blocking	721	time). This will work even when the event loop does not support blocking
586	waits otherwise.	722	waits otherwise.
587		723
588	=item $bool = $cv->ready	724	=item $bool = $cv->ready
589		725
590	Returns true when the condition is "true", i.e. whether C<send> or	726	Returns true when the condition is "true", i.e. whether C<send> or
591	C<croak> have been called.	727	C<croak> have been called.
592		728
593	=item $cb = $cv->cb ([new callback])	729	=item $cb = $cv->cb ($cb->($cv))
594		730
595	This is a mutator function that returns the callback set and optionally	731	This is a mutator function that returns the callback set and optionally
596	replaces it before doing so.	732	replaces it before doing so.
597		733
598	The callback will be called when the condition becomes "true", i.e. when	734	The callback will be called when the condition becomes "true", i.e. when
…		…
600	variable itself. Calling C<recv> inside the callback or at any later time	736	variable itself. Calling C<recv> inside the callback or at any later time
601	is guaranteed not to block.	737	is guaranteed not to block.
602		738
603	=back	739	=back
604		740
		741	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		742
		743	The available backend classes are (every class has its own manpage):
		744
		745	=over 4
		746
		747	=item Backends that are autoprobed when no other event loop can be found.
		748
		749	EV is the preferred backend when no other event loop seems to be in
		750	use. If EV is not installed, then AnyEvent will try Event, and, failing
		751	that, will fall back to its own pure-perl implementation, which is
		752	available everywhere as it comes with AnyEvent itself.
		753
		754	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		755	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		756	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		757
		758	=item Backends that are transparently being picked up when they are used.
		759
		760	These will be used when they are currently loaded when the first watcher
		761	is created, in which case it is assumed that the application is using
		762	them. This means that AnyEvent will automatically pick the right backend
		763	when the main program loads an event module before anything starts to
		764	create watchers. Nothing special needs to be done by the main program.
		765
		766	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		767	AnyEvent::Impl::Tk based on Tk, very broken.
		768	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		769	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		770
		771	=item Backends with special needs.
		772
		773	Qt requires the Qt::Application to be instantiated first, but will
		774	otherwise be picked up automatically. As long as the main program
		775	instantiates the application before any AnyEvent watchers are created,
		776	everything should just work.
		777
		778	AnyEvent::Impl::Qt based on Qt.
		779
		780	Support for IO::Async can only be partial, as it is too broken and
		781	architecturally limited to even support the AnyEvent API. It also
		782	is the only event loop that needs the loop to be set explicitly, so
		783	it can only be used by a main program knowing about AnyEvent. See
		784	L<AnyEvent::Impl::Async> for the gory details.
		785
		786	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		787
		788	=item Event loops that are indirectly supported via other backends.
		789
		790	Some event loops can be supported via other modules:
		791
		792	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		793
		794	B<WxWidgets> has no support for watching file handles. However, you can
		795	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		796	polls 20 times per second, which was considered to be too horrible to even
		797	consider for AnyEvent.
		798
		799	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		800	backend, so it can be supported through POE.
		801
		802	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		803	load L<POE> when detecting them, in the hope that POE will pick them up,
		804	in which case everything will be automatic.
		805
		806	=back
		807
605	=head1 GLOBAL VARIABLES AND FUNCTIONS	808	=head1 GLOBAL VARIABLES AND FUNCTIONS
606		809
		810	These are not normally required to use AnyEvent, but can be useful to
		811	write AnyEvent extension modules.
		812
607	=over 4	813	=over 4
608		814
609	=item $AnyEvent::MODEL	815	=item $AnyEvent::MODEL
610		816
611	Contains C<undef> until the first watcher is being created. Then it	817	Contains C<undef> until the first watcher is being created, before the
		818	backend has been autodetected.
		819
612	contains the event model that is being used, which is the name of the	820	Afterwards it contains the event model that is being used, which is the
613	Perl class implementing the model. This class is usually one of the	821	name of the Perl class implementing the model. This class is usually one
614	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	822	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
615	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	823	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
616		824	will be C<urxvt::anyevent>).
617	The known classes so far are:
618
619	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
620	AnyEvent::Impl::Event based on Event, second best choice.
621	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
622	AnyEvent::Impl::Glib based on Glib, third-best choice.
623	AnyEvent::Impl::Tk based on Tk, very bad choice.
624	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
625	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
626	AnyEvent::Impl::POE based on POE, not generic enough for full support.
627
628	There is no support for WxWidgets, as WxWidgets has no support for
629	watching file handles. However, you can use WxWidgets through the
630	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
631	second, which was considered to be too horrible to even consider for
632	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
633	it's adaptor.
634
635	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
636	autodetecting them.
637		825
638	=item AnyEvent::detect	826	=item AnyEvent::detect
639		827
640	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	828	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
641	if necessary. You should only call this function right before you would	829	if necessary. You should only call this function right before you would
642	have created an AnyEvent watcher anyway, that is, as late as possible at	830	have created an AnyEvent watcher anyway, that is, as late as possible at
643	runtime.	831	runtime, and not e.g. while initialising of your module.
		832
		833	If you need to do some initialisation before AnyEvent watchers are
		834	created, use C<post_detect>.
644		835
645	=item $guard = AnyEvent::post_detect { BLOCK }	836	=item $guard = AnyEvent::post_detect { BLOCK }
646		837
647	Arranges for the code block to be executed as soon as the event model is	838	Arranges for the code block to be executed as soon as the event model is
648	autodetected (or immediately if this has already happened).	839	autodetected (or immediately if this has already happened).
		840
		841	The block will be executed I<after> the actual backend has been detected
		842	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		843	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		844	other initialisations - see the sources of L<AnyEvent::Strict> or
		845	L<AnyEvent::AIO> to see how this is used.
		846
		847	The most common usage is to create some global watchers, without forcing
		848	event module detection too early, for example, L<AnyEvent::AIO> creates
		849	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		850	avoid autodetecting the event module at load time.
649		851
650	If called in scalar or list context, then it creates and returns an object	852	If called in scalar or list context, then it creates and returns an object
651	that automatically removes the callback again when it is destroyed. See	853	that automatically removes the callback again when it is destroyed. See
652	L<Coro::BDB> for a case where this is useful.	854	L<Coro::BDB> for a case where this is useful.
653		855
…		…
656	If there are any code references in this array (you can C<push> to it	858	If there are any code references in this array (you can C<push> to it
657	before or after loading AnyEvent), then they will called directly after	859	before or after loading AnyEvent), then they will called directly after
658	the event loop has been chosen.	860	the event loop has been chosen.
659		861
660	You should check C<$AnyEvent::MODEL> before adding to this array, though:	862	You should check C<$AnyEvent::MODEL> before adding to this array, though:
661	if it contains a true value then the event loop has already been detected,	863	if it is defined then the event loop has already been detected, and the
662	and the array will be ignored.	864	array will be ignored.
663		865
664	Best use C<AnyEvent::post_detect { BLOCK }> instead.	866	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		867	it,as it takes care of these details.
		868
		869	This variable is mainly useful for modules that can do something useful
		870	when AnyEvent is used and thus want to know when it is initialised, but do
		871	not need to even load it by default. This array provides the means to hook
		872	into AnyEvent passively, without loading it.
665		873
666	=back	874	=back
667		875
668	=head1 WHAT TO DO IN A MODULE	876	=head1 WHAT TO DO IN A MODULE
669		877
…		…
724		932
725		933
726	=head1 OTHER MODULES	934	=head1 OTHER MODULES
727		935
728	The following is a non-exhaustive list of additional modules that use	936	The following is a non-exhaustive list of additional modules that use
729	AnyEvent and can therefore be mixed easily with other AnyEvent modules	937	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
730	in the same program. Some of the modules come with AnyEvent, some are	938	modules and other event loops in the same program. Some of the modules
731	available via CPAN.	939	come with AnyEvent, most are available via CPAN.
732		940
733	=over 4	941	=over 4
734		942
735	=item L<AnyEvent::Util>	943	=item L<AnyEvent::Util>
736		944
…		…
745		953
746	=item L<AnyEvent::Handle>	954	=item L<AnyEvent::Handle>
747		955
748	Provide read and write buffers, manages watchers for reads and writes,	956	Provide read and write buffers, manages watchers for reads and writes,
749	supports raw and formatted I/O, I/O queued and fully transparent and	957	supports raw and formatted I/O, I/O queued and fully transparent and
750	non-blocking SSL/TLS.	958	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
751		959
752	=item L<AnyEvent::DNS>	960	=item L<AnyEvent::DNS>
753		961
754	Provides rich asynchronous DNS resolver capabilities.	962	Provides rich asynchronous DNS resolver capabilities.
755		963
…		…
783		991
784	=item L<AnyEvent::GPSD>	992	=item L<AnyEvent::GPSD>
785		993
786	A non-blocking interface to gpsd, a daemon delivering GPS information.	994	A non-blocking interface to gpsd, a daemon delivering GPS information.
787		995
		996	=item L<AnyEvent::IRC>
		997
		998	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		999
		1000	=item L<AnyEvent::XMPP>
		1001
		1002	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1003	Net::XMPP2>.
		1004
788	=item L<AnyEvent::IGS>	1005	=item L<AnyEvent::IGS>
789		1006
790	A non-blocking interface to the Internet Go Server protocol (used by	1007	A non-blocking interface to the Internet Go Server protocol (used by
791	L<App::IGS>).	1008	L<App::IGS>).
792		1009
793	=item L<Net::IRC3>
794
795	AnyEvent based IRC client module family.
796
797	=item L<Net::XMPP2>
798
799	AnyEvent based XMPP (Jabber protocol) module family.
800
801	=item L<Net::FCP>	1010	=item L<Net::FCP>
802		1011
803	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1012	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
804	of AnyEvent.	1013	of AnyEvent.
805		1014
…		…
809		1018
810	=item L<Coro>	1019	=item L<Coro>
811		1020
812	Has special support for AnyEvent via L<Coro::AnyEvent>.	1021	Has special support for AnyEvent via L<Coro::AnyEvent>.
813		1022
814	=item L<IO::Lambda>
815
816	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
817
818	=back	1023	=back
819		1024
820	=cut	1025	=cut
821		1026
822	package AnyEvent;	1027	package AnyEvent;
823		1028
824	no warnings;	1029	no warnings;
825	use strict;	1030	use strict qw(vars subs);
826		1031
827	use Carp;	1032	use Carp ();
828		1033
829	our $VERSION = 4.2;	1034	our $VERSION = 4.83;
830	our $MODEL;	1035	our $MODEL;
831		1036
832	our $AUTOLOAD;	1037	our $AUTOLOAD;
833	our @ISA;	1038	our @ISA;
834		1039
835	our @REGISTRY;	1040	our @REGISTRY;
836		1041
837	our $WIN32;	1042	our $WIN32;
838		1043
839	BEGIN {	1044	BEGIN {
840	my $win32 = ! ! ($^O =~ /mswin32/i);	1045	eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
841	eval "sub WIN32(){ $win32 }";	1046	eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
		1047
		1048	delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
		1049	if ${^TAINT};
842	}	1050	}
843		1051
844	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	1052	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
845		1053
846	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred	1054	our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
…		…
857	[Event:: => AnyEvent::Impl::Event::],	1065	[Event:: => AnyEvent::Impl::Event::],
858	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1066	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
859	# everything below here will not be autoprobed	1067	# everything below here will not be autoprobed
860	# as the pureperl backend should work everywhere	1068	# as the pureperl backend should work everywhere
861	# and is usually faster	1069	# and is usually faster
862	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
863	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1070	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
864	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1071	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1072	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
865	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1073	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
866	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	1074	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
867	[Wx:: => AnyEvent::Impl::POE::],	1075	[Wx:: => AnyEvent::Impl::POE::],
868	[Prima:: => AnyEvent::Impl::POE::],	1076	[Prima:: => AnyEvent::Impl::POE::],
		1077	# IO::Async is just too broken - we would need workarounds for its
		1078	# byzantine signal and broken child handling, among others.
		1079	# IO::Async is rather hard to detect, as it doesn't have any
		1080	# obvious default class.
		1081	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1082	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
		1083	# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
869	);	1084	);
870		1085
871	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);	1086	our %method = map +($_ => 1),
		1087	qw(io timer time now now_update signal child idle condvar one_event DESTROY);
872		1088
873	our @post_detect;	1089	our @post_detect;
874		1090
875	sub post_detect(&) {	1091	sub post_detect(&) {
876	my ($cb) = @_;	1092	my ($cb) = @_;
…		…
881	1	1097	1
882	} else {	1098	} else {
883	push @post_detect, $cb;	1099	push @post_detect, $cb;
884		1100
885	defined wantarray	1101	defined wantarray
886	? bless \$cb, "AnyEvent::Util::PostDetect"	1102	? bless \$cb, "AnyEvent::Util::postdetect"
887	: ()	1103	: ()
888	}	1104	}
889	}	1105	}
890		1106
891	sub AnyEvent::Util::PostDetect::DESTROY {	1107	sub AnyEvent::Util::postdetect::DESTROY {
892	@post_detect = grep $_ != ${$_[0]}, @post_detect;	1108	@post_detect = grep $_ != ${$_[0]}, @post_detect;
893	}	1109	}
894		1110
895	sub detect() {	1111	sub detect() {
896	unless ($MODEL) {	1112	unless ($MODEL) {
…		…
899		1115
900	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	1116	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
901	my $model = "AnyEvent::Impl::$1";	1117	my $model = "AnyEvent::Impl::$1";
902	if (eval "require $model") {	1118	if (eval "require $model") {
903	$MODEL = $model;	1119	$MODEL = $model;
904	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;	1120	warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $verbose > 1;
905	} else {	1121	} else {
906	warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;	1122	warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $verbose;
907	}	1123	}
908	}	1124	}
909		1125
910	# check for already loaded models	1126	# check for already loaded models
911	unless ($MODEL) {	1127	unless ($MODEL) {
…		…
933	last;	1149	last;
934	}	1150	}
935	}	1151	}
936		1152
937	$MODEL	1153	$MODEL
938	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";	1154	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
939	}	1155	}
940	}	1156	}
941		1157
		1158	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		1159
942	unshift @ISA, $MODEL;	1160	unshift @ISA, $MODEL;
943	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	1161
		1162	require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
944		1163
945	(shift @post_detect)->() while @post_detect;	1164	(shift @post_detect)->() while @post_detect;
946	}	1165	}
947		1166
948	$MODEL	1167	$MODEL
…		…
950		1169
951	sub AUTOLOAD {	1170	sub AUTOLOAD {
952	(my $func = $AUTOLOAD) =~ s/.*://;	1171	(my $func = $AUTOLOAD) =~ s/.*://;
953		1172
954	$method{$func}	1173	$method{$func}
955	or croak "$func: not a valid method for AnyEvent objects";	1174	or Carp::croak "$func: not a valid method for AnyEvent objects";
956		1175
957	detect unless $MODEL;	1176	detect unless $MODEL;
958		1177
959	my $class = shift;	1178	my $class = shift;
960	$class->$func (@_);	1179	$class->$func (@_);
961	}	1180	}
962		1181
		1182	# utility function to dup a filehandle. this is used by many backends
		1183	# to support binding more than one watcher per filehandle (they usually
		1184	# allow only one watcher per fd, so we dup it to get a different one).
		1185	sub _dupfh($$;$$) {
		1186	my ($poll, $fh, $r, $w) = @_;
		1187
		1188	# cygwin requires the fh mode to be matching, unix doesn't
		1189	my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
		1190
		1191	open my $fh2, $mode, $fh
		1192	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
		1193
		1194	# we assume CLOEXEC is already set by perl in all important cases
		1195
		1196	($fh2, $rw)
		1197	}
		1198
963	package AnyEvent::Base;	1199	package AnyEvent::Base;
964		1200
965	# default implementation for now and time	1201	# default implementations for many methods
966		1202
967	use Time::HiRes ();	1203	BEGIN {
		1204	if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
		1205	*_time = \&Time::HiRes::time;
		1206	# if (eval "use POSIX (); (POSIX::times())...
		1207	} else {
		1208	*_time = sub { time }; # epic fail
		1209	}
		1210	}
968		1211
969	sub time { Time::HiRes::time }	1212	sub time { _time }
970	sub now { Time::HiRes::time }	1213	sub now { _time }
		1214	sub now_update { }
971		1215
972	# default implementation for ->condvar	1216	# default implementation for ->condvar
973		1217
974	sub condvar {	1218	sub condvar {
975	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::	1219	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
976	}	1220	}
977		1221
978	# default implementation for ->signal	1222	# default implementation for ->signal
979		1223
980	our %SIG_CB;	1224	our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
		1225
		1226	sub _signal_exec {
		1227	sysread $SIGPIPE_R, my $dummy, 4;
		1228
		1229	while (%SIG_EV) {
		1230	for (keys %SIG_EV) {
		1231	delete $SIG_EV{$_};
		1232	$_->() for values %{ $SIG_CB{$_} || {} };
		1233	}
		1234	}
		1235	}
981		1236
982	sub signal {	1237	sub signal {
983	my (undef, %arg) = @_;	1238	my (undef, %arg) = @_;
984		1239
		1240	unless ($SIGPIPE_R) {
		1241	require Fcntl;
		1242
		1243	if (AnyEvent::WIN32) {
		1244	require AnyEvent::Util;
		1245
		1246	($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
		1247	AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
		1248	AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
		1249	} else {
		1250	pipe $SIGPIPE_R, $SIGPIPE_W;
		1251	fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
		1252	fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
		1253
		1254	# not strictly required, as $^F is normally 2, but let's make sure...
		1255	fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1256	fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
		1257	}
		1258
		1259	$SIGPIPE_R
		1260	or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
		1261
		1262	$SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
		1263	}
		1264
985	my $signal = uc $arg{signal}	1265	my $signal = uc $arg{signal}
986	or Carp::croak "required option 'signal' is missing";	1266	or Carp::croak "required option 'signal' is missing";
987		1267
988	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};	1268	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
989	$SIG{$signal} ||= sub {	1269	$SIG{$signal} ||= sub {
990	$_->() for values %{ $SIG_CB{$signal} || {} };	1270	local $!;
		1271	syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
		1272	undef $SIG_EV{$signal};
991	};	1273	};
992		1274
993	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"	1275	bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
994	}	1276	}
995		1277
996	sub AnyEvent::Base::Signal::DESTROY {	1278	sub AnyEvent::Base::signal::DESTROY {
997	my ($signal, $cb) = @{$_[0]};	1279	my ($signal, $cb) = @{$_[0]};
998		1280
999	delete $SIG_CB{$signal}{$cb};	1281	delete $SIG_CB{$signal}{$cb};
1000		1282
		1283	# delete doesn't work with older perls - they then
		1284	# print weird messages, or just unconditionally exit
		1285	# instead of getting the default action.
1001	delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };	1286	undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1002	}	1287	}
1003		1288
1004	# default implementation for ->child	1289	# default implementation for ->child
1005		1290
1006	our %PID_CB;	1291	our %PID_CB;
1007	our $CHLD_W;	1292	our $CHLD_W;
1008	our $CHLD_DELAY_W;	1293	our $CHLD_DELAY_W;
1009	our $PID_IDLE;
1010	our $WNOHANG;	1294	our $WNOHANG;
1011		1295
1012	sub _child_wait {	1296	sub _sigchld {
1013	while (0 < (my $pid = waitpid -1, $WNOHANG)) {	1297	while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1014	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),	1298	$_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1015	(values %{ $PID_CB{0} || {} });	1299	(values %{ $PID_CB{0} || {} });
1016	}	1300	}
1017
1018	undef $PID_IDLE;
1019	}
1020
1021	sub _sigchld {
1022	# make sure we deliver these changes "synchronous" with the event loop.
1023	$CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1024	undef $CHLD_DELAY_W;
1025	&_child_wait;
1026	});
1027	}	1301	}
1028		1302
1029	sub child {	1303	sub child {
1030	my (undef, %arg) = @_;	1304	my (undef, %arg) = @_;
1031		1305
1032	defined (my $pid = $arg{pid} + 0)	1306	defined (my $pid = $arg{pid} + 0)
1033	or Carp::croak "required option 'pid' is missing";	1307	or Carp::croak "required option 'pid' is missing";
1034		1308
1035	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1309	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
1036		1310
1037	unless ($WNOHANG) {
1038	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;	1311	$WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1039	}
1040		1312
1041	unless ($CHLD_W) {	1313	unless ($CHLD_W) {
1042	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1314	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1043	# child could be a zombie already, so make at least one round	1315	# child could be a zombie already, so make at least one round
1044	&_sigchld;	1316	&_sigchld;
1045	}	1317	}
1046		1318
1047	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"	1319	bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1048	}	1320	}
1049		1321
1050	sub AnyEvent::Base::Child::DESTROY {	1322	sub AnyEvent::Base::child::DESTROY {
1051	my ($pid, $cb) = @{$_[0]};	1323	my ($pid, $cb) = @{$_[0]};
1052		1324
1053	delete $PID_CB{$pid}{$cb};	1325	delete $PID_CB{$pid}{$cb};
1054	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1326	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1055		1327
1056	undef $CHLD_W unless keys %PID_CB;	1328	undef $CHLD_W unless keys %PID_CB;
		1329	}
		1330
		1331	# idle emulation is done by simply using a timer, regardless
		1332	# of whether the process is idle or not, and not letting
		1333	# the callback use more than 50% of the time.
		1334	sub idle {
		1335	my (undef, %arg) = @_;
		1336
		1337	my ($cb, $w, $rcb) = $arg{cb};
		1338
		1339	$rcb = sub {
		1340	if ($cb) {
		1341	$w = _time;
		1342	&$cb;
		1343	$w = _time - $w;
		1344
		1345	# never use more then 50% of the time for the idle watcher,
		1346	# within some limits
		1347	$w = 0.0001 if $w < 0.0001;
		1348	$w = 5 if $w > 5;
		1349
		1350	$w = AnyEvent->timer (after => $w, cb => $rcb);
		1351	} else {
		1352	# clean up...
		1353	undef $w;
		1354	undef $rcb;
		1355	}
		1356	};
		1357
		1358	$w = AnyEvent->timer (after => 0.05, cb => $rcb);
		1359
		1360	bless \\$cb, "AnyEvent::Base::idle"
		1361	}
		1362
		1363	sub AnyEvent::Base::idle::DESTROY {
		1364	undef $${$_[0]};
1057	}	1365	}
1058		1366
1059	package AnyEvent::CondVar;	1367	package AnyEvent::CondVar;
1060		1368
1061	our @ISA = AnyEvent::CondVar::Base::;	1369	our @ISA = AnyEvent::CondVar::Base::;
…		…
1063	package AnyEvent::CondVar::Base;	1371	package AnyEvent::CondVar::Base;
1064		1372
1065	use overload	1373	use overload
1066	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },	1374	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1067	fallback => 1;	1375	fallback => 1;
		1376
		1377	our $WAITING;
1068		1378
1069	sub _send {	1379	sub _send {
1070	# nop	1380	# nop
1071	}	1381	}
1072		1382
…		…
1085	sub ready {	1395	sub ready {
1086	$_[0]{_ae_sent}	1396	$_[0]{_ae_sent}
1087	}	1397	}
1088		1398
1089	sub _wait {	1399	sub _wait {
		1400	$WAITING
		1401	and !$_[0]{_ae_sent}
		1402	and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
		1403
		1404	local $WAITING = 1;
1090	AnyEvent->one_event while !$_[0]{_ae_sent};	1405	AnyEvent->one_event while !$_[0]{_ae_sent};
1091	}	1406	}
1092		1407
1093	sub recv {	1408	sub recv {
1094	$_[0]->_wait;	1409	$_[0]->_wait;
…		…
1113	}	1428	}
1114		1429
1115	# undocumented/compatibility with pre-3.4	1430	# undocumented/compatibility with pre-3.4
1116	*broadcast = \&send;	1431	*broadcast = \&send;
1117	*wait = \&_wait;	1432	*wait = \&_wait;
		1433
		1434	=head1 ERROR AND EXCEPTION HANDLING
		1435
		1436	In general, AnyEvent does not do any error handling - it relies on the
		1437	caller to do that if required. The L<AnyEvent::Strict> module (see also
		1438	the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
		1439	checking of all AnyEvent methods, however, which is highly useful during
		1440	development.
		1441
		1442	As for exception handling (i.e. runtime errors and exceptions thrown while
		1443	executing a callback), this is not only highly event-loop specific, but
		1444	also not in any way wrapped by this module, as this is the job of the main
		1445	program.
		1446
		1447	The pure perl event loop simply re-throws the exception (usually
		1448	within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
		1449	$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
		1450	so on.
		1451
		1452	=head1 ENVIRONMENT VARIABLES
		1453
		1454	The following environment variables are used by this module or its
		1455	submodules.
		1456
		1457	Note that AnyEvent will remove I<all> environment variables starting with
		1458	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		1459	enabled.
		1460
		1461	=over 4
		1462
		1463	=item C<PERL_ANYEVENT_VERBOSE>
		1464
		1465	By default, AnyEvent will be completely silent except in fatal
		1466	conditions. You can set this environment variable to make AnyEvent more
		1467	talkative.
		1468
		1469	When set to C<1> or higher, causes AnyEvent to warn about unexpected
		1470	conditions, such as not being able to load the event model specified by
		1471	C<PERL_ANYEVENT_MODEL>.
		1472
		1473	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		1474	model it chooses.
		1475
		1476	=item C<PERL_ANYEVENT_STRICT>
		1477
		1478	AnyEvent does not do much argument checking by default, as thorough
		1479	argument checking is very costly. Setting this variable to a true value
		1480	will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
		1481	check the arguments passed to most method calls. If it finds any problems,
		1482	it will croak.
		1483
		1484	In other words, enables "strict" mode.
		1485
		1486	Unlike C<use strict>, it is definitely recommended to keep it off in
		1487	production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
		1488	developing programs can be very useful, however.
		1489
		1490	=item C<PERL_ANYEVENT_MODEL>
		1491
		1492	This can be used to specify the event model to be used by AnyEvent, before
		1493	auto detection and -probing kicks in. It must be a string consisting
		1494	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		1495	and the resulting module name is loaded and if the load was successful,
		1496	used as event model. If it fails to load AnyEvent will proceed with
		1497	auto detection and -probing.
		1498
		1499	This functionality might change in future versions.
		1500
		1501	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		1502	could start your program like this:
		1503
		1504	PERL_ANYEVENT_MODEL=Perl perl ...
		1505
		1506	=item C<PERL_ANYEVENT_PROTOCOLS>
		1507
		1508	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1509	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1510	of auto probing).
		1511
		1512	Must be set to a comma-separated list of protocols or address families,
		1513	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1514	used, and preference will be given to protocols mentioned earlier in the
		1515	list.
		1516
		1517	This variable can effectively be used for denial-of-service attacks
		1518	against local programs (e.g. when setuid), although the impact is likely
		1519	small, as the program has to handle conenction and other failures anyways.
		1520
		1521	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1522	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1523	- only support IPv4, never try to resolve or contact IPv6
		1524	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1525	IPv6, but prefer IPv6 over IPv4.
		1526
		1527	=item C<PERL_ANYEVENT_EDNS0>
		1528
		1529	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1530	for DNS. This extension is generally useful to reduce DNS traffic, but
		1531	some (broken) firewalls drop such DNS packets, which is why it is off by
		1532	default.
		1533
		1534	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1535	EDNS0 in its DNS requests.
		1536
		1537	=item C<PERL_ANYEVENT_MAX_FORKS>
		1538
		1539	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1540	will create in parallel.
		1541
		1542	=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
		1543
		1544	The default value for the C<max_outstanding> parameter for the default DNS
		1545	resolver - this is the maximum number of parallel DNS requests that are
		1546	sent to the DNS server.
		1547
		1548	=item C<PERL_ANYEVENT_RESOLV_CONF>
		1549
		1550	The file to use instead of F</etc/resolv.conf> (or OS-specific
		1551	configuration) in the default resolver. When set to the empty string, no
		1552	default config will be used.
		1553
		1554	=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
		1555
		1556	When neither C<ca_file> nor C<ca_path> was specified during
		1557	L<AnyEvent::TLS> context creation, and either of these environment
		1558	variables exist, they will be used to specify CA certificate locations
		1559	instead of a system-dependent default.
		1560
		1561	=back
1118		1562
1119	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1563	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1120		1564
1121	This is an advanced topic that you do not normally need to use AnyEvent in	1565	This is an advanced topic that you do not normally need to use AnyEvent in
1122	a module. This section is only of use to event loop authors who want to	1566	a module. This section is only of use to event loop authors who want to
…		…
1156		1600
1157	I<rxvt-unicode> also cheats a bit by not providing blocking access to	1601	I<rxvt-unicode> also cheats a bit by not providing blocking access to
1158	condition variables: code blocking while waiting for a condition will	1602	condition variables: code blocking while waiting for a condition will
1159	C<die>. This still works with most modules/usages, and blocking calls must	1603	C<die>. This still works with most modules/usages, and blocking calls must
1160	not be done in an interactive application, so it makes sense.	1604	not be done in an interactive application, so it makes sense.
1161
1162	=head1 ENVIRONMENT VARIABLES
1163
1164	The following environment variables are used by this module:
1165
1166	=over 4
1167
1168	=item C<PERL_ANYEVENT_VERBOSE>
1169
1170	By default, AnyEvent will be completely silent except in fatal
1171	conditions. You can set this environment variable to make AnyEvent more
1172	talkative.
1173
1174	When set to C<1> or higher, causes AnyEvent to warn about unexpected
1175	conditions, such as not being able to load the event model specified by
1176	C<PERL_ANYEVENT_MODEL>.
1177
1178	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1179	model it chooses.
1180
1181	=item C<PERL_ANYEVENT_MODEL>
1182
1183	This can be used to specify the event model to be used by AnyEvent, before
1184	auto detection and -probing kicks in. It must be a string consisting
1185	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1186	and the resulting module name is loaded and if the load was successful,
1187	used as event model. If it fails to load AnyEvent will proceed with
1188	auto detection and -probing.
1189
1190	This functionality might change in future versions.
1191
1192	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1193	could start your program like this:
1194
1195	PERL_ANYEVENT_MODEL=Perl perl ...
1196
1197	=item C<PERL_ANYEVENT_PROTOCOLS>
1198
1199	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1200	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1201	of auto probing).
1202
1203	Must be set to a comma-separated list of protocols or address families,
1204	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1205	used, and preference will be given to protocols mentioned earlier in the
1206	list.
1207
1208	This variable can effectively be used for denial-of-service attacks
1209	against local programs (e.g. when setuid), although the impact is likely
1210	small, as the program has to handle connection errors already-
1211
1212	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1213	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1214	- only support IPv4, never try to resolve or contact IPv6
1215	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1216	IPv6, but prefer IPv6 over IPv4.
1217
1218	=item C<PERL_ANYEVENT_EDNS0>
1219
1220	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1221	for DNS. This extension is generally useful to reduce DNS traffic, but
1222	some (broken) firewalls drop such DNS packets, which is why it is off by
1223	default.
1224
1225	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1226	EDNS0 in its DNS requests.
1227
1228	=item C<PERL_ANYEVENT_MAX_FORKS>
1229
1230	The maximum number of child processes that C<AnyEvent::Util::fork_call>
1231	will create in parallel.
1232
1233	=back
1234		1605
1235	=head1 EXAMPLE PROGRAM	1606	=head1 EXAMPLE PROGRAM
1236		1607
1237	The following program uses an I/O watcher to read data from STDIN, a timer	1608	The following program uses an I/O watcher to read data from STDIN, a timer
1238	to display a message once per second, and a condition variable to quit the	1609	to display a message once per second, and a condition variable to quit the
…		…
1432	watcher.	1803	watcher.
1433		1804
1434	=head3 Results	1805	=head3 Results
1435		1806
1436	name watchers bytes create invoke destroy comment	1807	name watchers bytes create invoke destroy comment
1437	EV/EV 400000 244 0.56 0.46 0.31 EV native interface	1808	EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1438	EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers	1809	EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1439	CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal	1810	CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1440	Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation	1811	Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1441	Event/Event 16000 516 31.88 31.30 0.85 Event native interface	1812	Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1442	Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers	1813	Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
		1814	IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
		1815	IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1443	Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour	1816	Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1444	Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers	1817	Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1445	POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event	1818	POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1446	POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select	1819	POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1447		1820
1448	=head3 Discussion	1821	=head3 Discussion
1449		1822
1450	The benchmark does I<not> measure scalability of the event loop very	1823	The benchmark does I<not> measure scalability of the event loop very
1451	well. For example, a select-based event loop (such as the pure perl one)	1824	well. For example, a select-based event loop (such as the pure perl one)
…		…
1476	performance becomes really bad with lots of file descriptors (and few of	1849	performance becomes really bad with lots of file descriptors (and few of
1477	them active), of course, but this was not subject of this benchmark.	1850	them active), of course, but this was not subject of this benchmark.
1478		1851
1479	The C<Event> module has a relatively high setup and callback invocation	1852	The C<Event> module has a relatively high setup and callback invocation
1480	cost, but overall scores in on the third place.	1853	cost, but overall scores in on the third place.
		1854
		1855	C<IO::Async> performs admirably well, about on par with C<Event>, even
		1856	when using its pure perl backend.
1481		1857
1482	C<Glib>'s memory usage is quite a bit higher, but it features a	1858	C<Glib>'s memory usage is quite a bit higher, but it features a
1483	faster callback invocation and overall ends up in the same class as	1859	faster callback invocation and overall ends up in the same class as
1484	C<Event>. However, Glib scales extremely badly, doubling the number of	1860	C<Event>. However, Glib scales extremely badly, doubling the number of
1485	watchers increases the processing time by more than a factor of four,	1861	watchers increases the processing time by more than a factor of four,
…		…
1563	it to another server. This includes deleting the old timeout and creating	1939	it to another server. This includes deleting the old timeout and creating
1564	a new one that moves the timeout into the future.	1940	a new one that moves the timeout into the future.
1565		1941
1566	=head3 Results	1942	=head3 Results
1567		1943
1568	name sockets create request	1944	name sockets create request
1569	EV 20000 69.01 11.16	1945	EV 20000 69.01 11.16
1570	Perl 20000 73.32 35.87	1946	Perl 20000 73.32 35.87
		1947	IOAsync 20000 157.00 98.14 epoll
		1948	IOAsync 20000 159.31 616.06 poll
1571	Event 20000 212.62 257.32	1949	Event 20000 212.62 257.32
1572	Glib 20000 651.16 1896.30	1950	Glib 20000 651.16 1896.30
1573	POE 20000 349.67 12317.24 uses POE::Loop::Event	1951	POE 20000 349.67 12317.24 uses POE::Loop::Event
1574		1952
1575	=head3 Discussion	1953	=head3 Discussion
1576		1954
1577	This benchmark I<does> measure scalability and overall performance of the	1955	This benchmark I<does> measure scalability and overall performance of the
1578	particular event loop.	1956	particular event loop.
…		…
1580	EV is again fastest. Since it is using epoll on my system, the setup time	1958	EV is again fastest. Since it is using epoll on my system, the setup time
1581	is relatively high, though.	1959	is relatively high, though.
1582		1960
1583	Perl surprisingly comes second. It is much faster than the C-based event	1961	Perl surprisingly comes second. It is much faster than the C-based event
1584	loops Event and Glib.	1962	loops Event and Glib.
		1963
		1964	IO::Async performs very well when using its epoll backend, and still quite
		1965	good compared to Glib when using its pure perl backend.
1585		1966
1586	Event suffers from high setup time as well (look at its code and you will	1967	Event suffers from high setup time as well (look at its code and you will
1587	understand why). Callback invocation also has a high overhead compared to	1968	understand why). Callback invocation also has a high overhead compared to
1588	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event	1969	the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1589	uses select or poll in basically all documented configurations.	1970	uses select or poll in basically all documented configurations.
…		…
1652	=item * C-based event loops perform very well with small number of	2033	=item * C-based event loops perform very well with small number of
1653	watchers, as the management overhead dominates.	2034	watchers, as the management overhead dominates.
1654		2035
1655	=back	2036	=back
1656		2037
		2038	=head2 THE IO::Lambda BENCHMARK
		2039
		2040	Recently I was told about the benchmark in the IO::Lambda manpage, which
		2041	could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
		2042	simply compares IO::Lambda with POE, and IO::Lambda looks better (which
		2043	shouldn't come as a surprise to anybody). As such, the benchmark is
		2044	fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
		2045	very optimal. But how would AnyEvent compare when used without the extra
		2046	baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
		2047
		2048	The benchmark itself creates an echo-server, and then, for 500 times,
		2049	connects to the echo server, sends a line, waits for the reply, and then
		2050	creates the next connection. This is a rather bad benchmark, as it doesn't
		2051	test the efficiency of the framework or much non-blocking I/O, but it is a
		2052	benchmark nevertheless.
		2053
		2054	name runtime
		2055	Lambda/select 0.330 sec
		2056	+ optimized 0.122 sec
		2057	Lambda/AnyEvent 0.327 sec
		2058	+ optimized 0.138 sec
		2059	Raw sockets/select 0.077 sec
		2060	POE/select, components 0.662 sec
		2061	POE/select, raw sockets 0.226 sec
		2062	POE/select, optimized 0.404 sec
		2063
		2064	AnyEvent/select/nb 0.085 sec
		2065	AnyEvent/EV/nb 0.068 sec
		2066	+state machine 0.134 sec
		2067
		2068	The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
		2069	benchmarks actually make blocking connects and use 100% blocking I/O,
		2070	defeating the purpose of an event-based solution. All of the newly
		2071	written AnyEvent benchmarks use 100% non-blocking connects (using
		2072	AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
		2073	resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
		2074	generally require a lot more bookkeeping and event handling than blocking
		2075	connects (which involve a single syscall only).
		2076
		2077	The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
		2078	offers similar expressive power as POE and IO::Lambda, using conventional
		2079	Perl syntax. This means that both the echo server and the client are 100%
		2080	non-blocking, further placing it at a disadvantage.
		2081
		2082	As you can see, the AnyEvent + EV combination even beats the
		2083	hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
		2084	backend easily beats IO::Lambda and POE.
		2085
		2086	And even the 100% non-blocking version written using the high-level (and
		2087	slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
		2088	large margin, even though it does all of DNS, tcp-connect and socket I/O
		2089	in a non-blocking way.
		2090
		2091	The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
		2092	F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
		2093	part of the IO::lambda distribution and were used without any changes.
		2094
		2095
		2096	=head1 SIGNALS
		2097
		2098	AnyEvent currently installs handlers for these signals:
		2099
		2100	=over 4
		2101
		2102	=item SIGCHLD
		2103
		2104	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
		2105	emulation for event loops that do not support them natively. Also, some
		2106	event loops install a similar handler.
		2107
		2108	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
		2109	AnyEvent will reset it to default, to avoid losing child exit statuses.
		2110
		2111	=item SIGPIPE
		2112
		2113	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
		2114	when AnyEvent gets loaded.
		2115
		2116	The rationale for this is that AnyEvent users usually do not really depend
		2117	on SIGPIPE delivery (which is purely an optimisation for shell use, or
		2118	badly-written programs), but C<SIGPIPE> can cause spurious and rare
		2119	program exits as a lot of people do not expect C<SIGPIPE> when writing to
		2120	some random socket.
		2121
		2122	The rationale for installing a no-op handler as opposed to ignoring it is
		2123	that this way, the handler will be restored to defaults on exec.
		2124
		2125	Feel free to install your own handler, or reset it to defaults.
		2126
		2127	=back
		2128
		2129	=cut
		2130
		2131	undef $SIG{CHLD}
		2132	if $SIG{CHLD} eq 'IGNORE';
		2133
		2134	$SIG{PIPE} = sub { }
		2135	unless defined $SIG{PIPE};
1657		2136
1658	=head1 FORK	2137	=head1 FORK
1659		2138
1660	Most event libraries are not fork-safe. The ones who are usually are	2139	Most event libraries are not fork-safe. The ones who are usually are
1661	because they rely on inefficient but fork-safe C<select> or C<poll>	2140	because they rely on inefficient but fork-safe C<select> or C<poll>
…		…
1681		2160
1682	use AnyEvent;	2161	use AnyEvent;
1683		2162
1684	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can	2163	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1685	be used to probe what backend is used and gain other information (which is	2164	be used to probe what backend is used and gain other information (which is
1686	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	2165	probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
		2166	$ENV{PERL_ANYEVENT_STRICT}.
		2167
		2168	Note that AnyEvent will remove I<all> environment variables starting with
		2169	C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
		2170	enabled.
1687		2171
1688		2172
1689	=head1 BUGS	2173	=head1 BUGS
1690		2174
1691	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard	2175	Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1692	to work around. If you suffer from memleaks, first upgrade to Perl 5.10	2176	to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1693	and check wether the leaks still show up. (Perl 5.10.0 has other annoying	2177	and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1694	mamleaks, such as leaking on C<map> and C<grep> but it is usually not as	2178	memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1695	pronounced).	2179	pronounced).
1696		2180
1697		2181
1698	=head1 SEE ALSO	2182	=head1 SEE ALSO
1699		2183
…		…
1703	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2187	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1704		2188
1705	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2189	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1706	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2190	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1707	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2191	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1708	L<AnyEvent::Impl::POE>.	2192	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
1709		2193
1710	Non-blocking file handles, sockets, TCP clients and	2194	Non-blocking file handles, sockets, TCP clients and
1711	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2195	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1712		2196
1713	Asynchronous DNS: L<AnyEvent::DNS>.	2197	Asynchronous DNS: L<AnyEvent::DNS>.
1714		2198
1715	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2199	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2200	L<Coro::Event>,
1716		2201
1717	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2202	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2203	L<AnyEvent::HTTP>.
1718		2204
1719		2205
1720	=head1 AUTHOR	2206	=head1 AUTHOR
1721		2207
1722	Marc Lehmann <schmorp@schmorp.de>	2208	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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