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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.107 by root, Tue May 6 12:15:50 2008 UTC vs.
Revision 1.138 by root, Mon May 26 05:09:53 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 ->send	21	$w->recv; # enters "main loop" till $condvar gets ->send
21	$w->send; # 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
…		…
278	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	278	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
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
284	AnyEvent::detect; # force event module to be initialised
285		283
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,
…		…
293	$done->send;	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<send> method.	316	by calling the C<send> method (or calling the condition variable as if it
		317	were a callback, read about the caveats in the description for the C<<
		318	->send >> method).
319		319
320	Condition variables are similar to callbacks, except that you can	320	Condition variables are similar to callbacks, except that you can
321	optionally wait for them. They can also be called merge points - points	321	optionally wait for them. They can also be called merge points - points
322	in time where multiple outstandign events have been processed. And yet	322	in time where multiple outstanding events have been processed. And yet
323	another way to call them is transations - each condition variable can be	323	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	324	used to represent a transaction, which finishes at some point and delivers
325	a result.	325	a result.
326		326
327	Condition variables are very useful to signal that something has finished,	327	Condition variables are very useful to signal that something has finished,
328	for example, if you write a module that does asynchronous http requests,	328	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	329	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	330	availability of results. The user can either act when the callback is
331	called or can synchronously C<< ->wait >> for the results.	331	called or can synchronously C<< ->recv >> for the results.
332		332
333	You can also use them to simulate traditional event loops - for example,	333	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	334	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	335	could C<< ->recv >> in your main program until the user clicks the Quit
336	button of your app, which would C<< ->send >> the "quit" event.	336	button of your app, which would C<< ->send >> the "quit" event.
337		337
338	Note that condition variables recurse into the event loop - if you have	338	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	339	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	340	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,	341	you should avoid making a blocking wait yourself, at least in callbacks,
342	as this asks for trouble.	342	as this asks for trouble.
343		343
344	Condition variables are represented by hash refs in perl, and the keys	344	Condition variables are represented by hash refs in perl, and the keys
…		…
349		349
350	There are two "sides" to a condition variable - the "producer side" which	350	There are two "sides" to a condition variable - the "producer side" which
351	eventually calls C<< -> send >>, and the "consumer side", which waits	351	eventually calls C<< -> send >>, and the "consumer side", which waits
352	for the send to occur.	352	for the send to occur.
353		353
354	Example:	354	Example: wait for a timer.
355		355
356	# wait till the result is ready	356	# wait till the result is ready
357	my $result_ready = AnyEvent->condvar;	357	my $result_ready = AnyEvent->condvar;
358		358
359	# do something such as adding a timer	359	# do something such as adding a timer
…		…
365	cb => sub { $result_ready->send },	365	cb => sub { $result_ready->send },
366	);	366	);
367		367
368	# this "blocks" (while handling events) till the callback	368	# this "blocks" (while handling events) till the callback
369	# calls send	369	# calls send
370	$result_ready->wait;	370	$result_ready->recv;
		371
		372	Example: wait for a timer, but take advantage of the fact that
		373	condition variables are also code references.
		374
		375	my $done = AnyEvent->condvar;
		376	my $delay = AnyEvent->timer (after => 5, cb => $done);
		377	$done->recv;
371		378
372	=head3 METHODS FOR PRODUCERS	379	=head3 METHODS FOR PRODUCERS
373		380
374	These methods should only be used by the producing side, i.e. the	381	These methods should only be used by the producing side, i.e. the
375	code/module that eventually sends the signal. Note that it is also	382	code/module that eventually sends the signal. Note that it is also
…		…
378		385
379	=over 4	386	=over 4
380		387
381	=item $cv->send (...)	388	=item $cv->send (...)
382		389
383	Flag the condition as ready - a running C<< ->wait >> and all further	390	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	391	calls to C<recv> will (eventually) return after this method has been
385	called. If nobody is waiting the send will be remembered.	392	called. If nobody is waiting the send will be remembered.
386		393
387	If a callback has been set on the condition variable, it is called	394	If a callback has been set on the condition variable, it is called
388	immediately from within send.	395	immediately from within send.
389		396
390	Any arguments passed to the C<send> call will be returned by all	397	Any arguments passed to the C<send> call will be returned by all
391	future C<< ->wait >> calls.	398	future C<< ->recv >> calls.
		399
		400	Condition variables are overloaded so one can call them directly
		401	(as a code reference). Calling them directly is the same as calling
		402	C<send>. Note, however, that many C-based event loops do not handle
		403	overloading, so as tempting as it may be, passing a condition variable
		404	instead of a callback does not work. Both the pure perl and EV loops
		405	support overloading, however, as well as all functions that use perl to
		406	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
		407	example).
392		408
393	=item $cv->croak ($error)	409	=item $cv->croak ($error)
394		410
395	Similar to send, but causes all call's wait C<< ->wait >> to invoke	411	Similar to send, but causes all call's to C<< ->recv >> to invoke
396	C<Carp::croak> with the given error message/object/scalar.	412	C<Carp::croak> with the given error message/object/scalar.
397		413
398	This can be used to signal any errors to the condition variable	414	This can be used to signal any errors to the condition variable
399	user/consumer.	415	user/consumer.
400		416
401	=item $cv->begin ([group callback])	417	=item $cv->begin ([group callback])
402		418
403	=item $cv->end	419	=item $cv->end
		420
		421	These two methods are EXPERIMENTAL and MIGHT CHANGE.
404		422
405	These two methods can be used to combine many transactions/events into	423	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	424	one. For example, a function that pings many hosts in parallel might want
407	to use a condition variable for the whole process.	425	to use a condition variable for the whole process.
408		426
…		…
443	doesn't execute once).	461	doesn't execute once).
444		462
445	This is the general pattern when you "fan out" into multiple subrequests:	463	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>	464	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	465	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>.	466	C<begin> and for each subrequest you finish, call C<end>.
449		467
450	=back	468	=back
451		469
452	=head3 METHODS FOR CONSUMERS	470	=head3 METHODS FOR CONSUMERS
453		471
454	These methods should only be used by the consuming side, i.e. the	472	These methods should only be used by the consuming side, i.e. the
455	code awaits the condition.	473	code awaits the condition.
456		474
457	=over 4	475	=over 4
458		476
459	=item $cv->wait	477	=item $cv->recv
460		478
461	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	479	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
462	>> methods have been called on c<$cv>, while servicing other watchers	480	>> methods have been called on c<$cv>, while servicing other watchers
463	normally.	481	normally.
464		482
…		…
475	(programs might want to do that to stay interactive), so I<if you are	493	(programs might want to do that to stay interactive), so I<if you are
476	using this from a module, never require a blocking wait>, but let the	494	using this from a module, never require a blocking wait>, but let the
477	caller decide whether the call will block or not (for example, by coupling	495	caller decide whether the call will block or not (for example, by coupling
478	condition variables with some kind of request results and supporting	496	condition variables with some kind of request results and supporting
479	callbacks so the caller knows that getting the result will not block,	497	callbacks so the caller knows that getting the result will not block,
480	while still suppporting blocking waits if the caller so desires).	498	while still supporting blocking waits if the caller so desires).
481		499
482	Another reason I<never> to C<< ->wait >> in a module is that you cannot	500	Another reason I<never> to C<< ->recv >> in a module is that you cannot
483	sensibly have two C<< ->wait >>'s in parallel, as that would require	501	sensibly have two C<< ->recv >>'s in parallel, as that would require
484	multiple interpreters or coroutines/threads, none of which C<AnyEvent>	502	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
485	can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and	503	can supply.
486	L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
487	from different coroutines, however).
488		504
		505	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
		506	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
		507	versions and also integrates coroutines into AnyEvent, making blocking
		508	C<< ->recv >> calls perfectly safe as long as they are done from another
		509	coroutine (one that doesn't run the event loop).
		510
489	You can ensure that C<< -wait >> never blocks by setting a callback and	511	You can ensure that C<< -recv >> never blocks by setting a callback and
490	only calling C<< ->wait >> from within that callback (or at a later	512	only calling C<< ->recv >> from within that callback (or at a later
491	time). This will work even when the event loop does not support blocking	513	time). This will work even when the event loop does not support blocking
492	waits otherwise.	514	waits otherwise.
493		515
494	=item $bool = $cv->ready	516	=item $bool = $cv->ready
495		517
…		…
500		522
501	This is a mutator function that returns the callback set and optionally	523	This is a mutator function that returns the callback set and optionally
502	replaces it before doing so.	524	replaces it before doing so.
503		525
504	The callback will be called when the condition becomes "true", i.e. when	526	The callback will be called when the condition becomes "true", i.e. when
505	C<send> or C<croak> are called. Calling C<wait> inside the callback	527	C<send> or C<croak> are called. Calling C<recv> inside the callback
506	or at any later time is guaranteed not to block.	528	or at any later time is guaranteed not to block.
507		529
508	=back	530	=back
509		531
510	=head1 GLOBAL VARIABLES AND FUNCTIONS	532	=head1 GLOBAL VARIABLES AND FUNCTIONS
…		…
519	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	541	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case
520	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	542	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
521		543
522	The known classes so far are:	544	The known classes so far are:
523		545
524	AnyEvent::Impl::CoroEV based on Coro::EV, best choice.
525	AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice.
526	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).	546	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
527	AnyEvent::Impl::Event based on Event, second best choice.	547	AnyEvent::Impl::Event based on Event, second best choice.
528	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.	548	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
529	AnyEvent::Impl::Glib based on Glib, third-best choice.	549	AnyEvent::Impl::Glib based on Glib, third-best choice.
530	AnyEvent::Impl::Tk based on Tk, very bad choice.	550	AnyEvent::Impl::Tk based on Tk, very bad choice.
…		…
547	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	567	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
548	if necessary. You should only call this function right before you would	568	if necessary. You should only call this function right before you would
549	have created an AnyEvent watcher anyway, that is, as late as possible at	569	have created an AnyEvent watcher anyway, that is, as late as possible at
550	runtime.	570	runtime.
551		571
		572	=item $guard = AnyEvent::post_detect { BLOCK }
		573
		574	Arranges for the code block to be executed as soon as the event model is
		575	autodetected (or immediately if this has already happened).
		576
		577	If called in scalar or list context, then it creates and returns an object
		578	that automatically removes the callback again when it is destroyed. See
		579	L<Coro::BDB> for a case where this is useful.
		580
		581	=item @AnyEvent::post_detect
		582
		583	If there are any code references in this array (you can C<push> to it
		584	before or after loading AnyEvent), then they will called directly after
		585	the event loop has been chosen.
		586
		587	You should check C<$AnyEvent::MODEL> before adding to this array, though:
		588	if it contains a true value then the event loop has already been detected,
		589	and the array will be ignored.
		590
		591	Best use C<AnyEvent::post_detect { BLOCK }> instead.
		592
552	=back	593	=back
553		594
554	=head1 WHAT TO DO IN A MODULE	595	=head1 WHAT TO DO IN A MODULE
555		596
556	As a module author, you should C<use AnyEvent> and call AnyEvent methods	597	As a module author, you should C<use AnyEvent> and call AnyEvent methods
…		…
559	Be careful when you create watchers in the module body - AnyEvent will	600	Be careful when you create watchers in the module body - AnyEvent will
560	decide which event module to use as soon as the first method is called, so	601	decide which event module to use as soon as the first method is called, so
561	by calling AnyEvent in your module body you force the user of your module	602	by calling AnyEvent in your module body you force the user of your module
562	to load the event module first.	603	to load the event module first.
563		604
564	Never call C<< ->wait >> on a condition variable unless you I<know> that	605	Never call C<< ->recv >> on a condition variable unless you I<know> that
565	the C<< ->send >> method has been called on it already. This is	606	the C<< ->send >> method has been called on it already. This is
566	because it will stall the whole program, and the whole point of using	607	because it will stall the whole program, and the whole point of using
567	events is to stay interactive.	608	events is to stay interactive.
568		609
569	It is fine, however, to call C<< ->wait >> when the user of your module	610	It is fine, however, to call C<< ->recv >> when the user of your module
570	requests it (i.e. if you create a http request object ad have a method	611	requests it (i.e. if you create a http request object ad have a method
571	called C<results> that returns the results, it should call C<< ->wait >>	612	called C<results> that returns the results, it should call C<< ->recv >>
572	freely, as the user of your module knows what she is doing. always).	613	freely, as the user of your module knows what she is doing. always).
573		614
574	=head1 WHAT TO DO IN THE MAIN PROGRAM	615	=head1 WHAT TO DO IN THE MAIN PROGRAM
575		616
576	There will always be a single main program - the only place that should	617	There will always be a single main program - the only place that should
…		…
578		619
579	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	620	If it doesn't care, it can just "use AnyEvent" and use it itself, or not
580	do anything special (it does not need to be event-based) and let AnyEvent	621	do anything special (it does not need to be event-based) and let AnyEvent
581	decide which implementation to chose if some module relies on it.	622	decide which implementation to chose if some module relies on it.
582		623
583	If the main program relies on a specific event model. For example, in	624	If the main program relies on a specific event model - for example, in
584	Gtk2 programs you have to rely on the Glib module. You should load the	625	Gtk2 programs you have to rely on the Glib module - you should load the
585	event module before loading AnyEvent or any module that uses it: generally	626	event module before loading AnyEvent or any module that uses it: generally
586	speaking, you should load it as early as possible. The reason is that	627	speaking, you should load it as early as possible. The reason is that
587	modules might create watchers when they are loaded, and AnyEvent will	628	modules might create watchers when they are loaded, and AnyEvent will
588	decide on the event model to use as soon as it creates watchers, and it	629	decide on the event model to use as soon as it creates watchers, and it
589	might chose the wrong one unless you load the correct one yourself.	630	might chose the wrong one unless you load the correct one yourself.
590		631
591	You can chose to use a rather inefficient pure-perl implementation by	632	You can chose to use a pure-perl implementation by loading the
592	loading the C<AnyEvent::Impl::Perl> module, which gives you similar	633	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
593	behaviour everywhere, but letting AnyEvent chose is generally better.	634	everywhere, but letting AnyEvent chose the model is generally better.
		635
		636	=head2 MAINLOOP EMULATION
		637
		638	Sometimes (often for short test scripts, or even standalone programs who
		639	only want to use AnyEvent), you do not want to run a specific event loop.
		640
		641	In that case, you can use a condition variable like this:
		642
		643	AnyEvent->condvar->recv;
		644
		645	This has the effect of entering the event loop and looping forever.
		646
		647	Note that usually your program has some exit condition, in which case
		648	it is better to use the "traditional" approach of storing a condition
		649	variable somewhere, waiting for it, and sending it when the program should
		650	exit cleanly.
		651
594		652
595	=head1 OTHER MODULES	653	=head1 OTHER MODULES
596		654
597	The following is a non-exhaustive list of additional modules that use	655	The following is a non-exhaustive list of additional modules that use
598	AnyEvent and can therefore be mixed easily with other AnyEvent modules	656	AnyEvent and can therefore be mixed easily with other AnyEvent modules
…		…
610		668
611	Provide read and write buffers and manages watchers for reads and writes.	669	Provide read and write buffers and manages watchers for reads and writes.
612		670
613	=item L<AnyEvent::Socket>	671	=item L<AnyEvent::Socket>
614		672
615	Provides a means to do non-blocking connects, accepts etc.	673	Provides various utility functions for (internet protocol) sockets,
		674	addresses and name resolution. Also functions to create non-blocking tcp
		675	connections or tcp servers, with IPv6 and SRV record support and more.
		676
		677	=item L<AnyEvent::DNS>
		678
		679	Provides rich asynchronous DNS resolver capabilities.
616		680
617	=item L<AnyEvent::HTTPD>	681	=item L<AnyEvent::HTTPD>
618		682
619	Provides a simple web application server framework.	683	Provides a simple web application server framework.
620
621	=item L<AnyEvent::DNS>
622
623	Provides asynchronous DNS resolver capabilities, beyond what
624	L<AnyEvent::Util> offers.
625		684
626	=item L<AnyEvent::FastPing>	685	=item L<AnyEvent::FastPing>
627		686
628	The fastest ping in the west.	687	The fastest ping in the west.
629		688
…		…
644		703
645	High level API for event-based execution flow control.	704	High level API for event-based execution flow control.
646		705
647	=item L<Coro>	706	=item L<Coro>
648		707
649	Has special support for AnyEvent.	708	Has special support for AnyEvent via L<Coro::AnyEvent>.
		709
		710	=item L<AnyEvent::AIO>, L<IO::AIO>
		711
		712	Truly asynchronous I/O, should be in the toolbox of every event
		713	programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
		714	together.
		715
		716	=item L<AnyEvent::BDB>, L<BDB>
		717
		718	Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
		719	IO::AIO and AnyEvent together.
650		720
651	=item L<IO::Lambda>	721	=item L<IO::Lambda>
652		722
653	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.	723	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
654
655	=item L<IO::AIO>
656
657	Truly asynchronous I/O, should be in the toolbox of every event
658	programmer. Can be trivially made to use AnyEvent.
659
660	=item L<BDB>
661
662	Truly asynchronous Berkeley DB access. Can be trivially made to use
663	AnyEvent.
664		724
665	=back	725	=back
666		726
667	=cut	727	=cut
668		728
…		…
671	no warnings;	731	no warnings;
672	use strict;	732	use strict;
673		733
674	use Carp;	734	use Carp;
675		735
676	our $VERSION = '3.3';	736	our $VERSION = '4.03';
677	our $MODEL;	737	our $MODEL;
678		738
679	our $AUTOLOAD;	739	our $AUTOLOAD;
680	our @ISA;	740	our @ISA;
681		741
		742	our @REGISTRY;
		743
		744	our $WIN32;
		745
		746	BEGIN {
		747	my $win32 = ! ! ($^O =~ /mswin32/i);
		748	eval "sub WIN32(){ $win32 }";
		749	}
		750
682	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	751	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
683		752
684	our @REGISTRY;	753	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
		754
		755	{
		756	my $idx;
		757	$PROTOCOL{$_} = ++$idx
		758	for reverse split /\s,\s/,
		759	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
		760	}
		761
		762	sub import {
		763	shift;
		764	return unless @_;
		765
		766	my $pkg = caller;
		767
		768	no strict 'refs';
		769
		770	for (@_) {
		771	{"$pkg\::WIN32"} = WIN32 if $_ eq "WIN32";
		772	}
		773	}
685		774
686	my @models = (	775	my @models = (
687	[Coro::EV:: => AnyEvent::Impl::CoroEV::],
688	[Coro::Event:: => AnyEvent::Impl::CoroEvent::],
689	[EV:: => AnyEvent::Impl::EV::],	776	[EV:: => AnyEvent::Impl::EV::],
690	[Event:: => AnyEvent::Impl::Event::],	777	[Event:: => AnyEvent::Impl::Event::],
691	[Tk:: => AnyEvent::Impl::Tk::],
692	[Wx:: => AnyEvent::Impl::POE::],
693	[Prima:: => AnyEvent::Impl::POE::],
694	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	778	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
695	# everything below here will not be autoprobed as the pureperl backend should work everywhere	779	# everything below here will not be autoprobed
696	[Glib:: => AnyEvent::Impl::Glib::],	780	# as the pureperl backend should work everywhere
		781	# and is usually faster
		782	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		783	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
697	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	784	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
698	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	785	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
699	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	786	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
		787	[Wx:: => AnyEvent::Impl::POE::],
		788	[Prima:: => AnyEvent::Impl::POE::],
700	);	789	);
701		790
702	our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);	791	our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);
		792
		793	our @post_detect;
		794
		795	sub post_detect(&) {
		796	my ($cb) = @_;
		797
		798	if ($MODEL) {
		799	$cb->();
		800
		801	1
		802	} else {
		803	push @post_detect, $cb;
		804
		805	defined wantarray
		806	? bless \$cb, "AnyEvent::Util::PostDetect"
		807	: ()
		808	}
		809	}
		810
		811	sub AnyEvent::Util::PostDetect::DESTROY {
		812	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		813	}
703		814
704	sub detect() {	815	sub detect() {
705	unless ($MODEL) {	816	unless ($MODEL) {
706	no strict 'refs';	817	no strict 'refs';
		818	local $SIG{__DIE__};
707		819
708	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	820	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
709	my $model = "AnyEvent::Impl::$1";	821	my $model = "AnyEvent::Impl::$1";
710	if (eval "require $model") {	822	if (eval "require $model") {
711	$MODEL = $model;	823	$MODEL = $model;
…		…
741	last;	853	last;
742	}	854	}
743	}	855	}
744		856
745	$MODEL	857	$MODEL
746	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.";	858	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
747	}	859	}
748	}	860	}
749		861
750	unshift @ISA, $MODEL;	862	unshift @ISA, $MODEL;
751	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	863	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
		864
		865	(shift @post_detect)->() while @post_detect;
752	}	866	}
753		867
754	$MODEL	868	$MODEL
755	}	869	}
756		870
…		…
766	$class->$func (@_);	880	$class->$func (@_);
767	}	881	}
768		882
769	package AnyEvent::Base;	883	package AnyEvent::Base;
770		884
771	# default implementation for ->condvar, ->wait, ->broadcast	885	# default implementation for ->condvar
772		886
773	sub condvar {	887	sub condvar {
774	bless \my $flag, "AnyEvent::Base::CondVar"	888	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
775	}
776
777	sub AnyEvent::Base::CondVar::broadcast {
778	${$_[0]}++;
779	}
780
781	sub AnyEvent::Base::CondVar::wait {
782	AnyEvent->one_event while !${$_[0]};
783	}	889	}
784		890
785	# default implementation for ->signal	891	# default implementation for ->signal
786		892
787	our %SIG_CB;	893	our %SIG_CB;
…		…
840	or Carp::croak "required option 'pid' is missing";	946	or Carp::croak "required option 'pid' is missing";
841		947
842	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	948	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
843		949
844	unless ($WNOHANG) {	950	unless ($WNOHANG) {
845	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } \|\| 1;	951	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
846	}	952	}
847		953
848	unless ($CHLD_W) {	954	unless ($CHLD_W) {
849	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	955	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
850	# child could be a zombie already, so make at least one round	956	# child could be a zombie already, so make at least one round
…		…
860	delete $PID_CB{$pid}{$cb};	966	delete $PID_CB{$pid}{$cb};
861	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	967	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
862		968
863	undef $CHLD_W unless keys %PID_CB;	969	undef $CHLD_W unless keys %PID_CB;
864	}	970	}
		971
		972	package AnyEvent::CondVar;
		973
		974	our @ISA = AnyEvent::CondVar::Base::;
		975
		976	package AnyEvent::CondVar::Base;
		977
		978	use overload
		979	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },
		980	fallback => 1;
		981
		982	sub _send {
		983	# nop
		984	}
		985
		986	sub send {
		987	my $cv = shift;
		988	$cv->{_ae_sent} = [@_];
		989	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
		990	$cv->_send;
		991	}
		992
		993	sub croak {
		994	$_[0]{_ae_croak} = $_[1];
		995	$_[0]->send;
		996	}
		997
		998	sub ready {
		999	$_[0]{_ae_sent}
		1000	}
		1001
		1002	sub _wait {
		1003	AnyEvent->one_event while !$_[0]{_ae_sent};
		1004	}
		1005
		1006	sub recv {
		1007	$_[0]->_wait;
		1008
		1009	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
		1010	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
		1011	}
		1012
		1013	sub cb {
		1014	$_[0]{_ae_cb} = $_[1] if @_ > 1;
		1015	$_[0]{_ae_cb}
		1016	}
		1017
		1018	sub begin {
		1019	++$_[0]{_ae_counter};
		1020	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
		1021	}
		1022
		1023	sub end {
		1024	return if --$_[0]{_ae_counter};
		1025	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
		1026	}
		1027
		1028	# undocumented/compatibility with pre-3.4
		1029	*broadcast = \&send;
		1030	*wait = \&_wait;
865		1031
866	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1032	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
867		1033
868	This is an advanced topic that you do not normally need to use AnyEvent in	1034	This is an advanced topic that you do not normally need to use AnyEvent in
869	a module. This section is only of use to event loop authors who want to	1035	a module. This section is only of use to event loop authors who want to
…		…
926	model it chooses.	1092	model it chooses.
927		1093
928	=item C<PERL_ANYEVENT_MODEL>	1094	=item C<PERL_ANYEVENT_MODEL>
929		1095
930	This can be used to specify the event model to be used by AnyEvent, before	1096	This can be used to specify the event model to be used by AnyEvent, before
931	autodetection and -probing kicks in. It must be a string consisting	1097	auto detection and -probing kicks in. It must be a string consisting
932	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	1098	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
933	and the resulting module name is loaded and if the load was successful,	1099	and the resulting module name is loaded and if the load was successful,
934	used as event model. If it fails to load AnyEvent will proceed with	1100	used as event model. If it fails to load AnyEvent will proceed with
935	autodetection and -probing.	1101	auto detection and -probing.
936		1102
937	This functionality might change in future versions.	1103	This functionality might change in future versions.
938		1104
939	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	1105	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
940	could start your program like this:	1106	could start your program like this:
941		1107
942	PERL_ANYEVENT_MODEL=Perl perl ...	1108	PERL_ANYEVENT_MODEL=Perl perl ...
		1109
		1110	=item C<PERL_ANYEVENT_PROTOCOLS>
		1111
		1112	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1113	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1114	of auto probing).
		1115
		1116	Must be set to a comma-separated list of protocols or address families,
		1117	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1118	used, and preference will be given to protocols mentioned earlier in the
		1119	list.
		1120
		1121	This variable can effectively be used for denial-of-service attacks
		1122	against local programs (e.g. when setuid), although the impact is likely
		1123	small, as the program has to handle connection errors already-
		1124
		1125	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1126	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1127	- only support IPv4, never try to resolve or contact IPv6
		1128	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1129	IPv6, but prefer IPv6 over IPv4.
		1130
		1131	=item C<PERL_ANYEVENT_EDNS0>
		1132
		1133	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1134	for DNS. This extension is generally useful to reduce DNS traffic, but
		1135	some (broken) firewalls drop such DNS packets, which is why it is off by
		1136	default.
		1137
		1138	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1139	EDNS0 in its DNS requests.
