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 | |
… | |
… | |
121 | The interface itself is vaguely similar, but not identical to the L<Event> |
121 | The interface itself is vaguely similar, but not identical to the L<Event> |
122 | module. |
122 | module. |
123 | |
123 | |
124 | During the first call of any watcher-creation method, the module tries |
124 | During the first call of any watcher-creation method, the module tries |
125 | to detect the currently loaded event loop by probing whether one of the |
125 | to detect the currently loaded event loop by probing whether one of the |
126 | following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>, |
126 | following modules is already loaded: L<EV>, L<AnyEvent::Loop>, |
127 | L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one |
127 | L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one |
128 | found is used. If none are detected, the module tries to load the first |
128 | found is used. If none are detected, the module tries to load the first |
129 | four modules in the order given; but note that if L<EV> is not |
129 | four modules in the order given; but note that if L<EV> is not |
130 | available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so |
130 | available, the pure-perl L<AnyEvent::Loop> should always work, so |
131 | the other two are not normally tried. |
131 | the other two are not normally tried. |
132 | |
132 | |
133 | Because AnyEvent first checks for modules that are already loaded, loading |
133 | Because AnyEvent first checks for modules that are already loaded, loading |
134 | an event model explicitly before first using AnyEvent will likely make |
134 | an event model explicitly before first using AnyEvent will likely make |
135 | that model the default. For example: |
135 | that model the default. For example: |
… | |
… | |
142 | The I<likely> means that, if any module loads another event model and |
142 | The I<likely> means that, if any module loads another event model and |
143 | starts using it, all bets are off - this case should be very rare though, |
143 | starts using it, all bets are off - this case should be very rare though, |
144 | as very few modules hardcode event loops without announcing this very |
144 | as very few modules hardcode event loops without announcing this very |
145 | loudly. |
145 | loudly. |
146 | |
146 | |
147 | The pure-perl implementation of AnyEvent is called |
147 | The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like |
148 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
148 | other event modules you can load it explicitly and enjoy the high |
149 | explicitly and enjoy the high availability of that event loop :) |
149 | availability of that event loop :) |
150 | |
150 | |
151 | =head1 WATCHERS |
151 | =head1 WATCHERS |
152 | |
152 | |
153 | AnyEvent has the central concept of a I<watcher>, which is an object that |
153 | AnyEvent has the central concept of a I<watcher>, which is an object that |
154 | stores relevant data for each kind of event you are waiting for, such as |
154 | stores relevant data for each kind of event you are waiting for, such as |
… | |
… | |
356 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
356 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
357 | account. |
357 | account. |
358 | |
358 | |
359 | =item AnyEvent->now_update |
359 | =item AnyEvent->now_update |
360 | |
360 | |
361 | Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache |
361 | Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current |
362 | the current time for each loop iteration (see the discussion of L<< |
362 | time for each loop iteration (see the discussion of L<< AnyEvent->now >>, |
363 | AnyEvent->now >>, above). |
363 | above). |
364 | |
364 | |
365 | When a callback runs for a long time (or when the process sleeps), then |
365 | When a callback runs for a long time (or when the process sleeps), then |
366 | this "current" time will differ substantially from the real time, which |
366 | this "current" time will differ substantially from the real time, which |
367 | might affect timers and time-outs. |
367 | might affect timers and time-outs. |
368 | |
368 | |
… | |
… | |
482 | thing in an AnyEvent program, you I<have> to create at least one |
482 | thing in an AnyEvent program, you I<have> to create at least one |
483 | watcher before you C<fork> the child (alternatively, you can call |
483 | watcher before you C<fork> the child (alternatively, you can call |
484 | C<AnyEvent::detect>). |
484 | C<AnyEvent::detect>). |
485 | |
485 | |
486 | As most event loops do not support waiting for child events, they will be |
486 | As most event loops do not support waiting for child events, they will be |
487 | emulated by AnyEvent in most cases, in which the latency and race problems |
487 | emulated by AnyEvent in most cases, in which case the latency and race |
488 | mentioned in the description of signal watchers apply. |
488 | problems mentioned in the description of signal watchers apply. |
489 | |
489 | |
490 | Example: fork a process and wait for it |
490 | Example: fork a process and wait for it |
491 | |
491 | |
492 | my $done = AnyEvent->condvar; |
492 | my $done = AnyEvent->condvar; |
493 | |
493 | |
… | |
… | |
860 | use. If EV is not installed, then AnyEvent will fall back to its own |
860 | use. If EV is not installed, then AnyEvent will fall back to its own |
861 | pure-perl implementation, which is available everywhere as it comes with |
861 | pure-perl implementation, which is available everywhere as it comes with |
862 | AnyEvent itself. |
862 | AnyEvent itself. |
863 | |
863 | |
864 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
864 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
865 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
865 | AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable. |
866 | |
866 | |
867 | =item Backends that are transparently being picked up when they are used. |
867 | =item Backends that are transparently being picked up when they are used. |
868 | |
868 | |
869 | These will be used if they are already loaded when the first watcher |
869 | These will be used if they are already loaded when the first watcher |
870 | is created, in which case it is assumed that the application is using |
870 | is created, in which case it is assumed that the application is using |
… | |
… | |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
880 | AnyEvent::Impl::Irssi used when running within irssi. |
880 | AnyEvent::Impl::Irssi used when running within irssi. |
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
881 | AnyEvent::Impl::IOAsync based on IO::Async. |
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
|
|
883 | AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). |
883 | |
884 | |
884 | =item Backends with special needs. |
885 | =item Backends with special needs. |
885 | |
886 | |
886 | Qt requires the Qt::Application to be instantiated first, but will |
887 | Qt requires the Qt::Application to be instantiated first, but will |
887 | otherwise be picked up automatically. As long as the main program |
888 | otherwise be picked up automatically. As long as the main program |
… | |
… | |
932 | |
933 | |
933 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
934 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
934 | if necessary. You should only call this function right before you would |
935 | if necessary. You should only call this function right before you would |
935 | have created an AnyEvent watcher anyway, that is, as late as possible at |
936 | have created an AnyEvent watcher anyway, that is, as late as possible at |
936 | runtime, and not e.g. during initialisation of your module. |
937 | runtime, and not e.g. during initialisation of your module. |
|
|
938 | |
|
|
939 | The effect of calling this function is as if a watcher had been created |
|
|
940 | (specifically, actions that happen "when the first watcher is created" |
|
|
941 | happen when calling detetc as well). |
937 | |
942 | |
938 | If you need to do some initialisation before AnyEvent watchers are |
943 | If you need to do some initialisation before AnyEvent watchers are |
939 | created, use C<post_detect>. |
944 | created, use C<post_detect>. |
940 | |
945 | |
941 | =item $guard = AnyEvent::post_detect { BLOCK } |
946 | =item $guard = AnyEvent::post_detect { BLOCK } |
… | |
… | |
1004 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
1009 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
1005 | # as soon as it is |
1010 | # as soon as it is |
1006 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
1011 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
1007 | } |
1012 | } |
1008 | |
1013 | |
|
|
1014 | =item AnyEvent::postpone { BLOCK } |
|
|
1015 | |
|
|
1016 | Arranges for the block to be executed as soon as possible, but not before |
|
|
1017 | the call itself returns. In practise, the block will be executed just |
|
|
1018 | before the event loop polls for new events, or shortly afterwards. |
|
|
1019 | |
|
|
1020 | This function never returns anything (to make the C<return postpone { ... |
|
|
1021 | }> idiom more useful. |
|
|
1022 | |
|
|
1023 | To understand the usefulness of this function, consider a function that |
|
|
1024 | asynchronously does something for you and returns some transaction |
|
|
1025 | object or guard to let you cancel the operation. For example, |
|
|
1026 | C<AnyEvent::Socket::tcp_connect>: |
|
|
1027 | |
|
|
1028 | # start a conenction attempt unless one is active |
|
|
1029 | $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub { |
|
|
1030 | delete $self->{connect_guard}; |
|
|
1031 | ... |
|
|
1032 | }; |
|
|
1033 | |
|
|
1034 | Imagine that this function could instantly call the callback, for |
|
|
1035 | example, because it detects an obvious error such as a negative port |
|
|
1036 | number. Invoking the callback before the function returns causes problems |
|
|
1037 | however: the callback will be called and will try to delete the guard |
|
|
1038 | object. But since the function hasn't returned yet, there is nothing to |
|
|
1039 | delete. When the function eventually returns it will assign the guard |
|
|
1040 | object to C<< $self->{connect_guard} >>, where it will likely never be |
|
|
1041 | deleted, so the program thinks it is still trying to connect. |
|
|
1042 | |
|
|
1043 | This is where C<AnyEvent::postpone> should be used. Instead of calling the |
|
|
1044 | callback directly on error: |
|
|
1045 | |
|
|
1046 | $cb->(undef), return # signal error to callback, BAD! |
|
|
1047 | if $some_error_condition; |
|
|
1048 | |
|
|
1049 | It should use C<postpone>: |
|
|
1050 | |
|
|
1051 | AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later |
|
|
1052 | if $some_error_condition; |
|
|
1053 | |
|
|
1054 | =item AnyEvent::log $level, $msg[, @args] |
|
|
1055 | |
|
|
1056 | Log the given C<$msg> at the given C<$level>. |
|
|
1057 | |
|
|
1058 | Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> - |
|
|
1059 | consequently, look at the L<AnyEvent::Log> documentation for details. |
|
|
1060 | |
|
|
1061 | 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. |
|
|
1063 | |
1009 | =back |
1064 | =back |
1010 | |
1065 | |
1011 | =head1 WHAT TO DO IN A MODULE |
1066 | =head1 WHAT TO DO IN A MODULE |
1012 | |
1067 | |
1013 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
1068 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
1046 | modules might create watchers when they are loaded, and AnyEvent will |
1101 | modules might create watchers when they are loaded, and AnyEvent will |
1047 | decide on the event model to use as soon as it creates watchers, and it |
1102 | decide on the event model to use as soon as it creates watchers, and it |
1048 | might choose the wrong one unless you load the correct one yourself. |
1103 | might choose the wrong one unless you load the correct one yourself. |
1049 | |
1104 | |
1050 | You can chose to use a pure-perl implementation by loading the |
1105 | You can chose to use a pure-perl implementation by loading the |
1051 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
1106 | C<AnyEvent::Loop> module, which gives you similar behaviour |
1052 | everywhere, but letting AnyEvent chose the model is generally better. |
1107 | everywhere, but letting AnyEvent chose the model is generally better. |
1053 | |
1108 | |
1054 | =head2 MAINLOOP EMULATION |
1109 | =head2 MAINLOOP EMULATION |
1055 | |
1110 | |
1056 | Sometimes (often for short test scripts, or even standalone programs who |
1111 | Sometimes (often for short test scripts, or even standalone programs who |
… | |
… | |
1069 | |
1124 | |
1070 | |
1125 | |
1071 | =head1 OTHER MODULES |
1126 | =head1 OTHER MODULES |
1072 | |
1127 | |
1073 | The following is a non-exhaustive list of additional modules that use |
1128 | The following is a non-exhaustive list of additional modules that use |
1074 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
1129 | AnyEvent as a client and can therefore be mixed easily with other |
1075 | modules and other event loops in the same program. Some of the modules |
1130 | AnyEvent modules and other event loops in the same program. Some of the |
1076 | come as part of AnyEvent, the others are available via CPAN. |
1131 | modules come as part of AnyEvent, the others are available via CPAN (see |
|
|
1132 | L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for |
|
|
1133 | a longer non-exhaustive list), and the list is heavily biased towards |
|
|
1134 | modules of the AnyEvent author himself :) |
1077 | |
1135 | |
1078 | =over 4 |
1136 | =over 4 |
1079 | |
1137 | |
1080 | =item L<AnyEvent::Util> |
1138 | =item L<AnyEvent::Util> |
1081 | |
1139 | |
… | |
… | |
1151 | |
1209 | |
1152 | package AnyEvent; |
1210 | package AnyEvent; |
1153 | |
1211 | |
1154 | # basically a tuned-down version of common::sense |
1212 | # basically a tuned-down version of common::sense |
1155 | sub common_sense { |
1213 | sub common_sense { |
1156 | # from common:.sense 3.3 |
1214 | # from common:.sense 3.4 |
1157 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; |
1215 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; |
1158 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1216 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1159 | $^H |= 0x00000600; |
1217 | $^H |= 0x00000600; |
1160 | } |
1218 | } |
1161 | |
1219 | |
1162 | BEGIN { AnyEvent::common_sense } |
1220 | BEGIN { AnyEvent::common_sense } |
1163 | |
1221 | |
1164 | use Carp (); |
1222 | use Carp (); |
1165 | |
1223 | |
1166 | our $VERSION = '5.29'; |
1224 | our $VERSION = '6.01'; |
1167 | our $MODEL; |
1225 | our $MODEL; |
1168 | |
1226 | |
1169 | our $AUTOLOAD; |
|
|
1170 | our @ISA; |
1227 | our @ISA; |
1171 | |
1228 | |
1172 | our @REGISTRY; |
1229 | our @REGISTRY; |
1173 | |
1230 | |
1174 | our $VERBOSE; |
1231 | our $VERBOSE; |
… | |
… | |
1179 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1236 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1180 | |
1237 | |
1181 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1238 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1182 | if ${^TAINT}; |
1239 | if ${^TAINT}; |
1183 | |
1240 | |
|
|
1241 | $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"} |
|
|
1242 | for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV; |
|
|
1243 | |
|
|
1244 | @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = () |
|
|
1245 | if ${^TAINT}; |
|
|
1246 | |
1184 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1247 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1185 | |
|
|
1186 | } |
1248 | } |
1187 | |
1249 | |
1188 | our $MAX_SIGNAL_LATENCY = 10; |
1250 | our $MAX_SIGNAL_LATENCY = 10; |
1189 | |
1251 | |
1190 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1252 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
… | |
… | |
1194 | $PROTOCOL{$_} = ++$idx |
1256 | $PROTOCOL{$_} = ++$idx |
1195 | for reverse split /\s*,\s*/, |
1257 | for reverse split /\s*,\s*/, |
1196 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1258 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1197 | } |
1259 | } |
1198 | |
1260 | |
|
|
1261 | our @post_detect; |
|
|
1262 | |
|
|
1263 | sub post_detect(&) { |
|
|
1264 | my ($cb) = @_; |
|
|
1265 | |
|
|
1266 | push @post_detect, $cb; |
|
|
1267 | |
|
|
1268 | defined wantarray |
|
|
1269 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1270 | : () |
|
|
1271 | } |
|
|
1272 | |
|
|
1273 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1274 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1275 | } |
|
|
1276 | |
|
|
1277 | our $POSTPONE_W; |
|
|
1278 | our @POSTPONE; |
|
|
1279 | |
|
|
1280 | sub _postpone_exec { |
|
|
1281 | undef $POSTPONE_W; |
|
|
1282 | |
|
|
1283 | &{ shift @POSTPONE } |
|
|
1284 | while @POSTPONE; |
|
|
1285 | } |
|
|
1286 | |
|
|
1287 | sub postpone(&) { |
|
|
1288 | push @POSTPONE, shift; |
|
|
1289 | |
|
|
1290 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
|
|
1291 | |
|
|
1292 | () |
|
|
1293 | } |
|
|
1294 | |
|
|
1295 | sub log($$;@) { |
|
|
1296 | # only load the bug bloated module when we actually are about to log something |
|
|
1297 | if ($_[0] <= $VERBOSE) { |
|
|
1298 | require AnyEvent::Log; |
|
|
1299 | # AnyEvent::Log overwrites this function |
|
|
1300 | goto &log; |
|
|
1301 | } |
|
|
1302 | } |
|
|
1303 | |
|
|
1304 | if (length $ENV{PERL_ANYEVENT_LOG}) { |
|
|
1305 | require AnyEvent::Log; # AnyEvent::Log does the thing for us |
|
|
1306 | } |
|
|
1307 | |
1199 | my @models = ( |
1308 | our @models = ( |
1200 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1309 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1201 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1310 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1202 | # everything below here will not (normally) be autoprobed |
1311 | # everything below here will not (normally) be autoprobed |
1203 | # as the pureperl backend should work everywhere |
1312 | # as the pure perl backend should work everywhere |
1204 | # and is usually faster |
1313 | # and is usually faster |
1205 | [Event:: => AnyEvent::Impl::Event::, 1], |
1314 | [Event:: => AnyEvent::Impl::Event::, 1], |
1206 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1315 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1207 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1316 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1208 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1317 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1209 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1318 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1210 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1319 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1211 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1320 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1212 | [Wx:: => AnyEvent::Impl::POE::], |
1321 | [Wx:: => AnyEvent::Impl::POE::], |
1213 | [Prima:: => AnyEvent::Impl::POE::], |
1322 | [Prima:: => AnyEvent::Impl::POE::], |
1214 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], |
1323 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
1215 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1324 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
|
|
1325 | [FLTK:: => AnyEvent::Impl::FLTK2::], |
1216 | ); |
1326 | ); |
1217 | |
1327 | |
1218 | our %method = map +($_ => 1), |
1328 | our @isa_hook; |
|
|
1329 | |
|
|
1330 | sub _isa_set { |
|
|
1331 | my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL); |
|
|
1332 | |
|
|
1333 | @{"$pkg[$_-1]::ISA"} = $pkg[$_] |
|
|
1334 | for 1 .. $#pkg; |
|
|
1335 | |
|
|
1336 | grep $_ && $_->[1], @isa_hook |
|
|
1337 | and AE::_reset (); |
|
|
1338 | } |
|
|
1339 | |
|
|
1340 | # used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy |
|
|
1341 | sub _isa_hook($$;$) { |
|
|
1342 | my ($i, $pkg, $reset_ae) = @_; |
|
|
1343 | |
|
|
1344 | $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef; |
|
|
1345 | |
|
|
1346 | _isa_set; |
|
|
1347 | } |
|
|
1348 | |
|
|
1349 | # all autoloaded methods reserve the complete glob, not just the method slot. |
|
|
1350 | # due to bugs in perls method cache implementation. |
1219 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1351 | our @methods = qw(io timer time now now_update signal child idle condvar); |
1220 | |
|
|
1221 | our @post_detect; |
|
|
1222 | |
|
|
1223 | sub post_detect(&) { |
|
|
1224 | my ($cb) = @_; |
|
|
1225 | |
|
|
1226 | push @post_detect, $cb; |
|
|
1227 | |
|
|
1228 | defined wantarray |
|
|
1229 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1230 | : () |
|
|
1231 | } |
|
|
1232 | |
|
|
1233 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1234 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1235 | } |
|
|
1236 | |
1352 | |
1237 | sub detect() { |
1353 | sub detect() { |
|
|
1354 | return $MODEL if $MODEL; # some programs keep references to detect |
|
|
1355 | |
|
|
1356 | local $!; # for good measure |
|
|
1357 | local $SIG{__DIE__}; # we use eval |
|
|
1358 | |
1238 | # free some memory |
1359 | # free some memory |
1239 | *detect = sub () { $MODEL }; |
1360 | *detect = sub () { $MODEL }; |
|
|
1361 | # undef &func doesn't correctly update the method cache. grmbl. |
|
|
1362 | # so we delete the whole glob. grmbl. |
|
|
1363 | # otoh, perl doesn't let me undef an active usb, but it lets me free |
|
|
1364 | # a glob with an active sub. hrm. i hope it works, but perl is |
|
|
1365 | # usually buggy in this department. sigh. |
|
|
1366 | delete @{"AnyEvent::"}{@methods}; |
|
|
1367 | undef @methods; |
1240 | |
1368 | |
1241 | local $!; # for good measure |
|
|
1242 | local $SIG{__DIE__}; |
|
|
1243 | |
|
|
1244 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1369 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1245 | my $model = "AnyEvent::Impl::$1"; |
1370 | my $model = $1; |
|
|
1371 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1246 | if (eval "require $model") { |
1372 | if (eval "require $model") { |
|
|
1373 | AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."; |
1247 | $MODEL = $model; |
1374 | $MODEL = $model; |
1248 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
|
|
1249 | } else { |
1375 | } else { |
1250 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1376 | AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; |
1251 | } |
1377 | } |
1252 | } |
1378 | } |
1253 | |
1379 | |
1254 | # check for already loaded models |
1380 | # check for already loaded models |
1255 | unless ($MODEL) { |
1381 | unless ($MODEL) { |
1256 | for (@REGISTRY, @models) { |
1382 | for (@REGISTRY, @models) { |
1257 | my ($package, $model) = @$_; |
1383 | my ($package, $model) = @$_; |
1258 | if (${"$package\::VERSION"} > 0) { |
1384 | if (${"$package\::VERSION"} > 0) { |
1259 | if (eval "require $model") { |
1385 | if (eval "require $model") { |
|
|
1386 | AnyEvent::log 7 => "autodetected model '$model', using it."; |
1260 | $MODEL = $model; |
1387 | $MODEL = $model; |
1261 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1262 | last; |
1388 | last; |
1263 | } |
1389 | } |
1264 | } |
1390 | } |
1265 | } |
1391 | } |
1266 | |
1392 | |
… | |
… | |
1272 | $autoload |
1398 | $autoload |
1273 | and eval "require $package" |
1399 | and eval "require $package" |
1274 | and ${"$package\::VERSION"} > 0 |
1400 | and ${"$package\::VERSION"} > 0 |
1275 | and eval "require $model" |
1401 | and eval "require $model" |
1276 | ) { |
1402 | ) { |
|
|
1403 | AnyEvent::log 7 => "autoloaded model '$model', using it."; |
1277 | $MODEL = $model; |
1404 | $MODEL = $model; |
1278 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1279 | last; |
1405 | last; |
1280 | } |
1406 | } |
1281 | } |
1407 | } |
1282 | |
1408 | |
1283 | $MODEL |
1409 | $MODEL |
1284 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; |
1410 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; |
1285 | } |
1411 | } |
1286 | } |
1412 | } |
1287 | |
1413 | |
1288 | @models = (); # free probe data |
1414 | # free memory only needed for probing |
|
|
1415 | undef @models; |
|
|
1416 | undef @REGISTRY; |
1289 | |
1417 | |
1290 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1418 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1291 | unshift @ISA, $MODEL; |
|
|
1292 | |
1419 | |
1293 | # now nuke some methods that are overridden by the backend. |
1420 | # now nuke some methods that are overridden by the backend. |
1294 | # SUPER is not allowed. |
1421 | # SUPER usage is not allowed in these. |
1295 | for (qw(time signal child idle)) { |
1422 | for (qw(time signal child idle)) { |
1296 | undef &{"AnyEvent::Base::$_"} |
1423 | undef &{"AnyEvent::Base::$_"} |
1297 | if defined &{"$MODEL\::$_"}; |
1424 | if defined &{"$MODEL\::$_"}; |
1298 | } |
1425 | } |
1299 | |
1426 | |
|
|
1427 | _isa_set; |
|
|
1428 | |
|
|
1429 | # we're officially open! |
|
|
1430 | |
1300 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1431 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
1301 | eval { require AnyEvent::Strict }; |
1432 | require AnyEvent::Strict; |
1302 | warn "AnyEvent: cannot load AnyEvent::Strict: $@" |
|
|
1303 | if $@ && $VERBOSE; |
|
|
1304 | } |
1433 | } |
1305 | |
1434 | |
|
|
1435 | if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { |
|
|
1436 | require AnyEvent::Debug; |
|
|
1437 | AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); |
|
|
1438 | } |
|
|
1439 | |
|
|
1440 | if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { |
|
|
1441 | require AnyEvent::Socket; |
|
|
1442 | require AnyEvent::Debug; |
|
|
1443 | |
|
|
1444 | my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; |
|
|
1445 | $shell =~ s/\$\$/$$/g; |
|
|
1446 | |
|
|
1447 | my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); |
|
|
1448 | $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); |
|
|
1449 | } |
|
|
1450 | |
|
|
1451 | # now the anyevent environment is set up as the user told us to, so |
|
|
1452 | # call the actual user code - post detects |
|
|
1453 | |
1306 | (shift @post_detect)->() while @post_detect; |
1454 | (shift @post_detect)->() while @post_detect; |
|
|
1455 | undef @post_detect; |
1307 | |
1456 | |
1308 | *post_detect = sub(&) { |
1457 | *post_detect = sub(&) { |
1309 | shift->(); |
1458 | shift->(); |
1310 | |
1459 | |
1311 | undef |
1460 | undef |
1312 | }; |
1461 | }; |
1313 | |
1462 | |
1314 | $MODEL |
1463 | $MODEL |
1315 | } |
1464 | } |
1316 | |
1465 | |
1317 | sub AUTOLOAD { |
1466 | for my $name (@methods) { |
1318 | (my $func = $AUTOLOAD) =~ s/.*://; |
1467 | *$name = sub { |
1319 | |
|
|
1320 | $method{$func} |
|
|
1321 | or Carp::croak "$func: not a valid AnyEvent class method"; |
|
|
1322 | |
|
|
1323 | detect; |
1468 | detect; |
1324 | |
1469 | # we use goto because |
1325 | my $class = shift; |
1470 | # a) it makes the thunk more transparent |
1326 | $class->$func (@_); |
1471 | # b) it allows us to delete the thunk later |
|
|
1472 | goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" } |
|
|
1473 | }; |
1327 | } |
1474 | } |
1328 | |
1475 | |
1329 | # utility function to dup a filehandle. this is used by many backends |
1476 | # utility function to dup a filehandle. this is used by many backends |
1330 | # to support binding more than one watcher per filehandle (they usually |
1477 | # to support binding more than one watcher per filehandle (they usually |
1331 | # allow only one watcher per fd, so we dup it to get a different one). |
1478 | # allow only one watcher per fd, so we dup it to get a different one). |
… | |
… | |
1355 | |
1502 | |
1356 | package AE; |
1503 | package AE; |
1357 | |
1504 | |
1358 | our $VERSION = $AnyEvent::VERSION; |
1505 | our $VERSION = $AnyEvent::VERSION; |
1359 | |
1506 | |
|
|
1507 | sub _reset() { |
|
|
1508 | eval q{ |
1360 | # fall back to the main API by default - backends and AnyEvent::Base |
1509 | # fall back to the main API by default - backends and AnyEvent::Base |
1361 | # implementations can overwrite these. |
1510 | # implementations can overwrite these. |
1362 | |
1511 | |
1363 | sub io($$$) { |
1512 | sub io($$$) { |
1364 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1513 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1365 | } |
1514 | } |
1366 | |
1515 | |
1367 | sub timer($$$) { |
1516 | sub timer($$$) { |
1368 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
1517 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
1369 | } |
1518 | } |
1370 | |
1519 | |
1371 | sub signal($$) { |
1520 | sub signal($$) { |
1372 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
1521 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
1373 | } |
1522 | } |
1374 | |
1523 | |
1375 | sub child($$) { |
1524 | sub child($$) { |
1376 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1525 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1377 | } |
1526 | } |
1378 | |
1527 | |
1379 | sub idle($) { |
1528 | sub idle($) { |
1380 | AnyEvent->idle (cb => $_[0]) |
1529 | AnyEvent->idle (cb => $_[0]); |
1381 | } |
1530 | } |
1382 | |
1531 | |
1383 | sub cv(;&) { |
1532 | sub cv(;&) { |
1384 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1533 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1385 | } |
1534 | } |
1386 | |
1535 | |
1387 | sub now() { |
1536 | sub now() { |
1388 | AnyEvent->now |
1537 | AnyEvent->now |
1389 | } |
1538 | } |
1390 | |
1539 | |
1391 | sub now_update() { |
1540 | sub now_update() { |
1392 | AnyEvent->now_update |
1541 | AnyEvent->now_update |
1393 | } |
1542 | } |
1394 | |
1543 | |
1395 | sub time() { |
1544 | sub time() { |
1396 | AnyEvent->time |
1545 | AnyEvent->time |
|
|
1546 | } |
|
|
1547 | |
|
|
1548 | *postpone = \&AnyEvent::postpone; |
|
|
1549 | *log = \&AnyEvent::log; |
|
|
1550 | }; |
|
|
1551 | die if $@; |
1397 | } |
1552 | } |
|
|
1553 | |
|
|
1554 | BEGIN { _reset } |
1398 | |
1555 | |
1399 | package AnyEvent::Base; |
1556 | package AnyEvent::Base; |
1400 | |
1557 | |
1401 | # default implementations for many methods |
1558 | # default implementations for many methods |
1402 | |
1559 | |
1403 | sub time { |
1560 | sub time { |
1404 | eval q{ # poor man's autoloading {} |
1561 | eval q{ # poor man's autoloading {} |
1405 | # probe for availability of Time::HiRes |
1562 | # probe for availability of Time::HiRes |
1406 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1563 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1407 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1564 | AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy." |
|
|
1565 | if $AnyEvent::VERBOSE >= 8; |
|
|
1566 | *time = sub { Time::HiRes::time () }; |
1408 | *AE::time = \&Time::HiRes::time; |
1567 | *AE::time = \& Time::HiRes::time ; |
1409 | # if (eval "use POSIX (); (POSIX::times())... |
1568 | # if (eval "use POSIX (); (POSIX::times())... |
1410 | } else { |
1569 | } else { |
1411 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1570 | AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!"; |
|
|
1571 | *time = sub { CORE::time }; |
1412 | *AE::time = sub (){ time }; # epic fail |
1572 | *AE::time = sub (){ CORE::time }; |
1413 | } |
1573 | } |
1414 | |
1574 | |
1415 | *time = sub { AE::time }; # different prototypes |
1575 | *now = \&time; |
1416 | }; |
1576 | }; |
1417 | die if $@; |
1577 | die if $@; |
1418 | |
1578 | |
1419 | &time |
1579 | &time |
1420 | } |
1580 | } |
1421 | |
1581 | |
1422 | *now = \&time; |
1582 | *now = \&time; |
1423 | |
|
|
1424 | sub now_update { } |
1583 | sub now_update { } |
1425 | |
1584 | |
|
|
1585 | sub _poll { |
|
|
1586 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
|
|
1587 | } |
|
|
1588 | |
1426 | # default implementation for ->condvar |
1589 | # default implementation for ->condvar |
|
|
1590 | # in fact, the default should not be overwritten |
1427 | |
1591 | |
1428 | sub condvar { |
1592 | sub condvar { |
1429 | eval q{ # poor man's autoloading {} |
1593 | eval q{ # poor man's autoloading {} |
1430 | *condvar = sub { |
1594 | *condvar = sub { |
1431 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1595 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
… | |
… | |
1509 | |
1673 | |
1510 | sub signal { |
1674 | sub signal { |
1511 | eval q{ # poor man's autoloading {} |
1675 | eval q{ # poor man's autoloading {} |
1512 | # probe for availability of Async::Interrupt |
1676 | # probe for availability of Async::Interrupt |
1513 | if (_have_async_interrupt) { |
1677 | if (_have_async_interrupt) { |
1514 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1678 | AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling." |
|
|
1679 | if $AnyEvent::VERBOSE >= 8; |
1515 | |
1680 | |
1516 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1681 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1517 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1682 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1518 | |
1683 | |
1519 | } else { |
1684 | } else { |
1520 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1685 | AnyEvent::log 8 => "using emulated perl signal handling with latency timer." |
|
|
1686 | if $AnyEvent::VERBOSE >= 8; |
1521 | |
1687 | |
1522 | if (AnyEvent::WIN32) { |
1688 | if (AnyEvent::WIN32) { |
1523 | require AnyEvent::Util; |
1689 | require AnyEvent::Util; |
1524 | |
1690 | |
1525 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1691 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
… | |
… | |
1601 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1767 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1602 | |
1768 | |
1603 | while (%SIG_EV) { |
1769 | while (%SIG_EV) { |
1604 | for (keys %SIG_EV) { |
1770 | for (keys %SIG_EV) { |
1605 | delete $SIG_EV{$_}; |
1771 | delete $SIG_EV{$_}; |
1606 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1772 | &$_ for values %{ $SIG_CB{$_} || {} }; |
1607 | } |
1773 | } |
1608 | } |
1774 | } |
1609 | }; |
1775 | }; |
1610 | }; |
1776 | }; |
1611 | die if $@; |
1777 | die if $@; |
… | |
… | |
1638 | }; |
1804 | }; |
1639 | |
1805 | |
1640 | *child = sub { |
1806 | *child = sub { |
1641 | my (undef, %arg) = @_; |
1807 | my (undef, %arg) = @_; |
1642 | |
1808 | |
1643 | defined (my $pid = $arg{pid} + 0) |
1809 | my $pid = $arg{pid}; |
1644 | or Carp::croak "required option 'pid' is missing"; |
1810 | my $cb = $arg{cb}; |
1645 | |
1811 | |
1646 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1812 | $PID_CB{$pid}{$cb+0} = $cb; |
1647 | |
1813 | |
1648 | unless ($CHLD_W) { |
1814 | unless ($CHLD_W) { |
1649 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1815 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1650 | # child could be a zombie already, so make at least one round |
1816 | # child could be a zombie already, so make at least one round |
1651 | &_sigchld; |
1817 | &_sigchld; |
1652 | } |
1818 | } |
1653 | |
1819 | |
1654 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1820 | bless [$pid, $cb+0], "AnyEvent::Base::child" |
1655 | }; |
1821 | }; |
1656 | |
1822 | |
1657 | *AnyEvent::Base::child::DESTROY = sub { |
1823 | *AnyEvent::Base::child::DESTROY = sub { |
1658 | my ($pid, $cb) = @{$_[0]}; |
1824 | my ($pid, $icb) = @{$_[0]}; |
1659 | |
1825 | |
1660 | delete $PID_CB{$pid}{$cb}; |
1826 | delete $PID_CB{$pid}{$icb}; |
1661 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1827 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1662 | |
1828 | |
1663 | undef $CHLD_W unless keys %PID_CB; |
1829 | undef $CHLD_W unless keys %PID_CB; |
1664 | }; |
1830 | }; |
1665 | }; |
1831 | }; |
… | |
… | |
1678 | |
1844 | |
1679 | my ($cb, $w, $rcb) = $arg{cb}; |
1845 | my ($cb, $w, $rcb) = $arg{cb}; |
1680 | |
1846 | |
1681 | $rcb = sub { |
1847 | $rcb = sub { |
1682 | if ($cb) { |
1848 | if ($cb) { |
1683 | $w = _time; |
1849 | $w = AE::time; |
1684 | &$cb; |
1850 | &$cb; |
1685 | $w = _time - $w; |
1851 | $w = AE::time - $w; |
1686 | |
1852 | |
1687 | # never use more then 50% of the time for the idle watcher, |
1853 | # never use more then 50% of the time for the idle watcher, |
1688 | # within some limits |
1854 | # within some limits |
1689 | $w = 0.0001 if $w < 0.0001; |
1855 | $w = 0.0001 if $w < 0.0001; |
1690 | $w = 5 if $w > 5; |
1856 | $w = 5 if $w > 5; |
… | |
… | |
1737 | |
1903 | |
1738 | sub _send { |
1904 | sub _send { |
1739 | # nop |
1905 | # nop |
1740 | } |
1906 | } |
1741 | |
1907 | |
|
|
1908 | sub _wait { |
|
|
1909 | AnyEvent->_poll until $_[0]{_ae_sent}; |
|
|
1910 | } |
|
|
1911 | |
1742 | sub send { |
1912 | sub send { |
1743 | my $cv = shift; |
1913 | my $cv = shift; |
1744 | $cv->{_ae_sent} = [@_]; |
1914 | $cv->{_ae_sent} = [@_]; |
1745 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
1915 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
1746 | $cv->_send; |
1916 | $cv->_send; |
… | |
… | |
1753 | |
1923 | |
1754 | sub ready { |
1924 | sub ready { |
1755 | $_[0]{_ae_sent} |
1925 | $_[0]{_ae_sent} |
1756 | } |
1926 | } |
1757 | |
1927 | |
1758 | sub _wait { |
|
|
1759 | $WAITING |
|
|
1760 | and !$_[0]{_ae_sent} |
|
|
1761 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; |
|
|
1762 | |
|
|
1763 | local $WAITING = 1; |
|
|
1764 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
|
|
1765 | } |
|
|
1766 | |
|
|
1767 | sub recv { |
1928 | sub recv { |
|
|
1929 | unless ($_[0]{_ae_sent}) { |
|
|
1930 | $WAITING |
|
|
1931 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted"; |
|
|
1932 | |
|
|
1933 | local $WAITING = 1; |
1768 | $_[0]->_wait; |
1934 | $_[0]->_wait; |
|
|
1935 | } |
1769 | |
1936 | |
1770 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1937 | $_[0]{_ae_croak} |
1771 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1938 | and Carp::croak $_[0]{_ae_croak}; |
|
|
1939 | |
|
|
1940 | wantarray |
|
|
1941 | ? @{ $_[0]{_ae_sent} } |
|
|
1942 | : $_[0]{_ae_sent}[0] |
1772 | } |
1943 | } |
1773 | |
1944 | |
1774 | sub cb { |
1945 | sub cb { |
1775 | my $cv = shift; |
1946 | my $cv = shift; |
1776 | |
1947 | |
… | |
… | |
1792 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
1963 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
1793 | } |
1964 | } |
1794 | |
1965 | |
1795 | # undocumented/compatibility with pre-3.4 |
1966 | # undocumented/compatibility with pre-3.4 |
1796 | *broadcast = \&send; |
1967 | *broadcast = \&send; |
1797 | *wait = \&_wait; |
1968 | *wait = \&recv; |
1798 | |
1969 | |
1799 | =head1 ERROR AND EXCEPTION HANDLING |
1970 | =head1 ERROR AND EXCEPTION HANDLING |
1800 | |
1971 | |
1801 | In general, AnyEvent does not do any error handling - it relies on the |
1972 | In general, AnyEvent does not do any error handling - it relies on the |
1802 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
1973 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
… | |
… | |
1814 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
1985 | $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and |
1815 | so on. |
1986 | so on. |
1816 | |
1987 | |
1817 | =head1 ENVIRONMENT VARIABLES |
1988 | =head1 ENVIRONMENT VARIABLES |
1818 | |
1989 | |
1819 | The following environment variables are used by this module or its |
1990 | AnyEvent supports a number of environment variables that tune the |
1820 | submodules. |
1991 | runtime behaviour. They are usually evaluated when AnyEvent is |
|
|
1992 | loaded, initialised, or a submodule that uses them is loaded. Many of |
|
|
1993 | them also cause AnyEvent to load additional modules - for example, |
|
|
1994 | C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be |
|
|
1995 | loaded. |
1821 | |
1996 | |
1822 | Note that AnyEvent will remove I<all> environment variables starting with |
1997 | All the environment variables documented here start with |
1823 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
1998 | C<PERL_ANYEVENT_>, which is what AnyEvent considers its own |
1824 | enabled. |
1999 | namespace. Other modules are encouraged (but by no means required) to use |
|
|
2000 | C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule |
|
|
2001 | namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could |
|
|
2002 | be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env |
|
|
2003 | variables starting with C<AE_>, see below). |
|
|
2004 | |
|
|
2005 | All variables can also be set via the C<AE_> prefix, that is, instead |
|
|
2006 | of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In |
|
|
2007 | case there is a clash btween anyevent and another program that uses |
|
|
2008 | C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something> |
|
|
2009 | variable to the empty string, as those variables take precedence. |
|
|
2010 | |
|
|
2011 | When AnyEvent is first loaded, it copies all C<AE_xxx> env variables |
|
|
2012 | to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already |
|
|
2013 | exists. If taint mode is on, then AnyEvent will remove I<all> environment |
|
|
2014 | variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them |
|
|
2015 | with C<undef> or the empty string, if the corresaponding C<AE_> variable |
|
|
2016 | is set). |
|
|
2017 | |
|
|
2018 | The exact algorithm is currently: |
|
|
2019 | |
|
|
2020 | 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV |
|
|
2021 | 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists |
|
|
2022 | 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef. |
|
|
2023 | |
|
|
2024 | This ensures that child processes will not see the C<AE_> variables. |
|
|
2025 | |
|
|
2026 | The following environment variables are currently known to AnyEvent: |
1825 | |
2027 | |
1826 | =over 4 |
2028 | =over 4 |
1827 | |
2029 | |
1828 | =item C<PERL_ANYEVENT_VERBOSE> |
2030 | =item C<PERL_ANYEVENT_VERBOSE> |
1829 | |
2031 | |
1830 | By default, AnyEvent will be completely silent except in fatal |
2032 | By default, AnyEvent will be completely silent except in fatal |
1831 | conditions. You can set this environment variable to make AnyEvent more |
2033 | conditions. You can set this environment variable to make AnyEvent more |
1832 | talkative. |
2034 | talkative. If you want to do more than just set the global logging level |
|
|
2035 | you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more |
|
|
2036 | complex specifications. |
1833 | |
2037 | |
1834 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
2038 | When set to C<5> or higher, causes AnyEvent to warn about unexpected |
1835 | conditions, such as not being able to load the event model specified by |
2039 | conditions, such as not being able to load the event model specified by |
1836 | C<PERL_ANYEVENT_MODEL>. |
2040 | C<PERL_ANYEVENT_MODEL>. |
1837 | |
2041 | |
1838 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
2042 | When set to C<7> or higher, cause AnyEvent to report to STDERR which event |
1839 | model it chooses. |
2043 | model it chooses. |
1840 | |
2044 | |
1841 | When set to C<8> or higher, then AnyEvent will report extra information on |
2045 | When set to C<8> or higher, then AnyEvent will report extra information on |
1842 | which optional modules it loads and how it implements certain features. |
2046 | which optional modules it loads and how it implements certain features. |
|
|
2047 | |
|
|
2048 | =item C<PERL_ANYEVENT_LOG> |
|
|
2049 | |
|
|
2050 | Accepts rather complex logging specifications. For example, you could log |
|
|
2051 | all C<debug> messages of some module to stderr, warnings and above to |
|
|
2052 | stderr, and errors and above to syslog, with: |
|
|
2053 | |
|
|
2054 | PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog |
|
|
2055 | |
|
|
2056 | For the rather extensive details, see L<AnyEvent::Log>. |
|
|
2057 | |
|
|
2058 | Note that specifying this environment variable causes the L<AnyEvent::Log> |
|
|
2059 | module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only |
|
|
2060 | using the latter saves a few hundred kB of memory until the first message |
|
|
2061 | is being logged. |
1843 | |
2062 | |
1844 | =item C<PERL_ANYEVENT_STRICT> |
2063 | =item C<PERL_ANYEVENT_STRICT> |
1845 | |
2064 | |
1846 | AnyEvent does not do much argument checking by default, as thorough |
2065 | AnyEvent does not do much argument checking by default, as thorough |
1847 | argument checking is very costly. Setting this variable to a true value |
2066 | argument checking is very costly. Setting this variable to a true value |
… | |
… | |
1854 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
2073 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
1855 | >>, it is definitely recommended to keep it off in production. Keeping |
2074 | >>, it is definitely recommended to keep it off in production. Keeping |
1856 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
2075 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
1857 | can be very useful, however. |
2076 | can be very useful, however. |
1858 | |
2077 | |
|
|
2078 | =item C<PERL_ANYEVENT_DEBUG_SHELL> |
|
|
2079 | |
|
|
2080 | If this env variable is set, then its contents will be interpreted by |
|
|
2081 | C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of |
|
|
2082 | C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on |
|
|
2083 | that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. |
|
|
2084 | |
|
|
2085 | This takes place when the first watcher is created. |
|
|
2086 | |
|
|
2087 | For example, to bind a debug shell on a unix domain socket in |
|
|
2088 | F<< /tmp/debug<pid>.sock >>, you could use this: |
|
|
2089 | |
|
|
2090 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
|
|
2091 | |
|
|
2092 | Note that creating sockets in F</tmp> is very unsafe on multiuser |
|
|
2093 | systems. |
|
|
2094 | |
|
|
2095 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
|
|
2096 | |
|
|
2097 | Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for |
|
|
2098 | debugging purposes. See C<AnyEvent::Debug::wrap> for details. |
|
|
2099 | |
1859 | =item C<PERL_ANYEVENT_MODEL> |
2100 | =item C<PERL_ANYEVENT_MODEL> |
1860 | |
2101 | |
1861 | This can be used to specify the event model to be used by AnyEvent, before |
2102 | This can be used to specify the event model to be used by AnyEvent, before |
1862 | auto detection and -probing kicks in. It must be a string consisting |
2103 | auto detection and -probing kicks in. |
1863 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
2104 | |
|
|
2105 | It normally is a string consisting entirely of ASCII letters (e.g. C<EV> |
|
|
2106 | or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the |
1864 | and the resulting module name is loaded and if the load was successful, |
2107 | resulting module name is loaded and - if the load was successful - used as |
1865 | used as event model. If it fails to load AnyEvent will proceed with |
2108 | event model backend. If it fails to load then AnyEvent will proceed with |
1866 | auto detection and -probing. |
2109 | auto detection and -probing. |
1867 | |
2110 | |
1868 | This functionality might change in future versions. |
2111 | If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then |
|
|
2112 | nothing gets prepended and the module name is used as-is (hint: C<::> at |
|
|
2113 | the end of a string designates a module name and quotes it appropriately). |
1869 | |
2114 | |
1870 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
2115 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
1871 | could start your program like this: |
2116 | could start your program like this: |
1872 | |
2117 | |
1873 | PERL_ANYEVENT_MODEL=Perl perl ... |
2118 | PERL_ANYEVENT_MODEL=Perl perl ... |
1874 | |
2119 | |
1875 | =item C<PERL_ANYEVENT_PROTOCOLS> |
2120 | =item C<PERL_ANYEVENT_PROTOCOLS> |
… | |
… | |
1891 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
2136 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
1892 | - only support IPv4, never try to resolve or contact IPv6 |
2137 | - only support IPv4, never try to resolve or contact IPv6 |
1893 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
2138 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
1894 | IPv6, but prefer IPv6 over IPv4. |
2139 | IPv6, but prefer IPv6 over IPv4. |
1895 | |
2140 | |
|
|
2141 | =item C<PERL_ANYEVENT_HOSTS> |
|
|
2142 | |
|
|
2143 | This variable, if specified, overrides the F</etc/hosts> file used by |
|
|
2144 | L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read |
|
|
2145 | from that file instead. |
|
|
2146 | |
1896 | =item C<PERL_ANYEVENT_EDNS0> |
2147 | =item C<PERL_ANYEVENT_EDNS0> |
1897 | |
2148 | |
1898 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
2149 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for |
1899 | for DNS. This extension is generally useful to reduce DNS traffic, but |
2150 | DNS. This extension is generally useful to reduce DNS traffic, especially |
1900 | some (broken) firewalls drop such DNS packets, which is why it is off by |
2151 | when DNSSEC is involved, but some (broken) firewalls drop such DNS |
1901 | default. |
2152 | packets, which is why it is off by default. |
1902 | |
2153 | |
1903 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
2154 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1904 | EDNS0 in its DNS requests. |
2155 | EDNS0 in its DNS requests. |
1905 | |
2156 | |
1906 | =item C<PERL_ANYEVENT_MAX_FORKS> |
2157 | =item C<PERL_ANYEVENT_MAX_FORKS> |
… | |
… | |
1914 | resolver - this is the maximum number of parallel DNS requests that are |
2165 | resolver - this is the maximum number of parallel DNS requests that are |
1915 | sent to the DNS server. |
2166 | sent to the DNS server. |
1916 | |
2167 | |
1917 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
2168 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
1918 | |
2169 | |
1919 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
2170 | The absolute path to a F<resolv.conf>-style file to use instead of |
1920 | configuration) in the default resolver. When set to the empty string, no |
2171 | F</etc/resolv.conf> (or the OS-specific configuration) in the default |
1921 | default config will be used. |
2172 | resolver, or the empty string to select the default configuration. |
1922 | |
2173 | |
1923 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
2174 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
1924 | |
2175 | |
1925 | When neither C<ca_file> nor C<ca_path> was specified during |
2176 | When neither C<ca_file> nor C<ca_path> was specified during |
1926 | L<AnyEvent::TLS> context creation, and either of these environment |
2177 | L<AnyEvent::TLS> context creation, and either of these environment |
1927 | variables exist, they will be used to specify CA certificate locations |
2178 | variables are nonempty, they will be used to specify CA certificate |
1928 | instead of a system-dependent default. |
2179 | locations instead of a system-dependent default. |
1929 | |
2180 | |
1930 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
2181 | =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> |
1931 | |
2182 | |
1932 | When these are set to C<1>, then the respective modules are not |
2183 | When these are set to C<1>, then the respective modules are not |
1933 | loaded. Mostly good for testing AnyEvent itself. |
2184 | loaded. Mostly good for testing AnyEvent itself. |
… | |
… | |
2265 | (even when used without AnyEvent), but most event loops have acceptable |
2516 | (even when used without AnyEvent), but most event loops have acceptable |
2266 | performance with or without AnyEvent. |
2517 | performance with or without AnyEvent. |
2267 | |
2518 | |
2268 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2519 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2269 | the actual event loop, only with extremely fast event loops such as EV |
2520 | the actual event loop, only with extremely fast event loops such as EV |
2270 | adds AnyEvent significant overhead. |
2521 | does AnyEvent add significant overhead. |
2271 | |
2522 | |
2272 | =item * You should avoid POE like the plague if you want performance or |
2523 | =item * You should avoid POE like the plague if you want performance or |
2273 | reasonable memory usage. |
2524 | reasonable memory usage. |
2274 | |
2525 | |
2275 | =back |
2526 | =back |
… | |
… | |
2574 | |
2825 | |
2575 | =item L<Time::HiRes> |
2826 | =item L<Time::HiRes> |
2576 | |
2827 | |
2577 | This module is part of perl since release 5.008. It will be used when the |
2828 | This module is part of perl since release 5.008. It will be used when the |
2578 | chosen event library does not come with a timing source of its own. The |
2829 | chosen event library does not come with a timing source of its own. The |
2579 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
2830 | pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to |
2580 | try to use a monotonic clock for timing stability. |
2831 | try to use a monotonic clock for timing stability. |
2581 | |
2832 | |
2582 | =back |
2833 | =back |
2583 | |
2834 | |
2584 | |
2835 | |
… | |
… | |
2650 | |
2901 | |
2651 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2902 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2652 | |
2903 | |
2653 | FAQ: L<AnyEvent::FAQ>. |
2904 | FAQ: L<AnyEvent::FAQ>. |
2654 | |
2905 | |
2655 | Utility functions: L<AnyEvent::Util>. |
2906 | Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log> |
|
|
2907 | (simply logging). |
2656 | |
2908 | |
2657 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
2909 | Development/Debugging: L<AnyEvent::Strict> (stricter checking), |
2658 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2910 | L<AnyEvent::Debug> (interactive shell, watcher tracing). |
|
|
2911 | |
|
|
2912 | Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, |
|
|
2913 | L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, |
|
|
2914 | L<Qt>, L<POE>, L<FLTK>. |
2659 | |
2915 | |
2660 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2916 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2661 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2917 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2662 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2918 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2663 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2919 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>, |
|
|
2920 | L<AnyEvent::Impl::FLTK>. |
2664 | |
2921 | |
2665 | Non-blocking file handles, sockets, TCP clients and |
2922 | Non-blocking handles, pipes, stream sockets, TCP clients and |
2666 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2923 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2667 | |
2924 | |
2668 | Asynchronous DNS: L<AnyEvent::DNS>. |
2925 | Asynchronous DNS: L<AnyEvent::DNS>. |
2669 | |
2926 | |
2670 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
2927 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |