ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.82 by root, Fri Apr 25 13:32:39 2008 UTC vs.
Revision 1.113 by root, Sat May 10 20:30:35 2008 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, Coro::EV, Coro::Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, 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->wait; # enters "main loop" till $condvar gets ->broadcast 20 $w->wait; # enters "main loop" till $condvar gets ->send
21 $w->broadcast; # wake up current and all future wait's 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
25Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 25Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26nowadays. So what is different about AnyEvent? 26nowadays. So what is different about AnyEvent?
66 66
67Of course, if you want lots of policy (this can arguably be somewhat 67Of course, if you want lots of policy (this can arguably be somewhat
68useful) and you want to force your users to use the one and only event 68useful) and you want to force your users to use the one and only event
69model, you should I<not> use this module. 69model, you should I<not> use this module.
70 70
71
72=head1 DESCRIPTION 71=head1 DESCRIPTION
73 72
74L<AnyEvent> provides an identical interface to multiple event loops. This 73L<AnyEvent> provides an identical interface to multiple event loops. This
75allows module authors to utilise an event loop without forcing module 74allows module authors to utilise an event loop without forcing module
76users to use the same event loop (as only a single event loop can coexist 75users to use the same event loop (as only a single event loop can coexist
79The interface itself is vaguely similar, but not identical to the L<Event> 78The interface itself is vaguely similar, but not identical to the L<Event>
80module. 79module.
81 80
82During the first call of any watcher-creation method, the module tries 81During the first call of any watcher-creation method, the module tries
83to detect the currently loaded event loop by probing whether one of the 82to detect the currently loaded event loop by probing whether one of the
84following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>, 83following modules is already loaded: L<EV>,
85L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, 84L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,
86L<POE>. The first one found is used. If none are found, the module tries 85L<POE>. The first one found is used. If none are found, the module tries
87to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl 86to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl
88adaptor should always succeed) in the order given. The first one that can 87adaptor should always succeed) in the order given. The first one that can
89be successfully loaded will be used. If, after this, still none could be 88be successfully loaded will be used. If, after this, still none could be
141=head2 I/O WATCHERS 140=head2 I/O WATCHERS
142 141
143You can create an I/O watcher by calling the C<< AnyEvent->io >> method 142You can create an I/O watcher by calling the C<< AnyEvent->io >> method
144with the following mandatory key-value pairs as arguments: 143with the following mandatory key-value pairs as arguments:
145 144
146C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for 145C<fh> the Perl I<file handle> (I<not> file descriptor) to watch
147events. C<poll> must be a string that is either C<r> or C<w>, which 146for events. C<poll> must be a string that is either C<r> or C<w>,
148creates a watcher waiting for "r"eadable or "w"ritable events, 147which creates a watcher waiting for "r"eadable or "w"ritable events,
149respectively. C<cb> is the callback to invoke each time the file handle 148respectively. C<cb> is the callback to invoke each time the file handle
150becomes ready. 149becomes ready.
151 150
151Although the callback might get passed parameters, their value and
152presence is undefined and you cannot rely on them. Portable AnyEvent
153callbacks cannot use arguments passed to I/O watcher callbacks.
154
152The I/O watcher might use the underlying file descriptor or a copy of it. 155The I/O watcher might use the underlying file descriptor or a copy of it.
153It is not allowed to close a file handle as long as any watcher is active 156You must not close a file handle as long as any watcher is active on the
154on the underlying file descriptor. 157underlying file descriptor.
155 158
156Some event loops issue spurious readyness notifications, so you should 159Some event loops issue spurious readyness notifications, so you should
157always use non-blocking calls when reading/writing from/to your file 160always use non-blocking calls when reading/writing from/to your file
158handles. 161handles.
159 162
170 173
171You can create a time watcher by calling the C<< AnyEvent->timer >> 174You can create a time watcher by calling the C<< AnyEvent->timer >>
172method with the following mandatory arguments: 175method with the following mandatory arguments:
173 176
174C<after> specifies after how many seconds (fractional values are 177C<after> specifies after how many seconds (fractional values are
175supported) should the timer activate. C<cb> the callback to invoke in that 178supported) the callback should be invoked. C<cb> is the callback to invoke
176case. 179in that case.
180
181Although the callback might get passed parameters, their value and
182presence is undefined and you cannot rely on them. Portable AnyEvent
183callbacks cannot use arguments passed to time watcher callbacks.
177 184
178The timer callback will be invoked at most once: if you want a repeating 185The timer callback will be invoked at most once: if you want a repeating
179timer you have to create a new watcher (this is a limitation by both Tk 186timer you have to create a new watcher (this is a limitation by both Tk
180and Glib). 187and Glib).
181 188
226 233
227You can watch for signals using a signal watcher, C<signal> is the signal 234You can watch for signals using a signal watcher, C<signal> is the signal
228I<name> without any C<SIG> prefix, C<cb> is the Perl callback to 235I<name> without any C<SIG> prefix, C<cb> is the Perl callback to
229be invoked whenever a signal occurs. 236be invoked whenever a signal occurs.
230 237
238Although the callback might get passed parameters, their value and
239presence is undefined and you cannot rely on them. Portable AnyEvent
240callbacks cannot use arguments passed to signal watcher callbacks.
241
231Multiple signal occurances can be clumped together into one callback 242Multiple signal occurances can be clumped together into one callback
232invocation, and callback invocation will be synchronous. synchronous means 243invocation, and callback invocation will be synchronous. synchronous means
233that it might take a while until the signal gets handled by the process, 244that it might take a while until the signal gets handled by the process,
234but it is guarenteed not to interrupt any other callbacks. 245but it is guarenteed not to interrupt any other callbacks.
235 246
249 260
250The child process is specified by the C<pid> argument (if set to C<0>, it 261The child process is specified by the C<pid> argument (if set to C<0>, it
251watches for any child process exit). The watcher will trigger as often 262watches for any child process exit). The watcher will trigger as often
252as status change for the child are received. This works by installing a 263as status change for the child are received. This works by installing a
253signal handler for C<SIGCHLD>. The callback will be called with the pid 264signal handler for C<SIGCHLD>. The callback will be called with the pid
254and exit status (as returned by waitpid). 265and exit status (as returned by waitpid), so unlike other watcher types,
266you I<can> rely on child watcher callback arguments.
255 267
256There is a slight catch to child watchers, however: you usually start them 268There is a slight catch to child watchers, however: you usually start them
257I<after> the child process was created, and this means the process could 269I<after> the child process was created, and this means the process could
258have exited already (and no SIGCHLD will be sent anymore). 270have exited already (and no SIGCHLD will be sent anymore).
259 271
276 my $w = AnyEvent->child ( 288 my $w = AnyEvent->child (
277 pid => $pid, 289 pid => $pid,
278 cb => sub { 290 cb => sub {
279 my ($pid, $status) = @_; 291 my ($pid, $status) = @_;
280 warn "pid $pid exited with status $status"; 292 warn "pid $pid exited with status $status";
281 $done->broadcast; 293 $done->send;
282 }, 294 },
283 ); 295 );
284 296
285 # do something else, then wait for process exit 297 # do something else, then wait for process exit
286 $done->wait; 298 $done->wait;
287 299
288=head2 CONDITION VARIABLES 300=head2 CONDITION VARIABLES
289 301
302If you are familiar with some event loops you will know that all of them
303require you to run some blocking "loop", "run" or similar function that
304will actively watch for new events and call your callbacks.
305
306AnyEvent is different, it expects somebody else to run the event loop and
307will only block when necessary (usually when told by the user).
308
309The instrument to do that is called a "condition variable", so called
310because they represent a condition that must become true.
311
290Condition variables can be created by calling the C<< AnyEvent->condvar >> 312Condition variables can be created by calling the C<< AnyEvent->condvar
291method without any arguments. 313>> method, usually without arguments. The only argument pair allowed is
314C<cb>, which specifies a callback to be called when the condition variable
315becomes true.
292 316
293A condition variable waits for a condition - precisely that the C<< 317After creation, the conditon variable is "false" until it becomes "true"
294->broadcast >> method has been called. 318by calling the C<send> method.
295 319
296They are very useful to signal that a condition has been fulfilled, for 320Condition variables are similar to callbacks, except that you can
321optionally wait for them. They can also be called merge points - points
322in time where multiple outstandign events have been processed. And yet
323another way to call them is transations - each condition variable can be
324used to represent a transaction, which finishes at some point and delivers
325a result.
326
327Condition variables are very useful to signal that something has finished,
297example, if you write a module that does asynchronous http requests, 328for example, if you write a module that does asynchronous http requests,
298then a condition variable would be the ideal candidate to signal the 329then a condition variable would be the ideal candidate to signal the
299availability of results. 330availability of results. The user can either act when the callback is
331called or can synchronously C<< ->wait >> for the results.
300 332
301You can also use condition variables to block your main program until 333You can also use them to simulate traditional event loops - for example,
302an event occurs - for example, you could C<< ->wait >> in your main 334you can block your main program until an event occurs - for example, you
303program until the user clicks the Quit button in your app, which would C<< 335could C<< ->wait >> in your main program until the user clicks the Quit
304->broadcast >> the "quit" event. 336button of your app, which would C<< ->send >> the "quit" event.
305 337
306Note that condition variables recurse into the event loop - if you have 338Note that condition variables recurse into the event loop - if you have
307two pirces of code that call C<< ->wait >> in a round-robbin fashion, you 339two pieces of code that call C<< ->wait >> in a round-robbin fashion, you
308lose. Therefore, condition variables are good to export to your caller, but 340lose. Therefore, condition variables are good to export to your caller, but
309you should avoid making a blocking wait yourself, at least in callbacks, 341you should avoid making a blocking wait yourself, at least in callbacks,
310as this asks for trouble. 342as this asks for trouble.
311 343
312This object has two methods: 344Condition variables are represented by hash refs in perl, and the keys
345used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
346easy (it is often useful to build your own transaction class on top of
347AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
348it's C<new> method in your own C<new> method.
349
350There are two "sides" to a condition variable - the "producer side" which
351eventually calls C<< -> send >>, and the "consumer side", which waits
352for the send to occur.
353
354Example:
355
356 # wait till the result is ready
357 my $result_ready = AnyEvent->condvar;
358
359 # do something such as adding a timer
360 # or socket watcher the calls $result_ready->send
361 # when the "result" is ready.
362 # in this case, we simply use a timer:
363 my $w = AnyEvent->timer (
364 after => 1,
365 cb => sub { $result_ready->send },
366 );
367
368 # this "blocks" (while handling events) till the callback
369 # calls send
370 $result_ready->wait;
371
372=head3 METHODS FOR PRODUCERS
373
374These methods should only be used by the producing side, i.e. the
375code/module that eventually sends the signal. Note that it is also
376the producer side which creates the condvar in most cases, but it isn't
377uncommon for the consumer to create it as well.
313 378
314=over 4 379=over 4
315 380
381=item $cv->send (...)
382
383Flag the condition as ready - a running C<< ->wait >> and all further
384calls to C<wait> will (eventually) return after this method has been
385called. If nobody is waiting the send will be remembered.
386
387If a callback has been set on the condition variable, it is called
388immediately from within send.
389
390Any arguments passed to the C<send> call will be returned by all
391future C<< ->wait >> calls.
392
393=item $cv->croak ($error)
394
395Similar to send, but causes all call's wait C<< ->wait >> to invoke
396C<Carp::croak> with the given error message/object/scalar.
397
398This can be used to signal any errors to the condition variable
399user/consumer.
400
401=item $cv->begin ([group callback])
402
403=item $cv->end
404
405These two methods can be used to combine many transactions/events into
406one. For example, a function that pings many hosts in parallel might want
407to use a condition variable for the whole process.
408
409Every call to C<< ->begin >> will increment a counter, and every call to
410C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
411>>, the (last) callback passed to C<begin> will be executed. That callback
412is I<supposed> to call C<< ->send >>, but that is not required. If no
413callback was set, C<send> will be called without any arguments.
414
415Let's clarify this with the ping example:
416
417 my $cv = AnyEvent->condvar;
418
419 my %result;
420 $cv->begin (sub { $cv->send (\%result) });
421
422 for my $host (@list_of_hosts) {
423 $cv->begin;
424 ping_host_then_call_callback $host, sub {
425 $result{$host} = ...;
426 $cv->end;
427 };
428 }
429
430 $cv->end;
431
432This code fragment supposedly pings a number of hosts and calls
433C<send> after results for all then have have been gathered - in any
434order. To achieve this, the code issues a call to C<begin> when it starts
435each ping request and calls C<end> when it has received some result for
436it. Since C<begin> and C<end> only maintain a counter, the order in which
437results arrive is not relevant.
438
439There is an additional bracketing call to C<begin> and C<end> outside the
440loop, which serves two important purposes: first, it sets the callback
441to be called once the counter reaches C<0>, and second, it ensures that
442C<send> is called even when C<no> hosts are being pinged (the loop
443doesn't execute once).
444
445This is the general pattern when you "fan out" into multiple subrequests:
446use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
447is called at least once, and then, for each subrequest you start, call
448C<begin> and for eahc subrequest you finish, call C<end>.
449
450=back
451
452=head3 METHODS FOR CONSUMERS
453
454These methods should only be used by the consuming side, i.e. the
455code awaits the condition.
456
457=over 4
458
316=item $cv->wait 459=item $cv->wait
317 460
318Wait (blocking if necessary) until the C<< ->broadcast >> method has been 461Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
319called on c<$cv>, while servicing other watchers normally. 462>> methods have been called on c<$cv>, while servicing other watchers
463normally.
320 464
321You can only wait once on a condition - additional calls will return 465You can only wait once on a condition - additional calls are valid but
322immediately. 466will return immediately.
467
468If an error condition has been set by calling C<< ->croak >>, then this
469function will call C<croak>.
470
471In list context, all parameters passed to C<send> will be returned,
472in scalar context only the first one will be returned.
323 473
324Not all event models support a blocking wait - some die in that case 474Not all event models support a blocking wait - some die in that case
325(programs might want to do that to stay interactive), so I<if you are 475(programs might want to do that to stay interactive), so I<if you are
326using this from a module, never require a blocking wait>, but let the 476using this from a module, never require a blocking wait>, but let the
327caller decide whether the call will block or not (for example, by coupling 477caller decide whether the call will block or not (for example, by coupling
330while still suppporting blocking waits if the caller so desires). 480while still suppporting blocking waits if the caller so desires).
331 481
332Another reason I<never> to C<< ->wait >> in a module is that you cannot 482Another reason I<never> to C<< ->wait >> in a module is that you cannot
333sensibly have two C<< ->wait >>'s in parallel, as that would require 483sensibly have two C<< ->wait >>'s in parallel, as that would require
334multiple interpreters or coroutines/threads, none of which C<AnyEvent> 484multiple interpreters or coroutines/threads, none of which C<AnyEvent>
335can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and 485can supply.
336L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
337from different coroutines, however).
338 486
339=item $cv->broadcast 487The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
488fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
489versions and also integrates coroutines into AnyEvent, making blocking
490C<< ->wait >> calls perfectly safe as long as they are done from another
491coroutine (one that doesn't run the event loop).
340 492
341Flag the condition as ready - a running C<< ->wait >> and all further 493You can ensure that C<< -wait >> never blocks by setting a callback and
342calls to C<wait> will (eventually) return after this method has been 494only calling C<< ->wait >> from within that callback (or at a later
343called. If nobody is waiting the broadcast will be remembered.. 495time). This will work even when the event loop does not support blocking
496waits otherwise.
497
498=item $bool = $cv->ready
499
500Returns true when the condition is "true", i.e. whether C<send> or
501C<croak> have been called.
502
503=item $cb = $cv->cb ([new callback])
504
505This is a mutator function that returns the callback set and optionally
506replaces it before doing so.
507
508The callback will be called when the condition becomes "true", i.e. when
509C<send> or C<croak> are called. Calling C<wait> inside the callback
510or at any later time is guaranteed not to block.
344 511
345=back 512=back
346
347Example:
348
349 # wait till the result is ready
350 my $result_ready = AnyEvent->condvar;
351
352 # do something such as adding a timer
353 # or socket watcher the calls $result_ready->broadcast
354 # when the "result" is ready.
355 # in this case, we simply use a timer:
356 my $w = AnyEvent->timer (
357 after => 1,
358 cb => sub { $result_ready->broadcast },
359 );
360
361 # this "blocks" (while handling events) till the watcher
362 # calls broadcast
363 $result_ready->wait;
364 513
365=head1 GLOBAL VARIABLES AND FUNCTIONS 514=head1 GLOBAL VARIABLES AND FUNCTIONS
366 515
367=over 4 516=over 4
368 517
374C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 523C<AnyEvent::Impl:xxx> modules, but can be any other class in the case
375AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 524AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
376 525
377The known classes so far are: 526The known classes so far are:
378 527
379 AnyEvent::Impl::CoroEV based on Coro::EV, best choice.
380 AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice.
381 AnyEvent::Impl::EV based on EV (an interface to libev, best choice). 528 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
382 AnyEvent::Impl::Event based on Event, second best choice. 529 AnyEvent::Impl::Event based on Event, second best choice.
530 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
383 AnyEvent::Impl::Glib based on Glib, third-best choice. 531 AnyEvent::Impl::Glib based on Glib, third-best choice.
384 AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable.
385 AnyEvent::Impl::Tk based on Tk, very bad choice. 532 AnyEvent::Impl::Tk based on Tk, very bad choice.
386 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). 533 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
387 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 534 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
388 AnyEvent::Impl::POE based on POE, not generic enough for full support. 535 AnyEvent::Impl::POE based on POE, not generic enough for full support.
389 536
402Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 549Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
403if necessary. You should only call this function right before you would 550if necessary. You should only call this function right before you would
404have created an AnyEvent watcher anyway, that is, as late as possible at 551have created an AnyEvent watcher anyway, that is, as late as possible at
405runtime. 552runtime.
406 553
554=item $guard = AnyEvent::post_detect { BLOCK }
555
556Arranges for the code block to be executed as soon as the event model is
557autodetected (or immediately if this has already happened).
558
559If called in scalar or list context, then it creates and returns an object
560that automatically removes the callback again when it is destroyed. See
561L<Coro::BDB> for a case where this is useful.
562
563=item @AnyEvent::post_detect
564
565If there are any code references in this array (you can C<push> to it
566before or after loading AnyEvent), then they will called directly after
567the event loop has been chosen.
568
569You should check C<$AnyEvent::MODEL> before adding to this array, though:
570if it contains a true value then the event loop has already been detected,
571and the array will be ignored.
572
573Best use C<AnyEvent::post_detect { BLOCK }> instead.
574
407=back 575=back
408 576
409=head1 WHAT TO DO IN A MODULE 577=head1 WHAT TO DO IN A MODULE
410 578
411As a module author, you should C<use AnyEvent> and call AnyEvent methods 579As a module author, you should C<use AnyEvent> and call AnyEvent methods
415decide which event module to use as soon as the first method is called, so 583decide which event module to use as soon as the first method is called, so
416by calling AnyEvent in your module body you force the user of your module 584by calling AnyEvent in your module body you force the user of your module
417to load the event module first. 585to load the event module first.
418 586
419Never call C<< ->wait >> on a condition variable unless you I<know> that 587Never call C<< ->wait >> on a condition variable unless you I<know> that
420the C<< ->broadcast >> method has been called on it already. This is 588the C<< ->send >> method has been called on it already. This is
421because it will stall the whole program, and the whole point of using 589because it will stall the whole program, and the whole point of using
422events is to stay interactive. 590events is to stay interactive.
423 591
424It is fine, however, to call C<< ->wait >> when the user of your module 592It is fine, however, to call C<< ->wait >> when the user of your module
425requests it (i.e. if you create a http request object ad have a method 593requests it (i.e. if you create a http request object ad have a method
445 613
446You can chose to use a rather inefficient pure-perl implementation by 614You can chose to use a rather inefficient pure-perl implementation by
447loading the C<AnyEvent::Impl::Perl> module, which gives you similar 615loading the C<AnyEvent::Impl::Perl> module, which gives you similar
448behaviour everywhere, but letting AnyEvent chose is generally better. 616behaviour everywhere, but letting AnyEvent chose is generally better.
449 617
618=head1 OTHER MODULES
619
620The following is a non-exhaustive list of additional modules that use
621AnyEvent and can therefore be mixed easily with other AnyEvent modules
622in the same program. Some of the modules come with AnyEvent, some are
623available via CPAN.
624
625=over 4
626
627=item L<AnyEvent::Util>
628
629Contains various utility functions that replace often-used but blocking
630functions such as C<inet_aton> by event-/callback-based versions.
631
632=item L<AnyEvent::Handle>
633
634Provide read and write buffers and manages watchers for reads and writes.
635
636=item L<AnyEvent::HTTPD>
637
638Provides a simple web application server framework.
639
640=item L<AnyEvent::DNS>
641
642Provides asynchronous DNS resolver capabilities, beyond what
643L<AnyEvent::Util> offers.
644
645=item L<AnyEvent::FastPing>
646
647The fastest ping in the west.
648
649=item L<Net::IRC3>
650
651AnyEvent based IRC client module family.
652
653=item L<Net::XMPP2>
654
655AnyEvent based XMPP (Jabber protocol) module family.
656
657=item L<Net::FCP>
658
659AnyEvent-based implementation of the Freenet Client Protocol, birthplace
660of AnyEvent.
661
662=item L<Event::ExecFlow>
663
664High level API for event-based execution flow control.
665
666=item L<Coro>
667
668Has special support for AnyEvent via L<Coro::AnyEvent>.
669
670=item L<AnyEvent::AIO>, L<IO::AIO>
671
672Truly asynchronous I/O, should be in the toolbox of every event
673programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
674together.
675
676=item L<AnyEvent::BDB>, L<BDB>
677
678Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
679IO::AIO and AnyEvent together.
680
681=item L<IO::Lambda>
682
683The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
684
685=back
686
450=cut 687=cut
451 688
452package AnyEvent; 689package AnyEvent;
453 690
454no warnings; 691no warnings;
455use strict; 692use strict;
456 693
457use Carp; 694use Carp;
458 695
459our $VERSION = '3.3'; 696our $VERSION = '3.4';
460our $MODEL; 697our $MODEL;
461 698
462our $AUTOLOAD; 699our $AUTOLOAD;
463our @ISA; 700our @ISA;
464 701
465our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 702our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
466 703
467our @REGISTRY; 704our @REGISTRY;
468 705
469my @models = ( 706my @models = (
470 [Coro::EV:: => AnyEvent::Impl::CoroEV::],
471 [Coro::Event:: => AnyEvent::Impl::CoroEvent::],
472 [EV:: => AnyEvent::Impl::EV::], 707 [EV:: => AnyEvent::Impl::EV::],
473 [Event:: => AnyEvent::Impl::Event::], 708 [Event:: => AnyEvent::Impl::Event::],
474 [Glib:: => AnyEvent::Impl::Glib::],
475 [Tk:: => AnyEvent::Impl::Tk::], 709 [Tk:: => AnyEvent::Impl::Tk::],
476 [Wx:: => AnyEvent::Impl::POE::], 710 [Wx:: => AnyEvent::Impl::POE::],
477 [Prima:: => AnyEvent::Impl::POE::], 711 [Prima:: => AnyEvent::Impl::POE::],
478 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 712 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
479 # everything below here will not be autoprobed as the pureperl backend should work everywhere 713 # everything below here will not be autoprobed as the pureperl backend should work everywhere
714 [Glib:: => AnyEvent::Impl::Glib::],
480 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 715 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
481 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 716 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
482 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 717 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
483); 718);
484 719
485our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY); 720our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);
721
722our @post_detect;
723
724sub post_detect(&) {
725 my ($cb) = @_;
726
727 if ($MODEL) {
728 $cb->();
729
730 1
731 } else {
732 push @post_detect, $cb;
733
734 defined wantarray
735 ? bless \$cb, "AnyEvent::Util::Guard"
736 : ()
737 }
738}
739
740sub AnyEvent::Util::Guard::DESTROY {
741 @post_detect = grep $_ != ${$_[0]}, @post_detect;
742}
486 743
487sub detect() { 744sub detect() {
488 unless ($MODEL) { 745 unless ($MODEL) {
489 no strict 'refs'; 746 no strict 'refs';
490 747
524 last; 781 last;
525 } 782 }
526 } 783 }
527 784
528 $MODEL 785 $MODEL
529 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."; 786 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
530 } 787 }
531 } 788 }
532 789
533 unshift @ISA, $MODEL; 790 unshift @ISA, $MODEL;
534 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 791 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
792
793 (shift @post_detect)->() while @post_detect;
535 } 794 }
536 795
537 $MODEL 796 $MODEL
538} 797}
539 798
881 }); 1140 });
882 1141
883 $quit->wait; 1142 $quit->wait;
884 1143
885 1144
886=head1 BENCHMARK 1145=head1 BENCHMARKS
887 1146
888To give you an idea of the performance and overheads that AnyEvent adds 1147To give you an idea of the performance and overheads that AnyEvent adds
889over the event loops themselves (and to give you an impression of the 1148over the event loops themselves and to give you an impression of the speed
890speed of various event loops), here is a benchmark of various supported 1149of various event loops I prepared some benchmarks.
891event models natively and with anyevent. The benchmark creates a lot of 1150
892timers (with a zero timeout) and I/O watchers (watching STDOUT, a pty, to 1151=head2 BENCHMARKING ANYEVENT OVERHEAD
1152
1153Here is a benchmark of various supported event models used natively and
1154through anyevent. The benchmark creates a lot of timers (with a zero
1155timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
893become writable, which it is), lets them fire exactly once and destroys 1156which it is), lets them fire exactly once and destroys them again.
894them again.
895 1157
896Rewriting the benchmark to use many different sockets instead of using 1158Source code for this benchmark is found as F<eg/bench> in the AnyEvent
897the same filehandle for all I/O watchers results in a much longer runtime 1159distribution.
898(socket creation is expensive), but qualitatively the same figures, so it
899was not used.
900 1160
901=head2 Explanation of the columns 1161=head3 Explanation of the columns
902 1162
903I<watcher> is the number of event watchers created/destroyed. Since 1163I<watcher> is the number of event watchers created/destroyed. Since
904different event models feature vastly different performances, each event 1164different event models feature vastly different performances, each event
905loop was given a number of watchers so that overall runtime is acceptable 1165loop was given a number of watchers so that overall runtime is acceptable
906and similar between tested event loop (and keep them from crashing): Glib 1166and similar between tested event loop (and keep them from crashing): Glib
922signal the end of this phase. 1182signal the end of this phase.
923 1183
924I<destroy> is the time, in microseconds, that it takes to destroy a single 1184I<destroy> is the time, in microseconds, that it takes to destroy a single
925watcher. 1185watcher.
926 1186
927=head2 Results 1187=head3 Results
928 1188
929 name watchers bytes create invoke destroy comment 1189 name watchers bytes create invoke destroy comment
930 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1190 EV/EV 400000 244 0.56 0.46 0.31 EV native interface
931 EV/Any 100000 610 3.52 0.91 0.75 EV + AnyEvent watchers 1191 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers
932 CoroEV/Any 100000 610 3.49 0.92 0.75 coroutines + Coro::Signal 1192 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal
933 Perl/Any 100000 513 4.91 0.92 1.15 pure perl implementation 1193 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation
934 Event/Event 16000 523 28.05 21.38 0.86 Event native interface 1194 Event/Event 16000 516 31.88 31.30 0.85 Event native interface
935 Event/Any 16000 943 34.43 20.48 1.39 Event + AnyEvent watchers 1195 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers
936 Glib/Any 16000 1357 96.99 12.55 55.51 quadratic behaviour 1196 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour
937 Tk/Any 2000 1855 27.01 66.61 14.03 SEGV with >> 2000 watchers 1197 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers
938 POE/Event 2000 6644 108.15 768.19 14.33 via POE::Loop::Event 1198 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event
939 POE/Select 2000 6343 94.69 807.65 562.69 via POE::Loop::Select 1199 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select
940 1200
941=head2 Discussion 1201=head3 Discussion
942 1202
943The benchmark does I<not> measure scalability of the event loop very 1203The benchmark does I<not> measure scalability of the event loop very
944well. For example, a select-based event loop (such as the pure perl one) 1204well. For example, a select-based event loop (such as the pure perl one)
945can never compete with an event loop that uses epoll when the number of 1205can never compete with an event loop that uses epoll when the number of
946file descriptors grows high. In this benchmark, all events become ready at 1206file descriptors grows high. In this benchmark, all events become ready at
947the same time, so select/poll-based implementations get an unnatural speed 1207the same time, so select/poll-based implementations get an unnatural speed
948boost. 1208boost.
949 1209
1210Also, note that the number of watchers usually has a nonlinear effect on
1211overall speed, that is, creating twice as many watchers doesn't take twice
1212the time - usually it takes longer. This puts event loops tested with a
1213higher number of watchers at a disadvantage.
1214
1215To put the range of results into perspective, consider that on the
1216benchmark machine, handling an event takes roughly 1600 CPU cycles with
1217EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1218cycles with POE.
1219
950C<EV> is the sole leader regarding speed and memory use, which are both 1220C<EV> is the sole leader regarding speed and memory use, which are both
951maximal/minimal, respectively. Even when going through AnyEvent, there are 1221maximal/minimal, respectively. Even when going through AnyEvent, it uses
952only two event loops that use slightly less memory (the C<Event> module 1222far less memory than any other event loop and is still faster than Event
953natively and the pure perl backend), and no faster event models, not even 1223natively.
954C<Event> natively.
955 1224
956The pure perl implementation is hit in a few sweet spots (both the 1225The pure perl implementation is hit in a few sweet spots (both the
957zero timeout and the use of a single fd hit optimisations in the perl 1226constant timeout and the use of a single fd hit optimisations in the perl
958interpreter and the backend itself, and all watchers become ready at the 1227interpreter and the backend itself). Nevertheless this shows that it
959same time). Nevertheless this shows that it adds very little overhead in 1228adds very little overhead in itself. Like any select-based backend its
960itself. Like any select-based backend its performance becomes really bad 1229performance becomes really bad with lots of file descriptors (and few of
961with lots of file descriptors (and few of them active), of course, but 1230them active), of course, but this was not subject of this benchmark.
962this was not subject of this benchmark.
963 1231
964The C<Event> module has a relatively high setup and callback invocation cost, 1232The C<Event> module has a relatively high setup and callback invocation
965but overall scores on the third place. 1233cost, but overall scores in on the third place.
966 1234
967C<Glib>'s memory usage is quite a bit bit higher, but it features a 1235C<Glib>'s memory usage is quite a bit higher, but it features a
968faster callback invocation and overall ends up in the same class as 1236faster callback invocation and overall ends up in the same class as
969C<Event>. However, Glib scales extremely badly, doubling the number of 1237C<Event>. However, Glib scales extremely badly, doubling the number of
970watchers increases the processing time by more than a factor of four, 1238watchers increases the processing time by more than a factor of four,
971making it completely unusable when using larger numbers of watchers 1239making it completely unusable when using larger numbers of watchers
972(note that only a single file descriptor was used in the benchmark, so 1240(note that only a single file descriptor was used in the benchmark, so
975The C<Tk> adaptor works relatively well. The fact that it crashes with 1243The C<Tk> adaptor works relatively well. The fact that it crashes with
976more than 2000 watchers is a big setback, however, as correctness takes 1244more than 2000 watchers is a big setback, however, as correctness takes
977precedence over speed. Nevertheless, its performance is surprising, as the 1245precedence over speed. Nevertheless, its performance is surprising, as the
978file descriptor is dup()ed for each watcher. This shows that the dup() 1246file descriptor is dup()ed for each watcher. This shows that the dup()
979employed by some adaptors is not a big performance issue (it does incur a 1247employed by some adaptors is not a big performance issue (it does incur a
980hidden memory cost inside the kernel, though, that is not reflected in the 1248hidden memory cost inside the kernel which is not reflected in the figures
981figures above). 1249above).
982 1250
983C<POE>, regardless of underlying event loop (wether using its pure perl 1251C<POE>, regardless of underlying event loop (whether using its pure perl
984select-based backend or the Event module) shows abysmal performance and 1252select-based backend or the Event module, the POE-EV backend couldn't
1253be tested because it wasn't working) shows abysmal performance and
985memory usage: Watchers use almost 30 times as much memory as EV watchers, 1254memory usage with AnyEvent: Watchers use almost 30 times as much memory
986and 10 times as much memory as both Event or EV via AnyEvent. Watcher 1255as EV watchers, and 10 times as much memory as Event (the high memory
1256requirements are caused by requiring a session for each watcher). Watcher
987invocation is almost 900 times slower than with AnyEvent's pure perl 1257invocation speed is almost 900 times slower than with AnyEvent's pure perl
1258implementation.
1259
988implementation. The design of the POE adaptor class in AnyEvent can not 1260The design of the POE adaptor class in AnyEvent can not really account
989really account for this, as session creation overhead is small compared 1261for the performance issues, though, as session creation overhead is
990to execution of the state machine, which is coded pretty optimally within 1262small compared to execution of the state machine, which is coded pretty
991L<AnyEvent::Impl::POE>. POE simply seems to be abysmally slow. 1263optimally within L<AnyEvent::Impl::POE> (and while everybody agrees that
1264using multiple sessions is not a good approach, especially regarding
1265memory usage, even the author of POE could not come up with a faster
1266design).
992 1267
993=head2 Summary 1268=head3 Summary
994 1269
1270=over 4
1271
995Using EV through AnyEvent is faster than any other event loop, but most 1272=item * Using EV through AnyEvent is faster than any other event loop
996event loops have acceptable performance with or without AnyEvent. 1273(even when used without AnyEvent), but most event loops have acceptable
1274performance with or without AnyEvent.
997 1275
998The overhead AnyEvent adds is usually much smaller than the overhead of 1276=item * The overhead AnyEvent adds is usually much smaller than the overhead of
999the actual event loop, only with extremely fast event loops such as the EV 1277the actual event loop, only with extremely fast event loops such as EV
1000adds AnyEvent significant overhead. 1278adds AnyEvent significant overhead.
1001 1279
1002And you should simply avoid POE like the plague if you want performance or 1280=item * You should avoid POE like the plague if you want performance or
1003reasonable memory usage. 1281reasonable memory usage.
1004 1282
1283=back
1284
1285=head2 BENCHMARKING THE LARGE SERVER CASE
1286
1287This benchmark atcually benchmarks the event loop itself. It works by
1288creating a number of "servers": each server consists of a socketpair, a
1289timeout watcher that gets reset on activity (but never fires), and an I/O
1290watcher waiting for input on one side of the socket. Each time the socket
1291watcher reads a byte it will write that byte to a random other "server".
1292
1293The effect is that there will be a lot of I/O watchers, only part of which
1294are active at any one point (so there is a constant number of active
1295fds for each loop iterstaion, but which fds these are is random). The
1296timeout is reset each time something is read because that reflects how
1297most timeouts work (and puts extra pressure on the event loops).
1298
1299In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100
1300(1%) are active. This mirrors the activity of large servers with many
1301connections, most of which are idle at any one point in time.
1302
1303Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1304distribution.
1305
1306=head3 Explanation of the columns
1307
1308I<sockets> is the number of sockets, and twice the number of "servers" (as
1309each server has a read and write socket end).
1310
1311I<create> is the time it takes to create a socketpair (which is
1312nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1313
1314I<request>, the most important value, is the time it takes to handle a
1315single "request", that is, reading the token from the pipe and forwarding
1316it to another server. This includes deleting the old timeout and creating
1317a new one that moves the timeout into the future.
1318
1319=head3 Results
1320
1321 name sockets create request
1322 EV 20000 69.01 11.16
1323 Perl 20000 73.32 35.87
1324 Event 20000 212.62 257.32
1325 Glib 20000 651.16 1896.30
1326 POE 20000 349.67 12317.24 uses POE::Loop::Event
1327
1328=head3 Discussion
1329
1330This benchmark I<does> measure scalability and overall performance of the
1331particular event loop.
1332
1333EV is again fastest. Since it is using epoll on my system, the setup time
1334is relatively high, though.
1335
1336Perl surprisingly comes second. It is much faster than the C-based event
1337loops Event and Glib.
1338
1339Event suffers from high setup time as well (look at its code and you will
1340understand why). Callback invocation also has a high overhead compared to
1341the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1342uses select or poll in basically all documented configurations.
1343
1344Glib is hit hard by its quadratic behaviour w.r.t. many watchers. It
1345clearly fails to perform with many filehandles or in busy servers.
1346
1347POE is still completely out of the picture, taking over 1000 times as long
1348as EV, and over 100 times as long as the Perl implementation, even though
1349it uses a C-based event loop in this case.
1350
1351=head3 Summary
1352
1353=over 4
1354
1355=item * The pure perl implementation performs extremely well.
1356
1357=item * Avoid Glib or POE in large projects where performance matters.
1358
1359=back
1360
1361=head2 BENCHMARKING SMALL SERVERS
1362
1363While event loops should scale (and select-based ones do not...) even to
1364large servers, most programs we (or I :) actually write have only a few
1365I/O watchers.
1366
1367In this benchmark, I use the same benchmark program as in the large server
1368case, but it uses only eight "servers", of which three are active at any
1369one time. This should reflect performance for a small server relatively
1370well.
1371
1372The columns are identical to the previous table.
1373
1374=head3 Results
1375
1376 name sockets create request
1377 EV 16 20.00 6.54
1378 Perl 16 25.75 12.62
1379 Event 16 81.27 35.86
1380 Glib 16 32.63 15.48
1381 POE 16 261.87 276.28 uses POE::Loop::Event
1382
1383=head3 Discussion
1384
1385The benchmark tries to test the performance of a typical small
1386server. While knowing how various event loops perform is interesting, keep
1387in mind that their overhead in this case is usually not as important, due
1388to the small absolute number of watchers (that is, you need efficiency and
1389speed most when you have lots of watchers, not when you only have a few of
1390them).
1391
1392EV is again fastest.
1393
1394Perl again comes second. It is noticably faster than the C-based event
1395loops Event and Glib, although the difference is too small to really
1396matter.
1397
1398POE also performs much better in this case, but is is still far behind the
1399others.
1400
1401=head3 Summary
1402
1403=over 4
1404
1405=item * C-based event loops perform very well with small number of
1406watchers, as the management overhead dominates.
1407
1408=back
1409
1005 1410
1006=head1 FORK 1411=head1 FORK
1007 1412
1008Most event libraries are not fork-safe. The ones who are usually are 1413Most event libraries are not fork-safe. The ones who are usually are
1009because they are so inefficient. Only L<EV> is fully fork-aware. 1414because they rely on inefficient but fork-safe C<select> or C<poll>
1415calls. Only L<EV> is fully fork-aware.
1010 1416
1011If you have to fork, you must either do so I<before> creating your first 1417If you have to fork, you must either do so I<before> creating your first
1012watcher OR you must not use AnyEvent at all in the child. 1418watcher OR you must not use AnyEvent at all in the child.
1013 1419
1014 1420
1026 1432
1027 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 1433 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1028 1434
1029 use AnyEvent; 1435 use AnyEvent;
1030 1436
1437Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1438be used to probe what backend is used and gain other information (which is
1439probably even less useful to an attacker than PERL_ANYEVENT_MODEL).
1440
1031 1441
1032=head1 SEE ALSO 1442=head1 SEE ALSO
1033 1443
1034Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, 1444Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1035L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>,
1036L<Event::Lib>, L<Qt>, L<POE>. 1445L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1037 1446
1038Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, 1447Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1039L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, 1448L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1040L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>, 1449L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1041L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>. 1450L<AnyEvent::Impl::POE>.
1451
1452Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
1042 1453
1043Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. 1454Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.
1044 1455
1045 1456
1046=head1 AUTHOR 1457=head1 AUTHOR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines