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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.105 by root, Thu May 1 12:35:54 2008 UTC vs.
Revision 1.133 by root, Sun May 25 03:44:03 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
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {	15	my $w = AnyEvent->timer (after => $seconds, cb => sub {
16	...	16	...
17	});	17	});
18		18
19	my $w = AnyEvent->condvar; # stores whether a condition was flagged	19	my $w = AnyEvent->condvar; # stores whether a condition was flagged
		20	$w->send; # wake up current and all future recv's
20	$w->wait; # enters "main loop" till $condvar gets ->broadcast	21	$w->recv; # enters "main loop" till $condvar gets ->send
21	$w->broadcast; # wake up current and all future wait's
22		22
23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24		24
25	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	25	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26	nowadays. So what is different about AnyEvent?	26	nowadays. So what is different about AnyEvent?
…		…
57	as those use one of the supported event loops. It is trivial to add new	57	as those use one of the supported event loops. It is trivial to add new
58	event loops to AnyEvent, too, so it is future-proof).	58	event loops to AnyEvent, too, so it is future-proof).
59		59
60	In addition to being free of having to use I<the one and only true event	60	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	61	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	62	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	63	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	64	offering the functionality that is necessary, in as thin as a wrapper as
65	technically possible.	65	technically possible.
66		66
67	Of course, if you want lots of policy (this can arguably be somewhat	67	Of course, if you want lots of policy (this can arguably be somewhat
…		…
78	The interface itself is vaguely similar, but not identical to the L<Event>	78	The interface itself is vaguely similar, but not identical to the L<Event>
79	module.	79	module.
80		80
81	During the first call of any watcher-creation method, the module tries	81	During the first call of any watcher-creation method, the module tries
82	to detect the currently loaded event loop by probing whether one of the	82	to detect the currently loaded event loop by probing whether one of the
83	following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>,	83	following modules is already loaded: L<EV>,
84	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,	84	L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,
85	L<POE>. The first one found is used. If none are found, the module tries	85	L<POE>. The first one found is used. If none are found, the module tries
86	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl	86	to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl
87	adaptor should always succeed) in the order given. The first one that can	87	adaptor should always succeed) in the order given. The first one that can
88	be successfully loaded will be used. If, after this, still none could be	88	be successfully loaded will be used. If, after this, still none could be
…		…
108		108
109	=head1 WATCHERS	109	=head1 WATCHERS
110		110
111	AnyEvent has the central concept of a I<watcher>, which is an object that	111	AnyEvent has the central concept of a I<watcher>, which is an object that
112	stores relevant data for each kind of event you are waiting for, such as	112	stores relevant data for each kind of event you are waiting for, such as
113	the callback to call, the filehandle to watch, etc.	113	the callback to call, the file handle to watch, etc.
114		114
115	These watchers are normal Perl objects with normal Perl lifetime. After	115	These watchers are normal Perl objects with normal Perl lifetime. After
116	creating a watcher it will immediately "watch" for events and invoke the	116	creating a watcher it will immediately "watch" for events and invoke the
117	callback when the event occurs (of course, only when the event model	117	callback when the event occurs (of course, only when the event model
118	is in control).	118	is in control).
…		…
237		237
238	Although the callback might get passed parameters, their value and	238	Although the callback might get passed parameters, their value and
239	presence is undefined and you cannot rely on them. Portable AnyEvent	239	presence is undefined and you cannot rely on them. Portable AnyEvent
240	callbacks cannot use arguments passed to signal watcher callbacks.	240	callbacks cannot use arguments passed to signal watcher callbacks.
241		241
242	Multiple signal occurances can be clumped together into one callback	242	Multiple signal occurrences can be clumped together into one callback
243	invocation, and callback invocation will be synchronous. synchronous means	243	invocation, and callback invocation will be synchronous. Synchronous means
244	that it might take a while until the signal gets handled by the process,	244	that it might take a while until the signal gets handled by the process,
245	but it is guarenteed not to interrupt any other callbacks.	245	but it is guaranteed not to interrupt any other callbacks.
246		246
247	The main advantage of using these watchers is that you can share a signal	247	The main advantage of using these watchers is that you can share a signal
248	between multiple watchers.	248	between multiple watchers.
249		249
250	This watcher might use C<%SIG>, so programs overwriting those signals	250	This watcher might use C<%SIG>, so programs overwriting those signals
…		…
279		279
280	Example: fork a process and wait for it	280	Example: fork a process and wait for it
281		281
282	my $done = AnyEvent->condvar;	282	my $done = AnyEvent->condvar;
283		283
284	AnyEvent::detect; # force event module to be initialised
285
286	my $pid = fork or exit 5;	284	my $pid = fork or exit 5;
287		285
288	my $w = AnyEvent->child (	286	my $w = AnyEvent->child (
289	pid => $pid,	287	pid => $pid,
290	cb => sub {	288	cb => sub {
291	my ($pid, $status) = @_;	289	my ($pid, $status) = @_;
292	warn "pid $pid exited with status $status";	290	warn "pid $pid exited with status $status";
293	$done->broadcast;	291	$done->send;
294	},	292	},
295	);	293	);
296		294
297	# do something else, then wait for process exit	295	# do something else, then wait for process exit
298	$done->wait;	296	$done->recv;
299		297
300	=head2 CONDITION VARIABLES	298	=head2 CONDITION VARIABLES
301		299
302	If you are familiar with some event loops you will know that all of them	300	If you are familiar with some event loops you will know that all of them
303	require you to run some blocking "loop", "run" or similar function that	301	require you to run some blocking "loop", "run" or similar function that
…		…
312	Condition variables can be created by calling the C<< AnyEvent->condvar	310	Condition variables can be created by calling the C<< AnyEvent->condvar
313	>> method, usually without arguments. The only argument pair allowed is	311	>> method, usually without arguments. The only argument pair allowed is
314	C<cb>, which specifies a callback to be called when the condition variable	312	C<cb>, which specifies a callback to be called when the condition variable
315	becomes true.	313	becomes true.
316		314
317	After creation, the conditon variable is "false" until it becomes "true"	315	After creation, the condition variable is "false" until it becomes "true"
318	by calling the C<broadcast> method.	316	by calling the C<send> method (or calling the condition variable as if it
		317	were a callback).
319		318
320	Condition variables are similar to callbacks, except that you can	319	Condition variables are similar to callbacks, except that you can
321	optionally wait for them. They can also be called merge points - points	320	optionally wait for them. They can also be called merge points - points
322	in time where multiple outstandign events have been processed. And yet	321	in time where multiple outstanding events have been processed. And yet
323	another way to call them is transations - each condition variable can be	322	another way to call them is transactions - each condition variable can be
324	used to represent a transaction, which finishes at some point and delivers	323	used to represent a transaction, which finishes at some point and delivers
325	a result.	324	a result.
326		325
327	Condition variables are very useful to signal that something has finished,	326	Condition variables are very useful to signal that something has finished,
328	for example, if you write a module that does asynchronous http requests,	327	for example, if you write a module that does asynchronous http requests,
329	then a condition variable would be the ideal candidate to signal the	328	then a condition variable would be the ideal candidate to signal the
330	availability of results. The user can either act when the callback is	329	availability of results. The user can either act when the callback is
331	called or can synchronously C<< ->wait >> for the results.	330	called or can synchronously C<< ->recv >> for the results.
332		331
333	You can also use them to simulate traditional event loops - for example,	332	You can also use them to simulate traditional event loops - for example,
334	you can block your main program until an event occurs - for example, you	333	you can block your main program until an event occurs - for example, you
335	could C<< ->wait >> in your main program until the user clicks the Quit	334	could C<< ->recv >> in your main program until the user clicks the Quit
336	button of your app, which would C<< ->broadcast >> the "quit" event.	335	button of your app, which would C<< ->send >> the "quit" event.
337		336
338	Note that condition variables recurse into the event loop - if you have	337	Note that condition variables recurse into the event loop - if you have
339	two pieces of code that call C<< ->wait >> in a round-robbin fashion, you	338	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	339	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,	340	you should avoid making a blocking wait yourself, at least in callbacks,
342	as this asks for trouble.	341	as this asks for trouble.
343		342
344	Condition variables are represented by hash refs in perl, and the keys	343	Condition variables are represented by hash refs in perl, and the keys
…		…
346	easy (it is often useful to build your own transaction class on top of	345	easy (it is often useful to build your own transaction class on top of
347	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call	346	AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
348	it's C<new> method in your own C<new> method.	347	it's C<new> method in your own C<new> method.
349		348
350	There are two "sides" to a condition variable - the "producer side" which	349	There are two "sides" to a condition variable - the "producer side" which
351	eventually calls C<< -> broadcast >>, and the "consumer side", which waits	350	eventually calls C<< -> send >>, and the "consumer side", which waits
352	for the broadcast to occur.	351	for the send to occur.
353		352
354	Example:	353	Example: wait for a timer.
355		354
356	# wait till the result is ready	355	# wait till the result is ready
357	my $result_ready = AnyEvent->condvar;	356	my $result_ready = AnyEvent->condvar;
358		357
359	# do something such as adding a timer	358	# do something such as adding a timer
360	# or socket watcher the calls $result_ready->broadcast	359	# or socket watcher the calls $result_ready->send
361	# when the "result" is ready.	360	# when the "result" is ready.
362	# in this case, we simply use a timer:	361	# in this case, we simply use a timer:
363	my $w = AnyEvent->timer (	362	my $w = AnyEvent->timer (
364	after => 1,	363	after => 1,
365	cb => sub { $result_ready->broadcast },	364	cb => sub { $result_ready->send },
366	);	365	);
367		366
368	# this "blocks" (while handling events) till the callback	367	# this "blocks" (while handling events) till the callback
369	# calls broadcast	368	# calls send
370	$result_ready->wait;	369	$result_ready->recv;
		370
		371	Example: wait for a timer, but take advantage of the fact that
		372	condition variables are also code references.
		373
		374	my $done = AnyEvent->condvar;
		375	my $delay = AnyEvent->timer (after => 5, cb => $done);
		376	$done->recv;
371		377
372	=head3 METHODS FOR PRODUCERS	378	=head3 METHODS FOR PRODUCERS
373		379
374	These methods should only be used by the producing side, i.e. the	380	These methods should only be used by the producing side, i.e. the
375	code/module that eventually broadcasts the signal. Note that it is also	381	code/module that eventually sends the signal. Note that it is also
376	the producer side which creates the condvar in most cases, but it isn't	382	the producer side which creates the condvar in most cases, but it isn't
377	uncommon for the consumer to create it as well.	383	uncommon for the consumer to create it as well.
378		384
379	=over 4	385	=over 4
380		386
381	=item $cv->broadcast (...)	387	=item $cv->send (...)
382		388
383	Flag the condition as ready - a running C<< ->wait >> and all further	389	Flag the condition as ready - a running C<< ->recv >> and all further
384	calls to C<wait> will (eventually) return after this method has been	390	calls to C<recv> will (eventually) return after this method has been
385	called. If nobody is waiting the broadcast will be remembered.	391	called. If nobody is waiting the send will be remembered.
386		392
387	If a callback has been set on the condition variable, it is called	393	If a callback has been set on the condition variable, it is called
388	immediately from within broadcast.	394	immediately from within send.
389		395
390	Any arguments passed to the C<broadcast> call will be returned by all	396	Any arguments passed to the C<send> call will be returned by all
391	future C<< ->wait >> calls.	397	future C<< ->recv >> calls.
		398
		399	Condition variables are overloaded so one can call them directly (as a
		400	code reference). Calling them directly is the same as calling C<send>.
392		401
393	=item $cv->croak ($error)	402	=item $cv->croak ($error)
394		403
395	Similar to broadcast, but causes all call's wait C<< ->wait >> to invoke	404	Similar to send, but causes all call's to C<< ->recv >> to invoke
396	C<Carp::croak> with the given error message/object/scalar.	405	C<Carp::croak> with the given error message/object/scalar.
397		406
398	This can be used to signal any errors to the condition variable	407	This can be used to signal any errors to the condition variable
399	user/consumer.	408	user/consumer.
400		409
401	=item $cv->begin ([group callback])	410	=item $cv->begin ([group callback])
402		411
403	=item $cv->end	412	=item $cv->end
		413
		414	These two methods are EXPERIMENTAL and MIGHT CHANGE.
404		415
405	These two methods can be used to combine many transactions/events into	416	These two methods can be used to combine many transactions/events into
406	one. For example, a function that pings many hosts in parallel might want	417	one. For example, a function that pings many hosts in parallel might want
407	to use a condition variable for the whole process.	418	to use a condition variable for the whole process.
408		419
409	Every call to C<< ->begin >> will increment a counter, and every call to	420	Every call to C<< ->begin >> will increment a counter, and every call to
410	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end	421	C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
411	>>, the (last) callback passed to C<begin> will be executed. That callback	422	>>, the (last) callback passed to C<begin> will be executed. That callback
412	is I<supposed> to call C<< ->broadcast >>, but that is not required. If no	423	is I<supposed> to call C<< ->send >>, but that is not required. If no
413	callback was set, C<broadcast> will be called without any arguments.	424	callback was set, C<send> will be called without any arguments.
414		425
415	Let's clarify this with the ping example:	426	Let's clarify this with the ping example:
416		427
417	my $cv = AnyEvent->condvar;	428	my $cv = AnyEvent->condvar;
418		429
419	my %result;	430	my %result;
420	$cv->begin (sub { $cv->broadcast (\%result) });	431	$cv->begin (sub { $cv->send (\%result) });
421		432
422	for my $host (@list_of_hosts) {	433	for my $host (@list_of_hosts) {
423	$cv->begin;	434	$cv->begin;
424	ping_host_then_call_callback $host, sub {	435	ping_host_then_call_callback $host, sub {
425	$result{$host} = ...;	436	$result{$host} = ...;
…		…
428	}	439	}
429		440
430	$cv->end;	441	$cv->end;
431		442
432	This code fragment supposedly pings a number of hosts and calls	443	This code fragment supposedly pings a number of hosts and calls
433	C<broadcast> after results for all then have have been gathered - in any	444	C<send> after results for all then have have been gathered - in any
434	order. To achieve this, the code issues a call to C<begin> when it starts	445	order. To achieve this, the code issues a call to C<begin> when it starts
435	each ping request and calls C<end> when it has received some result for	446	each ping request and calls C<end> when it has received some result for
436	it. Since C<begin> and C<end> only maintain a counter, the order in which	447	it. Since C<begin> and C<end> only maintain a counter, the order in which
437	results arrive is not relevant.	448	results arrive is not relevant.
438		449
439	There is an additional bracketing call to C<begin> and C<end> outside the	450	There is an additional bracketing call to C<begin> and C<end> outside the
440	loop, which serves two important purposes: first, it sets the callback	451	loop, which serves two important purposes: first, it sets the callback
441	to be called once the counter reaches C<0>, and second, it ensures that	452	to be called once the counter reaches C<0>, and second, it ensures that
442	broadcast is called even when C<no> hosts are being pinged (the loop	453	C<send> is called even when C<no> hosts are being pinged (the loop
443	doesn't execute once).	454	doesn't execute once).
444		455
445	This is the general pattern when you "fan out" into multiple subrequests:	456	This is the general pattern when you "fan out" into multiple subrequests:
446	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>	457	use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
447	is called at least once, and then, for each subrequest you start, call	458	is called at least once, and then, for each subrequest you start, call
448	C<begin> and for eahc subrequest you finish, call C<end>.	459	C<begin> and for each subrequest you finish, call C<end>.
449		460
450	=back	461	=back
451		462
452	=head3 METHODS FOR CONSUMERS	463	=head3 METHODS FOR CONSUMERS
453		464
454	These methods should only be used by the consuming side, i.e. the	465	These methods should only be used by the consuming side, i.e. the
455	code awaits the condition.	466	code awaits the condition.
456		467
457	=item $cv->wait	468	=over 4
458		469
		470	=item $cv->recv
		471
459	Wait (blocking if necessary) until the C<< ->broadcast >> or C<< ->croak	472	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
460	>> methods have been called on c<$cv>, while servicing other watchers	473	>> methods have been called on c<$cv>, while servicing other watchers
461	normally.	474	normally.
462		475
463	You can only wait once on a condition - additional calls are valid but	476	You can only wait once on a condition - additional calls are valid but
464	will return immediately.	477	will return immediately.
465		478
466	If an error condition has been set by calling C<< ->croak >>, then this	479	If an error condition has been set by calling C<< ->croak >>, then this
467	function will call C<croak>.	480	function will call C<croak>.
468		481
469	In list context, all parameters passed to C<broadcast> will be returned,	482	In list context, all parameters passed to C<send> will be returned,
470	in scalar context only the first one will be returned.	483	in scalar context only the first one will be returned.
471		484
472	Not all event models support a blocking wait - some die in that case	485	Not all event models support a blocking wait - some die in that case
473	(programs might want to do that to stay interactive), so I<if you are	486	(programs might want to do that to stay interactive), so I<if you are
474	using this from a module, never require a blocking wait>, but let the	487	using this from a module, never require a blocking wait>, but let the
475	caller decide whether the call will block or not (for example, by coupling	488	caller decide whether the call will block or not (for example, by coupling
476	condition variables with some kind of request results and supporting	489	condition variables with some kind of request results and supporting
477	callbacks so the caller knows that getting the result will not block,	490	callbacks so the caller knows that getting the result will not block,
478	while still suppporting blocking waits if the caller so desires).	491	while still supporting blocking waits if the caller so desires).
479		492
480	Another reason I<never> to C<< ->wait >> in a module is that you cannot	493	Another reason I<never> to C<< ->recv >> in a module is that you cannot
481	sensibly have two C<< ->wait >>'s in parallel, as that would require	494	sensibly have two C<< ->recv >>'s in parallel, as that would require
482	multiple interpreters or coroutines/threads, none of which C<AnyEvent>	495	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
483	can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and	496	can supply.
484	L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
485	from different coroutines, however).
486		497
		498	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
		499	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
		500	versions and also integrates coroutines into AnyEvent, making blocking
		501	C<< ->recv >> calls perfectly safe as long as they are done from another
		502	coroutine (one that doesn't run the event loop).
		503
487	You can ensure that C<< -wait >> never blocks by setting a callback and	504	You can ensure that C<< -recv >> never blocks by setting a callback and
488	only calling C<< ->wait >> from within that callback (or at a later	505	only calling C<< ->recv >> from within that callback (or at a later
489	time). This will work even when the event loop does not support blocking	506	time). This will work even when the event loop does not support blocking
490	waits otherwise.	507	waits otherwise.
491		508
		509	=item $bool = $cv->ready
		510
		511	Returns true when the condition is "true", i.e. whether C<send> or
		512	C<croak> have been called.
		513
		514	=item $cb = $cv->cb ([new callback])
		515
		516	This is a mutator function that returns the callback set and optionally
		517	replaces it before doing so.
		518
		519	The callback will be called when the condition becomes "true", i.e. when
		520	C<send> or C<croak> are called. Calling C<recv> inside the callback
		521	or at any later time is guaranteed not to block.
		522
492	=back	523	=back
		524
		525	=head3 MAINLOOP EMULATION
		526
		527	Sometimes (often for short test scripts, or even standalone programs
		528	who only want to use AnyEvent), you I<do> want your program to block
		529	indefinitely in some event loop.
		530
		531	In that case, you cna use a condition variable like this:
		532
		533	AnyEvent->condvar->recv;
		534
		535	This has the effect of entering the event loop and looping forever.
		536
		537	Note that usually your program has some exit condition, in which case
		538	it is better to use the "traditional" approach of storing a condition
		539	variable, waiting for it, and sending it when the program should exit
		540	cleanly.
		541
493		542
494	=head1 GLOBAL VARIABLES AND FUNCTIONS	543	=head1 GLOBAL VARIABLES AND FUNCTIONS
495		544
496	=over 4	545	=over 4
497		546
…		…
503	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	552	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case
504	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	553	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
505		554
506	The known classes so far are:	555	The known classes so far are:
507		556
508	AnyEvent::Impl::CoroEV based on Coro::EV, best choice.
509	AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice.
510	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).	557	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
511	AnyEvent::Impl::Event based on Event, second best choice.	558	AnyEvent::Impl::Event based on Event, second best choice.
512	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	559	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
513	AnyEvent::Impl::Glib based on Glib, third-best choice.	560	AnyEvent::Impl::Glib based on Glib, third-best choice.
514	AnyEvent::Impl::Tk based on Tk, very bad choice.	561	AnyEvent::Impl::Tk based on Tk, very bad choice.
…		…
531	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	578	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
532	if necessary. You should only call this function right before you would	579	if necessary. You should only call this function right before you would
533	have created an AnyEvent watcher anyway, that is, as late as possible at	580	have created an AnyEvent watcher anyway, that is, as late as possible at
534	runtime.	581	runtime.
535		582
		583	=item $guard = AnyEvent::post_detect { BLOCK }
		584
		585	Arranges for the code block to be executed as soon as the event model is
		586	autodetected (or immediately if this has already happened).
		587
		588	If called in scalar or list context, then it creates and returns an object
		589	that automatically removes the callback again when it is destroyed. See
		590	L<Coro::BDB> for a case where this is useful.
		591
		592	=item @AnyEvent::post_detect
		593
		594	If there are any code references in this array (you can C<push> to it
		595	before or after loading AnyEvent), then they will called directly after
		596	the event loop has been chosen.
		597
		598	You should check C<$AnyEvent::MODEL> before adding to this array, though:
		599	if it contains a true value then the event loop has already been detected,
		600	and the array will be ignored.
		601
		602	Best use C<AnyEvent::post_detect { BLOCK }> instead.
		603
536	=back	604	=back
537		605
538	=head1 WHAT TO DO IN A MODULE	606	=head1 WHAT TO DO IN A MODULE
539		607
540	As a module author, you should C<use AnyEvent> and call AnyEvent methods	608	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
543	Be careful when you create watchers in the module body - AnyEvent will	611	Be careful when you create watchers in the module body - AnyEvent will
544	decide which event module to use as soon as the first method is called, so	612	decide which event module to use as soon as the first method is called, so
545	by calling AnyEvent in your module body you force the user of your module	613	by calling AnyEvent in your module body you force the user of your module
546	to load the event module first.	614	to load the event module first.
547		615
548	Never call C<< ->wait >> on a condition variable unless you I<know> that	616	Never call C<< ->recv >> on a condition variable unless you I<know> that
549	the C<< ->broadcast >> method has been called on it already. This is	617	the C<< ->send >> method has been called on it already. This is
550	because it will stall the whole program, and the whole point of using	618	because it will stall the whole program, and the whole point of using
551	events is to stay interactive.	619	events is to stay interactive.
552		620
553	It is fine, however, to call C<< ->wait >> when the user of your module	621	It is fine, however, to call C<< ->recv >> when the user of your module
554	requests it (i.e. if you create a http request object ad have a method	622	requests it (i.e. if you create a http request object ad have a method
555	called C<results> that returns the results, it should call C<< ->wait >>	623	called C<results> that returns the results, it should call C<< ->recv >>
556	freely, as the user of your module knows what she is doing. always).	624	freely, as the user of your module knows what she is doing. always).
557		625
558	=head1 WHAT TO DO IN THE MAIN PROGRAM	626	=head1 WHAT TO DO IN THE MAIN PROGRAM
559		627
560	There will always be a single main program - the only place that should	628	There will always be a single main program - the only place that should
…		…
594		662
595	Provide read and write buffers and manages watchers for reads and writes.	663	Provide read and write buffers and manages watchers for reads and writes.
596		664
597	=item L<AnyEvent::Socket>	665	=item L<AnyEvent::Socket>
598		666
599	Provides a means to do non-blocking connects, accepts etc.	667	Provides various utility functions for (internet protocol) sockets,
		668	addresses and name resolution. Also functions to create non-blocking tcp
		669	connections or tcp servers, with IPv6 and SRV record support and more.
600		670
601	=item L<AnyEvent::HTTPD>	671	=item L<AnyEvent::HTTPD>
602		672
603	Provides a simple web application server framework.	673	Provides a simple web application server framework.
604		674
605	=item L<AnyEvent::DNS>	675	=item L<AnyEvent::DNS>
606		676
607	Provides asynchronous DNS resolver capabilities, beyond what	677	Provides rich asynchronous DNS resolver capabilities.
608	L<AnyEvent::Util> offers.
609		678
610	=item L<AnyEvent::FastPing>	679	=item L<AnyEvent::FastPing>
611		680
612	The fastest ping in the west.	681	The fastest ping in the west.
613		682
…		…
628		697
629	High level API for event-based execution flow control.	698	High level API for event-based execution flow control.
630		699
631	=item L<Coro>	700	=item L<Coro>
632		701
633	Has special support for AnyEvent.	702	Has special support for AnyEvent via L<Coro::AnyEvent>.
		703
		704	=item L<AnyEvent::AIO>, L<IO::AIO>
		705
		706	Truly asynchronous I/O, should be in the toolbox of every event
		707	programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
		708	together.
		709
		710	=item L<AnyEvent::BDB>, L<BDB>
		711
		712	Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
		713	IO::AIO and AnyEvent together.
634		714
635	=item L<IO::Lambda>	715	=item L<IO::Lambda>
636		716
637	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.	717	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
638
639	=item L<IO::AIO>
640
641	Truly asynchronous I/O, should be in the toolbox of every event
642	programmer. Can be trivially made to use AnyEvent.
643
644	=item L<BDB>
645
646	Truly asynchronous Berkeley DB access. Can be trivially made to use
647	AnyEvent.
648		718
649	=back	719	=back
650		720
651	=cut	721	=cut
652		722
…		…
655	no warnings;	725	no warnings;
656	use strict;	726	use strict;
657		727
658	use Carp;	728	use Carp;
659		729
660	our $VERSION = '3.3';	730	our $VERSION = '4.03';
661	our $MODEL;	731	our $MODEL;
662		732
663	our $AUTOLOAD;	733	our $AUTOLOAD;
664	our @ISA;	734	our @ISA;
665		735
666	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	736	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
667		737
668	our @REGISTRY;	738	our @REGISTRY;
669		739
		740	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2)
		741
		742	{
		743	my $idx;
		744	$PROTOCOL{$_} = ++$idx
		745	for split /\s,\s/, $ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
		746	}
		747
670	my @models = (	748	my @models = (
671	[Coro::EV:: => AnyEvent::Impl::CoroEV::],
672	[Coro::Event:: => AnyEvent::Impl::CoroEvent::],
673	[EV:: => AnyEvent::Impl::EV::],	749	[EV:: => AnyEvent::Impl::EV::],
674	[Event:: => AnyEvent::Impl::Event::],	750	[Event:: => AnyEvent::Impl::Event::],
675	[Tk:: => AnyEvent::Impl::Tk::],	751	[Tk:: => AnyEvent::Impl::Tk::],
676	[Wx:: => AnyEvent::Impl::POE::],	752	[Wx:: => AnyEvent::Impl::POE::],
677	[Prima:: => AnyEvent::Impl::POE::],	753	[Prima:: => AnyEvent::Impl::POE::],
…		…
681	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	757	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
682	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	758	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
683	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	759	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
684	);	760	);
685		761
686	our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY);	762	our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);
		763
		764	our @post_detect;
		765
		766	sub post_detect(&) {
		767	my ($cb) = @_;
		768
		769	if ($MODEL) {
		770	$cb->();
		771
		772	1
		773	} else {
		774	push @post_detect, $cb;
		775
		776	defined wantarray
		777	? bless \$cb, "AnyEvent::Util::PostDetect"
		778	: ()
		779	}
		780	}
		781
		782	sub AnyEvent::Util::PostDetect::DESTROY {
		783	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		784	}
687		785
688	sub detect() {	786	sub detect() {
689	unless ($MODEL) {	787	unless ($MODEL) {
690	no strict 'refs';	788	no strict 'refs';
691		789
…		…
725	last;	823	last;
726	}	824	}
727	}	825	}
728		826
729	$MODEL	827	$MODEL
730	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.";	828	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
731	}	829	}
732	}	830	}
733		831
734	unshift @ISA, $MODEL;	832	unshift @ISA, $MODEL;
735	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	833	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		834
		835	(shift @post_detect)->() while @post_detect;
