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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.108 by root, Sat May 10 00:22:02 2008 UTC vs.
Revision 1.149 by root, Sat May 31 01:41:22 2008 UTC

…		…
1	=head1 NAME	1	=head1 => NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - provide framework for multiple event loops
4		4
5	EV, Event, 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
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
		23	=head1 INTRODUCTION/TUTORIAL
		24
		25	This manpage is mainly a reference manual. If you are interested
		26	in a tutorial or some gentle introduction, have a look at the
		27	L<AnyEvent::Intro> manpage.
22		28
23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)	29	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24		30
25	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen	31	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26	nowadays. So what is different about AnyEvent?	32	nowadays. So what is different about AnyEvent?
…		…
48	isn't itself. What's worse, all the potential users of your module are	54	isn't itself. What's worse, all the potential users of your module are
49	I<also> forced to use the same event loop you use.	55	I<also> forced to use the same event loop you use.
50		56
51	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works	57	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52	fine. AnyEvent + Tk works fine etc. etc. but none of these work together	58	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
53	with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if	59	with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
54	your module uses one of those, every user of your module has to use it,	60	your module uses one of those, every user of your module has to use it,
55	too. But if your module uses AnyEvent, it works transparently with all	61	too. But if your module uses AnyEvent, it works transparently with all
56	event models it supports (including stuff like POE and IO::Async, as long	62	event models it supports (including stuff like POE and IO::Async, as long
57	as those use one of the supported event loops. It is trivial to add new	63	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).	64	event loops to AnyEvent, too, so it is future-proof).
59		65
60	In addition to being free of having to use I<the one and only true event	66	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	67	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	68	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	69	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	70	offering the functionality that is necessary, in as thin as a wrapper as
65	technically possible.	71	technically possible.
66		72
		73	Of course, AnyEvent comes with a big (and fully optional!) toolbox
		74	of useful functionality, such as an asynchronous DNS resolver, 100%
		75	non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
		76	such as Windows) and lots of real-world knowledge and workarounds for
		77	platform bugs and differences.
		78
67	Of course, if you want lots of policy (this can arguably be somewhat	79	Now, if you I<do want> lots of policy (this can arguably be somewhat
68	useful) and you want to force your users to use the one and only event	80	useful) and you want to force your users to use the one and only event
69	model, you should I<not> use this module.	81	model, you should I<not> use this module.
70		82
71	=head1 DESCRIPTION	83	=head1 DESCRIPTION
72		84
…		…
102	starts using it, all bets are off. Maybe you should tell their authors to	114	starts using it, all bets are off. Maybe you should tell their authors to
103	use AnyEvent so their modules work together with others seamlessly...	115	use AnyEvent so their modules work together with others seamlessly...
104		116
105	The pure-perl implementation of AnyEvent is called	117	The pure-perl implementation of AnyEvent is called
106	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	118	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
107	explicitly.	119	explicitly and enjoy the high availability of that event loop :)
108		120
109	=head1 WATCHERS	121	=head1 WATCHERS
110		122
111	AnyEvent has the central concept of a I<watcher>, which is an object that	123	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	124	stores relevant data for each kind of event you are waiting for, such as
113	the callback to call, the filehandle to watch, etc.	125	the callback to call, the file handle to watch, etc.
114		126
115	These watchers are normal Perl objects with normal Perl lifetime. After	127	These watchers are normal Perl objects with normal Perl lifetime. After
116	creating a watcher it will immediately "watch" for events and invoke the	128	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	129	callback when the event occurs (of course, only when the event model
118	is in control).	130	is in control).
…		…
227	timers.	239	timers.
228		240
229	AnyEvent always prefers relative timers, if available, matching the	241	AnyEvent always prefers relative timers, if available, matching the
230	AnyEvent API.	242	AnyEvent API.
231		243
		244	AnyEvent has two additional methods that return the "current time":
		245
		246	=over 4
		247
		248	=item AnyEvent->time
		249
		250	This returns the "current wallclock time" as a fractional number of
		251	seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
		252	return, and the result is guaranteed to be compatible with those).
		253
		254	It progresses independently of any event loop processing, i.e. each call
		255	will check the system clock, which usually gets updated frequently.
		256
		257	=item AnyEvent->now
		258
		259	This also returns the "current wallclock time", but unlike C<time>, above,
		260	this value might change only once per event loop iteration, depending on
		261	the event loop (most return the same time as C<time>, above). This is the
		262	time that AnyEvent's timers get scheduled against.
		263
		264	I<In almost all cases (in all cases if you don't care), this is the
		265	function to call when you want to know the current time.>
		266
		267	This function is also often faster then C<< AnyEvent->time >>, and
		268	thus the preferred method if you want some timestamp (for example,
		269	L<AnyEvent::Handle> uses this to update it's activity timeouts).
		270
		271	The rest of this section is only of relevance if you try to be very exact
		272	with your timing, you can skip it without bad conscience.
		273
		274	For a practical example of when these times differ, consider L<Event::Lib>
		275	and L<EV> and the following set-up:
		276
		277	The event loop is running and has just invoked one of your callback at
		278	time=500 (assume no other callbacks delay processing). In your callback,
		279	you wait a second by executing C<sleep 1> (blocking the process for a
		280	second) and then (at time=501) you create a relative timer that fires
		281	after three seconds.
		282
		283	With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
		284	both return C<501>, because that is the current time, and the timer will
		285	be scheduled to fire at time=504 (C<501> + C<3>).
		286
		287	With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
		288	time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
		289	last event processing phase started. With L<EV>, your timer gets scheduled
		290	to run at time=503 (C<500> + C<3>).
		291
		292	In one sense, L<Event::Lib> is more exact, as it uses the current time
		293	regardless of any delays introduced by event processing. However, most
		294	callbacks do not expect large delays in processing, so this causes a
		295	higher drift (and a lot more system calls to get the current time).
		296
		297	In another sense, L<EV> is more exact, as your timer will be scheduled at
		298	the same time, regardless of how long event processing actually took.
		299
		300	In either case, if you care (and in most cases, you don't), then you
		301	can get whatever behaviour you want with any event loop, by taking the
		302	difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
		303	account.
		304
		305	=back
		306
232	=head2 SIGNAL WATCHERS	307	=head2 SIGNAL WATCHERS
233		308
234	You can watch for signals using a signal watcher, C<signal> is the signal	309	You can watch for signals using a signal watcher, C<signal> is the signal
235	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to	310	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to
236	be invoked whenever a signal occurs.	311	be invoked whenever a signal occurs.
237		312
238	Although the callback might get passed parameters, their value and	313	Although the callback might get passed parameters, their value and
239	presence is undefined and you cannot rely on them. Portable AnyEvent	314	presence is undefined and you cannot rely on them. Portable AnyEvent
240	callbacks cannot use arguments passed to signal watcher callbacks.	315	callbacks cannot use arguments passed to signal watcher callbacks.
241		316
242	Multiple signal occurances can be clumped together into one callback	317	Multiple signal occurrences can be clumped together into one callback
243	invocation, and callback invocation will be synchronous. synchronous means	318	invocation, and callback invocation will be synchronous. Synchronous means
244	that it might take a while until the signal gets handled by the process,	319	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.	320	but it is guaranteed not to interrupt any other callbacks.
246		321
247	The main advantage of using these watchers is that you can share a signal	322	The main advantage of using these watchers is that you can share a signal
248	between multiple watchers.	323	between multiple watchers.
249		324
250	This watcher might use C<%SIG>, so programs overwriting those signals	325	This watcher might use C<%SIG>, so programs overwriting those signals
…		…
278	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).	353	C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
279		354
280	Example: fork a process and wait for it	355	Example: fork a process and wait for it
281		356
282	my $done = AnyEvent->condvar;	357	my $done = AnyEvent->condvar;
283
284	AnyEvent::detect; # force event module to be initialised
285		358
286	my $pid = fork or exit 5;	359	my $pid = fork or exit 5;
287		360
288	my $w = AnyEvent->child (	361	my $w = AnyEvent->child (
289	pid => $pid,	362	pid => $pid,
…		…
293	$done->send;	366	$done->send;
294	},	367	},
295	);	368	);
296		369
297	# do something else, then wait for process exit	370	# do something else, then wait for process exit
298	$done->wait;	371	$done->recv;
299		372
300	=head2 CONDITION VARIABLES	373	=head2 CONDITION VARIABLES
301		374
302	If you are familiar with some event loops you will know that all of them	375	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	376	require you to run some blocking "loop", "run" or similar function that
…		…
312	Condition variables can be created by calling the C<< AnyEvent->condvar	385	Condition variables can be created by calling the C<< AnyEvent->condvar
313	>> method, usually without arguments. The only argument pair allowed is	386	>> method, usually without arguments. The only argument pair allowed is
314	C<cb>, which specifies a callback to be called when the condition variable	387	C<cb>, which specifies a callback to be called when the condition variable
315	becomes true.	388	becomes true.
316		389
317	After creation, the conditon variable is "false" until it becomes "true"	390	After creation, the condition variable is "false" until it becomes "true"
318	by calling the C<send> method.	391	by calling the C<send> method (or calling the condition variable as if it
		392	were a callback, read about the caveats in the description for the C<<
		393	->send >> method).
319		394
320	Condition variables are similar to callbacks, except that you can	395	Condition variables are similar to callbacks, except that you can
321	optionally wait for them. They can also be called merge points - points	396	optionally wait for them. They can also be called merge points - points
322	in time where multiple outstandign events have been processed. And yet	397	in time where multiple outstanding events have been processed. And yet
323	another way to call them is transations - each condition variable can be	398	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	399	used to represent a transaction, which finishes at some point and delivers
325	a result.	400	a result.
326		401
327	Condition variables are very useful to signal that something has finished,	402	Condition variables are very useful to signal that something has finished,
328	for example, if you write a module that does asynchronous http requests,	403	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	404	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	405	availability of results. The user can either act when the callback is
331	called or can synchronously C<< ->wait >> for the results.	406	called or can synchronously C<< ->recv >> for the results.
332		407
333	You can also use them to simulate traditional event loops - for example,	408	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	409	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	410	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.	411	button of your app, which would C<< ->send >> the "quit" event.
337		412
338	Note that condition variables recurse into the event loop - if you have	413	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	414	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	415	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,	416	you should avoid making a blocking wait yourself, at least in callbacks,
342	as this asks for trouble.	417	as this asks for trouble.
343		418
344	Condition variables are represented by hash refs in perl, and the keys	419	Condition variables are represented by hash refs in perl, and the keys
…		…
349		424
350	There are two "sides" to a condition variable - the "producer side" which	425	There are two "sides" to a condition variable - the "producer side" which
351	eventually calls C<< -> send >>, and the "consumer side", which waits	426	eventually calls C<< -> send >>, and the "consumer side", which waits
352	for the send to occur.	427	for the send to occur.
353		428
354	Example:	429	Example: wait for a timer.
355		430
356	# wait till the result is ready	431	# wait till the result is ready
357	my $result_ready = AnyEvent->condvar;	432	my $result_ready = AnyEvent->condvar;
358		433
359	# do something such as adding a timer	434	# do something such as adding a timer
…		…
365	cb => sub { $result_ready->send },	440	cb => sub { $result_ready->send },
366	);	441	);
367		442
368	# this "blocks" (while handling events) till the callback	443	# this "blocks" (while handling events) till the callback
369	# calls send	444	# calls send
370	$result_ready->wait;	445	$result_ready->recv;
		446
		447	Example: wait for a timer, but take advantage of the fact that
		448	condition variables are also code references.
		449
		450	my $done = AnyEvent->condvar;
		451	my $delay = AnyEvent->timer (after => 5, cb => $done);
		452	$done->recv;
