1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - events independent of event loop implementation |
3 | AnyEvent - the DBI of event loop programming |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, IO::Async, Qt and POE are |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt |
6 | various supported event loops/environments. |
6 | and POE are various supported event loops/environments. |
7 | |
7 | |
8 | =head1 SYNOPSIS |
8 | =head1 SYNOPSIS |
9 | |
9 | |
10 | use AnyEvent; |
10 | use AnyEvent; |
11 | |
11 | |
|
|
12 | # if you prefer function calls, look at the AE manpage for |
|
|
13 | # an alternative API. |
|
|
14 | |
12 | # file descriptor readable |
15 | # file handle or descriptor readable |
13 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
16 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
14 | |
17 | |
15 | # one-shot or repeating timers |
18 | # one-shot or repeating timers |
16 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
19 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
17 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
20 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
… | |
… | |
181 | my variables are only visible after the statement in which they are |
184 | my variables are only visible after the statement in which they are |
182 | declared. |
185 | declared. |
183 | |
186 | |
184 | =head2 I/O WATCHERS |
187 | =head2 I/O WATCHERS |
185 | |
188 | |
|
|
189 | $w = AnyEvent->io ( |
|
|
190 | fh => <filehandle_or_fileno>, |
|
|
191 | poll => <"r" or "w">, |
|
|
192 | cb => <callback>, |
|
|
193 | ); |
|
|
194 | |
186 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
195 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
187 | with the following mandatory key-value pairs as arguments: |
196 | with the following mandatory key-value pairs as arguments: |
188 | |
197 | |
189 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
198 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
190 | for events (AnyEvent might or might not keep a reference to this file |
199 | for events (AnyEvent might or might not keep a reference to this file |
… | |
… | |
219 | undef $w; |
228 | undef $w; |
220 | }); |
229 | }); |
221 | |
230 | |
222 | =head2 TIME WATCHERS |
231 | =head2 TIME WATCHERS |
223 | |
232 | |
|
|
233 | $w = AnyEvent->timer (after => <seconds>, cb => <callback>); |
|
|
234 | |
|
|
235 | $w = AnyEvent->timer ( |
|
|
236 | after => <fractional_seconds>, |
|
|
237 | interval => <fractional_seconds>, |
|
|
238 | cb => <callback>, |
|
|
239 | ); |
|
|
240 | |
224 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
241 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
225 | method with the following mandatory arguments: |
242 | method with the following mandatory arguments: |
226 | |
243 | |
227 | C<after> specifies after how many seconds (fractional values are |
244 | C<after> specifies after how many seconds (fractional values are |
228 | supported) the callback should be invoked. C<cb> is the callback to invoke |
245 | supported) the callback should be invoked. C<cb> is the callback to invoke |
… | |
… | |
349 | might affect timers and time-outs. |
366 | might affect timers and time-outs. |
350 | |
367 | |
351 | When this is the case, you can call this method, which will update the |
368 | When this is the case, you can call this method, which will update the |
352 | event loop's idea of "current time". |
369 | event loop's idea of "current time". |
353 | |
370 | |
|
|
371 | A typical example would be a script in a web server (e.g. C<mod_perl>) - |
|
|
372 | when mod_perl executes the script, then the event loop will have the wrong |
|
|
373 | idea about the "current time" (being potentially far in the past, when the |
|
|
374 | script ran the last time). In that case you should arrange a call to C<< |
|
|
375 | AnyEvent->now_update >> each time the web server process wakes up again |
|
|
376 | (e.g. at the start of your script, or in a handler). |
|
|
377 | |
354 | Note that updating the time I<might> cause some events to be handled. |
378 | Note that updating the time I<might> cause some events to be handled. |
355 | |
379 | |
356 | =back |
380 | =back |
357 | |
381 | |
358 | =head2 SIGNAL WATCHERS |
382 | =head2 SIGNAL WATCHERS |
|
|
383 | |
|
|
384 | $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>); |
359 | |
385 | |
360 | You can watch for signals using a signal watcher, C<signal> is the signal |
386 | You can watch for signals using a signal watcher, C<signal> is the signal |
361 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
387 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
362 | callback to be invoked whenever a signal occurs. |
388 | callback to be invoked whenever a signal occurs. |
363 | |
389 | |
… | |
… | |
380 | |
406 | |
381 | Example: exit on SIGINT |
407 | Example: exit on SIGINT |
382 | |
408 | |
383 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
409 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
384 | |
410 | |
|
|
411 | =head3 Restart Behaviour |
|
|
412 | |
|
|
413 | While restart behaviour is up to the event loop implementation, most will |
|
|
414 | not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's |
|
|
415 | pure perl implementation). |
|
|
416 | |
|
|
417 | =head3 Safe/Unsafe Signals |
|
|
418 | |
|
|
419 | Perl signals can be either "safe" (synchronous to opcode handling) or |
|
|
420 | "unsafe" (asynchronous) - the former might get delayed indefinitely, the |
|
|
421 | latter might corrupt your memory. |
|
|
422 | |
|
|
423 | AnyEvent signal handlers are, in addition, synchronous to the event loop, |
|
|
424 | i.e. they will not interrupt your running perl program but will only be |
|
|
425 | called as part of the normal event handling (just like timer, I/O etc. |
|
|
426 | callbacks, too). |
|
|
427 | |
385 | =head3 Signal Races, Delays and Workarounds |
428 | =head3 Signal Races, Delays and Workarounds |
386 | |
429 | |
387 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
430 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
388 | callbacks to signals in a generic way, which is a pity, as you cannot do |
431 | callbacks to signals in a generic way, which is a pity, as you cannot |
389 | race-free signal handling in perl. AnyEvent will try to do it's best, but |
432 | do race-free signal handling in perl, requiring C libraries for |
|
|
433 | this. AnyEvent will try to do it's best, which means in some cases, |
390 | in some cases, signals will be delayed. The maximum time a signal might |
434 | signals will be delayed. The maximum time a signal might be delayed is |
391 | be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 |
435 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
392 | seconds). This variable can be changed only before the first signal |
436 | variable can be changed only before the first signal watcher is created, |
393 | watcher is created, and should be left alone otherwise. Higher values |
437 | and should be left alone otherwise. This variable determines how often |
|
|
438 | AnyEvent polls for signals (in case a wake-up was missed). Higher values |
394 | will cause fewer spurious wake-ups, which is better for power and CPU |
439 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
440 | saving. |
|
|
441 | |
395 | saving. All these problems can be avoided by installing the optional |
442 | All these problems can be avoided by installing the optional |
396 | L<Async::Interrupt> module. This will not work with inherently broken |
443 | L<Async::Interrupt> module, which works with most event loops. It will not |
397 | event loops such as L<Event> or L<Event::Lib> (and not with L<POE> |
444 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
398 | currently, as POE does it's own workaround with one-second latency). With |
445 | (and not with L<POE> currently, as POE does it's own workaround with |
399 | those, you just have to suffer the delays. |
446 | one-second latency). For those, you just have to suffer the delays. |
400 | |
447 | |
401 | =head2 CHILD PROCESS WATCHERS |
448 | =head2 CHILD PROCESS WATCHERS |
|
|
449 | |
|
|
450 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
402 | |
451 | |
403 | You can also watch on a child process exit and catch its exit status. |
452 | You can also watch on a child process exit and catch its exit status. |
404 | |
453 | |
405 | The child process is specified by the C<pid> argument (one some backends, |
454 | The child process is specified by the C<pid> argument (one some backends, |
406 | using C<0> watches for any child process exit, on others this will |
455 | using C<0> watches for any child process exit, on others this will |
… | |
… | |
455 | # do something else, then wait for process exit |
504 | # do something else, then wait for process exit |
456 | $done->recv; |
505 | $done->recv; |
457 | |
506 | |
458 | =head2 IDLE WATCHERS |
507 | =head2 IDLE WATCHERS |
459 | |
508 | |
460 | Sometimes there is a need to do something, but it is not so important |
509 | $w = AnyEvent->idle (cb => <callback>); |
461 | to do it instantly, but only when there is nothing better to do. This |
|
|
462 | "nothing better to do" is usually defined to be "no other events need |
|
|
463 | attention by the event loop". |
|
|
464 | |
510 | |
465 | Idle watchers ideally get invoked when the event loop has nothing |
511 | Repeatedly invoke the callback after the process becomes idle, until |
466 | better to do, just before it would block the process to wait for new |
512 | either the watcher is destroyed or new events have been detected. |
467 | events. Instead of blocking, the idle watcher is invoked. |
|
|
468 | |
513 | |
469 | Most event loops unfortunately do not really support idle watchers (only |
514 | Idle watchers are useful when there is a need to do something, but it |
|
|
515 | is not so important (or wise) to do it instantly. The callback will be |
|
|
516 | invoked only when there is "nothing better to do", which is usually |
|
|
517 | defined as "all outstanding events have been handled and no new events |
|
|
518 | have been detected". That means that idle watchers ideally get invoked |
|
|
519 | when the event loop has just polled for new events but none have been |
|
|
520 | detected. Instead of blocking to wait for more events, the idle watchers |
|
|
521 | will be invoked. |
|
|
522 | |
|
|
523 | Unfortunately, most event loops do not really support idle watchers (only |
470 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
524 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
471 | will simply call the callback "from time to time". |
525 | will simply call the callback "from time to time". |
472 | |
526 | |
473 | Example: read lines from STDIN, but only process them when the |
527 | Example: read lines from STDIN, but only process them when the |
474 | program is otherwise idle: |
528 | program is otherwise idle: |
… | |
… | |
490 | }); |
544 | }); |
491 | }); |
545 | }); |
492 | |
546 | |
493 | =head2 CONDITION VARIABLES |
547 | =head2 CONDITION VARIABLES |
494 | |
548 | |
|
|
549 | $cv = AnyEvent->condvar; |
|
|
550 | |
|
|
551 | $cv->send (<list>); |
|
|
552 | my @res = $cv->recv; |
|
|
553 | |
495 | If you are familiar with some event loops you will know that all of them |
554 | If you are familiar with some event loops you will know that all of them |
496 | require you to run some blocking "loop", "run" or similar function that |
555 | require you to run some blocking "loop", "run" or similar function that |
497 | will actively watch for new events and call your callbacks. |
556 | will actively watch for new events and call your callbacks. |
498 | |
557 | |
499 | AnyEvent is slightly different: it expects somebody else to run the event |
558 | AnyEvent is slightly different: it expects somebody else to run the event |
500 | loop and will only block when necessary (usually when told by the user). |
559 | loop and will only block when necessary (usually when told by the user). |
501 | |
560 | |
502 | The instrument to do that is called a "condition variable", so called |
561 | The tool to do that is called a "condition variable", so called because |
503 | because they represent a condition that must become true. |
562 | they represent a condition that must become true. |
504 | |
563 | |
505 | Now is probably a good time to look at the examples further below. |
564 | Now is probably a good time to look at the examples further below. |
506 | |
565 | |
507 | Condition variables can be created by calling the C<< AnyEvent->condvar |
566 | Condition variables can be created by calling the C<< AnyEvent->condvar |
508 | >> method, usually without arguments. The only argument pair allowed is |
567 | >> method, usually without arguments. The only argument pair allowed is |
… | |
… | |
513 | After creation, the condition variable is "false" until it becomes "true" |
572 | After creation, the condition variable is "false" until it becomes "true" |
514 | by calling the C<send> method (or calling the condition variable as if it |
573 | by calling the C<send> method (or calling the condition variable as if it |
515 | were a callback, read about the caveats in the description for the C<< |
574 | were a callback, read about the caveats in the description for the C<< |
516 | ->send >> method). |
575 | ->send >> method). |
517 | |
576 | |
518 | Condition variables are similar to callbacks, except that you can |
577 | Since condition variables are the most complex part of the AnyEvent API, here are |
519 | optionally wait for them. They can also be called merge points - points |
578 | some different mental models of what they are - pick the ones you can connect to: |
520 | in time where multiple outstanding events have been processed. And yet |
579 | |
521 | another way to call them is transactions - each condition variable can be |
580 | =over 4 |
522 | used to represent a transaction, which finishes at some point and delivers |
581 | |
523 | a result. And yet some people know them as "futures" - a promise to |
582 | =item * Condition variables are like callbacks - you can call them (and pass them instead |
524 | compute/deliver something that you can wait for. |
583 | of callbacks). Unlike callbacks however, you can also wait for them to be called. |
|
|
584 | |
|
|
585 | =item * Condition variables are signals - one side can emit or send them, |
|
|
586 | the other side can wait for them, or install a handler that is called when |
|
|
587 | the signal fires. |
|
|
588 | |
|
|
589 | =item * Condition variables are like "Merge Points" - points in your program |
|
|
590 | where you merge multiple independent results/control flows into one. |
|
|
591 | |
|
|
592 | =item * Condition variables represent a transaction - function that start |
|
|
593 | some kind of transaction can return them, leaving the caller the choice |
|
|
594 | between waiting in a blocking fashion, or setting a callback. |
|
|
595 | |
|
|
596 | =item * Condition variables represent future values, or promises to deliver |
|
|
597 | some result, long before the result is available. |
|
|
598 | |
|
|
599 | =back |
525 | |
600 | |
526 | Condition variables are very useful to signal that something has finished, |
601 | Condition variables are very useful to signal that something has finished, |
527 | for example, if you write a module that does asynchronous http requests, |
602 | for example, if you write a module that does asynchronous http requests, |
528 | then a condition variable would be the ideal candidate to signal the |
603 | then a condition variable would be the ideal candidate to signal the |
529 | availability of results. The user can either act when the callback is |
604 | availability of results. The user can either act when the callback is |
… | |
… | |
550 | eventually calls C<< -> send >>, and the "consumer side", which waits |
625 | eventually calls C<< -> send >>, and the "consumer side", which waits |
551 | for the send to occur. |
626 | for the send to occur. |
552 | |
627 | |
553 | Example: wait for a timer. |
628 | Example: wait for a timer. |
554 | |
629 | |
555 | # wait till the result is ready |
630 | # condition: "wait till the timer is fired" |
556 | my $result_ready = AnyEvent->condvar; |
631 | my $timer_fired = AnyEvent->condvar; |
557 | |
632 | |
558 | # do something such as adding a timer |
633 | # create the timer - we could wait for, say |
559 | # or socket watcher the calls $result_ready->send |
634 | # a handle becomign ready, or even an |
560 | # when the "result" is ready. |
635 | # AnyEvent::HTTP request to finish, but |
561 | # in this case, we simply use a timer: |
636 | # in this case, we simply use a timer: |
562 | my $w = AnyEvent->timer ( |
637 | my $w = AnyEvent->timer ( |
563 | after => 1, |
638 | after => 1, |
564 | cb => sub { $result_ready->send }, |
639 | cb => sub { $timer_fired->send }, |
565 | ); |
640 | ); |
566 | |
641 | |
567 | # this "blocks" (while handling events) till the callback |
642 | # this "blocks" (while handling events) till the callback |
568 | # calls -<send |
643 | # calls ->send |
569 | $result_ready->recv; |
644 | $timer_fired->recv; |
570 | |
645 | |
571 | Example: wait for a timer, but take advantage of the fact that condition |
646 | Example: wait for a timer, but take advantage of the fact that condition |
572 | variables are also callable directly. |
647 | variables are also callable directly. |
573 | |
648 | |
574 | my $done = AnyEvent->condvar; |
649 | my $done = AnyEvent->condvar; |
… | |
… | |
637 | one. For example, a function that pings many hosts in parallel might want |
712 | one. For example, a function that pings many hosts in parallel might want |
638 | to use a condition variable for the whole process. |
713 | to use a condition variable for the whole process. |
639 | |
714 | |
640 | Every call to C<< ->begin >> will increment a counter, and every call to |
715 | Every call to C<< ->begin >> will increment a counter, and every call to |
641 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
716 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
642 | >>, the (last) callback passed to C<begin> will be executed. That callback |
717 | >>, the (last) callback passed to C<begin> will be executed, passing the |
643 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
718 | condvar as first argument. That callback is I<supposed> to call C<< ->send |
644 | callback was set, C<send> will be called without any arguments. |
719 | >>, but that is not required. If no group callback was set, C<send> will |
|
|
720 | be called without any arguments. |
645 | |
721 | |
646 | You can think of C<< $cv->send >> giving you an OR condition (one call |
722 | You can think of C<< $cv->send >> giving you an OR condition (one call |
647 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
723 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
648 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
724 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
649 | |
725 | |
… | |
… | |
676 | begung can potentially be zero: |
752 | begung can potentially be zero: |
677 | |
753 | |
678 | my $cv = AnyEvent->condvar; |
754 | my $cv = AnyEvent->condvar; |
679 | |
755 | |
680 | my %result; |
756 | my %result; |
681 | $cv->begin (sub { $cv->send (\%result) }); |
757 | $cv->begin (sub { shift->send (\%result) }); |
682 | |
758 | |
683 | for my $host (@list_of_hosts) { |
759 | for my $host (@list_of_hosts) { |
684 | $cv->begin; |
760 | $cv->begin; |
685 | ping_host_then_call_callback $host, sub { |
761 | ping_host_then_call_callback $host, sub { |
686 | $result{$host} = ...; |
762 | $result{$host} = ...; |
… | |
… | |
761 | =item $cb = $cv->cb ($cb->($cv)) |
837 | =item $cb = $cv->cb ($cb->($cv)) |
762 | |
838 | |
763 | This is a mutator function that returns the callback set and optionally |
839 | This is a mutator function that returns the callback set and optionally |
764 | replaces it before doing so. |
840 | replaces it before doing so. |
765 | |
841 | |
766 | The callback will be called when the condition becomes "true", i.e. when |
842 | The callback will be called when the condition becomes (or already was) |
767 | C<send> or C<croak> are called, with the only argument being the condition |
843 | "true", i.e. when C<send> or C<croak> are called (or were called), with |
768 | variable itself. Calling C<recv> inside the callback or at any later time |
844 | the only argument being the condition variable itself. Calling C<recv> |
769 | is guaranteed not to block. |
845 | inside the callback or at any later time is guaranteed not to block. |
770 | |
846 | |
771 | =back |
847 | =back |
772 | |
848 | |
773 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
849 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
774 | |
850 | |
… | |
… | |
777 | =over 4 |
853 | =over 4 |
778 | |
854 | |
779 | =item Backends that are autoprobed when no other event loop can be found. |
855 | =item Backends that are autoprobed when no other event loop can be found. |
780 | |
856 | |
781 | EV is the preferred backend when no other event loop seems to be in |
857 | EV is the preferred backend when no other event loop seems to be in |
782 | use. If EV is not installed, then AnyEvent will try Event, and, failing |
858 | use. If EV is not installed, then AnyEvent will fall back to its own |
783 | that, will fall back to its own pure-perl implementation, which is |
859 | pure-perl implementation, which is available everywhere as it comes with |
784 | available everywhere as it comes with AnyEvent itself. |
860 | AnyEvent itself. |
785 | |
861 | |
786 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
862 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
787 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
|
|
788 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
863 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
789 | |
864 | |
790 | =item Backends that are transparently being picked up when they are used. |
865 | =item Backends that are transparently being picked up when they are used. |
791 | |
866 | |
792 | These will be used when they are currently loaded when the first watcher |
867 | These will be used when they are currently loaded when the first watcher |
793 | is created, in which case it is assumed that the application is using |
868 | is created, in which case it is assumed that the application is using |
794 | them. This means that AnyEvent will automatically pick the right backend |
869 | them. This means that AnyEvent will automatically pick the right backend |
795 | when the main program loads an event module before anything starts to |
870 | when the main program loads an event module before anything starts to |
796 | create watchers. Nothing special needs to be done by the main program. |
871 | create watchers. Nothing special needs to be done by the main program. |
797 | |
872 | |
|
|
873 | AnyEvent::Impl::Event based on Event, very stable, few glitches. |
798 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
874 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
799 | AnyEvent::Impl::Tk based on Tk, very broken. |
875 | AnyEvent::Impl::Tk based on Tk, very broken. |
800 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
876 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
801 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
877 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
802 | AnyEvent::Impl::Irssi used when running within irssi. |
878 | AnyEvent::Impl::Irssi used when running within irssi. |
… | |
… | |
912 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
988 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
913 | if it is defined then the event loop has already been detected, and the |
989 | if it is defined then the event loop has already been detected, and the |
914 | array will be ignored. |
990 | array will be ignored. |
915 | |
991 | |
916 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
992 | Best use C<AnyEvent::post_detect { BLOCK }> when your application allows |
917 | it,as it takes care of these details. |
993 | it, as it takes care of these details. |
918 | |
994 | |
919 | This variable is mainly useful for modules that can do something useful |
995 | This variable is mainly useful for modules that can do something useful |
920 | when AnyEvent is used and thus want to know when it is initialised, but do |
996 | when AnyEvent is used and thus want to know when it is initialised, but do |
921 | not need to even load it by default. This array provides the means to hook |
997 | not need to even load it by default. This array provides the means to hook |
922 | into AnyEvent passively, without loading it. |
998 | into AnyEvent passively, without loading it. |
|
|
999 | |
|
|
1000 | Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used |
|
|
1001 | together, you could put this into Coro (this is the actual code used by |
|
|
1002 | Coro to accomplish this): |
|
|
1003 | |
|
|
1004 | if (defined $AnyEvent::MODEL) { |
|
|
1005 | # AnyEvent already initialised, so load Coro::AnyEvent |
|
|
1006 | require Coro::AnyEvent; |
|
|
1007 | } else { |
|
|
1008 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
|
|
1009 | # as soon as it is |
|
|
1010 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
|
|
1011 | } |
923 | |
1012 | |
924 | =back |
1013 | =back |
925 | |
1014 | |
926 | =head1 WHAT TO DO IN A MODULE |
1015 | =head1 WHAT TO DO IN A MODULE |
927 | |
1016 | |
… | |
… | |
984 | =head1 OTHER MODULES |
1073 | =head1 OTHER MODULES |
985 | |
1074 | |
986 | The following is a non-exhaustive list of additional modules that use |
1075 | The following is a non-exhaustive list of additional modules that use |
987 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
1076 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
988 | modules and other event loops in the same program. Some of the modules |
1077 | modules and other event loops in the same program. Some of the modules |
989 | come with AnyEvent, most are available via CPAN. |
1078 | come as part of AnyEvent, the others are available via CPAN. |
990 | |
1079 | |
991 | =over 4 |
1080 | =over 4 |
992 | |
1081 | |
993 | =item L<AnyEvent::Util> |
1082 | =item L<AnyEvent::Util> |
994 | |
1083 | |
… | |
… | |
1009 | |
1098 | |
1010 | =item L<AnyEvent::DNS> |
1099 | =item L<AnyEvent::DNS> |
1011 | |
1100 | |
1012 | Provides rich asynchronous DNS resolver capabilities. |
1101 | Provides rich asynchronous DNS resolver capabilities. |
1013 | |
1102 | |
|
|
1103 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
|
|
1104 | |
|
|
1105 | Implement event-based interfaces to the protocols of the same name (for |
|
|
1106 | the curious, IGS is the International Go Server and FCP is the Freenet |
|
|
1107 | Client Protocol). |
|
|
1108 | |
|
|
1109 | =item L<AnyEvent::Handle::UDP> |
|
|
1110 | |
|
|
1111 | Here be danger! |
|
|
1112 | |
|
|
1113 | As Pauli would put it, "Not only is it not right, it's not even wrong!" - |
|
|
1114 | there are so many things wrong with AnyEvent::Handle::UDP, most notably |
|
|
1115 | it's use of a stream-based API with a protocol that isn't streamable, that |
|
|
1116 | the only way to improve it is to delete it. |
|
|
1117 | |
|
|
1118 | It features data corruption (but typically only under load) and general |
|
|
1119 | confusion. On top, the author is not only clueless about UDP but also |
|
|
1120 | fact-resistant - some gems of his understanding: "connect doesn't work |
|
|
1121 | with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not |
|
|
1122 | packets", "I don't need to implement proper error checking as UDP doesn't |
|
|
1123 | support error checking" and so on - he doesn't even understand what's |
|
|
1124 | wrong with his module when it is explained to him. |
|
|
1125 | |
1014 | =item L<AnyEvent::HTTP> |
1126 | =item L<AnyEvent::DBI> |
1015 | |
1127 | |
1016 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
1128 | Executes L<DBI> requests asynchronously in a proxy process for you, |
1017 | HTTP requests. |
1129 | notifying you in an event-bnased way when the operation is finished. |
|
|
1130 | |
|
|
1131 | =item L<AnyEvent::AIO> |
|
|
1132 | |
|
|
1133 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
|
|
1134 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
|
|
1135 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
|
|
1136 | file I/O, and much more. |
1018 | |
1137 | |
1019 | =item L<AnyEvent::HTTPD> |
1138 | =item L<AnyEvent::HTTPD> |
1020 | |
1139 | |
1021 | Provides a simple web application server framework. |
1140 | A simple embedded webserver. |
1022 | |
1141 | |
1023 | =item L<AnyEvent::FastPing> |
1142 | =item L<AnyEvent::FastPing> |
1024 | |
1143 | |
1025 | The fastest ping in the west. |
1144 | The fastest ping in the west. |
1026 | |
|
|
1027 | =item L<AnyEvent::DBI> |
|
|
1028 | |
|
|
1029 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
1030 | |
|
|
1031 | =item L<AnyEvent::AIO> |
|
|
1032 | |
|
|
1033 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
1034 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
1035 | together. |
|
|
1036 | |
|
|
1037 | =item L<AnyEvent::BDB> |
|
|
1038 | |
|
|
1039 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
1040 | L<BDB> and AnyEvent together. |
|
|
1041 | |
|
|
1042 | =item L<AnyEvent::GPSD> |
|
|
1043 | |
|
|
1044 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
1045 | |
|
|
1046 | =item L<AnyEvent::IRC> |
|
|
1047 | |
|
|
1048 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
1049 | |
|
|
1050 | =item L<AnyEvent::XMPP> |
|
|
1051 | |
|
|
1052 | AnyEvent based XMPP (Jabber protocol) module family (replacing the older |
|
|
1053 | Net::XMPP2>. |
|
|
1054 | |
|
|
1055 | =item L<AnyEvent::IGS> |
|
|
1056 | |
|
|
1057 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
1058 | L<App::IGS>). |
|
|
1059 | |
|
|
1060 | =item L<Net::FCP> |
|
|
1061 | |
|
|
1062 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
|
|
1063 | of AnyEvent. |
|
|
1064 | |
|
|
1065 | =item L<Event::ExecFlow> |
|
|
1066 | |
|
|
1067 | High level API for event-based execution flow control. |
|
|
1068 | |
1145 | |
1069 | =item L<Coro> |
1146 | =item L<Coro> |
1070 | |
1147 | |
1071 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1148 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1072 | |
1149 | |
… | |
… | |
1076 | |
1153 | |
1077 | package AnyEvent; |
1154 | package AnyEvent; |
1078 | |
1155 | |
1079 | # basically a tuned-down version of common::sense |
1156 | # basically a tuned-down version of common::sense |
1080 | sub common_sense { |
1157 | sub common_sense { |
1081 | # no warnings |
1158 | # from common:.sense 1.0 |
1082 | ${^WARNING_BITS} ^= ${^WARNING_BITS}; |
1159 | ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00"; |
1083 | # use strict vars subs |
1160 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1084 | $^H |= 0x00000600; |
1161 | $^H |= 0x00000600; |
1085 | } |
1162 | } |
1086 | |
1163 | |
1087 | BEGIN { AnyEvent::common_sense } |
1164 | BEGIN { AnyEvent::common_sense } |
1088 | |
1165 | |
1089 | use Carp (); |
1166 | use Carp (); |
1090 | |
1167 | |
1091 | our $VERSION = 4.86; |
1168 | our $VERSION = '5.261'; |
1092 | our $MODEL; |
1169 | our $MODEL; |
1093 | |
1170 | |
1094 | our $AUTOLOAD; |
1171 | our $AUTOLOAD; |
1095 | our @ISA; |
1172 | our @ISA; |
1096 | |
1173 | |
1097 | our @REGISTRY; |
1174 | our @REGISTRY; |
1098 | |
1175 | |
1099 | our $WIN32; |
|
|
1100 | |
|
|
1101 | our $VERBOSE; |
1176 | our $VERBOSE; |
1102 | |
1177 | |
1103 | BEGIN { |
1178 | BEGIN { |
1104 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1179 | require "AnyEvent/constants.pl"; |
|
|
1180 | |
1105 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1181 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1106 | |
1182 | |
1107 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1183 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1108 | if ${^TAINT}; |
1184 | if ${^TAINT}; |
1109 | |
1185 | |
1110 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1186 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
… | |
… | |
1122 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1198 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1123 | } |
1199 | } |
1124 | |
1200 | |
1125 | my @models = ( |
1201 | my @models = ( |
1126 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1202 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1127 | [Event:: => AnyEvent::Impl::Event::, 1], |
|
|
1128 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1203 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1129 | # everything below here will not (normally) be autoprobed |
1204 | # everything below here will not (normally) be autoprobed |
1130 | # as the pureperl backend should work everywhere |
1205 | # as the pureperl backend should work everywhere |
1131 | # and is usually faster |
1206 | # and is usually faster |
|
|
1207 | [Event:: => AnyEvent::Impl::Event::, 1], |
1132 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1208 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1133 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1209 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1134 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1210 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1135 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1211 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1136 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1212 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
… | |
… | |
1139 | [Prima:: => AnyEvent::Impl::POE::], |
1215 | [Prima:: => AnyEvent::Impl::POE::], |
1140 | # IO::Async is just too broken - we would need workarounds for its |
1216 | # IO::Async is just too broken - we would need workarounds for its |
1141 | # byzantine signal and broken child handling, among others. |
1217 | # byzantine signal and broken child handling, among others. |
1142 | # IO::Async is rather hard to detect, as it doesn't have any |
1218 | # IO::Async is rather hard to detect, as it doesn't have any |
1143 | # obvious default class. |
1219 | # obvious default class. |
1144 | # [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1220 | [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1145 | # [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1221 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1146 | # [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1222 | [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1223 | [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1147 | ); |
1224 | ); |
1148 | |
1225 | |
1149 | our %method = map +($_ => 1), |
1226 | our %method = map +($_ => 1), |
1150 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1227 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1151 | |
1228 | |
1152 | our @post_detect; |
1229 | our @post_detect; |
1153 | |
1230 | |
1154 | sub post_detect(&) { |
1231 | sub post_detect(&) { |
1155 | my ($cb) = @_; |
1232 | my ($cb) = @_; |
1156 | |
1233 | |
1157 | if ($MODEL) { |
|
|
1158 | $cb->(); |
|
|
1159 | |
|
|
1160 | undef |
|
|
1161 | } else { |
|
|
1162 | push @post_detect, $cb; |
1234 | push @post_detect, $cb; |
1163 | |
1235 | |
1164 | defined wantarray |
1236 | defined wantarray |
1165 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1237 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1166 | : () |
1238 | : () |
1167 | } |
|
|
1168 | } |
1239 | } |
1169 | |
1240 | |
1170 | sub AnyEvent::Util::postdetect::DESTROY { |
1241 | sub AnyEvent::Util::postdetect::DESTROY { |
1171 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1242 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1172 | } |
1243 | } |
1173 | |
1244 | |
1174 | sub detect() { |
1245 | sub detect() { |
|
|
1246 | # free some memory |
|
|
1247 | *detect = sub () { $MODEL }; |
|
|
1248 | |
|
|
1249 | local $!; # for good measure |
|
|
1250 | local $SIG{__DIE__}; |
|
|
1251 | |
|
|
1252 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
|
|
1253 | my $model = "AnyEvent::Impl::$1"; |
|
|
1254 | if (eval "require $model") { |
|
|
1255 | $MODEL = $model; |
|
|
1256 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
|
|
1257 | } else { |
|
|
1258 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
|
|
1259 | } |
|
|
1260 | } |
|
|
1261 | |
|
|
1262 | # check for already loaded models |
1175 | unless ($MODEL) { |
1263 | unless ($MODEL) { |
1176 | local $SIG{__DIE__}; |
1264 | for (@REGISTRY, @models) { |
1177 | |
1265 | my ($package, $model) = @$_; |
1178 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1266 | if (${"$package\::VERSION"} > 0) { |
1179 | my $model = "AnyEvent::Impl::$1"; |
|
|
1180 | if (eval "require $model") { |
1267 | if (eval "require $model") { |
1181 | $MODEL = $model; |
1268 | $MODEL = $model; |
1182 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
1269 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1183 | } else { |
1270 | last; |
1184 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1271 | } |
1185 | } |
1272 | } |
1186 | } |
1273 | } |
1187 | |
1274 | |
1188 | # check for already loaded models |
|
|
1189 | unless ($MODEL) { |
1275 | unless ($MODEL) { |
|
|
1276 | # try to autoload a model |
1190 | for (@REGISTRY, @models) { |
1277 | for (@REGISTRY, @models) { |
1191 | my ($package, $model) = @$_; |
1278 | my ($package, $model, $autoload) = @$_; |
|
|
1279 | if ( |
|
|
1280 | $autoload |
|
|
1281 | and eval "require $package" |
1192 | if (${"$package\::VERSION"} > 0) { |
1282 | and ${"$package\::VERSION"} > 0 |
1193 | if (eval "require $model") { |
1283 | and eval "require $model" |
|
|
1284 | ) { |
1194 | $MODEL = $model; |
1285 | $MODEL = $model; |
1195 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1286 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1196 | last; |
1287 | last; |
1197 | } |
|
|
1198 | } |
1288 | } |
1199 | } |
1289 | } |
1200 | |
1290 | |
1201 | unless ($MODEL) { |
|
|
1202 | # try to autoload a model |
|
|
1203 | for (@REGISTRY, @models) { |
|
|
1204 | my ($package, $model, $autoload) = @$_; |
|
|
1205 | if ( |
|
|
1206 | $autoload |
|
|
1207 | and eval "require $package" |
|
|
1208 | and ${"$package\::VERSION"} > 0 |
|
|
1209 | and eval "require $model" |
|
|
1210 | ) { |
|
|
1211 | $MODEL = $model; |
|
|
1212 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1213 | last; |
|
|
1214 | } |
|
|
1215 | } |
|
|
1216 | |
|
|
1217 | $MODEL |
1291 | $MODEL |
1218 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
1292 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
1219 | } |
|
|
1220 | } |
1293 | } |
1221 | |
|
|
1222 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1223 | |
|
|
1224 | unshift @ISA, $MODEL; |
|
|
1225 | |
|
|
1226 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
|
|
1227 | |
|
|
1228 | (shift @post_detect)->() while @post_detect; |
|
|
1229 | } |
1294 | } |
|
|
1295 | |
|
|
1296 | @models = (); # free probe data |
|
|
1297 | |
|
|
1298 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1299 | unshift @ISA, $MODEL; |
|
|
1300 | |
|
|
1301 | # now nuke some methods that are overriden by the backend. |
|
|
1302 | # SUPER is not allowed. |
|
|
1303 | for (qw(time signal child idle)) { |
|
|
1304 | undef &{"AnyEvent::Base::$_"} |
|
|
1305 | if defined &{"$MODEL\::$_"}; |
|
|
1306 | } |
|
|
1307 | |
|
|
1308 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
|
|
1309 | |
|
|
1310 | (shift @post_detect)->() while @post_detect; |
|
|
1311 | |
|
|
1312 | *post_detect = sub(&) { |
|
|
1313 | shift->(); |
|
|
1314 | |
|
|
1315 | undef |
|
|
1316 | }; |
1230 | |
1317 | |
1231 | $MODEL |
1318 | $MODEL |
1232 | } |
1319 | } |
1233 | |
1320 | |
1234 | sub AUTOLOAD { |
1321 | sub AUTOLOAD { |
1235 | (my $func = $AUTOLOAD) =~ s/.*://; |
1322 | (my $func = $AUTOLOAD) =~ s/.*://; |
1236 | |
1323 | |
1237 | $method{$func} |
1324 | $method{$func} |
1238 | or Carp::croak "$func: not a valid method for AnyEvent objects"; |
1325 | or Carp::croak "$func: not a valid AnyEvent class method"; |
1239 | |
1326 | |
1240 | detect unless $MODEL; |
1327 | detect; |
1241 | |
1328 | |
1242 | my $class = shift; |
1329 | my $class = shift; |
1243 | $class->$func (@_); |
1330 | $class->$func (@_); |
1244 | } |
1331 | } |
1245 | |
1332 | |
… | |
… | |
1258 | # we assume CLOEXEC is already set by perl in all important cases |
1345 | # we assume CLOEXEC is already set by perl in all important cases |
1259 | |
1346 | |
1260 | ($fh2, $rw) |
1347 | ($fh2, $rw) |
1261 | } |
1348 | } |
1262 | |
1349 | |
|
|
1350 | =head1 SIMPLIFIED AE API |
|
|
1351 | |
|
|
1352 | Starting with version 5.0, AnyEvent officially supports a second, much |
|
|
1353 | simpler, API that is designed to reduce the calling, typing and memory |
|
|
1354 | overhead by using function call syntax and a fixed number of parameters. |
|
|
1355 | |
|
|
1356 | See the L<AE> manpage for details. |
|
|
1357 | |
|
|
1358 | =cut |
|
|
1359 | |
|
|
1360 | package AE; |
|
|
1361 | |
|
|
1362 | our $VERSION = $AnyEvent::VERSION; |
|
|
1363 | |
|
|
1364 | # fall back to the main API by default - backends and AnyEvent::Base |
|
|
1365 | # implementations can overwrite these. |
|
|
1366 | |
|
|
1367 | sub io($$$) { |
|
|
1368 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
|
|
1369 | } |
|
|
1370 | |
|
|
1371 | sub timer($$$) { |
|
|
1372 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
|
|
1373 | } |
|
|
1374 | |
|
|
1375 | sub signal($$) { |
|
|
1376 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
|
|
1377 | } |
|
|
1378 | |
|
|
1379 | sub child($$) { |
|
|
1380 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
|
|
1381 | } |
|
|
1382 | |
|
|
1383 | sub idle($) { |
|
|
1384 | AnyEvent->idle (cb => $_[0]) |
|
|
1385 | } |
|
|
1386 | |
|
|
1387 | sub cv(;&) { |
|
|
1388 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
|
|
1389 | } |
|
|
1390 | |
|
|
1391 | sub now() { |
|
|
1392 | AnyEvent->now |
|
|
1393 | } |
|
|
1394 | |
|
|
1395 | sub now_update() { |
|
|
1396 | AnyEvent->now_update |
|
|
1397 | } |
|
|
1398 | |
|
|
1399 | sub time() { |
|
|
1400 | AnyEvent->time |
|
|
1401 | } |
|
|
1402 | |
1263 | package AnyEvent::Base; |
1403 | package AnyEvent::Base; |
1264 | |
1404 | |
1265 | # default implementations for many methods |
1405 | # default implementations for many methods |
1266 | |
1406 | |
1267 | sub _time { |
1407 | sub time { |
|
|
1408 | eval q{ # poor man's autoloading {} |
1268 | # probe for availability of Time::HiRes |
1409 | # probe for availability of Time::HiRes |
1269 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1410 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1270 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1411 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1271 | *_time = \&Time::HiRes::time; |
1412 | *AE::time = \&Time::HiRes::time; |
1272 | # if (eval "use POSIX (); (POSIX::times())... |
1413 | # if (eval "use POSIX (); (POSIX::times())... |
1273 | } else { |
1414 | } else { |
1274 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1415 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1275 | *_time = sub { time }; # epic fail |
1416 | *AE::time = sub (){ time }; # epic fail |
|
|
1417 | } |
|
|
1418 | |
|
|
1419 | *time = sub { AE::time }; # different prototypes |
1276 | } |
1420 | }; |
|
|
1421 | die if $@; |
1277 | |
1422 | |
1278 | &_time |
1423 | &time |
1279 | } |
1424 | } |
1280 | |
1425 | |
1281 | sub time { _time } |
1426 | *now = \&time; |
1282 | sub now { _time } |
1427 | |
1283 | sub now_update { } |
1428 | sub now_update { } |
1284 | |
1429 | |
1285 | # default implementation for ->condvar |
1430 | # default implementation for ->condvar |
1286 | |
1431 | |
1287 | sub condvar { |
1432 | sub condvar { |
|
|
1433 | eval q{ # poor man's autoloading {} |
|
|
1434 | *condvar = sub { |
1288 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1435 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
|
|
1436 | }; |
|
|
1437 | |
|
|
1438 | *AE::cv = sub (;&) { |
|
|
1439 | bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar" |
|
|
1440 | }; |
|
|
1441 | }; |
|
|
1442 | die if $@; |
|
|
1443 | |
|
|
1444 | &condvar |
1289 | } |
1445 | } |
1290 | |
1446 | |
1291 | # default implementation for ->signal |
1447 | # default implementation for ->signal |
1292 | |
1448 | |
1293 | our $HAVE_ASYNC_INTERRUPT; |
1449 | our $HAVE_ASYNC_INTERRUPT; |
|
|
1450 | |
|
|
1451 | sub _have_async_interrupt() { |
|
|
1452 | $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} |
|
|
1453 | && eval "use Async::Interrupt 1.02 (); 1") |
|
|
1454 | unless defined $HAVE_ASYNC_INTERRUPT; |
|
|
1455 | |
|
|
1456 | $HAVE_ASYNC_INTERRUPT |
|
|
1457 | } |
|
|
1458 | |
1294 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1459 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1295 | our (%SIG_ASY, %SIG_ASY_W); |
1460 | our (%SIG_ASY, %SIG_ASY_W); |
1296 | our ($SIG_COUNT, $SIG_TW); |
1461 | our ($SIG_COUNT, $SIG_TW); |
1297 | |
1462 | |
1298 | sub _signal_exec { |
|
|
1299 | $HAVE_ASYNC_INTERRUPT |
|
|
1300 | ? $SIGPIPE_R->drain |
|
|
1301 | : sysread $SIGPIPE_R, my $dummy, 9; |
|
|
1302 | |
|
|
1303 | while (%SIG_EV) { |
|
|
1304 | for (keys %SIG_EV) { |
|
|
1305 | delete $SIG_EV{$_}; |
|
|
1306 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1307 | } |
|
|
1308 | } |
|
|
1309 | } |
|
|
1310 | |
|
|
1311 | # install a dumym wakeupw atcher to reduce signal catching latency |
1463 | # install a dummy wakeup watcher to reduce signal catching latency |
|
|
1464 | # used by Impls |
1312 | sub _sig_add() { |
1465 | sub _sig_add() { |
1313 | unless ($SIG_COUNT++) { |
1466 | unless ($SIG_COUNT++) { |
1314 | # try to align timer on a full-second boundary, if possible |
1467 | # try to align timer on a full-second boundary, if possible |
1315 | my $NOW = AnyEvent->now; |
1468 | my $NOW = AE::now; |
1316 | |
1469 | |
1317 | $SIG_TW = AnyEvent->timer ( |
1470 | $SIG_TW = AE::timer |
1318 | after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
1471 | $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), |
1319 | interval => $MAX_SIGNAL_LATENCY, |
1472 | $MAX_SIGNAL_LATENCY, |
1320 | cb => sub { }, # just for the PERL_ASYNC_CHECK |
1473 | sub { } # just for the PERL_ASYNC_CHECK |
1321 | ); |
1474 | ; |
1322 | } |
1475 | } |
1323 | } |
1476 | } |
1324 | |
1477 | |
1325 | sub _sig_del { |
1478 | sub _sig_del { |
1326 | undef $SIG_TW |
1479 | undef $SIG_TW |
1327 | unless --$SIG_COUNT; |
1480 | unless --$SIG_COUNT; |
1328 | } |
1481 | } |
1329 | |
1482 | |
|
|
1483 | our $_sig_name_init; $_sig_name_init = sub { |
|
|
1484 | eval q{ # poor man's autoloading {} |
|
|
1485 | undef $_sig_name_init; |
|
|
1486 | |
|
|
1487 | if (_have_async_interrupt) { |
|
|
1488 | *sig2num = \&Async::Interrupt::sig2num; |
|
|
1489 | *sig2name = \&Async::Interrupt::sig2name; |
|
|
1490 | } else { |
|
|
1491 | require Config; |
|
|
1492 | |
|
|
1493 | my %signame2num; |
|
|
1494 | @signame2num{ split ' ', $Config::Config{sig_name} } |
|
|
1495 | = split ' ', $Config::Config{sig_num}; |
|
|
1496 | |
|
|
1497 | my @signum2name; |
|
|
1498 | @signum2name[values %signame2num] = keys %signame2num; |
|
|
1499 | |
|
|
1500 | *sig2num = sub($) { |
|
|
1501 | $_[0] > 0 ? shift : $signame2num{+shift} |
|
|
1502 | }; |
|
|
1503 | *sig2name = sub ($) { |
|
|
1504 | $_[0] > 0 ? $signum2name[+shift] : shift |
|
|
1505 | }; |
|
|
1506 | } |
|
|
1507 | }; |
|
|
1508 | die if $@; |
|
|
1509 | }; |
|
|
1510 | |
|
|
1511 | sub sig2num ($) { &$_sig_name_init; &sig2num } |
|
|
1512 | sub sig2name($) { &$_sig_name_init; &sig2name } |
|
|
1513 | |
1330 | sub _signal { |
1514 | sub signal { |
1331 | my (undef, %arg) = @_; |
1515 | eval q{ # poor man's autoloading {} |
|
|
1516 | # probe for availability of Async::Interrupt |
|
|
1517 | if (_have_async_interrupt) { |
|
|
1518 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1332 | |
1519 | |
1333 | my $signal = uc $arg{signal} |
1520 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1334 | or Carp::croak "required option 'signal' is missing"; |
1521 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1335 | |
1522 | |
1336 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1523 | } else { |
|
|
1524 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1337 | |
1525 | |
1338 | if ($HAVE_ASYNC_INTERRUPT) { |
1526 | if (AnyEvent::WIN32) { |
1339 | # async::interrupt |
1527 | require AnyEvent::Util; |
1340 | |
1528 | |
1341 | $SIG_ASY{$signal} ||= do { |
1529 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1342 | my $asy = new Async::Interrupt |
1530 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; |
1343 | cb => sub { undef $SIG_EV{$signal} }, |
1531 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case |
1344 | signal => $signal, |
1532 | } else { |
1345 | pipe => [$SIGPIPE_R->filenos], |
1533 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1534 | fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R; |
|
|
1535 | fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1536 | |
|
|
1537 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1538 | fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC; |
|
|
1539 | fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC; |
1346 | ; |
1540 | } |
1347 | $asy->pipe_autodrain (0); |
|
|
1348 | |
1541 | |
1349 | $asy |
1542 | $SIGPIPE_R |
|
|
1543 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1544 | |
|
|
1545 | $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec; |
|
|
1546 | } |
|
|
1547 | |
|
|
1548 | *signal = $HAVE_ASYNC_INTERRUPT |
|
|
1549 | ? sub { |
|
|
1550 | my (undef, %arg) = @_; |
|
|
1551 | |
|
|
1552 | # async::interrupt |
|
|
1553 | my $signal = sig2num $arg{signal}; |
|
|
1554 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1555 | |
|
|
1556 | $SIG_ASY{$signal} ||= new Async::Interrupt |
|
|
1557 | cb => sub { undef $SIG_EV{$signal} }, |
|
|
1558 | signal => $signal, |
|
|
1559 | pipe => [$SIGPIPE_R->filenos], |
|
|
1560 | pipe_autodrain => 0, |
|
|
1561 | ; |
|
|
1562 | |
|
|
1563 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1564 | } |
|
|
1565 | : sub { |
|
|
1566 | my (undef, %arg) = @_; |
|
|
1567 | |
|
|
1568 | # pure perl |
|
|
1569 | my $signal = sig2name $arg{signal}; |
|
|
1570 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
|
|
1571 | |
|
|
1572 | $SIG{$signal} ||= sub { |
|
|
1573 | local $!; |
|
|
1574 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1575 | undef $SIG_EV{$signal}; |
|
|
1576 | }; |
|
|
1577 | |
|
|
1578 | # can't do signal processing without introducing races in pure perl, |
|
|
1579 | # so limit the signal latency. |
|
|
1580 | _sig_add; |
|
|
1581 | |
|
|
1582 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1583 | } |
|
|
1584 | ; |
|
|
1585 | |
|
|
1586 | *AnyEvent::Base::signal::DESTROY = sub { |
|
|
1587 | my ($signal, $cb) = @{$_[0]}; |
|
|
1588 | |
|
|
1589 | _sig_del; |
|
|
1590 | |
|
|
1591 | delete $SIG_CB{$signal}{$cb}; |
|
|
1592 | |
|
|
1593 | $HAVE_ASYNC_INTERRUPT |
|
|
1594 | ? delete $SIG_ASY{$signal} |
|
|
1595 | : # delete doesn't work with older perls - they then |
|
|
1596 | # print weird messages, or just unconditionally exit |
|
|
1597 | # instead of getting the default action. |
|
|
1598 | undef $SIG{$signal} |
|
|
1599 | unless keys %{ $SIG_CB{$signal} }; |
1350 | }; |
1600 | }; |
1351 | |
1601 | |
1352 | } else { |
1602 | *_signal_exec = sub { |
1353 | # pure perl |
1603 | $HAVE_ASYNC_INTERRUPT |
|
|
1604 | ? $SIGPIPE_R->drain |
|
|
1605 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1354 | |
1606 | |
1355 | $SIG{$signal} ||= sub { |
1607 | while (%SIG_EV) { |
1356 | local $!; |
1608 | for (keys %SIG_EV) { |
1357 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1609 | delete $SIG_EV{$_}; |
1358 | undef $SIG_EV{$signal}; |
1610 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1611 | } |
|
|
1612 | } |
1359 | }; |
1613 | }; |
1360 | |
|
|
1361 | # can't do signal processing without introducing races in pure perl, |
|
|
1362 | # so limit the signal latency. |
|
|
1363 | _sig_add; |
|
|
1364 | } |
1614 | }; |
|
|
1615 | die if $@; |
1365 | |
1616 | |
1366 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1367 | } |
|
|
1368 | |
|
|
1369 | sub signal { |
|
|
1370 | # probe for availability of Async::Interrupt |
|
|
1371 | if (!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} && eval "use Async::Interrupt 0.6 (); 1") { |
|
|
1372 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
|
|
1373 | |
|
|
1374 | $HAVE_ASYNC_INTERRUPT = 1; |
|
|
1375 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
|
|
1376 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); |
|
|
1377 | |
|
|
1378 | } else { |
|
|
1379 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
|
|
1380 | |
|
|
1381 | require Fcntl; |
|
|
1382 | |
|
|
1383 | if (AnyEvent::WIN32) { |
|
|
1384 | require AnyEvent::Util; |
|
|
1385 | |
|
|
1386 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1387 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1388 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1389 | } else { |
|
|
1390 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1391 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1392 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1393 | |
|
|
1394 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1395 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1396 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1397 | } |
|
|
1398 | |
|
|
1399 | $SIGPIPE_R |
|
|
1400 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1401 | |
|
|
1402 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1403 | } |
|
|
1404 | |
|
|
1405 | *signal = \&_signal; |
|
|
1406 | &signal |
1617 | &signal |
1407 | } |
|
|
1408 | |
|
|
1409 | sub AnyEvent::Base::signal::DESTROY { |
|
|
1410 | my ($signal, $cb) = @{$_[0]}; |
|
|
1411 | |
|
|
1412 | _sig_del; |
|
|
1413 | |
|
|
1414 | delete $SIG_CB{$signal}{$cb}; |
|
|
1415 | |
|
|
1416 | $HAVE_ASYNC_INTERRUPT |
|
|
1417 | ? delete $SIG_ASY{$signal} |
|
|
1418 | : # delete doesn't work with older perls - they then |
|
|
1419 | # print weird messages, or just unconditionally exit |
|
|
1420 | # instead of getting the default action. |
|
|
1421 | undef $SIG{$signal} |
|
|
1422 | unless keys %{ $SIG_CB{$signal} }; |
|
|
1423 | } |
1618 | } |
1424 | |
1619 | |
1425 | # default implementation for ->child |
1620 | # default implementation for ->child |
1426 | |
1621 | |
1427 | our %PID_CB; |
1622 | our %PID_CB; |
1428 | our $CHLD_W; |
1623 | our $CHLD_W; |
1429 | our $CHLD_DELAY_W; |
1624 | our $CHLD_DELAY_W; |
1430 | our $WNOHANG; |
1625 | our $WNOHANG; |
1431 | |
1626 | |
|
|
1627 | # used by many Impl's |
1432 | sub _emit_childstatus($$) { |
1628 | sub _emit_childstatus($$) { |
1433 | my (undef, $rpid, $rstatus) = @_; |
1629 | my (undef, $rpid, $rstatus) = @_; |
1434 | |
1630 | |
1435 | $_->($rpid, $rstatus) |
1631 | $_->($rpid, $rstatus) |
1436 | for values %{ $PID_CB{$rpid} || {} }, |
1632 | for values %{ $PID_CB{$rpid} || {} }, |
1437 | values %{ $PID_CB{0} || {} }; |
1633 | values %{ $PID_CB{0} || {} }; |
1438 | } |
1634 | } |
1439 | |
1635 | |
1440 | sub _sigchld { |
|
|
1441 | my $pid; |
|
|
1442 | |
|
|
1443 | AnyEvent->_emit_childstatus ($pid, $?) |
|
|
1444 | while ($pid = waitpid -1, $WNOHANG) > 0; |
|
|
1445 | } |
|
|
1446 | |
|
|
1447 | sub child { |
1636 | sub child { |
|
|
1637 | eval q{ # poor man's autoloading {} |
|
|
1638 | *_sigchld = sub { |
|
|
1639 | my $pid; |
|
|
1640 | |
|
|
1641 | AnyEvent->_emit_childstatus ($pid, $?) |
|
|
1642 | while ($pid = waitpid -1, $WNOHANG) > 0; |
|
|
1643 | }; |
|
|
1644 | |
|
|
1645 | *child = sub { |
1448 | my (undef, %arg) = @_; |
1646 | my (undef, %arg) = @_; |
1449 | |
1647 | |
1450 | defined (my $pid = $arg{pid} + 0) |
1648 | defined (my $pid = $arg{pid} + 0) |
1451 | or Carp::croak "required option 'pid' is missing"; |
1649 | or Carp::croak "required option 'pid' is missing"; |
1452 | |
1650 | |
1453 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1651 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1454 | |
1652 | |
1455 | # WNOHANG is almost cetrainly 1 everywhere |
1653 | # WNOHANG is almost cetrainly 1 everywhere |
1456 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1654 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1457 | ? 1 |
1655 | ? 1 |
1458 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1656 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1459 | |
1657 | |
1460 | unless ($CHLD_W) { |
1658 | unless ($CHLD_W) { |
1461 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1659 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1462 | # child could be a zombie already, so make at least one round |
1660 | # child could be a zombie already, so make at least one round |
1463 | &_sigchld; |
1661 | &_sigchld; |
1464 | } |
1662 | } |
1465 | |
1663 | |
1466 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1664 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1467 | } |
1665 | }; |
1468 | |
1666 | |
1469 | sub AnyEvent::Base::child::DESTROY { |
1667 | *AnyEvent::Base::child::DESTROY = sub { |
1470 | my ($pid, $cb) = @{$_[0]}; |
1668 | my ($pid, $cb) = @{$_[0]}; |
1471 | |
1669 | |
1472 | delete $PID_CB{$pid}{$cb}; |
1670 | delete $PID_CB{$pid}{$cb}; |
1473 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1671 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1474 | |
1672 | |
1475 | undef $CHLD_W unless keys %PID_CB; |
1673 | undef $CHLD_W unless keys %PID_CB; |
|
|
1674 | }; |
|
|
1675 | }; |
|
|
1676 | die if $@; |
|
|
1677 | |
|
|
1678 | &child |
1476 | } |
1679 | } |
1477 | |
1680 | |
1478 | # idle emulation is done by simply using a timer, regardless |
1681 | # idle emulation is done by simply using a timer, regardless |
1479 | # of whether the process is idle or not, and not letting |
1682 | # of whether the process is idle or not, and not letting |
1480 | # the callback use more than 50% of the time. |
1683 | # the callback use more than 50% of the time. |
1481 | sub idle { |
1684 | sub idle { |
|
|
1685 | eval q{ # poor man's autoloading {} |
|
|
1686 | *idle = sub { |
1482 | my (undef, %arg) = @_; |
1687 | my (undef, %arg) = @_; |
1483 | |
1688 | |
1484 | my ($cb, $w, $rcb) = $arg{cb}; |
1689 | my ($cb, $w, $rcb) = $arg{cb}; |
1485 | |
1690 | |
1486 | $rcb = sub { |
1691 | $rcb = sub { |
1487 | if ($cb) { |
1692 | if ($cb) { |
1488 | $w = _time; |
1693 | $w = _time; |
1489 | &$cb; |
1694 | &$cb; |
1490 | $w = _time - $w; |
1695 | $w = _time - $w; |
1491 | |
1696 | |
1492 | # never use more then 50% of the time for the idle watcher, |
1697 | # never use more then 50% of the time for the idle watcher, |
1493 | # within some limits |
1698 | # within some limits |
1494 | $w = 0.0001 if $w < 0.0001; |
1699 | $w = 0.0001 if $w < 0.0001; |
1495 | $w = 5 if $w > 5; |
1700 | $w = 5 if $w > 5; |
1496 | |
1701 | |
1497 | $w = AnyEvent->timer (after => $w, cb => $rcb); |
1702 | $w = AE::timer $w, 0, $rcb; |
1498 | } else { |
1703 | } else { |
1499 | # clean up... |
1704 | # clean up... |
1500 | undef $w; |
1705 | undef $w; |
1501 | undef $rcb; |
1706 | undef $rcb; |
|
|
1707 | } |
|
|
1708 | }; |
|
|
1709 | |
|
|
1710 | $w = AE::timer 0.05, 0, $rcb; |
|
|
1711 | |
|
|
1712 | bless \\$cb, "AnyEvent::Base::idle" |
1502 | } |
1713 | }; |
|
|
1714 | |
|
|
1715 | *AnyEvent::Base::idle::DESTROY = sub { |
|
|
1716 | undef $${$_[0]}; |
|
|
1717 | }; |
1503 | }; |
1718 | }; |
|
|
1719 | die if $@; |
1504 | |
1720 | |
1505 | $w = AnyEvent->timer (after => 0.05, cb => $rcb); |
1721 | &idle |
1506 | |
|
|
1507 | bless \\$cb, "AnyEvent::Base::idle" |
|
|
1508 | } |
|
|
1509 | |
|
|
1510 | sub AnyEvent::Base::idle::DESTROY { |
|
|
1511 | undef $${$_[0]}; |
|
|
1512 | } |
1722 | } |
1513 | |
1723 | |
1514 | package AnyEvent::CondVar; |
1724 | package AnyEvent::CondVar; |
1515 | |
1725 | |
1516 | our @ISA = AnyEvent::CondVar::Base::; |
1726 | our @ISA = AnyEvent::CondVar::Base::; |
… | |
… | |
1564 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1774 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1565 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1775 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1566 | } |
1776 | } |
1567 | |
1777 | |
1568 | sub cb { |
1778 | sub cb { |
1569 | $_[0]{_ae_cb} = $_[1] if @_ > 1; |
1779 | my $cv = shift; |
|
|
1780 | |
|
|
1781 | @_ |
|
|
1782 | and $cv->{_ae_cb} = shift |
|
|
1783 | and $cv->{_ae_sent} |
|
|
1784 | and (delete $cv->{_ae_cb})->($cv); |
|
|
1785 | |
1570 | $_[0]{_ae_cb} |
1786 | $cv->{_ae_cb} |
1571 | } |
1787 | } |
1572 | |
1788 | |
1573 | sub begin { |
1789 | sub begin { |
1574 | ++$_[0]{_ae_counter}; |
1790 | ++$_[0]{_ae_counter}; |
1575 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
1791 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
… | |
… | |
1784 | warn "read: $input\n"; # output what has been read |
2000 | warn "read: $input\n"; # output what has been read |
1785 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
2001 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
1786 | }, |
2002 | }, |
1787 | ); |
2003 | ); |
1788 | |
2004 | |
1789 | my $time_watcher; # can only be used once |
|
|
1790 | |
|
|
1791 | sub new_timer { |
|
|
1792 | $timer = AnyEvent->timer (after => 1, cb => sub { |
2005 | my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub { |
1793 | warn "timeout\n"; # print 'timeout' about every second |
2006 | warn "timeout\n"; # print 'timeout' at most every second |
1794 | &new_timer; # and restart the time |
|
|
1795 | }); |
2007 | }); |
1796 | } |
|
|
1797 | |
|
|
1798 | new_timer; # create first timer |
|
|
1799 | |
2008 | |
1800 | $cv->recv; # wait until user enters /^q/i |
2009 | $cv->recv; # wait until user enters /^q/i |
1801 | |
2010 | |
1802 | =head1 REAL-WORLD EXAMPLE |
2011 | =head1 REAL-WORLD EXAMPLE |
1803 | |
2012 | |
… | |
… | |
1876 | |
2085 | |
1877 | The actual code goes further and collects all errors (C<die>s, exceptions) |
2086 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1878 | that occurred during request processing. The C<result> method detects |
2087 | that occurred during request processing. The C<result> method detects |
1879 | whether an exception as thrown (it is stored inside the $txn object) |
2088 | whether an exception as thrown (it is stored inside the $txn object) |
1880 | and just throws the exception, which means connection errors and other |
2089 | and just throws the exception, which means connection errors and other |
1881 | problems get reported tot he code that tries to use the result, not in a |
2090 | problems get reported to the code that tries to use the result, not in a |
1882 | random callback. |
2091 | random callback. |
1883 | |
2092 | |
1884 | All of this enables the following usage styles: |
2093 | All of this enables the following usage styles: |
1885 | |
2094 | |
1886 | 1. Blocking: |
2095 | 1. Blocking: |
… | |
… | |
1934 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
2143 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1935 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
2144 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1936 | which it is), lets them fire exactly once and destroys them again. |
2145 | which it is), lets them fire exactly once and destroys them again. |
1937 | |
2146 | |
1938 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
2147 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1939 | distribution. |
2148 | distribution. It uses the L<AE> interface, which makes a real difference |
|
|
2149 | for the EV and Perl backends only. |
1940 | |
2150 | |
1941 | =head3 Explanation of the columns |
2151 | =head3 Explanation of the columns |
1942 | |
2152 | |
1943 | I<watcher> is the number of event watchers created/destroyed. Since |
2153 | I<watcher> is the number of event watchers created/destroyed. Since |
1944 | different event models feature vastly different performances, each event |
2154 | different event models feature vastly different performances, each event |
… | |
… | |
1965 | watcher. |
2175 | watcher. |
1966 | |
2176 | |
1967 | =head3 Results |
2177 | =head3 Results |
1968 | |
2178 | |
1969 | name watchers bytes create invoke destroy comment |
2179 | name watchers bytes create invoke destroy comment |
1970 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
2180 | EV/EV 100000 223 0.47 0.43 0.27 EV native interface |
1971 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
2181 | EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers |
1972 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
2182 | Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal |
1973 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
2183 | Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation |
1974 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
2184 | Event/Event 16000 516 31.16 31.84 0.82 Event native interface |
1975 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
2185 | Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers |
1976 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
2186 | IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll |
1977 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
2187 | IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll |
1978 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
2188 | Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour |
1979 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
2189 | Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers |
1980 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
2190 | POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event |
1981 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
2191 | POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select |
1982 | |
2192 | |
1983 | =head3 Discussion |
2193 | =head3 Discussion |
1984 | |
2194 | |
1985 | The benchmark does I<not> measure scalability of the event loop very |
2195 | The benchmark does I<not> measure scalability of the event loop very |
1986 | well. For example, a select-based event loop (such as the pure perl one) |
2196 | well. For example, a select-based event loop (such as the pure perl one) |
… | |
… | |
1998 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
2208 | benchmark machine, handling an event takes roughly 1600 CPU cycles with |
1999 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
2209 | EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU |
2000 | cycles with POE. |
2210 | cycles with POE. |
2001 | |
2211 | |
2002 | C<EV> is the sole leader regarding speed and memory use, which are both |
2212 | C<EV> is the sole leader regarding speed and memory use, which are both |
2003 | maximal/minimal, respectively. Even when going through AnyEvent, it uses |
2213 | maximal/minimal, respectively. When using the L<AE> API there is zero |
|
|
2214 | overhead (when going through the AnyEvent API create is about 5-6 times |
|
|
2215 | slower, with other times being equal, so still uses far less memory than |
2004 | far less memory than any other event loop and is still faster than Event |
2216 | any other event loop and is still faster than Event natively). |
2005 | natively. |
|
|
2006 | |
2217 | |
2007 | The pure perl implementation is hit in a few sweet spots (both the |
2218 | The pure perl implementation is hit in a few sweet spots (both the |
2008 | constant timeout and the use of a single fd hit optimisations in the perl |
2219 | constant timeout and the use of a single fd hit optimisations in the perl |
2009 | interpreter and the backend itself). Nevertheless this shows that it |
2220 | interpreter and the backend itself). Nevertheless this shows that it |
2010 | adds very little overhead in itself. Like any select-based backend its |
2221 | adds very little overhead in itself. Like any select-based backend its |
… | |
… | |
2084 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
2295 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
2085 | (1%) are active. This mirrors the activity of large servers with many |
2296 | (1%) are active. This mirrors the activity of large servers with many |
2086 | connections, most of which are idle at any one point in time. |
2297 | connections, most of which are idle at any one point in time. |
2087 | |
2298 | |
2088 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
2299 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
2089 | distribution. |
2300 | distribution. It uses the L<AE> interface, which makes a real difference |
|
|
2301 | for the EV and Perl backends only. |
2090 | |
2302 | |
2091 | =head3 Explanation of the columns |
2303 | =head3 Explanation of the columns |
2092 | |
2304 | |
2093 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
2305 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
2094 | each server has a read and write socket end). |
2306 | each server has a read and write socket end). |
… | |
… | |
2102 | a new one that moves the timeout into the future. |
2314 | a new one that moves the timeout into the future. |
2103 | |
2315 | |
2104 | =head3 Results |
2316 | =head3 Results |
2105 | |
2317 | |
2106 | name sockets create request |
2318 | name sockets create request |
2107 | EV 20000 69.01 11.16 |
2319 | EV 20000 62.66 7.99 |
2108 | Perl 20000 73.32 35.87 |
2320 | Perl 20000 68.32 32.64 |
2109 | IOAsync 20000 157.00 98.14 epoll |
2321 | IOAsync 20000 174.06 101.15 epoll |
2110 | IOAsync 20000 159.31 616.06 poll |
2322 | IOAsync 20000 174.67 610.84 poll |
2111 | Event 20000 212.62 257.32 |
2323 | Event 20000 202.69 242.91 |
2112 | Glib 20000 651.16 1896.30 |
2324 | Glib 20000 557.01 1689.52 |
2113 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
2325 | POE 20000 341.54 12086.32 uses POE::Loop::Event |
2114 | |
2326 | |
2115 | =head3 Discussion |
2327 | =head3 Discussion |
2116 | |
2328 | |
2117 | This benchmark I<does> measure scalability and overall performance of the |
2329 | This benchmark I<does> measure scalability and overall performance of the |
2118 | particular event loop. |
2330 | particular event loop. |
… | |
… | |
2244 | As you can see, the AnyEvent + EV combination even beats the |
2456 | As you can see, the AnyEvent + EV combination even beats the |
2245 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
2457 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
2246 | backend easily beats IO::Lambda and POE. |
2458 | backend easily beats IO::Lambda and POE. |
2247 | |
2459 | |
2248 | And even the 100% non-blocking version written using the high-level (and |
2460 | And even the 100% non-blocking version written using the high-level (and |
2249 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
2461 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda |
2250 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
2462 | higher level ("unoptimised") abstractions by a large margin, even though |
2251 | in a non-blocking way. |
2463 | it does all of DNS, tcp-connect and socket I/O in a non-blocking way. |
2252 | |
2464 | |
2253 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
2465 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
2254 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
2466 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
2255 | part of the IO::lambda distribution and were used without any changes. |
2467 | part of the IO::Lambda distribution and were used without any changes. |
2256 | |
2468 | |
2257 | |
2469 | |
2258 | =head1 SIGNALS |
2470 | =head1 SIGNALS |
2259 | |
2471 | |
2260 | AnyEvent currently installs handlers for these signals: |
2472 | AnyEvent currently installs handlers for these signals: |
… | |
… | |
2302 | it's built-in modules) are required to use it. |
2514 | it's built-in modules) are required to use it. |
2303 | |
2515 | |
2304 | That does not mean that AnyEvent won't take advantage of some additional |
2516 | That does not mean that AnyEvent won't take advantage of some additional |
2305 | modules if they are installed. |
2517 | modules if they are installed. |
2306 | |
2518 | |
2307 | This section epxlains which additional modules will be used, and how they |
2519 | This section explains which additional modules will be used, and how they |
2308 | affect AnyEvent's operetion. |
2520 | affect AnyEvent's operation. |
2309 | |
2521 | |
2310 | =over 4 |
2522 | =over 4 |
2311 | |
2523 | |
2312 | =item L<Async::Interrupt> |
2524 | =item L<Async::Interrupt> |
2313 | |
2525 | |
… | |
… | |
2318 | catch the signals) with some delay (default is 10 seconds, look for |
2530 | catch the signals) with some delay (default is 10 seconds, look for |
2319 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
2531 | C<$AnyEvent::MAX_SIGNAL_LATENCY>). |
2320 | |
2532 | |
2321 | If this module is available, then it will be used to implement signal |
2533 | If this module is available, then it will be used to implement signal |
2322 | catching, which means that signals will not be delayed, and the event loop |
2534 | catching, which means that signals will not be delayed, and the event loop |
2323 | will not be interrupted regularly, which is more efficient (And good for |
2535 | will not be interrupted regularly, which is more efficient (and good for |
2324 | battery life on laptops). |
2536 | battery life on laptops). |
2325 | |
2537 | |
2326 | This affects not just the pure-perl event loop, but also other event loops |
2538 | This affects not just the pure-perl event loop, but also other event loops |
2327 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
2539 | that have no signal handling on their own (e.g. Glib, Tk, Qt). |
2328 | |
2540 | |
… | |
… | |
2340 | automatic timer adjustments even when no monotonic clock is available, |
2552 | automatic timer adjustments even when no monotonic clock is available, |
2341 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
2553 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
2342 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
2554 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
2343 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
2555 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
2344 | |
2556 | |
|
|
2557 | If you only use backends that rely on another event loop (e.g. C<Tk>), |
|
|
2558 | then this module will do nothing for you. |
|
|
2559 | |
2345 | =item L<Guard> |
2560 | =item L<Guard> |
2346 | |
2561 | |
2347 | The guard module, when used, will be used to implement |
2562 | The guard module, when used, will be used to implement |
2348 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
2563 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
2349 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2564 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2350 | purely used for performance. |
2565 | purely used for performance. |
2351 | |
2566 | |
2352 | =item L<JSON> and L<JSON::XS> |
2567 | =item L<JSON> and L<JSON::XS> |
2353 | |
2568 | |
2354 | This module is required when you want to read or write JSON data via |
2569 | One of these modules is required when you want to read or write JSON data |
2355 | L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
2570 | via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take |
2356 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
2571 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
2357 | |
|
|
2358 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
|
|
2359 | installed. |
|
|
2360 | |
2572 | |
2361 | =item L<Net::SSLeay> |
2573 | =item L<Net::SSLeay> |
2362 | |
2574 | |
2363 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
2575 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
2364 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
2576 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
… | |
… | |
2375 | |
2587 | |
2376 | |
2588 | |
2377 | =head1 FORK |
2589 | =head1 FORK |
2378 | |
2590 | |
2379 | Most event libraries are not fork-safe. The ones who are usually are |
2591 | Most event libraries are not fork-safe. The ones who are usually are |
2380 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2592 | because they rely on inefficient but fork-safe C<select> or C<poll> calls |
2381 | calls. Only L<EV> is fully fork-aware. |
2593 | - higher performance APIs such as BSD's kqueue or the dreaded Linux epoll |
|
|
2594 | are usually badly thought-out hacks that are incompatible with fork in |
|
|
2595 | one way or another. Only L<EV> is fully fork-aware and ensures that you |
|
|
2596 | continue event-processing in both parent and child (or both, if you know |
|
|
2597 | what you are doing). |
|
|
2598 | |
|
|
2599 | This means that, in general, you cannot fork and do event processing in |
|
|
2600 | the child if the event library was initialised before the fork (which |
|
|
2601 | usually happens when the first AnyEvent watcher is created, or the library |
|
|
2602 | is loaded). |
2382 | |
2603 | |
2383 | If you have to fork, you must either do so I<before> creating your first |
2604 | If you have to fork, you must either do so I<before> creating your first |
2384 | watcher OR you must not use AnyEvent at all in the child OR you must do |
2605 | watcher OR you must not use AnyEvent at all in the child OR you must do |
2385 | something completely out of the scope of AnyEvent. |
2606 | something completely out of the scope of AnyEvent. |
|
|
2607 | |
|
|
2608 | The problem of doing event processing in the parent I<and> the child |
|
|
2609 | is much more complicated: even for backends that I<are> fork-aware or |
|
|
2610 | fork-safe, their behaviour is not usually what you want: fork clones all |
|
|
2611 | watchers, that means all timers, I/O watchers etc. are active in both |
|
|
2612 | parent and child, which is almost never what you want. USing C<exec> |
|
|
2613 | to start worker children from some kind of manage rprocess is usually |
|
|
2614 | preferred, because it is much easier and cleaner, at the expense of having |
|
|
2615 | to have another binary. |
2386 | |
2616 | |
2387 | |
2617 | |
2388 | =head1 SECURITY CONSIDERATIONS |
2618 | =head1 SECURITY CONSIDERATIONS |
2389 | |
2619 | |
2390 | AnyEvent can be forced to load any event model via |
2620 | AnyEvent can be forced to load any event model via |