943		1140
944	=back	1141	=back
945		1142
946	=head1 EXAMPLE PROGRAM	1143	=head1 EXAMPLE PROGRAM
947		1144
…		…
958	poll => 'r',	1155	poll => 'r',
959	cb => sub {	1156	cb => sub {
960	warn "io event <$_[0]>\n"; # will always output <r>	1157	warn "io event <$_[0]>\n"; # will always output <r>
961	chomp (my $input = <STDIN>); # read a line	1158	chomp (my $input = <STDIN>); # read a line
962	warn "read: $input\n"; # output what has been read	1159	warn "read: $input\n"; # output what has been read
963	$cv->broadcast if $input =~ /^q/i; # quit program if /^q/i	1160	$cv->send if $input =~ /^q/i; # quit program if /^q/i
964	},	1161	},
965	);	1162	);
966		1163
967	my $time_watcher; # can only be used once	1164	my $time_watcher; # can only be used once
968		1165
…		…
973	});	1170	});
974	}	1171	}
975		1172
976	new_timer; # create first timer	1173	new_timer; # create first timer
977		1174
978	$cv->wait; # wait until user enters /^q/i	1175	$cv->recv; # wait until user enters /^q/i
979		1176
980	=head1 REAL-WORLD EXAMPLE	1177	=head1 REAL-WORLD EXAMPLE
981		1178
982	Consider the L<Net::FCP> module. It features (among others) the following	1179	Consider the L<Net::FCP> module. It features (among others) the following
983	API calls, which are to freenet what HTTP GET requests are to http:	1180	API calls, which are to freenet what HTTP GET requests are to http:
…		…
1033	syswrite $txn->{fh}, $txn->{request}	1230	syswrite $txn->{fh}, $txn->{request}
1034	or die "connection or write error";	1231	or die "connection or write error";
1035	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });	1232	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
1036		1233
1037	Again, C<fh_ready_r> waits till all data has arrived, and then stores the	1234	Again, C<fh_ready_r> waits till all data has arrived, and then stores the
1038	result and signals any possible waiters that the request ahs finished:	1235	result and signals any possible waiters that the request has finished:
1039		1236
1040	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};	1237	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
1041		1238
1042	if (end-of-file or data complete) {	1239	if (end-of-file or data complete) {
1043	$txn->{result} = $txn->{buf};	1240	$txn->{result} = $txn->{buf};
1044	$txn->{finished}->broadcast;	1241	$txn->{finished}->send;
1045	$txb->{cb}->($txn) of $txn->{cb}; # also call callback	1242	$txb->{cb}->($txn) of $txn->{cb}; # also call callback
1046	}	1243	}
1047		1244
1048	The C<result> method, finally, just waits for the finished signal (if the	1245	The C<result> method, finally, just waits for the finished signal (if the
1049	request was already finished, it doesn't wait, of course, and returns the	1246	request was already finished, it doesn't wait, of course, and returns the
1050	data:	1247	data:
1051		1248
1052	$txn->{finished}->wait;	1249	$txn->{finished}->recv;
1053	return $txn->{result};	1250	return $txn->{result};
1054		1251
1055	The actual code goes further and collects all errors (C<die>s, exceptions)	1252	The actual code goes further and collects all errors (C<die>s, exceptions)
1056	that occured during request processing. The C<result> method detects	1253	that occurred during request processing. The C<result> method detects
1057	whether an exception as thrown (it is stored inside the $txn object)	1254	whether an exception as thrown (it is stored inside the $txn object)
1058	and just throws the exception, which means connection errors and other	1255	and just throws the exception, which means connection errors and other
1059	problems get reported tot he code that tries to use the result, not in a	1256	problems get reported tot he code that tries to use the result, not in a
1060	random callback.	1257	random callback.
1061		1258
…		…
1092		1289
1093	my $quit = AnyEvent->condvar;	1290	my $quit = AnyEvent->condvar;
1094		1291
1095	$fcp->txn_client_get ($url)->cb (sub {	1292	$fcp->txn_client_get ($url)->cb (sub {
1096	...	1293	...
1097	$quit->broadcast;	1294	$quit->send;
1098	});	1295	});
1099		1296
1100	$quit->wait;	1297	$quit->recv;
1101		1298
1102		1299
1103	=head1 BENCHMARKS	1300	=head1 BENCHMARKS
1104		1301
1105	To give you an idea of the performance and overheads that AnyEvent adds	1302	To give you an idea of the performance and overheads that AnyEvent adds
…		…
1107	of various event loops I prepared some benchmarks.	1304	of various event loops I prepared some benchmarks.
1108		1305
1109	=head2 BENCHMARKING ANYEVENT OVERHEAD	1306	=head2 BENCHMARKING ANYEVENT OVERHEAD
1110		1307
1111	Here is a benchmark of various supported event models used natively and	1308	Here is a benchmark of various supported event models used natively and
1112	through anyevent. The benchmark creates a lot of timers (with a zero	1309	through AnyEvent. The benchmark creates a lot of timers (with a zero
1113	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	1310	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1114	which it is), lets them fire exactly once and destroys them again.	1311	which it is), lets them fire exactly once and destroys them again.
1115		1312
1116	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	1313	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1117	distribution.	1314	distribution.
…		…
1134	all watchers, to avoid adding memory overhead. That means closure creation	1331	all watchers, to avoid adding memory overhead. That means closure creation
1135	and memory usage is not included in the figures.	1332	and memory usage is not included in the figures.
1136		1333
1137	I<invoke> is the time, in microseconds, used to invoke a simple	1334	I<invoke> is the time, in microseconds, used to invoke a simple
1138	callback. The callback simply counts down a Perl variable and after it was	1335	callback. The callback simply counts down a Perl variable and after it was
1139	invoked "watcher" times, it would C<< ->broadcast >> a condvar once to	1336	invoked "watcher" times, it would C<< ->send >> a condvar once to
1140	signal the end of this phase.	1337	signal the end of this phase.
1141		1338
1142	I<destroy> is the time, in microseconds, that it takes to destroy a single	1339	I<destroy> is the time, in microseconds, that it takes to destroy a single
1143	watcher.	1340	watcher.
1144		1341
…		…
1240		1437
1241	=back	1438	=back
1242		1439
1243	=head2 BENCHMARKING THE LARGE SERVER CASE	1440	=head2 BENCHMARKING THE LARGE SERVER CASE
1244		1441
1245	This benchmark atcually benchmarks the event loop itself. It works by	1442	This benchmark actually benchmarks the event loop itself. It works by
1246	creating a number of "servers": each server consists of a socketpair, a	1443	creating a number of "servers": each server consists of a socket pair, a
1247	timeout watcher that gets reset on activity (but never fires), and an I/O	1444	timeout watcher that gets reset on activity (but never fires), and an I/O
1248	watcher waiting for input on one side of the socket. Each time the socket	1445	watcher waiting for input on one side of the socket. Each time the socket
1249	watcher reads a byte it will write that byte to a random other "server".	1446	watcher reads a byte it will write that byte to a random other "server".
1250		1447
1251	The effect is that there will be a lot of I/O watchers, only part of which	1448	The effect is that there will be a lot of I/O watchers, only part of which
1252	are active at any one point (so there is a constant number of active	1449	are active at any one point (so there is a constant number of active
1253	fds for each loop iterstaion, but which fds these are is random). The	1450	fds for each loop iteration, but which fds these are is random). The
1254	timeout is reset each time something is read because that reflects how	1451	timeout is reset each time something is read because that reflects how
1255	most timeouts work (and puts extra pressure on the event loops).	1452	most timeouts work (and puts extra pressure on the event loops).
1256		1453
1257	In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100	1454	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1258	(1%) are active. This mirrors the activity of large servers with many	1455	(1%) are active. This mirrors the activity of large servers with many
1259	connections, most of which are idle at any one point in time.	1456	connections, most of which are idle at any one point in time.
1260		1457
1261	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	1458	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1262	distribution.	1459	distribution.
…		…
1264	=head3 Explanation of the columns	1461	=head3 Explanation of the columns
1265		1462
1266	I<sockets> is the number of sockets, and twice the number of "servers" (as	1463	I<sockets> is the number of sockets, and twice the number of "servers" (as
1267	each server has a read and write socket end).	1464	each server has a read and write socket end).
1268		1465
1269	I<create> is the time it takes to create a socketpair (which is	1466	I<create> is the time it takes to create a socket pair (which is
1270	nontrivial) and two watchers: an I/O watcher and a timeout watcher.	1467	nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1271		1468
1272	I<request>, the most important value, is the time it takes to handle a	1469	I<request>, the most important value, is the time it takes to handle a
1273	single "request", that is, reading the token from the pipe and forwarding	1470	single "request", that is, reading the token from the pipe and forwarding
1274	it to another server. This includes deleting the old timeout and creating	1471	it to another server. This includes deleting the old timeout and creating
…		…
1347	speed most when you have lots of watchers, not when you only have a few of	1544	speed most when you have lots of watchers, not when you only have a few of
1348	them).	1545	them).
1349		1546
1350	EV is again fastest.	1547	EV is again fastest.
1351		1548
1352	Perl again comes second. It is noticably faster than the C-based event	1549	Perl again comes second. It is noticeably faster than the C-based event
1353	loops Event and Glib, although the difference is too small to really	1550	loops Event and Glib, although the difference is too small to really
1354	matter.	1551	matter.
1355		1552
1356	POE also performs much better in this case, but is is still far behind the	1553	POE also performs much better in this case, but is is still far behind the
1357	others.	1554	others.
…		…
1397	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	1594	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).
1398		1595
1399		1596
1400	=head1 SEE ALSO	1597	=head1 SEE ALSO
1401		1598
1402	Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>,	1599	Utility functions: L<AnyEvent::Util>.
1403	L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>,	1600
		1601	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1404	L<Event::Lib>, L<Qt>, L<POE>.	1602	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1405		1603
1406	Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>,	1604	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1407	L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>,	1605	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1408	L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>,	1606	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1409	L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>.	1607	L<AnyEvent::Impl::POE>.
1410		1608
		1609	Non-blocking file handles, sockets, TCP clients and
		1610	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.
		1611
		1612	Asynchronous DNS: L<AnyEvent::DNS>.
		1613
		1614	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
		1615
1411	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.	1616	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1412		1617
1413		1618
1414	=head1 AUTHOR	1619	=head1 AUTHOR
1415		1620
1416	Marc Lehmann <schmorp@schmorp.de>	1621	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.107 by root, Tue May 6 12:15:50 2008 UTC vs. Revision 1.138 by root, Mon May 26 05:09:53 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.107 by root, Tue May 6 12:15:50 2008 UTC vs.
Revision 1.138 by root, Mon May 26 05:09:53 2008 UTC