371		453
372	=head3 METHODS FOR PRODUCERS	454	=head3 METHODS FOR PRODUCERS
373		455
374	These methods should only be used by the producing side, i.e. the	456	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	457	code/module that eventually sends the signal. Note that it is also
…		…
378		460
379	=over 4	461	=over 4
380		462
381	=item $cv->send (...)	463	=item $cv->send (...)
382		464
383	Flag the condition as ready - a running C<< ->wait >> and all further	465	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	466	calls to C<recv> will (eventually) return after this method has been
385	called. If nobody is waiting the send will be remembered.	467	called. If nobody is waiting the send will be remembered.
386		468
387	If a callback has been set on the condition variable, it is called	469	If a callback has been set on the condition variable, it is called
388	immediately from within send.	470	immediately from within send.
389		471
390	Any arguments passed to the C<send> call will be returned by all	472	Any arguments passed to the C<send> call will be returned by all
391	future C<< ->wait >> calls.	473	future C<< ->recv >> calls.
		474
		475	Condition variables are overloaded so one can call them directly
		476	(as a code reference). Calling them directly is the same as calling
		477	C<send>. Note, however, that many C-based event loops do not handle
		478	overloading, so as tempting as it may be, passing a condition variable
		479	instead of a callback does not work. Both the pure perl and EV loops
		480	support overloading, however, as well as all functions that use perl to
		481	invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
		482	example).
392		483
393	=item $cv->croak ($error)	484	=item $cv->croak ($error)
394		485
395	Similar to send, but causes all call's wait C<< ->wait >> to invoke	486	Similar to send, but causes all call's to C<< ->recv >> to invoke
396	C<Carp::croak> with the given error message/object/scalar.	487	C<Carp::croak> with the given error message/object/scalar.
397		488
398	This can be used to signal any errors to the condition variable	489	This can be used to signal any errors to the condition variable
399	user/consumer.	490	user/consumer.
400		491
401	=item $cv->begin ([group callback])	492	=item $cv->begin ([group callback])
402		493
403	=item $cv->end	494	=item $cv->end
		495
		496	These two methods are EXPERIMENTAL and MIGHT CHANGE.
404		497
405	These two methods can be used to combine many transactions/events into	498	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	499	one. For example, a function that pings many hosts in parallel might want
407	to use a condition variable for the whole process.	500	to use a condition variable for the whole process.
408		501
…		…
443	doesn't execute once).	536	doesn't execute once).
444		537
445	This is the general pattern when you "fan out" into multiple subrequests:	538	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>	539	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	540	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>.	541	C<begin> and for each subrequest you finish, call C<end>.
449		542
450	=back	543	=back
451		544
452	=head3 METHODS FOR CONSUMERS	545	=head3 METHODS FOR CONSUMERS
453		546
454	These methods should only be used by the consuming side, i.e. the	547	These methods should only be used by the consuming side, i.e. the
455	code awaits the condition.	548	code awaits the condition.
456		549
457	=over 4	550	=over 4
458		551
459	=item $cv->wait	552	=item $cv->recv
460		553
461	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak	554	Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
462	>> methods have been called on c<$cv>, while servicing other watchers	555	>> methods have been called on c<$cv>, while servicing other watchers
463	normally.	556	normally.
464		557
…		…
475	(programs might want to do that to stay interactive), so I<if you are	568	(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	569	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	570	caller decide whether the call will block or not (for example, by coupling
478	condition variables with some kind of request results and supporting	571	condition variables with some kind of request results and supporting
479	callbacks so the caller knows that getting the result will not block,	572	callbacks so the caller knows that getting the result will not block,
480	while still suppporting blocking waits if the caller so desires).	573	while still supporting blocking waits if the caller so desires).
481		574
482	Another reason I<never> to C<< ->wait >> in a module is that you cannot	575	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	576	sensibly have two C<< ->recv >>'s in parallel, as that would require
484	multiple interpreters or coroutines/threads, none of which C<AnyEvent>	577	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
485	can supply.	578	can supply.
486		579
487	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in	580	The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
488	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe	581	fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
489	versions and also integrates coroutines into AnyEvent, making blocking	582	versions and also integrates coroutines into AnyEvent, making blocking
490	C<< ->wait >> calls perfectly safe as long as they are done from another	583	C<< ->recv >> calls perfectly safe as long as they are done from another
491	coroutine (one that doesn't run the event loop).	584	coroutine (one that doesn't run the event loop).
492		585
493	You can ensure that C<< -wait >> never blocks by setting a callback and	586	You can ensure that C<< -recv >> never blocks by setting a callback and
494	only calling C<< ->wait >> from within that callback (or at a later	587	only calling C<< ->recv >> from within that callback (or at a later
495	time). This will work even when the event loop does not support blocking	588	time). This will work even when the event loop does not support blocking
496	waits otherwise.	589	waits otherwise.
497		590
498	=item $bool = $cv->ready	591	=item $bool = $cv->ready
499		592
…		…
504		597
505	This is a mutator function that returns the callback set and optionally	598	This is a mutator function that returns the callback set and optionally
506	replaces it before doing so.	599	replaces it before doing so.
507		600
508	The callback will be called when the condition becomes "true", i.e. when	601	The callback will be called when the condition becomes "true", i.e. when
509	C<send> or C<croak> are called. Calling C<wait> inside the callback	602	C<send> or C<croak> are called, with the only argument being the condition
510	or at any later time is guaranteed not to block.	603	variable itself. Calling C<recv> inside the callback or at any later time
		604	is guaranteed not to block.
511		605
512	=back	606	=back
513		607
514	=head1 GLOBAL VARIABLES AND FUNCTIONS	608	=head1 GLOBAL VARIABLES AND FUNCTIONS
515		609
…		…
549	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	643	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
550	if necessary. You should only call this function right before you would	644	if necessary. You should only call this function right before you would
551	have created an AnyEvent watcher anyway, that is, as late as possible at	645	have created an AnyEvent watcher anyway, that is, as late as possible at
552	runtime.	646	runtime.
553		647
		648	=item $guard = AnyEvent::post_detect { BLOCK }
		649
		650	Arranges for the code block to be executed as soon as the event model is
		651	autodetected (or immediately if this has already happened).
		652
		653	If called in scalar or list context, then it creates and returns an object
		654	that automatically removes the callback again when it is destroyed. See
		655	L<Coro::BDB> for a case where this is useful.
		656
554	=item @AnyEvent::detect	657	=item @AnyEvent::post_detect
555		658
556	If there are any code references in this array (you can C<push> to it	659	If there are any code references in this array (you can C<push> to it
557	before or after loading AnyEvent), then they will called directly after	660	before or after loading AnyEvent), then they will called directly after
558	the event loop has been chosen.	661	the event loop has been chosen.
559		662
560	You should check C<$AnyEvent::MODEL> before adding to this array, though:	663	You should check C<$AnyEvent::MODEL> before adding to this array, though:
561	if it contains a true value then the event loop has already been detected,	664	if it contains a true value then the event loop has already been detected,
562	and the array will be ignored.	665	and the array will be ignored.
		666
		667	Best use C<AnyEvent::post_detect { BLOCK }> instead.
563		668
564	=back	669	=back
565		670
566	=head1 WHAT TO DO IN A MODULE	671	=head1 WHAT TO DO IN A MODULE
567		672
…		…
571	Be careful when you create watchers in the module body - AnyEvent will	676	Be careful when you create watchers in the module body - AnyEvent will
572	decide which event module to use as soon as the first method is called, so	677	decide which event module to use as soon as the first method is called, so
573	by calling AnyEvent in your module body you force the user of your module	678	by calling AnyEvent in your module body you force the user of your module
574	to load the event module first.	679	to load the event module first.
575		680
576	Never call C<< ->wait >> on a condition variable unless you I<know> that	681	Never call C<< ->recv >> on a condition variable unless you I<know> that
577	the C<< ->send >> method has been called on it already. This is	682	the C<< ->send >> method has been called on it already. This is
578	because it will stall the whole program, and the whole point of using	683	because it will stall the whole program, and the whole point of using
579	events is to stay interactive.	684	events is to stay interactive.
580		685
581	It is fine, however, to call C<< ->wait >> when the user of your module	686	It is fine, however, to call C<< ->recv >> when the user of your module
582	requests it (i.e. if you create a http request object ad have a method	687	requests it (i.e. if you create a http request object ad have a method
583	called C<results> that returns the results, it should call C<< ->wait >>	688	called C<results> that returns the results, it should call C<< ->recv >>
584	freely, as the user of your module knows what she is doing. always).	689	freely, as the user of your module knows what she is doing. always).
585		690
586	=head1 WHAT TO DO IN THE MAIN PROGRAM	691	=head1 WHAT TO DO IN THE MAIN PROGRAM
587		692
588	There will always be a single main program - the only place that should	693	There will always be a single main program - the only place that should
…		…
590		695
591	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	696	If it doesn't care, it can just "use AnyEvent" and use it itself, or not
592	do anything special (it does not need to be event-based) and let AnyEvent	697	do anything special (it does not need to be event-based) and let AnyEvent
593	decide which implementation to chose if some module relies on it.	698	decide which implementation to chose if some module relies on it.
594		699
595	If the main program relies on a specific event model. For example, in	700	If the main program relies on a specific event model - for example, in
596	Gtk2 programs you have to rely on the Glib module. You should load the	701	Gtk2 programs you have to rely on the Glib module - you should load the
597	event module before loading AnyEvent or any module that uses it: generally	702	event module before loading AnyEvent or any module that uses it: generally
598	speaking, you should load it as early as possible. The reason is that	703	speaking, you should load it as early as possible. The reason is that
599	modules might create watchers when they are loaded, and AnyEvent will	704	modules might create watchers when they are loaded, and AnyEvent will
600	decide on the event model to use as soon as it creates watchers, and it	705	decide on the event model to use as soon as it creates watchers, and it
601	might chose the wrong one unless you load the correct one yourself.	706	might chose the wrong one unless you load the correct one yourself.
602		707
603	You can chose to use a rather inefficient pure-perl implementation by	708	You can chose to use a pure-perl implementation by loading the
604	loading the C<AnyEvent::Impl::Perl> module, which gives you similar	709	C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
605	behaviour everywhere, but letting AnyEvent chose is generally better.	710	everywhere, but letting AnyEvent chose the model is generally better.
		711
		712	=head2 MAINLOOP EMULATION
		713
		714	Sometimes (often for short test scripts, or even standalone programs who
		715	only want to use AnyEvent), you do not want to run a specific event loop.
		716
		717	In that case, you can use a condition variable like this:
		718
		719	AnyEvent->condvar->recv;
		720
		721	This has the effect of entering the event loop and looping forever.
		722
		723	Note that usually your program has some exit condition, in which case
		724	it is better to use the "traditional" approach of storing a condition
		725	variable somewhere, waiting for it, and sending it when the program should
		726	exit cleanly.
		727
