1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - the DBI of event loop programming |
3 | AnyEvent - the DBI of event loop programming |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt, |
6 | and POE are various supported event loops/environments. |
6 | FLTK 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 | |
… | |
… | |
271 | |
271 | |
272 | Example 2: fire an event after 0.5 seconds, then roughly every second. |
272 | Example 2: fire an event after 0.5 seconds, then roughly every second. |
273 | |
273 | |
274 | my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { |
274 | my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { |
275 | warn "timeout\n"; |
275 | warn "timeout\n"; |
276 | }; |
276 | }); |
277 | |
277 | |
278 | =head3 TIMING ISSUES |
278 | =head3 TIMING ISSUES |
279 | |
279 | |
280 | There are two ways to handle timers: based on real time (relative, "fire |
280 | There are two ways to handle timers: based on real time (relative, "fire |
281 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
281 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
… | |
… | |
415 | not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's |
415 | not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's |
416 | pure perl implementation). |
416 | pure perl implementation). |
417 | |
417 | |
418 | =head3 Safe/Unsafe Signals |
418 | =head3 Safe/Unsafe Signals |
419 | |
419 | |
420 | Perl signals can be either "safe" (synchronous to opcode handling) or |
420 | Perl signals can be either "safe" (synchronous to opcode handling) |
421 | "unsafe" (asynchronous) - the former might get delayed indefinitely, the |
421 | or "unsafe" (asynchronous) - the former might delay signal delivery |
422 | latter might corrupt your memory. |
422 | indefinitely, the latter might corrupt your memory. |
423 | |
423 | |
424 | AnyEvent signal handlers are, in addition, synchronous to the event loop, |
424 | AnyEvent signal handlers are, in addition, synchronous to the event loop, |
425 | i.e. they will not interrupt your running perl program but will only be |
425 | i.e. they will not interrupt your running perl program but will only be |
426 | called as part of the normal event handling (just like timer, I/O etc. |
426 | called as part of the normal event handling (just like timer, I/O etc. |
427 | callbacks, too). |
427 | callbacks, too). |
428 | |
428 | |
429 | =head3 Signal Races, Delays and Workarounds |
429 | =head3 Signal Races, Delays and Workarounds |
430 | |
430 | |
431 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
431 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support |
432 | callbacks to signals in a generic way, which is a pity, as you cannot |
432 | attaching callbacks to signals in a generic way, which is a pity, |
433 | do race-free signal handling in perl, requiring C libraries for |
433 | as you cannot do race-free signal handling in perl, requiring |
434 | this. AnyEvent will try to do its best, which means in some cases, |
434 | C libraries for this. AnyEvent will try to do its best, which |
435 | signals will be delayed. The maximum time a signal might be delayed is |
435 | means in some cases, signals will be delayed. The maximum time |
436 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
436 | a signal might be delayed is 10 seconds by default, but can |
437 | variable can be changed only before the first signal watcher is created, |
437 | be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or |
438 | and should be left alone otherwise. This variable determines how often |
438 | C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES> |
439 | AnyEvent polls for signals (in case a wake-up was missed). Higher values |
439 | section for details. |
440 | will cause fewer spurious wake-ups, which is better for power and CPU |
|
|
441 | saving. |
|
|
442 | |
440 | |
443 | All these problems can be avoided by installing the optional |
441 | All these problems can be avoided by installing the optional |
444 | L<Async::Interrupt> module, which works with most event loops. It will not |
442 | L<Async::Interrupt> module, which works with most event loops. It will not |
445 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
443 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
446 | (and not with L<POE> currently, as POE does its own workaround with |
444 | (and not with L<POE> currently). For those, you just have to suffer the |
447 | one-second latency). For those, you just have to suffer the delays. |
445 | delays. |
448 | |
446 | |
449 | =head2 CHILD PROCESS WATCHERS |
447 | =head2 CHILD PROCESS WATCHERS |
450 | |
448 | |
451 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
449 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
452 | |
450 | |
… | |
… | |
765 | }; |
763 | }; |
766 | } |
764 | } |
767 | |
765 | |
768 | $cv->end; |
766 | $cv->end; |
769 | |
767 | |
|
|
768 | ... |
|
|
769 | |
|
|
770 | my $results = $cv->recv; |
|
|
771 | |
770 | This code fragment supposedly pings a number of hosts and calls |
772 | This code fragment supposedly pings a number of hosts and calls |
771 | C<send> after results for all then have have been gathered - in any |
773 | C<send> after results for all then have have been gathered - in any |
772 | order. To achieve this, the code issues a call to C<begin> when it starts |
774 | order. To achieve this, the code issues a call to C<begin> when it starts |
773 | each ping request and calls C<end> when it has received some result for |
775 | each ping request and calls C<end> when it has received some result for |
774 | it. Since C<begin> and C<end> only maintain a counter, the order in which |
776 | it. Since C<begin> and C<end> only maintain a counter, the order in which |
… | |
… | |
809 | |
811 | |
810 | In list context, all parameters passed to C<send> will be returned, |
812 | In list context, all parameters passed to C<send> will be returned, |
811 | in scalar context only the first one will be returned. |
813 | in scalar context only the first one will be returned. |
812 | |
814 | |
813 | Note that doing a blocking wait in a callback is not supported by any |
815 | Note that doing a blocking wait in a callback is not supported by any |
814 | event loop, that is, recursive invocation of a blocking C<< ->recv |
816 | event loop, that is, recursive invocation of a blocking C<< ->recv >> is |
815 | >> is not allowed, and the C<recv> call will C<croak> if such a |
817 | not allowed and the C<recv> call will C<croak> if such a condition is |
816 | condition is detected. This condition can be slightly loosened by using |
818 | detected. This requirement can be dropped by relying on L<Coro::AnyEvent> |
817 | L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from |
819 | , which allows you to do a blocking C<< ->recv >> from any thread |
818 | any thread that doesn't run the event loop itself. |
820 | that doesn't run the event loop itself. L<Coro::AnyEvent> is loaded |
|
|
821 | automatically when L<Coro> is used with L<AnyEvent>, so code does not need |
|
|
822 | to do anything special to take advantage of that: any code that would |
|
|
823 | normally block your program because it calls C<recv>, be executed in an |
|
|
824 | C<async> thread instead without blocking other threads. |
819 | |
825 | |
820 | Not all event models support a blocking wait - some die in that case |
826 | Not all event models support a blocking wait - some die in that case |
821 | (programs might want to do that to stay interactive), so I<if you are |
827 | (programs might want to do that to stay interactive), so I<if you are |
822 | using this from a module, never require a blocking wait>. Instead, let the |
828 | using this from a module, never require a blocking wait>. Instead, let the |
823 | caller decide whether the call will block or not (for example, by coupling |
829 | caller decide whether the call will block or not (for example, by coupling |
… | |
… | |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
884 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
885 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
880 | AnyEvent::Impl::Irssi used when running within irssi. |
886 | AnyEvent::Impl::Irssi used when running within irssi. |
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
887 | AnyEvent::Impl::IOAsync based on IO::Async. |
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
888 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
883 | AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). |
889 | AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding). |
884 | |
890 | |
885 | =item Backends with special needs. |
891 | =item Backends with special needs. |
886 | |
892 | |
887 | Qt requires the Qt::Application to be instantiated first, but will |
893 | Qt requires the Qt::Application to be instantiated first, but will |
888 | otherwise be picked up automatically. As long as the main program |
894 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
1053 | |
1059 | |
1054 | =item AnyEvent::log $level, $msg[, @args] |
1060 | =item AnyEvent::log $level, $msg[, @args] |
1055 | |
1061 | |
1056 | Log the given C<$msg> at the given C<$level>. |
1062 | Log the given C<$msg> at the given C<$level>. |
1057 | |
1063 | |
1058 | Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> - |
1064 | If L<AnyEvent::Log> is not loaded then this function makes a simple test |
|
|
1065 | to see whether the message will be logged. If the test succeeds it will |
|
|
1066 | load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at |
1059 | consequently, look at the L<AnyEvent::Log> documentation for details. |
1067 | the L<AnyEvent::Log> documentation for details. |
|
|
1068 | |
|
|
1069 | If the test fails it will simply return. Right now this happens when a |
|
|
1070 | numerical loglevel is used and it is larger than the level specified via |
|
|
1071 | C<$ENV{PERL_ANYEVENT_VERBOSE}>. |
1060 | |
1072 | |
1061 | If you want to sprinkle loads of logging calls around your code, consider |
1073 | If you want to sprinkle loads of logging calls around your code, consider |
1062 | creating a logger callback with the C<AnyEvent::Log::logger< function. |
1074 | creating a logger callback with the C<AnyEvent::Log::logger> function, |
|
|
1075 | which can reduce typing, codesize and can reduce the logging overhead |
|
|
1076 | enourmously. |
1063 | |
1077 | |
1064 | =back |
1078 | =back |
1065 | |
1079 | |
1066 | =head1 WHAT TO DO IN A MODULE |
1080 | =head1 WHAT TO DO IN A MODULE |
1067 | |
1081 | |
… | |
… | |
1124 | |
1138 | |
1125 | |
1139 | |
1126 | =head1 OTHER MODULES |
1140 | =head1 OTHER MODULES |
1127 | |
1141 | |
1128 | The following is a non-exhaustive list of additional modules that use |
1142 | The following is a non-exhaustive list of additional modules that use |
1129 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
1143 | AnyEvent as a client and can therefore be mixed easily with other |
1130 | modules and other event loops in the same program. Some of the modules |
1144 | AnyEvent modules and other event loops in the same program. Some of the |
1131 | come as part of AnyEvent, the others are available via CPAN. |
1145 | modules come as part of AnyEvent, the others are available via CPAN (see |
|
|
1146 | L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for |
|
|
1147 | a longer non-exhaustive list), and the list is heavily biased towards |
|
|
1148 | modules of the AnyEvent author himself :) |
1132 | |
1149 | |
1133 | =over 4 |
1150 | =over 4 |
1134 | |
1151 | |
1135 | =item L<AnyEvent::Util> |
1152 | =item L<AnyEvent::Util> (part of the AnyEvent distribution) |
1136 | |
1153 | |
1137 | Contains various utility functions that replace often-used blocking |
1154 | Contains various utility functions that replace often-used blocking |
1138 | functions such as C<inet_aton> with event/callback-based versions. |
1155 | functions such as C<inet_aton> with event/callback-based versions. |
1139 | |
1156 | |
1140 | =item L<AnyEvent::Socket> |
1157 | =item L<AnyEvent::Socket> (part of the AnyEvent distribution) |
1141 | |
1158 | |
1142 | Provides various utility functions for (internet protocol) sockets, |
1159 | Provides various utility functions for (internet protocol) sockets, |
1143 | addresses and name resolution. Also functions to create non-blocking tcp |
1160 | addresses and name resolution. Also functions to create non-blocking tcp |
1144 | connections or tcp servers, with IPv6 and SRV record support and more. |
1161 | connections or tcp servers, with IPv6 and SRV record support and more. |
1145 | |
1162 | |
1146 | =item L<AnyEvent::Handle> |
1163 | =item L<AnyEvent::Handle> (part of the AnyEvent distribution) |
1147 | |
1164 | |
1148 | Provide read and write buffers, manages watchers for reads and writes, |
1165 | Provide read and write buffers, manages watchers for reads and writes, |
1149 | supports raw and formatted I/O, I/O queued and fully transparent and |
1166 | supports raw and formatted I/O, I/O queued and fully transparent and |
1150 | non-blocking SSL/TLS (via L<AnyEvent::TLS>). |
1167 | non-blocking SSL/TLS (via L<AnyEvent::TLS>). |
1151 | |
1168 | |
1152 | =item L<AnyEvent::DNS> |
1169 | =item L<AnyEvent::DNS> (part of the AnyEvent distribution) |
1153 | |
1170 | |
1154 | Provides rich asynchronous DNS resolver capabilities. |
1171 | Provides rich asynchronous DNS resolver capabilities. |
1155 | |
1172 | |
1156 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
1173 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
1157 | |
1174 | |
1158 | Implement event-based interfaces to the protocols of the same name (for |
1175 | Implement event-based interfaces to the protocols of the same name (for |
1159 | the curious, IGS is the International Go Server and FCP is the Freenet |
1176 | the curious, IGS is the International Go Server and FCP is the Freenet |
1160 | Client Protocol). |
1177 | Client Protocol). |
1161 | |
1178 | |
1162 | =item L<AnyEvent::Handle::UDP> |
1179 | =item L<AnyEvent::AIO> (part of the AnyEvent distribution) |
1163 | |
|
|
1164 | Here be danger! |
|
|
1165 | |
|
|
1166 | As Pauli would put it, "Not only is it not right, it's not even wrong!" - |
|
|
1167 | there are so many things wrong with AnyEvent::Handle::UDP, most notably |
|
|
1168 | its use of a stream-based API with a protocol that isn't streamable, that |
|
|
1169 | the only way to improve it is to delete it. |
|
|
1170 | |
|
|
1171 | It features data corruption (but typically only under load) and general |
|
|
1172 | confusion. On top, the author is not only clueless about UDP but also |
|
|
1173 | fact-resistant - some gems of his understanding: "connect doesn't work |
|
|
1174 | with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not |
|
|
1175 | packets", "I don't need to implement proper error checking as UDP doesn't |
|
|
1176 | support error checking" and so on - he doesn't even understand what's |
|
|
1177 | wrong with his module when it is explained to him. |
|
|
1178 | |
|
|
1179 | =item L<AnyEvent::DBI> |
|
|
1180 | |
|
|
1181 | Executes L<DBI> requests asynchronously in a proxy process for you, |
|
|
1182 | notifying you in an event-based way when the operation is finished. |
|
|
1183 | |
|
|
1184 | =item L<AnyEvent::AIO> |
|
|
1185 | |
1180 | |
1186 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
1181 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
1187 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
1182 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
1188 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
1183 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
1189 | file I/O, and much more. |
1184 | file I/O, and much more. |
1190 | |
1185 | |
|
|
1186 | =item L<AnyEvent::Filesys::Notify> |
|
|
1187 | |
|
|
1188 | AnyEvent is good for non-blocking stuff, but it can't detect file or |
|
|
1189 | path changes (e.g. "watch this directory for new files", "watch this |
|
|
1190 | file for changes"). The L<AnyEvent::Filesys::Notify> module promises to |
|
|
1191 | do just that in a portbale fashion, supporting inotify on GNU/Linux and |
|
|
1192 | some weird, without doubt broken, stuff on OS X to monitor files. It can |
|
|
1193 | fall back to blocking scans at regular intervals transparently on other |
|
|
1194 | platforms, so it's about as portable as it gets. |
|
|
1195 | |
|
|
1196 | (I haven't used it myself, but I haven't heard anybody complaining about |
|
|
1197 | it yet). |
|
|
1198 | |
|
|
1199 | =item L<AnyEvent::DBI> |
|
|
1200 | |
|
|
1201 | Executes L<DBI> requests asynchronously in a proxy process for you, |
|
|
1202 | notifying you in an event-based way when the operation is finished. |
|
|
1203 | |
1191 | =item L<AnyEvent::HTTPD> |
1204 | =item L<AnyEvent::HTTPD> |
1192 | |
1205 | |
1193 | A simple embedded webserver. |
1206 | A simple embedded webserver. |
1194 | |
1207 | |
1195 | =item L<AnyEvent::FastPing> |
1208 | =item L<AnyEvent::FastPing> |
1196 | |
1209 | |
1197 | The fastest ping in the west. |
1210 | The fastest ping in the west. |
1198 | |
1211 | |
1199 | =item L<Coro> |
1212 | =item L<Coro> |
1200 | |
1213 | |
1201 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1214 | Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you |
|
|
1215 | to simply invert the flow control - don't call us, we will call you: |
|
|
1216 | |
|
|
1217 | async { |
|
|
1218 | Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it |
|
|
1219 | print "5 seconds later!\n"; |
|
|
1220 | |
|
|
1221 | Coro::AnyEvent::readable *STDIN; # uses an I/O watcher |
|
|
1222 | my $line = <STDIN>; # works for ttys |
|
|
1223 | |
|
|
1224 | AnyEvent::HTTP::http_get "url", Coro::rouse_cb; |
|
|
1225 | my ($body, $hdr) = Coro::rouse_wait; |
|
|
1226 | }; |
1202 | |
1227 | |
1203 | =back |
1228 | =back |
1204 | |
1229 | |
1205 | =cut |
1230 | =cut |
1206 | |
1231 | |
1207 | package AnyEvent; |
1232 | package AnyEvent; |
1208 | |
|
|
1209 | # basically a tuned-down version of common::sense |
|
|
1210 | sub common_sense { |
|
|
1211 | # from common:.sense 3.4 |
|
|
1212 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; |
|
|
1213 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
|
|
1214 | $^H |= 0x00000600; |
|
|
1215 | } |
|
|
1216 | |
|
|
1217 | BEGIN { AnyEvent::common_sense } |
|
|
1218 | |
|
|
1219 | use Carp (); |
|
|
1220 | |
|
|
1221 | our $VERSION = '6.01'; |
|
|
1222 | our $MODEL; |
|
|
1223 | |
|
|
1224 | our @ISA; |
|
|
1225 | |
|
|
1226 | our @REGISTRY; |
|
|
1227 | |
|
|
1228 | our $VERBOSE; |
|
|
1229 | |
1233 | |
1230 | BEGIN { |
1234 | BEGIN { |
1231 | require "AnyEvent/constants.pl"; |
1235 | require "AnyEvent/constants.pl"; |
|
|
1236 | &AnyEvent::common_sense; |
|
|
1237 | } |
1232 | |
1238 | |
|
|
1239 | use Carp (); |
|
|
1240 | |
|
|
1241 | our $VERSION = '7.05'; |
|
|
1242 | our $MODEL; |
|
|
1243 | our @ISA; |
|
|
1244 | our @REGISTRY; |
|
|
1245 | our $VERBOSE; |
|
|
1246 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
|
|
1247 | our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!) |
|
|
1248 | |
|
|
1249 | BEGIN { |
1233 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1250 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1234 | |
1251 | |
1235 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1252 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1236 | if ${^TAINT}; |
1253 | if ${^TAINT}; |
1237 | |
1254 | |
1238 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1255 | $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"} |
1239 | } |
1256 | for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV; |
1240 | |
1257 | |
1241 | our $MAX_SIGNAL_LATENCY = 10; |
1258 | @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = () |
|
|
1259 | if ${^TAINT}; |
1242 | |
1260 | |
1243 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1261 | # $ENV{PERL_ANYEVENT_xxx} now valid |
1244 | |
1262 | |
1245 | { |
1263 | $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4; |
|
|
1264 | |
1246 | my $idx; |
1265 | my $idx; |
1247 | $PROTOCOL{$_} = ++$idx |
1266 | $PROTOCOL{$_} = ++$idx |
1248 | for reverse split /\s*,\s*/, |
1267 | for reverse split /\s*,\s*/, |
1249 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1268 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1250 | } |
1269 | } |
… | |
… | |
1282 | |
1301 | |
1283 | () |
1302 | () |
1284 | } |
1303 | } |
1285 | |
1304 | |
1286 | sub log($$;@) { |
1305 | sub log($$;@) { |
1287 | require AnyEvent::Log; |
1306 | # only load the big bloated module when we actually are about to log something |
|
|
1307 | if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal |
|
|
1308 | local ($!, $@); |
|
|
1309 | require AnyEvent::Log; # among other things, sets $VERBOSE to 9 |
1288 | # AnyEvent::Log overwrites this function |
1310 | # AnyEvent::Log overwrites this function |
1289 | goto &log; |
1311 | goto &log; |
|
|
1312 | } |
|
|
1313 | |
|
|
1314 | 0 # not logged |
|
|
1315 | } |
|
|
1316 | |
|
|
1317 | sub _logger($;$) { |
|
|
1318 | my ($level, $renabled) = @_; |
|
|
1319 | |
|
|
1320 | $$renabled = $level <= $VERBOSE; |
|
|
1321 | |
|
|
1322 | my $logger = [(caller)[0], $level, $renabled]; |
|
|
1323 | |
|
|
1324 | $AnyEvent::Log::LOGGER{$logger+0} = $logger; |
|
|
1325 | |
|
|
1326 | # return unless defined wantarray; |
|
|
1327 | # |
|
|
1328 | # require AnyEvent::Util; |
|
|
1329 | # my $guard = AnyEvent::Util::guard (sub { |
|
|
1330 | # # "clean up" |
|
|
1331 | # delete $LOGGER{$logger+0}; |
|
|
1332 | # }); |
|
|
1333 | # |
|
|
1334 | # sub { |
|
|
1335 | # return 0 unless $$renabled; |
|
|
1336 | # |
|
|
1337 | # $guard if 0; # keep guard alive, but don't cause runtime overhead |
|
|
1338 | # require AnyEvent::Log unless $AnyEvent::Log::VERSION; |
|
|
1339 | # package AnyEvent::Log; |
|
|
1340 | # _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time |
|
|
1341 | # } |
|
|
1342 | } |
|
|
1343 | |
|
|
1344 | if (length $ENV{PERL_ANYEVENT_LOG}) { |
|
|
1345 | require AnyEvent::Log; # AnyEvent::Log does the thing for us |
1290 | } |
1346 | } |
1291 | |
1347 | |
1292 | our @models = ( |
1348 | our @models = ( |
1293 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1349 | [EV:: => AnyEvent::Impl::EV::], |
1294 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1350 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl::], |
1295 | # everything below here will not (normally) be autoprobed |
1351 | # everything below here will not (normally) be autoprobed |
1296 | # as the pure perl backend should work everywhere |
1352 | # as the pure perl backend should work everywhere |
1297 | # and is usually faster |
1353 | # and is usually faster |
|
|
1354 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top |
1298 | [Event:: => AnyEvent::Impl::Event::, 1], |
1355 | [Event:: => AnyEvent::Impl::Event::], # slow, stable |
1299 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1356 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
|
|
1357 | # everything below here should not be autoloaded |
1300 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1358 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1301 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
|
|
1302 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1359 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1303 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1360 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1304 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1361 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1305 | [Wx:: => AnyEvent::Impl::POE::], |
1362 | [Wx:: => AnyEvent::Impl::POE::], |
1306 | [Prima:: => AnyEvent::Impl::POE::], |
1363 | [Prima:: => AnyEvent::Impl::POE::], |
1307 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
1364 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
1308 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1365 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1309 | [FLTK:: => AnyEvent::Impl::FLTK2::], |
1366 | [FLTK:: => AnyEvent::Impl::FLTK::], |
1310 | ); |
1367 | ); |
1311 | |
1368 | |
1312 | our @isa_hook; |
1369 | our @isa_hook; |
1313 | |
1370 | |
1314 | sub _isa_set { |
1371 | sub _isa_set { |
… | |
… | |
1334 | # due to bugs in perls method cache implementation. |
1391 | # due to bugs in perls method cache implementation. |
1335 | our @methods = qw(io timer time now now_update signal child idle condvar); |
1392 | our @methods = qw(io timer time now now_update signal child idle condvar); |
1336 | |
1393 | |
1337 | sub detect() { |
1394 | sub detect() { |
1338 | return $MODEL if $MODEL; # some programs keep references to detect |
1395 | return $MODEL if $MODEL; # some programs keep references to detect |
|
|
1396 | |
|
|
1397 | # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it |
|
|
1398 | # the author knows about the problems and what it does to AnyEvent as a whole |
|
|
1399 | # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent |
|
|
1400 | # anyway. |
|
|
1401 | AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n" |
|
|
1402 | . "design, abuses internals and breaks AnyEvent - will not continue." |
|
|
1403 | if exists $INC{"IO/Async/Loop/AnyEvent.pm"}; |
1339 | |
1404 | |
1340 | local $!; # for good measure |
1405 | local $!; # for good measure |
1341 | local $SIG{__DIE__}; # we use eval |
1406 | local $SIG{__DIE__}; # we use eval |
1342 | |
1407 | |
1343 | # free some memory |
1408 | # free some memory |
… | |
… | |
1352 | |
1417 | |
1353 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1418 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1354 | my $model = $1; |
1419 | my $model = $1; |
1355 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1420 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1356 | if (eval "require $model") { |
1421 | if (eval "require $model") { |
|
|
1422 | AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."; |
1357 | $MODEL = $model; |
1423 | $MODEL = $model; |
1358 | AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it." |
|
|
1359 | if $VERBOSE >= 7; |
|
|
1360 | } else { |
1424 | } else { |
1361 | AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; |
1425 | AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; |
1362 | } |
1426 | } |
1363 | } |
1427 | } |
1364 | |
1428 | |
1365 | # check for already loaded models |
1429 | # check for already loaded models |
1366 | unless ($MODEL) { |
1430 | unless ($MODEL) { |
1367 | for (@REGISTRY, @models) { |
1431 | for (@REGISTRY, @models) { |
1368 | my ($package, $model) = @$_; |
1432 | my ($package, $model) = @$_; |
1369 | if (${"$package\::VERSION"} > 0) { |
1433 | if (${"$package\::VERSION"} > 0) { |
1370 | if (eval "require $model") { |
1434 | if (eval "require $model") { |
|
|
1435 | AnyEvent::log 7 => "Autodetected model '$model', using it."; |
1371 | $MODEL = $model; |
1436 | $MODEL = $model; |
|
|
1437 | last; |
|
|
1438 | } else { |
|
|
1439 | AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@"; |
|
|
1440 | } |
|
|
1441 | } |
|
|
1442 | } |
|
|
1443 | |
|
|
1444 | unless ($MODEL) { |
|
|
1445 | # try to autoload a model |
|
|
1446 | for (@REGISTRY, @models) { |
|
|
1447 | my ($package, $model) = @$_; |
|
|
1448 | if ( |
|
|
1449 | eval "require $package" |
|
|
1450 | and ${"$package\::VERSION"} > 0 |
|
|
1451 | and eval "require $model" |
|
|
1452 | ) { |
1372 | AnyEvent::log 7 => "autodetected model '$model', using it." |
1453 | AnyEvent::log 7 => "Autoloaded model '$model', using it."; |
1373 | if $VERBOSE >= 7; |
1454 | $MODEL = $model; |
1374 | last; |
1455 | last; |
1375 | } |
1456 | } |
1376 | } |
1457 | } |
1377 | } |
|
|
1378 | |
|
|
1379 | unless ($MODEL) { |
|
|
1380 | # try to autoload a model |
|
|
1381 | for (@REGISTRY, @models) { |
|
|
1382 | my ($package, $model, $autoload) = @$_; |
|
|
1383 | if ( |
|
|
1384 | $autoload |
|
|
1385 | and eval "require $package" |
|
|
1386 | and ${"$package\::VERSION"} > 0 |
|
|
1387 | and eval "require $model" |
|
|
1388 | ) { |
|
|
1389 | $MODEL = $model; |
|
|
1390 | AnyEvent::log 7 => "autoloaded model '$model', using it." |
|
|
1391 | if $VERBOSE >= 7; |
|
|
1392 | last; |
|
|
1393 | } |
|
|
1394 | } |
|
|
1395 | |
1458 | |
1396 | $MODEL |
1459 | $MODEL |
1397 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; |
1460 | or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?"; |
1398 | } |
1461 | } |
1399 | } |
1462 | } |
1400 | |
1463 | |
1401 | # free memory only needed for probing |
1464 | # free memory only needed for probing |
1402 | undef @models; |
1465 | undef @models; |
… | |
… | |
1546 | |
1609 | |
1547 | sub time { |
1610 | sub time { |
1548 | eval q{ # poor man's autoloading {} |
1611 | eval q{ # poor man's autoloading {} |
1549 | # probe for availability of Time::HiRes |
1612 | # probe for availability of Time::HiRes |
1550 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1613 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1551 | AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy." |
|
|
1552 | if $AnyEvent::VERBOSE >= 8; |
|
|
1553 | *time = sub { Time::HiRes::time () }; |
1614 | *time = sub { Time::HiRes::time () }; |
1554 | *AE::time = \& Time::HiRes::time ; |
1615 | *AE::time = \& Time::HiRes::time ; |
|
|
1616 | *now = \&time; |
|
|
1617 | AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy."; |
1555 | # if (eval "use POSIX (); (POSIX::times())... |
1618 | # if (eval "use POSIX (); (POSIX::times())... |
1556 | } else { |
1619 | } else { |
1557 | AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!"; |
|
|
1558 | *time = sub { CORE::time }; |
1620 | *time = sub { CORE::time }; |
1559 | *AE::time = sub (){ CORE::time }; |
1621 | *AE::time = sub (){ CORE::time }; |
|
|
1622 | *now = \&time; |
|
|
1623 | AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!"; |
1560 | } |
1624 | } |
1561 | |
|
|
1562 | *now = \&time; |
|
|
1563 | }; |
1625 | }; |
1564 | die if $@; |
1626 | die if $@; |
1565 | |
1627 | |
1566 | &time |
1628 | &time |
1567 | } |
1629 | } |
… | |
… | |
1660 | |
1722 | |
1661 | sub signal { |
1723 | sub signal { |
1662 | eval q{ # poor man's autoloading {} |
1724 | eval q{ # poor man's autoloading {} |
1663 | # probe for availability of Async::Interrupt |
1725 | # probe for availability of Async::Interrupt |
1664 | if (_have_async_interrupt) { |
1726 | if (_have_async_interrupt) { |
1665 | AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling." |
1727 | AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling."; |
1666 | if $AnyEvent::VERBOSE >= 8; |
|
|
1667 | |
1728 | |
1668 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1729 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1669 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1730 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1670 | |
1731 | |
1671 | } else { |
1732 | } else { |
1672 | AnyEvent::log 8 => "using emulated perl signal handling with latency timer." |
1733 | AnyEvent::log 8 => "Using emulated perl signal handling with latency timer."; |
1673 | if $AnyEvent::VERBOSE >= 8; |
|
|
1674 | |
1734 | |
1675 | if (AnyEvent::WIN32) { |
1735 | if (AnyEvent::WIN32) { |
1676 | require AnyEvent::Util; |
1736 | require AnyEvent::Util; |
1677 | |
1737 | |
1678 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1738 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
… | |
… | |
1972 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
2032 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
1973 | so on. |
2033 | so on. |
1974 | |
2034 | |
1975 | =head1 ENVIRONMENT VARIABLES |
2035 | =head1 ENVIRONMENT VARIABLES |
1976 | |
2036 | |
1977 | The following environment variables are used by this module or its |
2037 | AnyEvent supports a number of environment variables that tune the |
1978 | submodules. |
2038 | runtime behaviour. They are usually evaluated when AnyEvent is |
|
|
2039 | loaded, initialised, or a submodule that uses them is loaded. Many of |
|
|
2040 | them also cause AnyEvent to load additional modules - for example, |
|
|
2041 | C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be |
|
|
2042 | loaded. |
1979 | |
2043 | |
1980 | Note that AnyEvent will remove I<all> environment variables starting with |
2044 | All the environment variables documented here start with |
1981 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
2045 | C<PERL_ANYEVENT_>, which is what AnyEvent considers its own |
1982 | enabled. |
2046 | namespace. Other modules are encouraged (but by no means required) to use |
|
|
2047 | C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule |
|
|
2048 | namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could |
|
|
2049 | be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env |
|
|
2050 | variables starting with C<AE_>, see below). |
|
|
2051 | |
|
|
2052 | All variables can also be set via the C<AE_> prefix, that is, instead |
|
|
2053 | of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In |
|
|
2054 | case there is a clash btween anyevent and another program that uses |
|
|
2055 | C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something> |
|
|
2056 | variable to the empty string, as those variables take precedence. |
|
|
2057 | |
|
|
2058 | When AnyEvent is first loaded, it copies all C<AE_xxx> env variables |
|
|
2059 | to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already |
|
|
2060 | exists. If taint mode is on, then AnyEvent will remove I<all> environment |
|
|
2061 | variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them |
|
|
2062 | with C<undef> or the empty string, if the corresaponding C<AE_> variable |
|
|
2063 | is set). |
|
|
2064 | |
|
|
2065 | The exact algorithm is currently: |
|
|
2066 | |
|
|
2067 | 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV |
|
|
2068 | 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists |
|
|
2069 | 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef. |
|
|
2070 | |
|
|
2071 | This ensures that child processes will not see the C<AE_> variables. |
|
|
2072 | |
|
|
2073 | The following environment variables are currently known to AnyEvent: |
1983 | |
2074 | |
1984 | =over 4 |
2075 | =over 4 |
1985 | |
2076 | |
1986 | =item C<PERL_ANYEVENT_VERBOSE> |
2077 | =item C<PERL_ANYEVENT_VERBOSE> |
1987 | |
2078 | |
1988 | By default, AnyEvent will be completely silent except in fatal |
2079 | By default, AnyEvent will log messages with loglevel C<4> (C<error>) or |
1989 | conditions. You can set this environment variable to make AnyEvent more |
2080 | higher (see L<AnyEvent::Log>). You can set this environment variable to a |
1990 | talkative. |
2081 | numerical loglevel to make AnyEvent more (or less) talkative. |
1991 | |
2082 | |
|
|
2083 | If you want to do more than just set the global logging level |
|
|
2084 | you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more |
|
|
2085 | complex specifications. |
|
|
2086 | |
|
|
2087 | When set to C<0> (C<off>), then no messages whatsoever will be logged with |
|
|
2088 | everything else at defaults. |
|
|
2089 | |
1992 | When set to C<5> or higher, causes AnyEvent to warn about unexpected |
2090 | When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected |
1993 | conditions, such as not being able to load the event model specified by |
2091 | conditions, such as not being able to load the event model specified by |
1994 | C<PERL_ANYEVENT_MODEL>. |
2092 | C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this |
|
|
2093 | is the minimum recommended level for use during development. |
1995 | |
2094 | |
1996 | When set to C<7> or higher, cause AnyEvent to report to STDERR which event |
2095 | When set to C<7> or higher (info), AnyEvent reports which event model it |
1997 | model it chooses. |
2096 | chooses. |
1998 | |
2097 | |
1999 | When set to C<8> or higher, then AnyEvent will report extra information on |
2098 | When set to C<8> or higher (debug), then AnyEvent will report extra |
2000 | which optional modules it loads and how it implements certain features. |
2099 | information on which optional modules it loads and how it implements |
|
|
2100 | certain features. |
|
|
2101 | |
|
|
2102 | =item C<PERL_ANYEVENT_LOG> |
|
|
2103 | |
|
|
2104 | Accepts rather complex logging specifications. For example, you could log |
|
|
2105 | all C<debug> messages of some module to stderr, warnings and above to |
|
|
2106 | stderr, and errors and above to syslog, with: |
|
|
2107 | |
|
|
2108 | PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog |
|
|
2109 | |
|
|
2110 | For the rather extensive details, see L<AnyEvent::Log>. |
|
|
2111 | |
|
|
2112 | This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded, |
|
|
2113 | so will take effect even before AnyEvent has initialised itself. |
|
|
2114 | |
|
|
2115 | Note that specifying this environment variable causes the L<AnyEvent::Log> |
|
|
2116 | module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only |
|
|
2117 | using the latter saves a few hundred kB of memory unless a module |
|
|
2118 | explicitly needs the extra features of AnyEvent::Log. |
2001 | |
2119 | |
2002 | =item C<PERL_ANYEVENT_STRICT> |
2120 | =item C<PERL_ANYEVENT_STRICT> |
2003 | |
2121 | |
2004 | AnyEvent does not do much argument checking by default, as thorough |
2122 | AnyEvent does not do much argument checking by default, as thorough |
2005 | argument checking is very costly. Setting this variable to a true value |
2123 | argument checking is very costly. Setting this variable to a true value |
… | |
… | |
2014 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
2132 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
2015 | can be very useful, however. |
2133 | can be very useful, however. |
2016 | |
2134 | |
2017 | =item C<PERL_ANYEVENT_DEBUG_SHELL> |
2135 | =item C<PERL_ANYEVENT_DEBUG_SHELL> |
2018 | |
2136 | |
2019 | If this env variable is set, then its contents will be interpreted by |
2137 | If this env variable is nonempty, then its contents will be interpreted by |
2020 | C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of |
2138 | C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after |
2021 | C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on |
2139 | replacing every occurance of C<$$> by the process pid). The shell object |
2022 | that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. |
2140 | is saved in C<$AnyEvent::Debug::SHELL>. |
2023 | |
2141 | |
2024 | This takes place when the first watcher is created. |
2142 | This happens when the first watcher is created. |
2025 | |
2143 | |
2026 | For example, to bind a debug shell on a unix domain socket in |
2144 | For example, to bind a debug shell on a unix domain socket in |
2027 | F<< /tmp/debug<pid>.sock >>, you could use this: |
2145 | F<< /tmp/debug<pid>.sock >>, you could use this: |
2028 | |
2146 | |
2029 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
2147 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
|
|
2148 | # connect with e.g.: socat readline /tmp/debug123.sock |
2030 | |
2149 | |
|
|
2150 | Or to bind to tcp port 4545 on localhost: |
|
|
2151 | |
|
|
2152 | PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog |
|
|
2153 | # connect with e.g.: telnet localhost 4545 |
|
|
2154 | |
2031 | Note that creating sockets in F</tmp> is very unsafe on multiuser |
2155 | Note that creating sockets in F</tmp> or on localhost is very unsafe on |
2032 | systems. |
2156 | multiuser systems. |
2033 | |
2157 | |
2034 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
2158 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
2035 | |
2159 | |
2036 | Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for |
2160 | Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for |
2037 | debugging purposes. See C<AnyEvent::Debug::wrap> for details. |
2161 | debugging purposes. See C<AnyEvent::Debug::wrap> for details. |
… | |
… | |
2054 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
2178 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
2055 | could start your program like this: |
2179 | could start your program like this: |
2056 | |
2180 | |
2057 | PERL_ANYEVENT_MODEL=Perl perl ... |
2181 | PERL_ANYEVENT_MODEL=Perl perl ... |
2058 | |
2182 | |
|
|
2183 | =item C<PERL_ANYEVENT_IO_MODEL> |
|
|
2184 | |
|
|
2185 | The current file I/O model - see L<AnyEvent::IO> for more info. |
|
|
2186 | |
|
|
2187 | At the moment, only C<Perl> (small, pure-perl, synchronous) and |
|
|
2188 | C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if |
|
|
2189 | L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>. |
|
|
2190 | |
2059 | =item C<PERL_ANYEVENT_PROTOCOLS> |
2191 | =item C<PERL_ANYEVENT_PROTOCOLS> |
2060 | |
2192 | |
2061 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
2193 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
2062 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
2194 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
2063 | of auto probing). |
2195 | of auto probing). |
… | |
… | |
2075 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
2207 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
2076 | - only support IPv4, never try to resolve or contact IPv6 |
2208 | - only support IPv4, never try to resolve or contact IPv6 |
2077 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
2209 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
2078 | IPv6, but prefer IPv6 over IPv4. |
2210 | IPv6, but prefer IPv6 over IPv4. |
2079 | |
2211 | |
|
|
2212 | =item C<PERL_ANYEVENT_HOSTS> |
|
|
2213 | |
|
|
2214 | This variable, if specified, overrides the F</etc/hosts> file used by |
|
|
2215 | L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read |
|
|
2216 | from that file instead. |
|
|
2217 | |
2080 | =item C<PERL_ANYEVENT_EDNS0> |
2218 | =item C<PERL_ANYEVENT_EDNS0> |
2081 | |
2219 | |
2082 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
2220 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for |
2083 | for DNS. This extension is generally useful to reduce DNS traffic, but |
2221 | DNS. This extension is generally useful to reduce DNS traffic, especially |
2084 | some (broken) firewalls drop such DNS packets, which is why it is off by |
2222 | when DNSSEC is involved, but some (broken) firewalls drop such DNS |
2085 | default. |
2223 | packets, which is why it is off by default. |
2086 | |
2224 | |
2087 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
2225 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
2088 | EDNS0 in its DNS requests. |
2226 | EDNS0 in its DNS requests. |
2089 | |
2227 | |
2090 | =item C<PERL_ANYEVENT_MAX_FORKS> |
2228 | =item C<PERL_ANYEVENT_MAX_FORKS> |
… | |
… | |
2096 | |
2234 | |
2097 | The default value for the C<max_outstanding> parameter for the default DNS |
2235 | The default value for the C<max_outstanding> parameter for the default DNS |
2098 | resolver - this is the maximum number of parallel DNS requests that are |
2236 | resolver - this is the maximum number of parallel DNS requests that are |
2099 | sent to the DNS server. |
2237 | sent to the DNS server. |
2100 | |
2238 | |
|
|
2239 | =item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY> |
|
|
2240 | |
|
|
2241 | Perl has inherently racy signal handling (you can basically choose between |
|
|
2242 | losing signals and memory corruption) - pure perl event loops (including |
|
|
2243 | C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore |
|
|
2244 | have to poll regularly to avoid losing signals. |
|
|
2245 | |
|
|
2246 | Some event loops are racy, but don't poll regularly, and some event loops |
|
|
2247 | are written in C but are still racy. For those event loops, AnyEvent |
|
|
2248 | installs a timer that regularly wakes up the event loop. |
|
|
2249 | |
|
|
2250 | By default, the interval for this timer is C<10> seconds, but you can |
|
|
2251 | override this delay with this environment variable (or by setting |
|
|
2252 | the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal |
|
|
2253 | watchers). |
|
|
2254 | |
|
|
2255 | Lower values increase CPU (and energy) usage, higher values can introduce |
|
|
2256 | long delays when reaping children or waiting for signals. |
|
|
2257 | |
|
|
2258 | The L<AnyEvent::Async> module, if available, will be used to avoid this |
|
|
2259 | polling (with most event loops). |
|
|
2260 | |
2101 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
2261 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
2102 | |
2262 | |
2103 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
2263 | The absolute path to a F<resolv.conf>-style file to use instead of |
2104 | configuration) in the default resolver. When set to the empty string, no |
2264 | F</etc/resolv.conf> (or the OS-specific configuration) in the default |
2105 | default config will be used. |
2265 | resolver, or the empty string to select the default configuration. |
2106 | |
2266 | |
2107 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
2267 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
2108 | |
2268 | |
2109 | When neither C<ca_file> nor C<ca_path> was specified during |
2269 | When neither C<ca_file> nor C<ca_path> was specified during |
2110 | L<AnyEvent::TLS> context creation, and either of these environment |
2270 | L<AnyEvent::TLS> context creation, and either of these environment |
2111 | variables exist, they will be used to specify CA certificate locations |
2271 | variables are nonempty, they will be used to specify CA certificate |
2112 | instead of a system-dependent default. |
2272 | locations instead of a system-dependent default. |
2113 | |
2273 | |
2114 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2274 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2115 | |
2275 | |
2116 | When these are set to C<1>, then the respective modules are not |
2276 | When these are set to C<1>, then the respective modules are not |
2117 | loaded. Mostly good for testing AnyEvent itself. |
2277 | loaded. Mostly good for testing AnyEvent itself. |
… | |
… | |
2761 | This module is part of perl since release 5.008. It will be used when the |
2921 | This module is part of perl since release 5.008. It will be used when the |
2762 | chosen event library does not come with a timing source of its own. The |
2922 | chosen event library does not come with a timing source of its own. The |
2763 | pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to |
2923 | pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to |
2764 | try to use a monotonic clock for timing stability. |
2924 | try to use a monotonic clock for timing stability. |
2765 | |
2925 | |
|
|
2926 | =item L<AnyEvent::AIO> (and L<IO::AIO>) |
|
|
2927 | |
|
|
2928 | The default implementation of L<AnyEvent::IO> is to do I/O synchronously, |
|
|
2929 | stopping programs while they access the disk, which is fine for a lot of |
|
|
2930 | programs. |
|
|
2931 | |
|
|
2932 | Installing AnyEvent::AIO (and its IO::AIO dependency) makes it switch to |
|
|
2933 | a true asynchronous implementation, so event processing can continue even |
|
|
2934 | while waiting for disk I/O. |
|
|
2935 | |
2766 | =back |
2936 | =back |
2767 | |
2937 | |
2768 | |
2938 | |
2769 | =head1 FORK |
2939 | =head1 FORK |
2770 | |
2940 | |
… | |
… | |
2853 | L<AnyEvent::Impl::FLTK>. |
3023 | L<AnyEvent::Impl::FLTK>. |
2854 | |
3024 | |
2855 | Non-blocking handles, pipes, stream sockets, TCP clients and |
3025 | Non-blocking handles, pipes, stream sockets, TCP clients and |
2856 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
3026 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2857 | |
3027 | |
|
|
3028 | Asynchronous File I/O: L<AnyEvent::IO>. |
|
|
3029 | |
2858 | Asynchronous DNS: L<AnyEvent::DNS>. |
3030 | Asynchronous DNS: L<AnyEvent::DNS>. |
2859 | |
3031 | |
2860 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
3032 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
2861 | |
3033 | |
2862 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>, |
3034 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>, |
… | |
… | |
2864 | |
3036 | |
2865 | |
3037 | |
2866 | =head1 AUTHOR |
3038 | =head1 AUTHOR |
2867 | |
3039 | |
2868 | Marc Lehmann <schmorp@schmorp.de> |
3040 | Marc Lehmann <schmorp@schmorp.de> |
2869 | http://home.schmorp.de/ |
3041 | http://anyevent.schmorp.de |
2870 | |
3042 | |
2871 | =cut |
3043 | =cut |
2872 | |
3044 | |
2873 | 1 |
3045 | 1 |
2874 | |
3046 | |