736	}	836	}
737		837
738	$MODEL	838	$MODEL
739	}	839	}
740		840
…		…
750	$class->$func (@_);	850	$class->$func (@_);
751	}	851	}
752		852
753	package AnyEvent::Base;	853	package AnyEvent::Base;
754		854
755	# default implementation for ->condvar, ->wait, ->broadcast	855	# default implementation for ->condvar
756		856
757	sub condvar {	857	sub condvar {
758	bless \my $flag, "AnyEvent::Base::CondVar"	858	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
759	}
760
761	sub AnyEvent::Base::CondVar::broadcast {
762	${$_[0]}++;
763	}
764
765	sub AnyEvent::Base::CondVar::wait {
766	AnyEvent->one_event while !${$_[0]};
767	}	859	}
768		860
769	# default implementation for ->signal	861	# default implementation for ->signal
770		862
771	our %SIG_CB;	863	our %SIG_CB;
…		…
845	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	937	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
846		938
847	undef $CHLD_W unless keys %PID_CB;	939	undef $CHLD_W unless keys %PID_CB;
848	}	940	}
849		941
		942	package AnyEvent::CondVar;
		943
		944	our @ISA = AnyEvent::CondVar::Base::;
		945
		946	package AnyEvent::CondVar::Base;
		947
		948	use overload
		949	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },
		950	fallback => 1;
		951
		952	sub _send {
		953	# nop
		954	}
		955
		956	sub send {
		957	my $cv = shift;
		958	$cv->{_ae_sent} = [@_];
		959	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
		960	$cv->_send;
		961	}
		962
		963	sub croak {
		964	$_[0]{_ae_croak} = $_[1];
		965	$_[0]->send;
		966	}
		967
		968	sub ready {
		969	$_[0]{_ae_sent}
		970	}
		971
		972	sub _wait {
		973	AnyEvent->one_event while !$_[0]{_ae_sent};
		974	}
		975
		976	sub recv {
		977	$_[0]->_wait;
		978
		979	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
		980	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
		981	}
		982
		983	sub cb {
		984	$_[0]{_ae_cb} = $_[1] if @_ > 1;
		985	$_[0]{_ae_cb}
		986	}
		987
		988	sub begin {
		989	++$_[0]{_ae_counter};
		990	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
		991	}
		992
		993	sub end {
		994	return if --$_[0]{_ae_counter};
		995	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
		996	}
		997
		998	# undocumented/compatibility with pre-3.4
		999	*broadcast = \&send;
		1000	*wait = \&_wait;
		1001
850	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1002	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
851		1003
852	This is an advanced topic that you do not normally need to use AnyEvent in	1004	This is an advanced topic that you do not normally need to use AnyEvent in
853	a module. This section is only of use to event loop authors who want to	1005	a module. This section is only of use to event loop authors who want to
854	provide AnyEvent compatibility.	1006	provide AnyEvent compatibility.
…		…
910	model it chooses.	1062	model it chooses.
911		1063
912	=item C<PERL_ANYEVENT_MODEL>	1064	=item C<PERL_ANYEVENT_MODEL>
913		1065
914	This can be used to specify the event model to be used by AnyEvent, before	1066	This can be used to specify the event model to be used by AnyEvent, before
915	autodetection and -probing kicks in. It must be a string consisting	1067	auto detection and -probing kicks in. It must be a string consisting
916	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	1068	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
917	and the resulting module name is loaded and if the load was successful,	1069	and the resulting module name is loaded and if the load was successful,
918	used as event model. If it fails to load AnyEvent will proceed with	1070	used as event model. If it fails to load AnyEvent will proceed with
919	autodetection and -probing.	1071	auto detection and -probing.
920		1072
921	This functionality might change in future versions.	1073	This functionality might change in future versions.
922		1074
923	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	1075	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
924	could start your program like this:	1076	could start your program like this:
925		1077
926	PERL_ANYEVENT_MODEL=Perl perl ...	1078	PERL_ANYEVENT_MODEL=Perl perl ...
		1079
		1080	=item C<PERL_ANYEVENT_PROTOCOLS>
		1081
		1082	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1083	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1084	of auto probing).
		1085
		1086	Must be set to a comma-separated list of protocols or address families,
		1087	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1088	used, and preference will be given to protocols mentioned earlier in the
		1089	list.
		1090
		1091	This variable can effectively be used for denial-of-service attacks
		1092	against local programs (e.g. when setuid), although the impact is likely
		1093	small, as the program has to handle connection errors already-
		1094
		1095	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1096	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1097	- only support IPv4, never try to resolve or contact IPv6
		1098	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1099	IPv6, but prefer IPv6 over IPv4.
		1100
		1101	=item C<PERL_ANYEVENT_EDNS0>
		1102
		1103	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1104	for DNS. This extension is generally useful to reduce DNS traffic, but
		1105	some (broken) firewalls drop such DNS packets, which is why it is off by
		1106	default.
		1107
		1108	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1109	EDNS0 in its DNS requests.
927		1110
928	=back	1111	=back
929		1112
930	=head1 EXAMPLE PROGRAM	1113	=head1 EXAMPLE PROGRAM
931		1114
…		…
942	poll => 'r',	1125	poll => 'r',
943	cb => sub {	1126	cb => sub {
944	warn "io event <$_[0]>\n"; # will always output <r>	1127	warn "io event <$_[0]>\n"; # will always output <r>
945	chomp (my $input = <STDIN>); # read a line	1128	chomp (my $input = <STDIN>); # read a line
946	warn "read: $input\n"; # output what has been read	1129	warn "read: $input\n"; # output what has been read
947	$cv->broadcast if $input =~ /^q/i; # quit program if /^q/i	1130	$cv->send if $input =~ /^q/i; # quit program if /^q/i
948	},	1131	},
949	);	1132	);
950		1133
951	my $time_watcher; # can only be used once	1134	my $time_watcher; # can only be used once
952		1135
…		…
957	});	1140	});
958	}	1141	}
959		1142
960	new_timer; # create first timer	1143	new_timer; # create first timer
961		1144
962	$cv->wait; # wait until user enters /^q/i	1145	$cv->recv; # wait until user enters /^q/i
963		1146
964	=head1 REAL-WORLD EXAMPLE	1147	=head1 REAL-WORLD EXAMPLE
965		1148
966	Consider the L<Net::FCP> module. It features (among others) the following	1149	Consider the L<Net::FCP> module. It features (among others) the following
967	API calls, which are to freenet what HTTP GET requests are to http:	1150	API calls, which are to freenet what HTTP GET requests are to http:
…		…
1017	syswrite $txn->{fh}, $txn->{request}	1200	syswrite $txn->{fh}, $txn->{request}
1018	or die "connection or write error";	1201	or die "connection or write error";
1019	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });	1202	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
1020		1203
1021	Again, C<fh_ready_r> waits till all data has arrived, and then stores the	1204	Again, C<fh_ready_r> waits till all data has arrived, and then stores the
1022	result and signals any possible waiters that the request ahs finished:	1205	result and signals any possible waiters that the request has finished:
1023		1206
1024	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};	1207	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
1025		1208
1026	if (end-of-file or data complete) {	1209	if (end-of-file or data complete) {
1027	$txn->{result} = $txn->{buf};	1210	$txn->{result} = $txn->{buf};
1028	$txn->{finished}->broadcast;	1211	$txn->{finished}->send;
1029	$txb->{cb}->($txn) of $txn->{cb}; # also call callback	1212	$txb->{cb}->($txn) of $txn->{cb}; # also call callback
1030	}	1213	}
1031		1214
1032	The C<result> method, finally, just waits for the finished signal (if the	1215	The C<result> method, finally, just waits for the finished signal (if the
1033	request was already finished, it doesn't wait, of course, and returns the	1216	request was already finished, it doesn't wait, of course, and returns the
1034	data:	1217	data:
1035		1218
1036	$txn->{finished}->wait;	1219	$txn->{finished}->recv;
1037	return $txn->{result};	1220	return $txn->{result};
1038		1221
1039	The actual code goes further and collects all errors (C<die>s, exceptions)	1222	The actual code goes further and collects all errors (C<die>s, exceptions)
1040	that occured during request processing. The C<result> method detects	1223	that occurred during request processing. The C<result> method detects
1041	whether an exception as thrown (it is stored inside the $txn object)	1224	whether an exception as thrown (it is stored inside the $txn object)
1042	and just throws the exception, which means connection errors and other	1225	and just throws the exception, which means connection errors and other
1043	problems get reported tot he code that tries to use the result, not in a	1226	problems get reported tot he code that tries to use the result, not in a
1044	random callback.	1227	random callback.
1045		1228
…		…
1076		1259
1077	my $quit = AnyEvent->condvar;	1260	my $quit = AnyEvent->condvar;
1078		1261
1079	$fcp->txn_client_get ($url)->cb (sub {	1262	$fcp->txn_client_get ($url)->cb (sub {
1080	...	1263	...
1081	$quit->broadcast;	1264	$quit->send;
1082	});	1265	});
1083		1266
1084	$quit->wait;	1267	$quit->recv;
1085		1268
1086		1269
1087	=head1 BENCHMARKS	1270	=head1 BENCHMARKS
1088		1271
1089	To give you an idea of the performance and overheads that AnyEvent adds	1272	To give you an idea of the performance and overheads that AnyEvent adds
…		…
1091	of various event loops I prepared some benchmarks.	1274	of various event loops I prepared some benchmarks.
1092		1275
1093	=head2 BENCHMARKING ANYEVENT OVERHEAD	1276	=head2 BENCHMARKING ANYEVENT OVERHEAD
1094		1277
1095	Here is a benchmark of various supported event models used natively and	1278	Here is a benchmark of various supported event models used natively and
1096	through anyevent. The benchmark creates a lot of timers (with a zero	1279	through AnyEvent. The benchmark creates a lot of timers (with a zero
1097	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	1280	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1098	which it is), lets them fire exactly once and destroys them again.	1281	which it is), lets them fire exactly once and destroys them again.
1099		1282
1100	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	1283	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1101	distribution.	1284	distribution.
…		…
1118	all watchers, to avoid adding memory overhead. That means closure creation	1301	all watchers, to avoid adding memory overhead. That means closure creation
1119	and memory usage is not included in the figures.	1302	and memory usage is not included in the figures.
1120		1303
1121	I<invoke> is the time, in microseconds, used to invoke a simple	1304	I<invoke> is the time, in microseconds, used to invoke a simple
1122	callback. The callback simply counts down a Perl variable and after it was	1305	callback. The callback simply counts down a Perl variable and after it was
1123	invoked "watcher" times, it would C<< ->broadcast >> a condvar once to	1306	invoked "watcher" times, it would C<< ->send >> a condvar once to
1124	signal the end of this phase.	1307	signal the end of this phase.
1125		1308
1126	I<destroy> is the time, in microseconds, that it takes to destroy a single	1309	I<destroy> is the time, in microseconds, that it takes to destroy a single
1127	watcher.	1310	watcher.
1128		1311
…		…
1224		1407
1225	=back	1408	=back
1226		1409
1227	=head2 BENCHMARKING THE LARGE SERVER CASE	1410	=head2 BENCHMARKING THE LARGE SERVER CASE
1228		1411
1229	This benchmark atcually benchmarks the event loop itself. It works by	1412	This benchmark actually benchmarks the event loop itself. It works by
1230	creating a number of "servers": each server consists of a socketpair, a	1413	creating a number of "servers": each server consists of a socket pair, a
1231	timeout watcher that gets reset on activity (but never fires), and an I/O	1414	timeout watcher that gets reset on activity (but never fires), and an I/O
1232	watcher waiting for input on one side of the socket. Each time the socket	1415	watcher waiting for input on one side of the socket. Each time the socket
1233	watcher reads a byte it will write that byte to a random other "server".	1416	watcher reads a byte it will write that byte to a random other "server".
1234		1417
1235	The effect is that there will be a lot of I/O watchers, only part of which	1418	The effect is that there will be a lot of I/O watchers, only part of which
1236	are active at any one point (so there is a constant number of active	1419	are active at any one point (so there is a constant number of active
1237	fds for each loop iterstaion, but which fds these are is random). The	1420	fds for each loop iteration, but which fds these are is random). The
1238	timeout is reset each time something is read because that reflects how	1421	timeout is reset each time something is read because that reflects how
1239	most timeouts work (and puts extra pressure on the event loops).	1422	most timeouts work (and puts extra pressure on the event loops).
1240		1423
1241	In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100	1424	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1242	(1%) are active. This mirrors the activity of large servers with many	1425	(1%) are active. This mirrors the activity of large servers with many
1243	connections, most of which are idle at any one point in time.	1426	connections, most of which are idle at any one point in time.
1244		1427
1245	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	1428	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1246	distribution.	1429	distribution.
…		…
1248	=head3 Explanation of the columns	1431	=head3 Explanation of the columns
1249		1432
1250	I<sockets> is the number of sockets, and twice the number of "servers" (as	1433	I<sockets> is the number of sockets, and twice the number of "servers" (as
1251	each server has a read and write socket end).	1434	each server has a read and write socket end).
1252		1435
1253	I<create> is the time it takes to create a socketpair (which is	1436	I<create> is the time it takes to create a socket pair (which is
1254	nontrivial) and two watchers: an I/O watcher and a timeout watcher.	1437	nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1255		1438
1256	I<request>, the most important value, is the time it takes to handle a	1439	I<request>, the most important value, is the time it takes to handle a
1257	single "request", that is, reading the token from the pipe and forwarding	1440	single "request", that is, reading the token from the pipe and forwarding
1258	it to another server. This includes deleting the old timeout and creating	1441	it to another server. This includes deleting the old timeout and creating
…		…
1331	speed most when you have lots of watchers, not when you only have a few of	1514	speed most when you have lots of watchers, not when you only have a few of
1332	them).	1515	them).
1333		1516
1334	EV is again fastest.	1517	EV is again fastest.
1335		1518
1336	Perl again comes second. It is noticably faster than the C-based event	1519	Perl again comes second. It is noticeably faster than the C-based event
1337	loops Event and Glib, although the difference is too small to really	1520	loops Event and Glib, although the difference is too small to really
1338	matter.	1521	matter.
1339		1522
1340	POE also performs much better in this case, but is is still far behind the	1523	POE also performs much better in this case, but is is still far behind the
1341	others.	1524	others.
…		…
1374		1557
1375	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }	1558	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1376		1559
1377	use AnyEvent;	1560	use AnyEvent;
1378		1561
		1562	Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
		1563	be used to probe what backend is used and gain other information (which is
		1564	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).
		1565
1379		1566
1380	=head1 SEE ALSO	1567	=head1 SEE ALSO
1381		1568
1382	Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>,	1569	Utility functions: L<AnyEvent::Util>.
1383	L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>,	1570
		1571	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1384	L<Event::Lib>, L<Qt>, L<POE>.	1572	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1385		1573
1386	Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>,	1574	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1387	L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>,	1575	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1388	L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>,	1576	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1389	L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>.	1577	L<AnyEvent::Impl::POE>.
1390		1578
		1579	Non-blocking file handles, sockets, TCP clients and
		1580	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.
		1581
		1582	Asynchronous DNS: L<AnyEvent::DNS>.
		1583
		1584	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
		1585
1391	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.	1586	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1392		1587
1393		1588
1394	=head1 AUTHOR	1589	=head1 AUTHOR
1395		1590
1396	Marc Lehmann <schmorp@schmorp.de>	1591	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.105 by root, Thu May 1 12:35:54 2008 UTC vs. Revision 1.133 by root, Sun May 25 03:44:03 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.105 by root, Thu May 1 12:35:54 2008 UTC vs.
Revision 1.133 by root, Sun May 25 03:44:03 2008 UTC