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.100 by elmex, Sun Apr 27 19:15:43 2008 UTC vs.
Revision 1.106 by root, Thu May 1 13:45:22 2008 UTC

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?
65technically possible. 65technically possible.
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
71#TODO#
72
73Net::IRC3
74AnyEvent::HTTPD
75AnyEvent::DNS
76IO::AnyEvent
77Net::FPing
78Net::XMPP2
79Coro
80
81AnyEvent::IRC
82AnyEvent::HTTPD
83AnyEvent::DNS
84AnyEvent::Handle
85AnyEvent::Socket
86AnyEvent::FPing
87AnyEvent::XMPP
88AnyEvent::SNMP
89Coro
90 70
91=head1 DESCRIPTION 71=head1 DESCRIPTION
92 72
93L<AnyEvent> provides an identical interface to multiple event loops. This 73L<AnyEvent> provides an identical interface to multiple event loops. This
94allows module authors to utilise an event loop without forcing module 74allows module authors to utilise an event loop without forcing module
308 my $w = AnyEvent->child ( 288 my $w = AnyEvent->child (
309 pid => $pid, 289 pid => $pid,
310 cb => sub { 290 cb => sub {
311 my ($pid, $status) = @_; 291 my ($pid, $status) = @_;
312 warn "pid $pid exited with status $status"; 292 warn "pid $pid exited with status $status";
313 $done->broadcast; 293 $done->send;
314 }, 294 },
315 ); 295 );
316 296
317 # do something else, then wait for process exit 297 # do something else, then wait for process exit
318 $done->wait; 298 $done->wait;
319 299
320=head2 CONDITION VARIABLES 300=head2 CONDITION VARIABLES
321 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
322Condition variables can be created by calling the C<< AnyEvent->condvar >> 312Condition variables can be created by calling the C<< AnyEvent->condvar
323method 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.
324 316
325A condition variable waits for a condition - precisely that the C<< 317After creation, the conditon variable is "false" until it becomes "true"
326->broadcast >> method has been called. 318by calling the C<send> method.
327 319
328They 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,
329example, if you write a module that does asynchronous http requests, 328for example, if you write a module that does asynchronous http requests,
330then a condition variable would be the ideal candidate to signal the 329then a condition variable would be the ideal candidate to signal the
331availability of results. 330availability of results. The user can either act when the callback is
331called or can synchronously C<< ->wait >> for the results.
332 332
333You can also use condition variables to block your main program until 333You can also use them to simulate traditional event loops - for example,
334an event occurs - for example, you could C<< ->wait >> in your main 334you can block your main program until an event occurs - for example, you
335program 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
336->broadcast >> the "quit" event. 336button of your app, which would C<< ->send >> the "quit" event.
337 337
338Note that condition variables recurse into the event loop - if you have 338Note that condition variables recurse into the event loop - if you have
339two 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
340lose. Therefore, condition variables are good to export to your caller, but 340lose. Therefore, condition variables are good to export to your caller, but
341you should avoid making a blocking wait yourself, at least in callbacks, 341you should avoid making a blocking wait yourself, at least in callbacks,
342as this asks for trouble. 342as this asks for trouble.
343 343
344This 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.
345 378
346=over 4 379=over 4
347 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
348=item $cv->wait 459=item $cv->wait
349 460
350Wait (blocking if necessary) until the C<< ->broadcast >> method has been 461Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
351called on c<$cv>, while servicing other watchers normally. 462>> methods have been called on c<$cv>, while servicing other watchers
463normally.
352 464
353You can only wait once on a condition - additional calls will return 465You can only wait once on a condition - additional calls are valid but
354immediately. 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.
355 473
356Not 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
357(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
358using 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
359caller 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
366multiple interpreters or coroutines/threads, none of which C<AnyEvent> 484multiple interpreters or coroutines/threads, none of which C<AnyEvent>
367can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and 485can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and
368L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s 486L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
369from different coroutines, however). 487from different coroutines, however).
370 488
371=item $cv->broadcast 489You can ensure that C<< -wait >> never blocks by setting a callback and
490only calling C<< ->wait >> from within that callback (or at a later
491time). This will work even when the event loop does not support blocking
492waits otherwise.
372 493
373Flag the condition as ready - a running C<< ->wait >> and all further 494=item $bool = $cv->ready
374calls to C<wait> will (eventually) return after this method has been 495
375called. If nobody is waiting the broadcast will be remembered.. 496Returns true when the condition is "true", i.e. whether C<send> or
497C<croak> have been called.
498
499=item $cb = $cv->cb ([new callback])
500
501This is a mutator function that returns the callback set and optionally
502replaces it before doing so.
503
504The callback will be called when the condition becomes "true", i.e. when
505C<send> or C<croak> are called. Calling C<wait> inside the callback
506or at any later time is guaranteed not to block.
376 507
377=back 508=back
378
379Example:
380
381 # wait till the result is ready
382 my $result_ready = AnyEvent->condvar;
383
384 # do something such as adding a timer
385 # or socket watcher the calls $result_ready->broadcast
386 # when the "result" is ready.
387 # in this case, we simply use a timer:
388 my $w = AnyEvent->timer (
389 after => 1,
390 cb => sub { $result_ready->broadcast },
391 );
392
393 # this "blocks" (while handling events) till the watcher
394 # calls broadcast
395 $result_ready->wait;
396 509
397=head1 GLOBAL VARIABLES AND FUNCTIONS 510=head1 GLOBAL VARIABLES AND FUNCTIONS
398 511
399=over 4 512=over 4
400 513
410 523
411 AnyEvent::Impl::CoroEV based on Coro::EV, best choice. 524 AnyEvent::Impl::CoroEV based on Coro::EV, best choice.
412 AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice. 525 AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice.
413 AnyEvent::Impl::EV based on EV (an interface to libev, best choice). 526 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
414 AnyEvent::Impl::Event based on Event, second best choice. 527 AnyEvent::Impl::Event based on Event, second best choice.
528 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
415 AnyEvent::Impl::Glib based on Glib, third-best choice. 529 AnyEvent::Impl::Glib based on Glib, third-best choice.
416 AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable.
417 AnyEvent::Impl::Tk based on Tk, very bad choice. 530 AnyEvent::Impl::Tk based on Tk, very bad choice.
418 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). 531 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
419 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 532 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
420 AnyEvent::Impl::POE based on POE, not generic enough for full support. 533 AnyEvent::Impl::POE based on POE, not generic enough for full support.
421 534
447decide which event module to use as soon as the first method is called, so 560decide which event module to use as soon as the first method is called, so
448by calling AnyEvent in your module body you force the user of your module 561by calling AnyEvent in your module body you force the user of your module
449to load the event module first. 562to load the event module first.
450 563
451Never call C<< ->wait >> on a condition variable unless you I<know> that 564Never call C<< ->wait >> on a condition variable unless you I<know> that
452the C<< ->broadcast >> method has been called on it already. This is 565the C<< ->send >> method has been called on it already. This is
453because it will stall the whole program, and the whole point of using 566because it will stall the whole program, and the whole point of using
454events is to stay interactive. 567events is to stay interactive.
455 568
456It is fine, however, to call C<< ->wait >> when the user of your module 569It is fine, however, to call C<< ->wait >> when the user of your module
457requests it (i.e. if you create a http request object ad have a method 570requests it (i.e. if you create a http request object ad have a method
479loading the C<AnyEvent::Impl::Perl> module, which gives you similar 592loading the C<AnyEvent::Impl::Perl> module, which gives you similar
480behaviour everywhere, but letting AnyEvent chose is generally better. 593behaviour everywhere, but letting AnyEvent chose is generally better.
481 594
482=head1 OTHER MODULES 595=head1 OTHER MODULES
483 596
484L<AnyEvent> itself comes with useful utility modules: 597The following is a non-exhaustive list of additional modules that use
485 598AnyEvent and can therefore be mixed easily with other AnyEvent modules
486To make it easier to do non-blocking IO the modules L<AnyEvent::Handle> 599in the same program. Some of the modules come with AnyEvent, some are
487and L<AnyEvent::Socket> are provided. L<AnyEvent::Handle> provides 600available via CPAN.
488read and write buffers and manages watchers for reads and writes.
489L<AnyEvent::Socket> provides means to do non-blocking connects.
490
491Aside from those there are these modules that support AnyEvent (and use it
492for non-blocking IO):
493 601
494=over 4 602=over 4
495 603
604=item L<AnyEvent::Util>
605
606Contains various utility functions that replace often-used but blocking
607functions such as C<inet_aton> by event-/callback-based versions.
608
609=item L<AnyEvent::Handle>
610
611Provide read and write buffers and manages watchers for reads and writes.
612
613=item L<AnyEvent::Socket>
614
615Provides a means to do non-blocking connects, accepts etc.
616
617=item L<AnyEvent::HTTPD>
618
619Provides a simple web application server framework.
620
621=item L<AnyEvent::DNS>
622
623Provides asynchronous DNS resolver capabilities, beyond what
624L<AnyEvent::Util> offers.
625
496=item L<AnyEvent::FastPing> 626=item L<AnyEvent::FastPing>
497 627
628The fastest ping in the west.
629
498=item L<Net::IRC3> 630=item L<Net::IRC3>
499 631
632AnyEvent based IRC client module family.
633
500=item L<Net::XMPP2> 634=item L<Net::XMPP2>
635
636AnyEvent based XMPP (Jabber protocol) module family.
637
638=item L<Net::FCP>
639
640AnyEvent-based implementation of the Freenet Client Protocol, birthplace
641of AnyEvent.
642
643=item L<Event::ExecFlow>
644
645High level API for event-based execution flow control.
646
647=item L<Coro>
648
649Has special support for AnyEvent.
650
651=item L<IO::Lambda>
652
653The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
654
655=item L<IO::AIO>
656
657Truly asynchronous I/O, should be in the toolbox of every event
658programmer. Can be trivially made to use AnyEvent.
659
660=item L<BDB>
661
662Truly asynchronous Berkeley DB access. Can be trivially made to use
663AnyEvent.
501 664
502=back 665=back
503 666
504=cut 667=cut
505 668
523my @models = ( 686my @models = (
524 [Coro::EV:: => AnyEvent::Impl::CoroEV::], 687 [Coro::EV:: => AnyEvent::Impl::CoroEV::],
525 [Coro::Event:: => AnyEvent::Impl::CoroEvent::], 688 [Coro::Event:: => AnyEvent::Impl::CoroEvent::],
526 [EV:: => AnyEvent::Impl::EV::], 689 [EV:: => AnyEvent::Impl::EV::],
527 [Event:: => AnyEvent::Impl::Event::], 690 [Event:: => AnyEvent::Impl::Event::],
528 [Glib:: => AnyEvent::Impl::Glib::],
529 [Tk:: => AnyEvent::Impl::Tk::], 691 [Tk:: => AnyEvent::Impl::Tk::],
530 [Wx:: => AnyEvent::Impl::POE::], 692 [Wx:: => AnyEvent::Impl::POE::],
531 [Prima:: => AnyEvent::Impl::POE::], 693 [Prima:: => AnyEvent::Impl::POE::],
532 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 694 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
533 # everything below here will not be autoprobed as the pureperl backend should work everywhere 695 # everything below here will not be autoprobed as the pureperl backend should work everywhere
696 [Glib:: => AnyEvent::Impl::Glib::],
534 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 697 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
535 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 698 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
536 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 699 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
537); 700);
538 701
539our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY); 702our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY);
540 703
541sub detect() { 704sub detect() {
542 unless ($MODEL) { 705 unless ($MODEL) {
543 no strict 'refs'; 706 no strict 'refs';
544 707
1041file descriptor is dup()ed for each watcher. This shows that the dup() 1204file descriptor is dup()ed for each watcher. This shows that the dup()
1042employed by some adaptors is not a big performance issue (it does incur a 1205employed by some adaptors is not a big performance issue (it does incur a
1043hidden memory cost inside the kernel which is not reflected in the figures 1206hidden memory cost inside the kernel which is not reflected in the figures
1044above). 1207above).
1045 1208
1046C<POE>, regardless of underlying event loop (whether using its pure 1209C<POE>, regardless of underlying event loop (whether using its pure perl
1047perl select-based backend or the Event module, the POE-EV backend 1210select-based backend or the Event module, the POE-EV backend couldn't
1048couldn't be tested because it wasn't working) shows abysmal performance 1211be tested because it wasn't working) shows abysmal performance and
1049and memory usage: Watchers use almost 30 times as much memory as 1212memory usage with AnyEvent: Watchers use almost 30 times as much memory
1050EV watchers, and 10 times as much memory as Event (the high memory 1213as EV watchers, and 10 times as much memory as Event (the high memory
1051requirements are caused by requiring a session for each watcher). Watcher 1214requirements are caused by requiring a session for each watcher). Watcher
1052invocation speed is almost 900 times slower than with AnyEvent's pure perl 1215invocation speed is almost 900 times slower than with AnyEvent's pure perl
1216implementation.
1217
1053implementation. The design of the POE adaptor class in AnyEvent can not 1218The design of the POE adaptor class in AnyEvent can not really account
1054really account for this, as session creation overhead is small compared 1219for the performance issues, though, as session creation overhead is
1055to execution of the state machine, which is coded pretty optimally within 1220small compared to execution of the state machine, which is coded pretty
1056L<AnyEvent::Impl::POE>. POE simply seems to be abysmally slow. 1221optimally within L<AnyEvent::Impl::POE> (and while everybody agrees that
1222using multiple sessions is not a good approach, especially regarding
1223memory usage, even the author of POE could not come up with a faster
1224design).
1057 1225
1058=head3 Summary 1226=head3 Summary
1059 1227
1060=over 4 1228=over 4
1061 1229
1140 1308
1141=head3 Summary 1309=head3 Summary
1142 1310
1143=over 4 1311=over 4
1144 1312
1145=item * The pure perl implementation performs extremely well, considering 1313=item * The pure perl implementation performs extremely well.
1146that it uses select.
1147 1314
1148=item * Avoid Glib or POE in large projects where performance matters. 1315=item * Avoid Glib or POE in large projects where performance matters.
1149 1316
1150=back 1317=back
1151 1318
1180speed most when you have lots of watchers, not when you only have a few of 1347speed most when you have lots of watchers, not when you only have a few of
1181them). 1348them).
1182 1349
1183EV is again fastest. 1350EV is again fastest.
1184 1351
1185The C-based event loops Event and Glib come in second this time, as the 1352Perl again comes second. It is noticably faster than the C-based event
1186overhead of running an iteration is much smaller in C than in Perl (little 1353loops Event and Glib, although the difference is too small to really
1187code to execute in the inner loop, and perl's function calling overhead is 1354matter.
1188high, and updating all the data structures is costly).
1189
1190The pure perl event loop is much slower, but still competitive.
1191 1355
1192POE also performs much better in this case, but is is still far behind the 1356POE also performs much better in this case, but is is still far behind the
1193others. 1357others.
1194 1358
1195=head3 Summary 1359=head3 Summary
1203 1367
1204 1368
1205=head1 FORK 1369=head1 FORK
1206 1370
1207Most event libraries are not fork-safe. The ones who are usually are 1371Most event libraries are not fork-safe. The ones who are usually are
1208because they are so inefficient. Only L<EV> is fully fork-aware. 1372because they rely on inefficient but fork-safe C<select> or C<poll>
1373calls. Only L<EV> is fully fork-aware.
1209 1374
1210If you have to fork, you must either do so I<before> creating your first 1375If you have to fork, you must either do so I<before> creating your first
1211watcher OR you must not use AnyEvent at all in the child. 1376watcher OR you must not use AnyEvent at all in the child.
1212 1377
1213 1378

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines