… | |
… | |
181 | my variables are only visible after the statement in which they are |
181 | my variables are only visible after the statement in which they are |
182 | declared. |
182 | declared. |
183 | |
183 | |
184 | =head2 I/O WATCHERS |
184 | =head2 I/O WATCHERS |
185 | |
185 | |
|
|
186 | $w = AnyEvent->io ( |
|
|
187 | fh => <filehandle_or_fileno>, |
|
|
188 | poll => <"r" or "w">, |
|
|
189 | cb => <callback>, |
|
|
190 | ); |
|
|
191 | |
186 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
192 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
187 | with the following mandatory key-value pairs as arguments: |
193 | with the following mandatory key-value pairs as arguments: |
188 | |
194 | |
189 | C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch |
195 | 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 |
196 | for events (AnyEvent might or might not keep a reference to this file |
… | |
… | |
219 | undef $w; |
225 | undef $w; |
220 | }); |
226 | }); |
221 | |
227 | |
222 | =head2 TIME WATCHERS |
228 | =head2 TIME WATCHERS |
223 | |
229 | |
|
|
230 | $w = AnyEvent->timer (after => <seconds>, cb => <callback>); |
|
|
231 | |
|
|
232 | $w = AnyEvent->timer ( |
|
|
233 | after => <fractional_seconds>, |
|
|
234 | interval => <fractional_seconds>, |
|
|
235 | cb => <callback>, |
|
|
236 | ); |
|
|
237 | |
224 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
238 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
225 | method with the following mandatory arguments: |
239 | method with the following mandatory arguments: |
226 | |
240 | |
227 | C<after> specifies after how many seconds (fractional values are |
241 | C<after> specifies after how many seconds (fractional values are |
228 | supported) the callback should be invoked. C<cb> is the callback to invoke |
242 | supported) the callback should be invoked. C<cb> is the callback to invoke |
… | |
… | |
355 | |
369 | |
356 | =back |
370 | =back |
357 | |
371 | |
358 | =head2 SIGNAL WATCHERS |
372 | =head2 SIGNAL WATCHERS |
359 | |
373 | |
|
|
374 | $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>); |
|
|
375 | |
360 | You can watch for signals using a signal watcher, C<signal> is the signal |
376 | 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 |
377 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
362 | callback to be invoked whenever a signal occurs. |
378 | callback to be invoked whenever a signal occurs. |
363 | |
379 | |
364 | Although the callback might get passed parameters, their value and |
380 | Although the callback might get passed parameters, their value and |
… | |
… | |
383 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
399 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
384 | |
400 | |
385 | =head3 Signal Races, Delays and Workarounds |
401 | =head3 Signal Races, Delays and Workarounds |
386 | |
402 | |
387 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
403 | 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 |
404 | 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 |
405 | do race-free signal handling in perl, requiring C libraries for |
|
|
406 | 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 |
407 | 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 |
408 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
392 | seconds). This variable can be changed only before the first signal |
409 | variable can be changed only before the first signal watcher is created, |
393 | watcher is created, and should be left alone otherwise. Higher values |
410 | and should be left alone otherwise. This variable determines how often |
|
|
411 | 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 |
412 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
413 | saving. |
|
|
414 | |
395 | saving. All these problems can be avoided by installing the optional |
415 | All these problems can be avoided by installing the optional |
396 | L<Async::Interrupt> module. This will not work with inherently broken |
416 | 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> |
417 | 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 |
418 | (and not with L<POE> currently, as POE does it's own workaround with |
399 | those, you just have to suffer the delays. |
419 | one-second latency). For those, you just have to suffer the delays. |
400 | |
420 | |
401 | =head2 CHILD PROCESS WATCHERS |
421 | =head2 CHILD PROCESS WATCHERS |
|
|
422 | |
|
|
423 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
402 | |
424 | |
403 | You can also watch on a child process exit and catch its exit status. |
425 | You can also watch on a child process exit and catch its exit status. |
404 | |
426 | |
405 | The child process is specified by the C<pid> argument (one some backends, |
427 | 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 |
428 | using C<0> watches for any child process exit, on others this will |
… | |
… | |
455 | # do something else, then wait for process exit |
477 | # do something else, then wait for process exit |
456 | $done->recv; |
478 | $done->recv; |
457 | |
479 | |
458 | =head2 IDLE WATCHERS |
480 | =head2 IDLE WATCHERS |
459 | |
481 | |
|
|
482 | $w = AnyEvent->idle (cb => <callback>); |
|
|
483 | |
460 | Sometimes there is a need to do something, but it is not so important |
484 | Sometimes there is a need to do something, but it is not so important |
461 | to do it instantly, but only when there is nothing better to do. This |
485 | 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 |
486 | "nothing better to do" is usually defined to be "no other events need |
463 | attention by the event loop". |
487 | attention by the event loop". |
464 | |
488 | |
… | |
… | |
490 | }); |
514 | }); |
491 | }); |
515 | }); |
492 | |
516 | |
493 | =head2 CONDITION VARIABLES |
517 | =head2 CONDITION VARIABLES |
494 | |
518 | |
|
|
519 | $cv = AnyEvent->condvar; |
|
|
520 | |
|
|
521 | $cv->send (<list>); |
|
|
522 | my @res = $cv->recv; |
|
|
523 | |
495 | If you are familiar with some event loops you will know that all of them |
524 | 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 |
525 | require you to run some blocking "loop", "run" or similar function that |
497 | will actively watch for new events and call your callbacks. |
526 | will actively watch for new events and call your callbacks. |
498 | |
527 | |
499 | AnyEvent is slightly different: it expects somebody else to run the event |
528 | AnyEvent is slightly different: it expects somebody else to run the event |
… | |
… | |
761 | =item $cb = $cv->cb ($cb->($cv)) |
790 | =item $cb = $cv->cb ($cb->($cv)) |
762 | |
791 | |
763 | This is a mutator function that returns the callback set and optionally |
792 | This is a mutator function that returns the callback set and optionally |
764 | replaces it before doing so. |
793 | replaces it before doing so. |
765 | |
794 | |
766 | The callback will be called when the condition becomes "true", i.e. when |
795 | 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 |
796 | "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 |
797 | the only argument being the condition variable itself. Calling C<recv> |
769 | is guaranteed not to block. |
798 | inside the callback or at any later time is guaranteed not to block. |
770 | |
799 | |
771 | =back |
800 | =back |
772 | |
801 | |
773 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
802 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
774 | |
803 | |
… | |
… | |
1086 | |
1115 | |
1087 | BEGIN { AnyEvent::common_sense } |
1116 | BEGIN { AnyEvent::common_sense } |
1088 | |
1117 | |
1089 | use Carp (); |
1118 | use Carp (); |
1090 | |
1119 | |
1091 | our $VERSION = 4.881; |
1120 | our $VERSION = 4.901; |
1092 | our $MODEL; |
1121 | our $MODEL; |
1093 | |
1122 | |
1094 | our $AUTOLOAD; |
1123 | our $AUTOLOAD; |
1095 | our @ISA; |
1124 | our @ISA; |
1096 | |
1125 | |
… | |
… | |
1605 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1634 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1606 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1635 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1607 | } |
1636 | } |
1608 | |
1637 | |
1609 | sub cb { |
1638 | sub cb { |
1610 | $_[0]{_ae_cb} = $_[1] if @_ > 1; |
1639 | my $cv = shift; |
|
|
1640 | |
|
|
1641 | @_ |
|
|
1642 | and $cv->{_ae_cb} = shift |
|
|
1643 | and $cv->{_ae_sent} |
|
|
1644 | and (delete $cv->{_ae_cb})->($cv); |
|
|
1645 | |
1611 | $_[0]{_ae_cb} |
1646 | $cv->{_ae_cb} |
1612 | } |
1647 | } |
1613 | |
1648 | |
1614 | sub begin { |
1649 | sub begin { |
1615 | ++$_[0]{_ae_counter}; |
1650 | ++$_[0]{_ae_counter}; |
1616 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
1651 | $_[0]{_ae_end_cb} = $_[1] if @_ > 1; |
… | |
… | |
1622 | } |
1657 | } |
1623 | |
1658 | |
1624 | # undocumented/compatibility with pre-3.4 |
1659 | # undocumented/compatibility with pre-3.4 |
1625 | *broadcast = \&send; |
1660 | *broadcast = \&send; |
1626 | *wait = \&_wait; |
1661 | *wait = \&_wait; |
|
|
1662 | |
|
|
1663 | ############################################################################# |
|
|
1664 | # "new" API, currently only emulation of it |
|
|
1665 | ############################################################################# |
|
|
1666 | |
|
|
1667 | package AE; |
|
|
1668 | |
|
|
1669 | sub io($$$) { |
|
|
1670 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
|
|
1671 | } |
|
|
1672 | |
|
|
1673 | sub timer($$$) { |
|
|
1674 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]); |
|
|
1675 | } |
|
|
1676 | |
|
|
1677 | sub signal($$) { |
|
|
1678 | AnyEvent->signal (signal => $_[0], cb => $_[1]); |
|
|
1679 | } |
|
|
1680 | |
|
|
1681 | sub child($$) { |
|
|
1682 | AnyEvent->child (pid => $_[0], cb => $_[1]); |
|
|
1683 | } |
|
|
1684 | |
|
|
1685 | sub idle($) { |
|
|
1686 | AnyEvent->idle (cb => $_[0]); |
|
|
1687 | } |
|
|
1688 | |
|
|
1689 | sub cv(;&) { |
|
|
1690 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
|
|
1691 | } |
|
|
1692 | |
|
|
1693 | sub now() { |
|
|
1694 | AnyEvent->now |
|
|
1695 | } |
|
|
1696 | |
|
|
1697 | sub now_update() { |
|
|
1698 | AnyEvent->now_update |
|
|
1699 | } |
|
|
1700 | |
|
|
1701 | sub time() { |
|
|
1702 | AnyEvent->time |
|
|
1703 | } |
1627 | |
1704 | |
1628 | =head1 ERROR AND EXCEPTION HANDLING |
1705 | =head1 ERROR AND EXCEPTION HANDLING |
1629 | |
1706 | |
1630 | In general, AnyEvent does not do any error handling - it relies on the |
1707 | In general, AnyEvent does not do any error handling - it relies on the |
1631 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
1708 | caller to do that if required. The L<AnyEvent::Strict> module (see also |