606		728
607	=head1 OTHER MODULES	729	=head1 OTHER MODULES
608		730
609	The following is a non-exhaustive list of additional modules that use	731	The following is a non-exhaustive list of additional modules that use
610	AnyEvent and can therefore be mixed easily with other AnyEvent modules	732	AnyEvent and can therefore be mixed easily with other AnyEvent modules
…		…
622		744
623	Provide read and write buffers and manages watchers for reads and writes.	745	Provide read and write buffers and manages watchers for reads and writes.
624		746
625	=item L<AnyEvent::Socket>	747	=item L<AnyEvent::Socket>
626		748
627	Provides a means to do non-blocking connects, accepts etc.	749	Provides various utility functions for (internet protocol) sockets,
		750	addresses and name resolution. Also functions to create non-blocking tcp
		751	connections or tcp servers, with IPv6 and SRV record support and more.
		752
		753	=item L<AnyEvent::DNS>
		754
		755	Provides rich asynchronous DNS resolver capabilities.
628		756
629	=item L<AnyEvent::HTTPD>	757	=item L<AnyEvent::HTTPD>
630		758
631	Provides a simple web application server framework.	759	Provides a simple web application server framework.
632
633	=item L<AnyEvent::DNS>
634
635	Provides asynchronous DNS resolver capabilities, beyond what
636	L<AnyEvent::Util> offers.
637		760
638	=item L<AnyEvent::FastPing>	761	=item L<AnyEvent::FastPing>
639		762
640	The fastest ping in the west.	763	The fastest ping in the west.
641		764
…		…
658		781
659	=item L<Coro>	782	=item L<Coro>
660		783
661	Has special support for AnyEvent via L<Coro::AnyEvent>.	784	Has special support for AnyEvent via L<Coro::AnyEvent>.
662		785
		786	=item L<AnyEvent::AIO>, L<IO::AIO>
		787
		788	Truly asynchronous I/O, should be in the toolbox of every event
		789	programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
		790	together.
		791
		792	=item L<AnyEvent::BDB>, L<BDB>
		793
		794	Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
		795	IO::AIO and AnyEvent together.
		796
663	=item L<IO::Lambda>	797	=item L<IO::Lambda>
664		798
665	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.	799	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
666
667	=item L<IO::AIO>
668
669	Truly asynchronous I/O, should be in the toolbox of every event
670	programmer. Can be trivially made to use AnyEvent.
671
672	=item L<BDB>
673
674	Truly asynchronous Berkeley DB access. Can be trivially made to use
675	AnyEvent.
676		800
677	=back	801	=back
678		802
679	=cut	803	=cut
680		804
…		…
683	no warnings;	807	no warnings;
684	use strict;	808	use strict;
685		809
686	use Carp;	810	use Carp;
687		811
688	our $VERSION = '3.4';	812	our $VERSION = 4.11;
689	our $MODEL;	813	our $MODEL;
690		814
691	our $AUTOLOAD;	815	our $AUTOLOAD;
692	our @ISA;	816	our @ISA;
693		817
		818	our @REGISTRY;
		819
		820	our $WIN32;
		821
		822	BEGIN {
		823	my $win32 = ! ! ($^O =~ /mswin32/i);
		824	eval "sub WIN32(){ $win32 }";
		825	}
		826
694	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	827	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
695		828
696	our @REGISTRY;	829	our %PROTOCOL; # (ipv4\|ipv6) => (1\|2), higher numbers are preferred
		830
		831	{
		832	my $idx;
		833	$PROTOCOL{$_} = ++$idx
		834	for reverse split /\s,\s/,
		835	$ENV{PERL_ANYEVENT_PROTOCOLS} \|\| "ipv4,ipv6";
		836	}
697		837
698	my @models = (	838	my @models = (
699	[EV:: => AnyEvent::Impl::EV::],	839	[EV:: => AnyEvent::Impl::EV::],
700	[Event:: => AnyEvent::Impl::Event::],	840	[Event:: => AnyEvent::Impl::Event::],
701	[Tk:: => AnyEvent::Impl::Tk::],
702	[Wx:: => AnyEvent::Impl::POE::],
703	[Prima:: => AnyEvent::Impl::POE::],
704	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	841	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
705	# everything below here will not be autoprobed as the pureperl backend should work everywhere	842	# everything below here will not be autoprobed
706	[Glib:: => AnyEvent::Impl::Glib::],	843	# as the pureperl backend should work everywhere
		844	# and is usually faster
		845	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		846	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
707	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	847	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
708	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	848	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
709	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza	849	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
		850	[Wx:: => AnyEvent::Impl::POE::],
		851	[Prima:: => AnyEvent::Impl::POE::],
710	);	852	);
711		853
712	our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);	854	our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);
713		855
714	our @detect;	856	our @post_detect;
		857
		858	sub post_detect(&) {
		859	my ($cb) = @_;
		860
		861	if ($MODEL) {
		862	$cb->();
		863
		864	1
		865	} else {
		866	push @post_detect, $cb;
		867
		868	defined wantarray
		869	? bless \$cb, "AnyEvent::Util::PostDetect"
		870	: ()
		871	}
		872	}
		873
		874	sub AnyEvent::Util::PostDetect::DESTROY {
		875	@post_detect = grep $_ != ${$_[0]}, @post_detect;
		876	}
715		877
716	sub detect() {	878	sub detect() {
717	unless ($MODEL) {	879	unless ($MODEL) {
718	no strict 'refs';	880	no strict 'refs';
		881	local $SIG{__DIE__};
719		882
720	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {	883	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
721	my $model = "AnyEvent::Impl::$1";	884	my $model = "AnyEvent::Impl::$1";
722	if (eval "require $model") {	885	if (eval "require $model") {
723	$MODEL = $model;	886	$MODEL = $model;
…		…
760	}	923	}
761		924
762	unshift @ISA, $MODEL;	925	unshift @ISA, $MODEL;
763	push @{"$MODEL\::ISA"}, "AnyEvent::Base";	926	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
764		927
765	(shift @detect)->() while @detect;	928	(shift @post_detect)->() while @post_detect;
766	}	929	}
767		930
768	$MODEL	931	$MODEL
769	}	932	}
770		933
…		…
780	$class->$func (@_);	943	$class->$func (@_);
781	}	944	}
782		945
783	package AnyEvent::Base;	946	package AnyEvent::Base;
784		947
		948	# default implementation for now and time
		949
		950	use Time::HiRes ();
		951
		952	sub time { Time::HiRes::time }
		953	sub now { Time::HiRes::time }
		954
785	# default implementation for ->condvar, ->wait, ->broadcast	955	# default implementation for ->condvar
786		956
787	sub condvar {	957	sub condvar {
788	bless \my $flag, "AnyEvent::Base::CondVar"	958	bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
789	}
790
791	sub AnyEvent::Base::CondVar::broadcast {
792	${$_[0]}++;
793	}
794
795	sub AnyEvent::Base::CondVar::wait {
796	AnyEvent->one_event while !${$_[0]};
797	}	959	}
798		960
799	# default implementation for ->signal	961	# default implementation for ->signal
800		962
801	our %SIG_CB;	963	our %SIG_CB;
…		…
854	or Carp::croak "required option 'pid' is missing";	1016	or Carp::croak "required option 'pid' is missing";
855		1017
856	$PID_CB{$pid}{$arg{cb}} = $arg{cb};	1018	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
857		1019
858	unless ($WNOHANG) {	1020	unless ($WNOHANG) {
859	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } \|\| 1;	1021	$WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } \|\| 1;
860	}	1022	}
861		1023
862	unless ($CHLD_W) {	1024	unless ($CHLD_W) {
863	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);	1025	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
864	# child could be a zombie already, so make at least one round	1026	# child could be a zombie already, so make at least one round
…		…
874	delete $PID_CB{$pid}{$cb};	1036	delete $PID_CB{$pid}{$cb};
875	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };	1037	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
876		1038
877	undef $CHLD_W unless keys %PID_CB;	1039	undef $CHLD_W unless keys %PID_CB;
878	}	1040	}
		1041
		1042	package AnyEvent::CondVar;
		1043
		1044	our @ISA = AnyEvent::CondVar::Base::;
		1045
		1046	package AnyEvent::CondVar::Base;
		1047
		1048	use overload
		1049	'&{}' => sub { my $self = shift; sub { $self->send (@_) } },
		1050	fallback => 1;
		1051
		1052	sub _send {
		1053	# nop
		1054	}
		1055
		1056	sub send {
		1057	my $cv = shift;
		1058	$cv->{_ae_sent} = [@_];
		1059	(delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
		1060	$cv->_send;
		1061	}
		1062
		1063	sub croak {
		1064	$_[0]{_ae_croak} = $_[1];
		1065	$_[0]->send;
		1066	}
		1067
		1068	sub ready {
		1069	$_[0]{_ae_sent}
		1070	}
		1071
		1072	sub _wait {
		1073	AnyEvent->one_event while !$_[0]{_ae_sent};
		1074	}
		1075
		1076	sub recv {
		1077	$_[0]->_wait;
		1078
		1079	Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
		1080	wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
		1081	}
		1082
		1083	sub cb {
		1084	$_[0]{_ae_cb} = $_[1] if @_ > 1;
		1085	$_[0]{_ae_cb}
		1086	}
		1087
		1088	sub begin {
		1089	++$_[0]{_ae_counter};
		1090	$_[0]{_ae_end_cb} = $_[1] if @_ > 1;
		1091	}
		1092
		1093	sub end {
		1094	return if --$_[0]{_ae_counter};
		1095	&{ $_[0]{_ae_end_cb} \|\| sub { $_[0]->send } };
		1096	}
		1097
		1098	# undocumented/compatibility with pre-3.4
		1099	*broadcast = \&send;
		1100	*wait = \&_wait;
879		1101
880	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	1102	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
881		1103
882	This is an advanced topic that you do not normally need to use AnyEvent in	1104	This is an advanced topic that you do not normally need to use AnyEvent in
883	a module. This section is only of use to event loop authors who want to	1105	a module. This section is only of use to event loop authors who want to
…		…
940	model it chooses.	1162	model it chooses.
941		1163
942	=item C<PERL_ANYEVENT_MODEL>	1164	=item C<PERL_ANYEVENT_MODEL>
943		1165
944	This can be used to specify the event model to be used by AnyEvent, before	1166	This can be used to specify the event model to be used by AnyEvent, before
945	autodetection and -probing kicks in. It must be a string consisting	1167	auto detection and -probing kicks in. It must be a string consisting
946	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended	1168	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
947	and the resulting module name is loaded and if the load was successful,	1169	and the resulting module name is loaded and if the load was successful,
948	used as event model. If it fails to load AnyEvent will proceed with	1170	used as event model. If it fails to load AnyEvent will proceed with
949	autodetection and -probing.	1171	auto detection and -probing.
950		1172
951	This functionality might change in future versions.	1173	This functionality might change in future versions.
952		1174
953	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you	1175	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
954	could start your program like this:	1176	could start your program like this:
955		1177
956	PERL_ANYEVENT_MODEL=Perl perl ...	1178	PERL_ANYEVENT_MODEL=Perl perl ...
		1179
		1180	=item C<PERL_ANYEVENT_PROTOCOLS>
		1181
		1182	Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
		1183	for IPv4 or IPv6. The default is unspecified (and might change, or be the result
		1184	of auto probing).
		1185
		1186	Must be set to a comma-separated list of protocols or address families,
		1187	current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
		1188	used, and preference will be given to protocols mentioned earlier in the
		1189	list.
		1190
		1191	This variable can effectively be used for denial-of-service attacks
		1192	against local programs (e.g. when setuid), although the impact is likely
		1193	small, as the program has to handle connection errors already-
		1194
		1195	Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
		1196	but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
		1197	- only support IPv4, never try to resolve or contact IPv6
		1198	addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
		1199	IPv6, but prefer IPv6 over IPv4.
		1200
		1201	=item C<PERL_ANYEVENT_EDNS0>
		1202
		1203	Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
		1204	for DNS. This extension is generally useful to reduce DNS traffic, but
		1205	some (broken) firewalls drop such DNS packets, which is why it is off by
		1206	default.
		1207
		1208	Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
		1209	EDNS0 in its DNS requests.
		1210
		1211	=item C<PERL_ANYEVENT_MAX_FORKS>
		1212
		1213	The maximum number of child processes that C<AnyEvent::Util::fork_call>
		1214	will create in parallel.
957		1215
958	=back	1216	=back
959		1217
960	=head1 EXAMPLE PROGRAM	1218	=head1 EXAMPLE PROGRAM
961		1219
…		…
972	poll => 'r',	1230	poll => 'r',
973	cb => sub {	1231	cb => sub {
974	warn "io event <$_[0]>\n"; # will always output <r>	1232	warn "io event <$_[0]>\n"; # will always output <r>
975	chomp (my $input = <STDIN>); # read a line	1233	chomp (my $input = <STDIN>); # read a line
976	warn "read: $input\n"; # output what has been read	1234	warn "read: $input\n"; # output what has been read
977	$cv->broadcast if $input =~ /^q/i; # quit program if /^q/i	1235	$cv->send if $input =~ /^q/i; # quit program if /^q/i
978	},	1236	},
979	);	1237	);
980		1238
981	my $time_watcher; # can only be used once	1239	my $time_watcher; # can only be used once
982		1240
…		…
987	});	1245	});
988	}	1246	}
989		1247
990	new_timer; # create first timer	1248	new_timer; # create first timer
991		1249
992	$cv->wait; # wait until user enters /^q/i	1250	$cv->recv; # wait until user enters /^q/i
993		1251
994	=head1 REAL-WORLD EXAMPLE	1252	=head1 REAL-WORLD EXAMPLE
995		1253
996	Consider the L<Net::FCP> module. It features (among others) the following	1254	Consider the L<Net::FCP> module. It features (among others) the following
997	API calls, which are to freenet what HTTP GET requests are to http:	1255	API calls, which are to freenet what HTTP GET requests are to http:
…		…
1047	syswrite $txn->{fh}, $txn->{request}	1305	syswrite $txn->{fh}, $txn->{request}
1048	or die "connection or write error";	1306	or die "connection or write error";
1049	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });	1307	$txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
1050		1308
1051	Again, C<fh_ready_r> waits till all data has arrived, and then stores the	1309	Again, C<fh_ready_r> waits till all data has arrived, and then stores the
1052	result and signals any possible waiters that the request ahs finished:	1310	result and signals any possible waiters that the request has finished:
1053		1311
1054	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};	1312	sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
1055		1313
1056	if (end-of-file or data complete) {	1314	if (end-of-file or data complete) {
1057	$txn->{result} = $txn->{buf};	1315	$txn->{result} = $txn->{buf};
1058	$txn->{finished}->broadcast;	1316	$txn->{finished}->send;
1059	$txb->{cb}->($txn) of $txn->{cb}; # also call callback	1317	$txb->{cb}->($txn) of $txn->{cb}; # also call callback
1060	}	1318	}
1061		1319
1062	The C<result> method, finally, just waits for the finished signal (if the	1320	The C<result> method, finally, just waits for the finished signal (if the
1063	request was already finished, it doesn't wait, of course, and returns the	1321	request was already finished, it doesn't wait, of course, and returns the
1064	data:	1322	data:
1065		1323
1066	$txn->{finished}->wait;	1324	$txn->{finished}->recv;
1067	return $txn->{result};	1325	return $txn->{result};
1068		1326
1069	The actual code goes further and collects all errors (C<die>s, exceptions)	1327	The actual code goes further and collects all errors (C<die>s, exceptions)
1070	that occured during request processing. The C<result> method detects	1328	that occurred during request processing. The C<result> method detects
1071	whether an exception as thrown (it is stored inside the $txn object)	1329	whether an exception as thrown (it is stored inside the $txn object)
1072	and just throws the exception, which means connection errors and other	1330	and just throws the exception, which means connection errors and other
1073	problems get reported tot he code that tries to use the result, not in a	1331	problems get reported tot he code that tries to use the result, not in a
1074	random callback.	1332	random callback.
1075		1333
…		…
1106		1364
1107	my $quit = AnyEvent->condvar;	1365	my $quit = AnyEvent->condvar;
1108		1366
1109	$fcp->txn_client_get ($url)->cb (sub {	1367	$fcp->txn_client_get ($url)->cb (sub {
1110	...	1368	...
1111	$quit->broadcast;	1369	$quit->send;
1112	});	1370	});
1113		1371
1114	$quit->wait;	1372	$quit->recv;
1115		1373
1116		1374
1117	=head1 BENCHMARKS	1375	=head1 BENCHMARKS
1118		1376
1119	To give you an idea of the performance and overheads that AnyEvent adds	1377	To give you an idea of the performance and overheads that AnyEvent adds
…		…
1121	of various event loops I prepared some benchmarks.	1379	of various event loops I prepared some benchmarks.
1122		1380
1123	=head2 BENCHMARKING ANYEVENT OVERHEAD	1381	=head2 BENCHMARKING ANYEVENT OVERHEAD
1124		1382
1125	Here is a benchmark of various supported event models used natively and	1383	Here is a benchmark of various supported event models used natively and
1126	through anyevent. The benchmark creates a lot of timers (with a zero	1384	through AnyEvent. The benchmark creates a lot of timers (with a zero
1127	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,	1385	timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1128	which it is), lets them fire exactly once and destroys them again.	1386	which it is), lets them fire exactly once and destroys them again.
1129		1387
1130	Source code for this benchmark is found as F<eg/bench> in the AnyEvent	1388	Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1131	distribution.	1389	distribution.
…		…
1148	all watchers, to avoid adding memory overhead. That means closure creation	1406	all watchers, to avoid adding memory overhead. That means closure creation
1149	and memory usage is not included in the figures.	1407	and memory usage is not included in the figures.
1150		1408
1151	I<invoke> is the time, in microseconds, used to invoke a simple	1409	I<invoke> is the time, in microseconds, used to invoke a simple
1152	callback. The callback simply counts down a Perl variable and after it was	1410	callback. The callback simply counts down a Perl variable and after it was
1153	invoked "watcher" times, it would C<< ->broadcast >> a condvar once to	1411	invoked "watcher" times, it would C<< ->send >> a condvar once to
1154	signal the end of this phase.	1412	signal the end of this phase.
1155		1413
1156	I<destroy> is the time, in microseconds, that it takes to destroy a single	1414	I<destroy> is the time, in microseconds, that it takes to destroy a single
1157	watcher.	1415	watcher.
1158		1416
…		…
1254		1512
1255	=back	1513	=back
1256		1514
1257	=head2 BENCHMARKING THE LARGE SERVER CASE	1515	=head2 BENCHMARKING THE LARGE SERVER CASE
1258		1516
1259	This benchmark atcually benchmarks the event loop itself. It works by	1517	This benchmark actually benchmarks the event loop itself. It works by
1260	creating a number of "servers": each server consists of a socketpair, a	1518	creating a number of "servers": each server consists of a socket pair, a
1261	timeout watcher that gets reset on activity (but never fires), and an I/O	1519	timeout watcher that gets reset on activity (but never fires), and an I/O
1262	watcher waiting for input on one side of the socket. Each time the socket	1520	watcher waiting for input on one side of the socket. Each time the socket
1263	watcher reads a byte it will write that byte to a random other "server".	1521	watcher reads a byte it will write that byte to a random other "server".
1264		1522
1265	The effect is that there will be a lot of I/O watchers, only part of which	1523	The effect is that there will be a lot of I/O watchers, only part of which
1266	are active at any one point (so there is a constant number of active	1524	are active at any one point (so there is a constant number of active
1267	fds for each loop iterstaion, but which fds these are is random). The	1525	fds for each loop iteration, but which fds these are is random). The
1268	timeout is reset each time something is read because that reflects how	1526	timeout is reset each time something is read because that reflects how
1269	most timeouts work (and puts extra pressure on the event loops).	1527	most timeouts work (and puts extra pressure on the event loops).
1270		1528
1271	In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100	1529	In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1272	(1%) are active. This mirrors the activity of large servers with many	1530	(1%) are active. This mirrors the activity of large servers with many
1273	connections, most of which are idle at any one point in time.	1531	connections, most of which are idle at any one point in time.
1274		1532
1275	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent	1533	Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1276	distribution.	1534	distribution.
…		…
1278	=head3 Explanation of the columns	1536	=head3 Explanation of the columns
1279		1537
1280	I<sockets> is the number of sockets, and twice the number of "servers" (as	1538	I<sockets> is the number of sockets, and twice the number of "servers" (as
1281	each server has a read and write socket end).	1539	each server has a read and write socket end).
1282		1540
1283	I<create> is the time it takes to create a socketpair (which is	1541	I<create> is the time it takes to create a socket pair (which is
1284	nontrivial) and two watchers: an I/O watcher and a timeout watcher.	1542	nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1285		1543
1286	I<request>, the most important value, is the time it takes to handle a	1544	I<request>, the most important value, is the time it takes to handle a
1287	single "request", that is, reading the token from the pipe and forwarding	1545	single "request", that is, reading the token from the pipe and forwarding
1288	it to another server. This includes deleting the old timeout and creating	1546	it to another server. This includes deleting the old timeout and creating
…		…
1361	speed most when you have lots of watchers, not when you only have a few of	1619	speed most when you have lots of watchers, not when you only have a few of
1362	them).	1620	them).
1363		1621
1364	EV is again fastest.	1622	EV is again fastest.
1365		1623
1366	Perl again comes second. It is noticably faster than the C-based event	1624	Perl again comes second. It is noticeably faster than the C-based event
1367	loops Event and Glib, although the difference is too small to really	1625	loops Event and Glib, although the difference is too small to really
1368	matter.	1626	matter.
1369		1627
1370	POE also performs much better in this case, but is is still far behind the	1628	POE also performs much better in this case, but is is still far behind the
1371	others.	1629	others.
…		…
1411	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).	1669	probably even less useful to an attacker than PERL_ANYEVENT_MODEL).
1412		1670
1413		1671
1414	=head1 SEE ALSO	1672	=head1 SEE ALSO
1415		1673
		1674	Utility functions: L<AnyEvent::Util>.
		1675
1416	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,	1676	Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1417	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	1677	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1418		1678
1419	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	1679	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1420	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	1680	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1421	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	1681	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1422	L<AnyEvent::Impl::POE>.	1682	L<AnyEvent::Impl::POE>.
1423		1683
		1684	Non-blocking file handles, sockets, TCP clients and
		1685	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.
		1686
		1687	Asynchronous DNS: L<AnyEvent::DNS>.
		1688
1424	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	1689	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
1425		1690
1426	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.	1691	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1427		1692
1428		1693
1429	=head1 AUTHOR	1694	=head1 AUTHOR
1430		1695
1431	Marc Lehmann <schmorp@schmorp.de>	1696	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.108 by root, Sat May 10 00:22:02 2008 UTC vs. Revision 1.149 by root, Sat May 31 01:41:22 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.108 by root, Sat May 10 00:22:02 2008 UTC vs.
Revision 1.149 by root, Sat May 31 01:41:22 2008 UTC