1 | NAME |
1 | NAME |
2 | AnyEvent - events independent of event loop implementation |
2 | AnyEvent - the DBI of event loop programming |
3 | |
3 | |
4 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
4 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, |
5 | event loops. |
5 | Qt and POE are various supported event loops/environments. |
6 | |
6 | |
7 | SYNOPSIS |
7 | SYNOPSIS |
8 | use AnyEvent; |
8 | use AnyEvent; |
9 | |
9 | |
10 | # file descriptor readable |
10 | # file descriptor readable |
… | |
… | |
43 | SUPPORT |
43 | SUPPORT |
44 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
44 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
45 | channel, too. |
45 | channel, too. |
46 | |
46 | |
47 | See the AnyEvent project page at the Schmorpforge Ta-Sa Software |
47 | See the AnyEvent project page at the Schmorpforge Ta-Sa Software |
48 | Respository, at <http://anyevent.schmorp.de>, for more info. |
48 | Repository, at <http://anyevent.schmorp.de>, for more info. |
49 | |
49 | |
50 | WHY YOU SHOULD USE THIS MODULE (OR NOT) |
50 | WHY YOU SHOULD USE THIS MODULE (OR NOT) |
51 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
51 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
52 | nowadays. So what is different about AnyEvent? |
52 | nowadays. So what is different about AnyEvent? |
53 | |
53 | |
… | |
… | |
173 | Note that "my $w; $w =" combination. This is necessary because in Perl, |
173 | Note that "my $w; $w =" combination. This is necessary because in Perl, |
174 | my variables are only visible after the statement in which they are |
174 | my variables are only visible after the statement in which they are |
175 | declared. |
175 | declared. |
176 | |
176 | |
177 | I/O WATCHERS |
177 | I/O WATCHERS |
|
|
178 | $w = AnyEvent->io ( |
|
|
179 | fh => <filehandle_or_fileno>, |
|
|
180 | poll => <"r" or "w">, |
|
|
181 | cb => <callback>, |
|
|
182 | ); |
|
|
183 | |
178 | You can create an I/O watcher by calling the "AnyEvent->io" method with |
184 | You can create an I/O watcher by calling the "AnyEvent->io" method with |
179 | the following mandatory key-value pairs as arguments: |
185 | the following mandatory key-value pairs as arguments: |
180 | |
186 | |
181 | "fh" is the Perl *file handle* (or a naked file descriptor) to watch for |
187 | "fh" is the Perl *file handle* (or a naked file descriptor) to watch for |
182 | events (AnyEvent might or might not keep a reference to this file |
188 | events (AnyEvent might or might not keep a reference to this file |
… | |
… | |
210 | warn "read: $input\n"; |
216 | warn "read: $input\n"; |
211 | undef $w; |
217 | undef $w; |
212 | }); |
218 | }); |
213 | |
219 | |
214 | TIME WATCHERS |
220 | TIME WATCHERS |
|
|
221 | $w = AnyEvent->timer (after => <seconds>, cb => <callback>); |
|
|
222 | |
|
|
223 | $w = AnyEvent->timer ( |
|
|
224 | after => <fractional_seconds>, |
|
|
225 | interval => <fractional_seconds>, |
|
|
226 | cb => <callback>, |
|
|
227 | ); |
|
|
228 | |
215 | You can create a time watcher by calling the "AnyEvent->timer" method |
229 | You can create a time watcher by calling the "AnyEvent->timer" method |
216 | with the following mandatory arguments: |
230 | with the following mandatory arguments: |
217 | |
231 | |
218 | "after" specifies after how many seconds (fractional values are |
232 | "after" specifies after how many seconds (fractional values are |
219 | supported) the callback should be invoked. "cb" is the callback to |
233 | supported) the callback should be invoked. "cb" is the callback to |
… | |
… | |
343 | the event loop's idea of "current time". |
357 | the event loop's idea of "current time". |
344 | |
358 | |
345 | Note that updating the time *might* cause some events to be handled. |
359 | Note that updating the time *might* cause some events to be handled. |
346 | |
360 | |
347 | SIGNAL WATCHERS |
361 | SIGNAL WATCHERS |
|
|
362 | $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>); |
|
|
363 | |
348 | You can watch for signals using a signal watcher, "signal" is the signal |
364 | You can watch for signals using a signal watcher, "signal" is the signal |
349 | *name* in uppercase and without any "SIG" prefix, "cb" is the Perl |
365 | *name* in uppercase and without any "SIG" prefix, "cb" is the Perl |
350 | callback to be invoked whenever a signal occurs. |
366 | callback to be invoked whenever a signal occurs. |
351 | |
367 | |
352 | Although the callback might get passed parameters, their value and |
368 | Although the callback might get passed parameters, their value and |
… | |
… | |
371 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
387 | my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); |
372 | |
388 | |
373 | Signal Races, Delays and Workarounds |
389 | Signal Races, Delays and Workarounds |
374 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
390 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
375 | callbacks to signals in a generic way, which is a pity, as you cannot do |
391 | callbacks to signals in a generic way, which is a pity, as you cannot do |
376 | race-free signal handling in perl. AnyEvent will try to do it's best, |
392 | race-free signal handling in perl, requiring C libraries for this. |
377 | but in some cases, signals will be delayed. The maximum time a signal |
393 | AnyEvent will try to do it's best, which means in some cases, signals |
378 | might be delayed is specified in $AnyEvent::MAX_SIGNAL_LATENCY (default: |
394 | will be delayed. The maximum time a signal might be delayed is specified |
379 | 10 seconds). This variable can be changed only before the first signal |
395 | in $AnyEvent::MAX_SIGNAL_LATENCY (default: 10 seconds). This variable |
380 | watcher is created, and should be left alone otherwise. Higher values |
396 | can be changed only before the first signal watcher is created, and |
|
|
397 | should be left alone otherwise. This variable determines how often |
|
|
398 | AnyEvent polls for signals (in case a wake-up was missed). Higher values |
381 | will cause fewer spurious wake-ups, which is better for power and CPU |
399 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
400 | saving. |
|
|
401 | |
382 | saving. All these problems can be avoided by installing the optional |
402 | All these problems can be avoided by installing the optional |
383 | Async::Interrupt module. This will not work with inherently broken event |
403 | Async::Interrupt module, which works with most event loops. It will not |
384 | loops such as Event or Event::Lib (and not with POE currently, as POE |
404 | work with inherently broken event loops such as Event or Event::Lib (and |
385 | does it's own workaround with one-second latency). With those, you just |
405 | not with POE currently, as POE does it's own workaround with one-second |
386 | have to suffer the delays. |
406 | latency). For those, you just have to suffer the delays. |
387 | |
407 | |
388 | CHILD PROCESS WATCHERS |
408 | CHILD PROCESS WATCHERS |
|
|
409 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
|
|
410 | |
389 | You can also watch on a child process exit and catch its exit status. |
411 | You can also watch on a child process exit and catch its exit status. |
390 | |
412 | |
391 | The child process is specified by the "pid" argument (if set to 0, it |
413 | The child process is specified by the "pid" argument (one some backends, |
392 | watches for any child process exit). The watcher will triggered only |
414 | using 0 watches for any child process exit, on others this will croak). |
393 | when the child process has finished and an exit status is available, not |
415 | The watcher will be triggered only when the child process has finished |
394 | on any trace events (stopped/continued). |
416 | and an exit status is available, not on any trace events |
|
|
417 | (stopped/continued). |
395 | |
418 | |
396 | The callback will be called with the pid and exit status (as returned by |
419 | The callback will be called with the pid and exit status (as returned by |
397 | waitpid), so unlike other watcher types, you *can* rely on child watcher |
420 | waitpid), so unlike other watcher types, you *can* rely on child watcher |
398 | callback arguments. |
421 | callback arguments. |
399 | |
422 | |
… | |
… | |
438 | |
461 | |
439 | # do something else, then wait for process exit |
462 | # do something else, then wait for process exit |
440 | $done->recv; |
463 | $done->recv; |
441 | |
464 | |
442 | IDLE WATCHERS |
465 | IDLE WATCHERS |
|
|
466 | $w = AnyEvent->idle (cb => <callback>); |
|
|
467 | |
443 | Sometimes there is a need to do something, but it is not so important to |
468 | Sometimes there is a need to do something, but it is not so important to |
444 | do it instantly, but only when there is nothing better to do. This |
469 | do it instantly, but only when there is nothing better to do. This |
445 | "nothing better to do" is usually defined to be "no other events need |
470 | "nothing better to do" is usually defined to be "no other events need |
446 | attention by the event loop". |
471 | attention by the event loop". |
447 | |
472 | |
… | |
… | |
472 | } |
497 | } |
473 | }); |
498 | }); |
474 | }); |
499 | }); |
475 | |
500 | |
476 | CONDITION VARIABLES |
501 | CONDITION VARIABLES |
|
|
502 | $cv = AnyEvent->condvar; |
|
|
503 | |
|
|
504 | $cv->send (<list>); |
|
|
505 | my @res = $cv->recv; |
|
|
506 | |
477 | If you are familiar with some event loops you will know that all of them |
507 | If you are familiar with some event loops you will know that all of them |
478 | require you to run some blocking "loop", "run" or similar function that |
508 | require you to run some blocking "loop", "run" or similar function that |
479 | will actively watch for new events and call your callbacks. |
509 | will actively watch for new events and call your callbacks. |
480 | |
510 | |
481 | AnyEvent is slightly different: it expects somebody else to run the |
511 | AnyEvent is slightly different: it expects somebody else to run the |
… | |
… | |
730 | |
760 | |
731 | $cb = $cv->cb ($cb->($cv)) |
761 | $cb = $cv->cb ($cb->($cv)) |
732 | This is a mutator function that returns the callback set and |
762 | This is a mutator function that returns the callback set and |
733 | optionally replaces it before doing so. |
763 | optionally replaces it before doing so. |
734 | |
764 | |
735 | The callback will be called when the condition becomes "true", i.e. |
765 | The callback will be called when the condition becomes (or already |
736 | when "send" or "croak" are called, with the only argument being the |
766 | was) "true", i.e. when "send" or "croak" are called (or were |
737 | condition variable itself. Calling "recv" inside the callback or at |
767 | called), with the only argument being the condition variable itself. |
|
|
768 | Calling "recv" inside the callback or at any later time is |
738 | any later time is guaranteed not to block. |
769 | guaranteed not to block. |
739 | |
770 | |
740 | SUPPORTED EVENT LOOPS/BACKENDS |
771 | SUPPORTED EVENT LOOPS/BACKENDS |
741 | The available backend classes are (every class has its own manpage): |
772 | The available backend classes are (every class has its own manpage): |
742 | |
773 | |
743 | Backends that are autoprobed when no other event loop can be found. |
774 | Backends that are autoprobed when no other event loop can be found. |
… | |
… | |
760 | |
791 | |
761 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
792 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
762 | AnyEvent::Impl::Tk based on Tk, very broken. |
793 | AnyEvent::Impl::Tk based on Tk, very broken. |
763 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
794 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
764 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
795 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
|
|
796 | AnyEvent::Impl::Irssi used when running within irssi. |
765 | |
797 | |
766 | Backends with special needs. |
798 | Backends with special needs. |
767 | Qt requires the Qt::Application to be instantiated first, but will |
799 | Qt requires the Qt::Application to be instantiated first, but will |
768 | otherwise be picked up automatically. As long as the main program |
800 | otherwise be picked up automatically. As long as the main program |
769 | instantiates the application before any AnyEvent watchers are |
801 | instantiates the application before any AnyEvent watchers are |
… | |
… | |
834 | creates and installs the global IO::AIO watcher in a "post_detect" |
866 | creates and installs the global IO::AIO watcher in a "post_detect" |
835 | block to avoid autodetecting the event module at load time. |
867 | block to avoid autodetecting the event module at load time. |
836 | |
868 | |
837 | If called in scalar or list context, then it creates and returns an |
869 | If called in scalar or list context, then it creates and returns an |
838 | object that automatically removes the callback again when it is |
870 | object that automatically removes the callback again when it is |
|
|
871 | destroyed (or "undef" when the hook was immediately executed). See |
839 | destroyed. See Coro::BDB for a case where this is useful. |
872 | AnyEvent::AIO for a case where this is useful. |
|
|
873 | |
|
|
874 | Example: Create a watcher for the IO::AIO module and store it in |
|
|
875 | $WATCHER. Only do so after the event loop is initialised, though. |
|
|
876 | |
|
|
877 | our WATCHER; |
|
|
878 | |
|
|
879 | my $guard = AnyEvent::post_detect { |
|
|
880 | $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); |
|
|
881 | }; |
|
|
882 | |
|
|
883 | # the ||= is important in case post_detect immediately runs the block, |
|
|
884 | # as to not clobber the newly-created watcher. assigning both watcher and |
|
|
885 | # post_detect guard to the same variable has the advantage of users being |
|
|
886 | # able to just C<undef $WATCHER> if the watcher causes them grief. |
|
|
887 | |
|
|
888 | $WATCHER ||= $guard; |
840 | |
889 | |
841 | @AnyEvent::post_detect |
890 | @AnyEvent::post_detect |
842 | If there are any code references in this array (you can "push" to it |
891 | If there are any code references in this array (you can "push" to it |
843 | before or after loading AnyEvent), then they will called directly |
892 | before or after loading AnyEvent), then they will called directly |
844 | after the event loop has been chosen. |
893 | after the event loop has been chosen. |
… | |
… | |
1758 | Event::Lib, Qt, POE. |
1807 | Event::Lib, Qt, POE. |
1759 | |
1808 | |
1760 | Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event, |
1809 | Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event, |
1761 | AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, |
1810 | AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, |
1762 | AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE, |
1811 | AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE, |
1763 | AnyEvent::Impl::IOAsync. |
1812 | AnyEvent::Impl::IOAsync, Anyevent::Impl::Irssi. |
1764 | |
1813 | |
1765 | Non-blocking file handles, sockets, TCP clients and servers: |
1814 | Non-blocking file handles, sockets, TCP clients and servers: |
1766 | AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS. |
1815 | AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS. |
1767 | |
1816 | |
1768 | Asynchronous DNS: AnyEvent::DNS. |
1817 | Asynchronous DNS: AnyEvent::DNS. |