… | |
… | |
85 | that isn't them. What's worse, all the potential users of your |
85 | that isn't them. What's worse, all the potential users of your |
86 | module are I<also> forced to use the same event loop you use. |
86 | module are I<also> forced to use the same event loop you use. |
87 | |
87 | |
88 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
88 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
89 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
89 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
90 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
90 | with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module |
91 | your module uses one of those, every user of your module has to use it, |
91 | uses one of those, every user of your module has to use it, too. But if |
92 | too. But if your module uses AnyEvent, it works transparently with all |
92 | your module uses AnyEvent, it works transparently with all event models it |
93 | event models it supports (including stuff like IO::Async, as long as those |
93 | supports (including stuff like IO::Async, as long as those use one of the |
94 | use one of the supported event loops. It is easy to add new event loops |
94 | supported event loops. It is easy to add new event loops to AnyEvent, too, |
95 | to AnyEvent, too, so it is future-proof). |
95 | so it is future-proof). |
96 | |
96 | |
97 | In addition to being free of having to use I<the one and only true event |
97 | In addition to being free of having to use I<the one and only true event |
98 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
98 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
99 | modules, you get an enormous amount of code and strict rules you have to |
99 | modules, you get an enormous amount of code and strict rules you have to |
100 | follow. AnyEvent, on the other hand, is lean and to the point, by only |
100 | follow. AnyEvent, on the other hand, is lean and to the point, by only |
… | |
… | |
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 |
… | |
… | |
876 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
876 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
877 | AnyEvent::Impl::Tk based on Tk, very broken. |
877 | AnyEvent::Impl::Tk based on Tk, very broken. |
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. |
|
|
882 | AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. |
|
|
883 | AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). |
881 | |
884 | |
882 | =item Backends with special needs. |
885 | =item Backends with special needs. |
883 | |
886 | |
884 | Qt requires the Qt::Application to be instantiated first, but will |
887 | Qt requires the Qt::Application to be instantiated first, but will |
885 | otherwise be picked up automatically. As long as the main program |
888 | otherwise be picked up automatically. As long as the main program |
886 | instantiates the application before any AnyEvent watchers are created, |
889 | instantiates the application before any AnyEvent watchers are created, |
887 | everything should just work. |
890 | everything should just work. |
888 | |
891 | |
889 | AnyEvent::Impl::Qt based on Qt. |
892 | AnyEvent::Impl::Qt based on Qt. |
890 | |
|
|
891 | Support for IO::Async can only be partial, as it is too broken and |
|
|
892 | architecturally limited to even support the AnyEvent API. It also |
|
|
893 | is the only event loop that needs the loop to be set explicitly, so |
|
|
894 | it can only be used by a main program knowing about AnyEvent. See |
|
|
895 | L<AnyEvent::Impl::IOAsync> for the gory details. |
|
|
896 | |
|
|
897 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
|
|
898 | |
893 | |
899 | =item Event loops that are indirectly supported via other backends. |
894 | =item Event loops that are indirectly supported via other backends. |
900 | |
895 | |
901 | Some event loops can be supported via other modules: |
896 | Some event loops can be supported via other modules: |
902 | |
897 | |
… | |
… | |
938 | |
933 | |
939 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
934 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
940 | 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 |
941 | 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 |
942 | 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). |
943 | |
942 | |
944 | If you need to do some initialisation before AnyEvent watchers are |
943 | If you need to do some initialisation before AnyEvent watchers are |
945 | created, use C<post_detect>. |
944 | created, use C<post_detect>. |
946 | |
945 | |
947 | =item $guard = AnyEvent::post_detect { BLOCK } |
946 | =item $guard = AnyEvent::post_detect { BLOCK } |
… | |
… | |
1010 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
1009 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
1011 | # as soon as it is |
1010 | # as soon as it is |
1012 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
1011 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
1013 | } |
1012 | } |
1014 | |
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 | |
1015 | =back |
1061 | =back |
1016 | |
1062 | |
1017 | =head1 WHAT TO DO IN A MODULE |
1063 | =head1 WHAT TO DO IN A MODULE |
1018 | |
1064 | |
1019 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
1065 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
1052 | modules might create watchers when they are loaded, and AnyEvent will |
1098 | modules might create watchers when they are loaded, and AnyEvent will |
1053 | decide on the event model to use as soon as it creates watchers, and it |
1099 | decide on the event model to use as soon as it creates watchers, and it |
1054 | might choose the wrong one unless you load the correct one yourself. |
1100 | might choose the wrong one unless you load the correct one yourself. |
1055 | |
1101 | |
1056 | You can chose to use a pure-perl implementation by loading the |
1102 | You can chose to use a pure-perl implementation by loading the |
1057 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
1103 | C<AnyEvent::Loop> module, which gives you similar behaviour |
1058 | everywhere, but letting AnyEvent chose the model is generally better. |
1104 | everywhere, but letting AnyEvent chose the model is generally better. |
1059 | |
1105 | |
1060 | =head2 MAINLOOP EMULATION |
1106 | =head2 MAINLOOP EMULATION |
1061 | |
1107 | |
1062 | Sometimes (often for short test scripts, or even standalone programs who |
1108 | Sometimes (often for short test scripts, or even standalone programs who |
… | |
… | |
1157 | |
1203 | |
1158 | package AnyEvent; |
1204 | package AnyEvent; |
1159 | |
1205 | |
1160 | # basically a tuned-down version of common::sense |
1206 | # basically a tuned-down version of common::sense |
1161 | sub common_sense { |
1207 | sub common_sense { |
1162 | # from common:.sense 3.3 |
1208 | # from common:.sense 3.4 |
1163 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; |
1209 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; |
1164 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1210 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1165 | $^H |= 0x00000600; |
1211 | $^H |= 0x00000600; |
1166 | } |
1212 | } |
1167 | |
1213 | |
1168 | BEGIN { AnyEvent::common_sense } |
1214 | BEGIN { AnyEvent::common_sense } |
1169 | |
1215 | |
1170 | use Carp (); |
1216 | use Carp (); |
1171 | |
1217 | |
1172 | our $VERSION = '5.271'; |
1218 | our $VERSION = '6.01'; |
1173 | our $MODEL; |
1219 | our $MODEL; |
1174 | |
1220 | |
1175 | our $AUTOLOAD; |
|
|
1176 | our @ISA; |
1221 | our @ISA; |
1177 | |
1222 | |
1178 | our @REGISTRY; |
1223 | our @REGISTRY; |
1179 | |
1224 | |
1180 | our $VERBOSE; |
1225 | our $VERBOSE; |
… | |
… | |
1186 | |
1231 | |
1187 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1232 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1188 | if ${^TAINT}; |
1233 | if ${^TAINT}; |
1189 | |
1234 | |
1190 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1235 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1191 | |
|
|
1192 | } |
1236 | } |
1193 | |
1237 | |
1194 | our $MAX_SIGNAL_LATENCY = 10; |
1238 | our $MAX_SIGNAL_LATENCY = 10; |
1195 | |
1239 | |
1196 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1240 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
… | |
… | |
1200 | $PROTOCOL{$_} = ++$idx |
1244 | $PROTOCOL{$_} = ++$idx |
1201 | for reverse split /\s*,\s*/, |
1245 | for reverse split /\s*,\s*/, |
1202 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1246 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1203 | } |
1247 | } |
1204 | |
1248 | |
|
|
1249 | our @post_detect; |
|
|
1250 | |
|
|
1251 | sub post_detect(&) { |
|
|
1252 | my ($cb) = @_; |
|
|
1253 | |
|
|
1254 | push @post_detect, $cb; |
|
|
1255 | |
|
|
1256 | defined wantarray |
|
|
1257 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1258 | : () |
|
|
1259 | } |
|
|
1260 | |
|
|
1261 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1262 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1263 | } |
|
|
1264 | |
|
|
1265 | our $POSTPONE_W; |
|
|
1266 | our @POSTPONE; |
|
|
1267 | |
|
|
1268 | sub _postpone_exec { |
|
|
1269 | undef $POSTPONE_W; |
|
|
1270 | |
|
|
1271 | &{ shift @POSTPONE } |
|
|
1272 | while @POSTPONE; |
|
|
1273 | } |
|
|
1274 | |
|
|
1275 | sub postpone(&) { |
|
|
1276 | push @POSTPONE, shift; |
|
|
1277 | |
|
|
1278 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
|
|
1279 | |
|
|
1280 | () |
|
|
1281 | } |
|
|
1282 | |
|
|
1283 | sub log($$;@) { |
|
|
1284 | require AnyEvent::Log; |
|
|
1285 | # AnyEvent::Log overwrites this function |
|
|
1286 | goto &log; |
|
|
1287 | } |
|
|
1288 | |
1205 | my @models = ( |
1289 | our @models = ( |
1206 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1290 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1207 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1291 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1208 | # everything below here will not (normally) be autoprobed |
1292 | # everything below here will not (normally) be autoprobed |
1209 | # as the pureperl backend should work everywhere |
1293 | # as the pure perl backend should work everywhere |
1210 | # and is usually faster |
1294 | # and is usually faster |
1211 | [Event:: => AnyEvent::Impl::Event::, 1], |
1295 | [Event:: => AnyEvent::Impl::Event::, 1], |
1212 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1296 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1213 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1297 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1214 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1298 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1215 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1299 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1216 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1300 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1217 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1301 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1218 | [Wx:: => AnyEvent::Impl::POE::], |
1302 | [Wx:: => AnyEvent::Impl::POE::], |
1219 | [Prima:: => AnyEvent::Impl::POE::], |
1303 | [Prima:: => AnyEvent::Impl::POE::], |
1220 | # IO::Async is just too broken - we would need workarounds for its |
1304 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect |
1221 | # byzantine signal and broken child handling, among others. |
1305 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1222 | # IO::Async is rather hard to detect, as it doesn't have any |
1306 | [FLTK:: => AnyEvent::Impl::FLTK2::], |
1223 | # obvious default class. |
|
|
1224 | [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1225 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1226 | [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1227 | [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1228 | ); |
1307 | ); |
1229 | |
1308 | |
1230 | our %method = map +($_ => 1), |
1309 | our @isa_hook; |
|
|
1310 | |
|
|
1311 | sub _isa_set { |
|
|
1312 | my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL); |
|
|
1313 | |
|
|
1314 | @{"$pkg[$_-1]::ISA"} = $pkg[$_] |
|
|
1315 | for 1 .. $#pkg; |
|
|
1316 | |
|
|
1317 | grep $_ && $_->[1], @isa_hook |
|
|
1318 | and AE::_reset (); |
|
|
1319 | } |
|
|
1320 | |
|
|
1321 | # used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy |
|
|
1322 | sub _isa_hook($$;$) { |
|
|
1323 | my ($i, $pkg, $reset_ae) = @_; |
|
|
1324 | |
|
|
1325 | $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef; |
|
|
1326 | |
|
|
1327 | _isa_set; |
|
|
1328 | } |
|
|
1329 | |
|
|
1330 | # all autoloaded methods reserve the complete glob, not just the method slot. |
|
|
1331 | # due to bugs in perls method cache implementation. |
1231 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1332 | our @methods = qw(io timer time now now_update signal child idle condvar); |
1232 | |
|
|
1233 | our @post_detect; |
|
|
1234 | |
|
|
1235 | sub post_detect(&) { |
|
|
1236 | my ($cb) = @_; |
|
|
1237 | |
|
|
1238 | push @post_detect, $cb; |
|
|
1239 | |
|
|
1240 | defined wantarray |
|
|
1241 | ? bless \$cb, "AnyEvent::Util::postdetect" |
|
|
1242 | : () |
|
|
1243 | } |
|
|
1244 | |
|
|
1245 | sub AnyEvent::Util::postdetect::DESTROY { |
|
|
1246 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
1247 | } |
|
|
1248 | |
1333 | |
1249 | sub detect() { |
1334 | sub detect() { |
|
|
1335 | return $MODEL if $MODEL; # some programs keep references to detect |
|
|
1336 | |
|
|
1337 | local $!; # for good measure |
|
|
1338 | local $SIG{__DIE__}; # we use eval |
|
|
1339 | |
1250 | # free some memory |
1340 | # free some memory |
1251 | *detect = sub () { $MODEL }; |
1341 | *detect = sub () { $MODEL }; |
|
|
1342 | # undef &func doesn't correctly update the method cache. grmbl. |
|
|
1343 | # so we delete the whole glob. grmbl. |
|
|
1344 | # otoh, perl doesn't let me undef an active usb, but it lets me free |
|
|
1345 | # a glob with an active sub. hrm. i hope it works, but perl is |
|
|
1346 | # usually buggy in this department. sigh. |
|
|
1347 | delete @{"AnyEvent::"}{@methods}; |
|
|
1348 | undef @methods; |
1252 | |
1349 | |
1253 | local $!; # for good measure |
|
|
1254 | local $SIG{__DIE__}; |
|
|
1255 | |
|
|
1256 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1350 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { |
1257 | my $model = "AnyEvent::Impl::$1"; |
1351 | my $model = $1; |
|
|
1352 | $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; |
1258 | if (eval "require $model") { |
1353 | if (eval "require $model") { |
1259 | $MODEL = $model; |
1354 | $MODEL = $model; |
1260 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
1355 | AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it." |
|
|
1356 | if $VERBOSE >= 7; |
1261 | } else { |
1357 | } else { |
1262 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1358 | AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; |
1263 | } |
1359 | } |
1264 | } |
1360 | } |
1265 | |
1361 | |
1266 | # check for already loaded models |
1362 | # check for already loaded models |
1267 | unless ($MODEL) { |
1363 | unless ($MODEL) { |
1268 | for (@REGISTRY, @models) { |
1364 | for (@REGISTRY, @models) { |
1269 | my ($package, $model) = @$_; |
1365 | my ($package, $model) = @$_; |
1270 | if (${"$package\::VERSION"} > 0) { |
1366 | if (${"$package\::VERSION"} > 0) { |
1271 | if (eval "require $model") { |
1367 | if (eval "require $model") { |
1272 | $MODEL = $model; |
1368 | $MODEL = $model; |
1273 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1369 | AnyEvent::log 7 => "autodetected model '$model', using it." |
|
|
1370 | if $VERBOSE >= 7; |
1274 | last; |
1371 | last; |
1275 | } |
1372 | } |
1276 | } |
1373 | } |
1277 | } |
1374 | } |
1278 | |
1375 | |
… | |
… | |
1285 | and eval "require $package" |
1382 | and eval "require $package" |
1286 | and ${"$package\::VERSION"} > 0 |
1383 | and ${"$package\::VERSION"} > 0 |
1287 | and eval "require $model" |
1384 | and eval "require $model" |
1288 | ) { |
1385 | ) { |
1289 | $MODEL = $model; |
1386 | $MODEL = $model; |
1290 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1387 | AnyEvent::log 7 => "autoloaded model '$model', using it." |
|
|
1388 | if $VERBOSE >= 7; |
1291 | last; |
1389 | last; |
1292 | } |
1390 | } |
1293 | } |
1391 | } |
1294 | |
1392 | |
1295 | $MODEL |
1393 | $MODEL |
1296 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
1394 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?"; |
1297 | } |
1395 | } |
1298 | } |
1396 | } |
1299 | |
1397 | |
1300 | @models = (); # free probe data |
1398 | # free memory only needed for probing |
|
|
1399 | undef @models; |
|
|
1400 | undef @REGISTRY; |
1301 | |
1401 | |
1302 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1402 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1303 | unshift @ISA, $MODEL; |
|
|
1304 | |
1403 | |
1305 | # now nuke some methods that are overriden by the backend. |
1404 | # now nuke some methods that are overridden by the backend. |
1306 | # SUPER is not allowed. |
1405 | # SUPER usage is not allowed in these. |
1307 | for (qw(time signal child idle)) { |
1406 | for (qw(time signal child idle)) { |
1308 | undef &{"AnyEvent::Base::$_"} |
1407 | undef &{"AnyEvent::Base::$_"} |
1309 | if defined &{"$MODEL\::$_"}; |
1408 | if defined &{"$MODEL\::$_"}; |
1310 | } |
1409 | } |
1311 | |
1410 | |
1312 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
1411 | _isa_set; |
|
|
1412 | |
|
|
1413 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
|
|
1414 | require AnyEvent::Strict; |
|
|
1415 | } |
|
|
1416 | |
|
|
1417 | if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { |
|
|
1418 | require AnyEvent::Debug; |
|
|
1419 | AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP}); |
|
|
1420 | } |
|
|
1421 | |
|
|
1422 | if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { |
|
|
1423 | require AnyEvent::Socket; |
|
|
1424 | require AnyEvent::Debug; |
|
|
1425 | |
|
|
1426 | my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL}; |
|
|
1427 | $shell =~ s/\$\$/$$/g; |
|
|
1428 | |
|
|
1429 | my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell); |
|
|
1430 | $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); |
|
|
1431 | } |
1313 | |
1432 | |
1314 | (shift @post_detect)->() while @post_detect; |
1433 | (shift @post_detect)->() while @post_detect; |
|
|
1434 | undef @post_detect; |
1315 | |
1435 | |
1316 | *post_detect = sub(&) { |
1436 | *post_detect = sub(&) { |
1317 | shift->(); |
1437 | shift->(); |
1318 | |
1438 | |
1319 | undef |
1439 | undef |
1320 | }; |
1440 | }; |
1321 | |
1441 | |
1322 | $MODEL |
1442 | $MODEL |
1323 | } |
1443 | } |
1324 | |
1444 | |
1325 | sub AUTOLOAD { |
1445 | for my $name (@methods) { |
1326 | (my $func = $AUTOLOAD) =~ s/.*://; |
1446 | *$name = sub { |
1327 | |
|
|
1328 | $method{$func} |
|
|
1329 | or Carp::croak "$func: not a valid AnyEvent class method"; |
|
|
1330 | |
|
|
1331 | detect; |
1447 | detect; |
1332 | |
1448 | # we use goto because |
1333 | my $class = shift; |
1449 | # a) it makes the thunk more transparent |
1334 | $class->$func (@_); |
1450 | # b) it allows us to delete the thunk later |
|
|
1451 | goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" } |
|
|
1452 | }; |
1335 | } |
1453 | } |
1336 | |
1454 | |
1337 | # utility function to dup a filehandle. this is used by many backends |
1455 | # utility function to dup a filehandle. this is used by many backends |
1338 | # to support binding more than one watcher per filehandle (they usually |
1456 | # to support binding more than one watcher per filehandle (they usually |
1339 | # allow only one watcher per fd, so we dup it to get a different one). |
1457 | # allow only one watcher per fd, so we dup it to get a different one). |
… | |
… | |
1363 | |
1481 | |
1364 | package AE; |
1482 | package AE; |
1365 | |
1483 | |
1366 | our $VERSION = $AnyEvent::VERSION; |
1484 | our $VERSION = $AnyEvent::VERSION; |
1367 | |
1485 | |
|
|
1486 | sub _reset() { |
|
|
1487 | eval q{ |
1368 | # fall back to the main API by default - backends and AnyEvent::Base |
1488 | # fall back to the main API by default - backends and AnyEvent::Base |
1369 | # implementations can overwrite these. |
1489 | # implementations can overwrite these. |
1370 | |
1490 | |
1371 | sub io($$$) { |
1491 | sub io($$$) { |
1372 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1492 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1373 | } |
1493 | } |
1374 | |
1494 | |
1375 | sub timer($$$) { |
1495 | sub timer($$$) { |
1376 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
1496 | AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) |
1377 | } |
1497 | } |
1378 | |
1498 | |
1379 | sub signal($$) { |
1499 | sub signal($$) { |
1380 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
1500 | AnyEvent->signal (signal => $_[0], cb => $_[1]) |
1381 | } |
1501 | } |
1382 | |
1502 | |
1383 | sub child($$) { |
1503 | sub child($$) { |
1384 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1504 | AnyEvent->child (pid => $_[0], cb => $_[1]) |
1385 | } |
1505 | } |
1386 | |
1506 | |
1387 | sub idle($) { |
1507 | sub idle($) { |
1388 | AnyEvent->idle (cb => $_[0]) |
1508 | AnyEvent->idle (cb => $_[0]); |
1389 | } |
1509 | } |
1390 | |
1510 | |
1391 | sub cv(;&) { |
1511 | sub cv(;&) { |
1392 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1512 | AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) |
1393 | } |
1513 | } |
1394 | |
1514 | |
1395 | sub now() { |
1515 | sub now() { |
1396 | AnyEvent->now |
1516 | AnyEvent->now |
1397 | } |
1517 | } |
1398 | |
1518 | |
1399 | sub now_update() { |
1519 | sub now_update() { |
1400 | AnyEvent->now_update |
1520 | AnyEvent->now_update |
1401 | } |
1521 | } |
1402 | |
1522 | |
1403 | sub time() { |
1523 | sub time() { |
1404 | AnyEvent->time |
1524 | AnyEvent->time |
|
|
1525 | } |
|
|
1526 | |
|
|
1527 | *postpone = \&AnyEvent::postpone; |
|
|
1528 | *log = \&AnyEvent::log; |
|
|
1529 | }; |
|
|
1530 | die if $@; |
1405 | } |
1531 | } |
|
|
1532 | |
|
|
1533 | BEGIN { _reset } |
1406 | |
1534 | |
1407 | package AnyEvent::Base; |
1535 | package AnyEvent::Base; |
1408 | |
1536 | |
1409 | # default implementations for many methods |
1537 | # default implementations for many methods |
1410 | |
1538 | |
1411 | sub time { |
1539 | sub time { |
1412 | eval q{ # poor man's autoloading {} |
1540 | eval q{ # poor man's autoloading {} |
1413 | # probe for availability of Time::HiRes |
1541 | # probe for availability of Time::HiRes |
1414 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1542 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1415 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1543 | AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy." |
|
|
1544 | if $AnyEvent::VERBOSE >= 8; |
|
|
1545 | *time = sub { Time::HiRes::time () }; |
1416 | *AE::time = \&Time::HiRes::time; |
1546 | *AE::time = \& Time::HiRes::time ; |
1417 | # if (eval "use POSIX (); (POSIX::times())... |
1547 | # if (eval "use POSIX (); (POSIX::times())... |
1418 | } else { |
1548 | } else { |
1419 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1549 | AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!"; |
|
|
1550 | *time = sub { CORE::time }; |
1420 | *AE::time = sub (){ time }; # epic fail |
1551 | *AE::time = sub (){ CORE::time }; |
1421 | } |
1552 | } |
1422 | |
1553 | |
1423 | *time = sub { AE::time }; # different prototypes |
1554 | *now = \&time; |
1424 | }; |
1555 | }; |
1425 | die if $@; |
1556 | die if $@; |
1426 | |
1557 | |
1427 | &time |
1558 | &time |
1428 | } |
1559 | } |
1429 | |
1560 | |
1430 | *now = \&time; |
1561 | *now = \&time; |
1431 | |
|
|
1432 | sub now_update { } |
1562 | sub now_update { } |
1433 | |
1563 | |
|
|
1564 | sub _poll { |
|
|
1565 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
|
|
1566 | } |
|
|
1567 | |
1434 | # default implementation for ->condvar |
1568 | # default implementation for ->condvar |
|
|
1569 | # in fact, the default should not be overwritten |
1435 | |
1570 | |
1436 | sub condvar { |
1571 | sub condvar { |
1437 | eval q{ # poor man's autoloading {} |
1572 | eval q{ # poor man's autoloading {} |
1438 | *condvar = sub { |
1573 | *condvar = sub { |
1439 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1574 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
… | |
… | |
1517 | |
1652 | |
1518 | sub signal { |
1653 | sub signal { |
1519 | eval q{ # poor man's autoloading {} |
1654 | eval q{ # poor man's autoloading {} |
1520 | # probe for availability of Async::Interrupt |
1655 | # probe for availability of Async::Interrupt |
1521 | if (_have_async_interrupt) { |
1656 | if (_have_async_interrupt) { |
1522 | warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; |
1657 | AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling." |
|
|
1658 | if $AnyEvent::VERBOSE >= 8; |
1523 | |
1659 | |
1524 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1660 | $SIGPIPE_R = new Async::Interrupt::EventPipe; |
1525 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1661 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1526 | |
1662 | |
1527 | } else { |
1663 | } else { |
1528 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1664 | AnyEvent::log 8 => "using emulated perl signal handling with latency timer." |
|
|
1665 | if $AnyEvent::VERBOSE >= 8; |
1529 | |
1666 | |
1530 | if (AnyEvent::WIN32) { |
1667 | if (AnyEvent::WIN32) { |
1531 | require AnyEvent::Util; |
1668 | require AnyEvent::Util; |
1532 | |
1669 | |
1533 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1670 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
… | |
… | |
1609 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1746 | : sysread $SIGPIPE_R, (my $dummy), 9; |
1610 | |
1747 | |
1611 | while (%SIG_EV) { |
1748 | while (%SIG_EV) { |
1612 | for (keys %SIG_EV) { |
1749 | for (keys %SIG_EV) { |
1613 | delete $SIG_EV{$_}; |
1750 | delete $SIG_EV{$_}; |
1614 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1751 | &$_ for values %{ $SIG_CB{$_} || {} }; |
1615 | } |
1752 | } |
1616 | } |
1753 | } |
1617 | }; |
1754 | }; |
1618 | }; |
1755 | }; |
1619 | die if $@; |
1756 | die if $@; |
… | |
… | |
1624 | # default implementation for ->child |
1761 | # default implementation for ->child |
1625 | |
1762 | |
1626 | our %PID_CB; |
1763 | our %PID_CB; |
1627 | our $CHLD_W; |
1764 | our $CHLD_W; |
1628 | our $CHLD_DELAY_W; |
1765 | our $CHLD_DELAY_W; |
1629 | our $WNOHANG; |
|
|
1630 | |
1766 | |
1631 | # used by many Impl's |
1767 | # used by many Impl's |
1632 | sub _emit_childstatus($$) { |
1768 | sub _emit_childstatus($$) { |
1633 | my (undef, $rpid, $rstatus) = @_; |
1769 | my (undef, $rpid, $rstatus) = @_; |
1634 | |
1770 | |
… | |
… | |
1641 | eval q{ # poor man's autoloading {} |
1777 | eval q{ # poor man's autoloading {} |
1642 | *_sigchld = sub { |
1778 | *_sigchld = sub { |
1643 | my $pid; |
1779 | my $pid; |
1644 | |
1780 | |
1645 | AnyEvent->_emit_childstatus ($pid, $?) |
1781 | AnyEvent->_emit_childstatus ($pid, $?) |
1646 | while ($pid = waitpid -1, $WNOHANG) > 0; |
1782 | while ($pid = waitpid -1, WNOHANG) > 0; |
1647 | }; |
1783 | }; |
1648 | |
1784 | |
1649 | *child = sub { |
1785 | *child = sub { |
1650 | my (undef, %arg) = @_; |
1786 | my (undef, %arg) = @_; |
1651 | |
1787 | |
1652 | defined (my $pid = $arg{pid} + 0) |
1788 | my $pid = $arg{pid}; |
1653 | or Carp::croak "required option 'pid' is missing"; |
1789 | my $cb = $arg{cb}; |
1654 | |
1790 | |
1655 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1791 | $PID_CB{$pid}{$cb+0} = $cb; |
1656 | |
|
|
1657 | # WNOHANG is almost cetrainly 1 everywhere |
|
|
1658 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
|
|
1659 | ? 1 |
|
|
1660 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
|
|
1661 | |
1792 | |
1662 | unless ($CHLD_W) { |
1793 | unless ($CHLD_W) { |
1663 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1794 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1664 | # child could be a zombie already, so make at least one round |
1795 | # child could be a zombie already, so make at least one round |
1665 | &_sigchld; |
1796 | &_sigchld; |
1666 | } |
1797 | } |
1667 | |
1798 | |
1668 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1799 | bless [$pid, $cb+0], "AnyEvent::Base::child" |
1669 | }; |
1800 | }; |
1670 | |
1801 | |
1671 | *AnyEvent::Base::child::DESTROY = sub { |
1802 | *AnyEvent::Base::child::DESTROY = sub { |
1672 | my ($pid, $cb) = @{$_[0]}; |
1803 | my ($pid, $icb) = @{$_[0]}; |
1673 | |
1804 | |
1674 | delete $PID_CB{$pid}{$cb}; |
1805 | delete $PID_CB{$pid}{$icb}; |
1675 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1806 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1676 | |
1807 | |
1677 | undef $CHLD_W unless keys %PID_CB; |
1808 | undef $CHLD_W unless keys %PID_CB; |
1678 | }; |
1809 | }; |
1679 | }; |
1810 | }; |
… | |
… | |
1692 | |
1823 | |
1693 | my ($cb, $w, $rcb) = $arg{cb}; |
1824 | my ($cb, $w, $rcb) = $arg{cb}; |
1694 | |
1825 | |
1695 | $rcb = sub { |
1826 | $rcb = sub { |
1696 | if ($cb) { |
1827 | if ($cb) { |
1697 | $w = _time; |
1828 | $w = AE::time; |
1698 | &$cb; |
1829 | &$cb; |
1699 | $w = _time - $w; |
1830 | $w = AE::time - $w; |
1700 | |
1831 | |
1701 | # never use more then 50% of the time for the idle watcher, |
1832 | # never use more then 50% of the time for the idle watcher, |
1702 | # within some limits |
1833 | # within some limits |
1703 | $w = 0.0001 if $w < 0.0001; |
1834 | $w = 0.0001 if $w < 0.0001; |
1704 | $w = 5 if $w > 5; |
1835 | $w = 5 if $w > 5; |
… | |
… | |
1751 | |
1882 | |
1752 | sub _send { |
1883 | sub _send { |
1753 | # nop |
1884 | # nop |
1754 | } |
1885 | } |
1755 | |
1886 | |
|
|
1887 | sub _wait { |
|
|
1888 | AnyEvent->_poll until $_[0]{_ae_sent}; |
|
|
1889 | } |
|
|
1890 | |
1756 | sub send { |
1891 | sub send { |
1757 | my $cv = shift; |
1892 | my $cv = shift; |
1758 | $cv->{_ae_sent} = [@_]; |
1893 | $cv->{_ae_sent} = [@_]; |
1759 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
1894 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
1760 | $cv->_send; |
1895 | $cv->_send; |
… | |
… | |
1767 | |
1902 | |
1768 | sub ready { |
1903 | sub ready { |
1769 | $_[0]{_ae_sent} |
1904 | $_[0]{_ae_sent} |
1770 | } |
1905 | } |
1771 | |
1906 | |
1772 | sub _wait { |
|
|
1773 | $WAITING |
|
|
1774 | and !$_[0]{_ae_sent} |
|
|
1775 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; |
|
|
1776 | |
|
|
1777 | local $WAITING = 1; |
|
|
1778 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
|
|
1779 | } |
|
|
1780 | |
|
|
1781 | sub recv { |
1907 | sub recv { |
|
|
1908 | unless ($_[0]{_ae_sent}) { |
|
|
1909 | $WAITING |
|
|
1910 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted"; |
|
|
1911 | |
|
|
1912 | local $WAITING = 1; |
1782 | $_[0]->_wait; |
1913 | $_[0]->_wait; |
|
|
1914 | } |
1783 | |
1915 | |
1784 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1916 | $_[0]{_ae_croak} |
1785 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1917 | and Carp::croak $_[0]{_ae_croak}; |
|
|
1918 | |
|
|
1919 | wantarray |
|
|
1920 | ? @{ $_[0]{_ae_sent} } |
|
|
1921 | : $_[0]{_ae_sent}[0] |
1786 | } |
1922 | } |
1787 | |
1923 | |
1788 | sub cb { |
1924 | sub cb { |
1789 | my $cv = shift; |
1925 | my $cv = shift; |
1790 | |
1926 | |
… | |
… | |
1806 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
1942 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
1807 | } |
1943 | } |
1808 | |
1944 | |
1809 | # undocumented/compatibility with pre-3.4 |
1945 | # undocumented/compatibility with pre-3.4 |
1810 | *broadcast = \&send; |
1946 | *broadcast = \&send; |
1811 | *wait = \&_wait; |
1947 | *wait = \&recv; |
1812 | |
1948 | |
1813 | =head1 ERROR AND EXCEPTION HANDLING |
1949 | =head1 ERROR AND EXCEPTION HANDLING |
1814 | |
1950 | |
1815 | In general, AnyEvent does not do any error handling - it relies on the |
1951 | In general, AnyEvent does not do any error handling - it relies on the |
1816 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
1952 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
… | |
… | |
1843 | |
1979 | |
1844 | By default, AnyEvent will be completely silent except in fatal |
1980 | By default, AnyEvent will be completely silent except in fatal |
1845 | conditions. You can set this environment variable to make AnyEvent more |
1981 | conditions. You can set this environment variable to make AnyEvent more |
1846 | talkative. |
1982 | talkative. |
1847 | |
1983 | |
1848 | When set to C<1> or higher, causes AnyEvent to warn about unexpected |
1984 | When set to C<5> or higher, causes AnyEvent to warn about unexpected |
1849 | conditions, such as not being able to load the event model specified by |
1985 | conditions, such as not being able to load the event model specified by |
1850 | C<PERL_ANYEVENT_MODEL>. |
1986 | C<PERL_ANYEVENT_MODEL>. |
1851 | |
1987 | |
1852 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1988 | When set to C<7> or higher, cause AnyEvent to report to STDERR which event |
1853 | model it chooses. |
1989 | model it chooses. |
1854 | |
1990 | |
1855 | When set to C<8> or higher, then AnyEvent will report extra information on |
1991 | When set to C<8> or higher, then AnyEvent will report extra information on |
1856 | which optional modules it loads and how it implements certain features. |
1992 | which optional modules it loads and how it implements certain features. |
1857 | |
1993 | |
… | |
… | |
1868 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
2004 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
1869 | >>, it is definitely recommended to keep it off in production. Keeping |
2005 | >>, it is definitely recommended to keep it off in production. Keeping |
1870 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
2006 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
1871 | can be very useful, however. |
2007 | can be very useful, however. |
1872 | |
2008 | |
|
|
2009 | =item C<PERL_ANYEVENT_DEBUG_SHELL> |
|
|
2010 | |
|
|
2011 | If this env variable is set, then its contents will be interpreted by |
|
|
2012 | C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of |
|
|
2013 | C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on |
|
|
2014 | that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. |
|
|
2015 | |
|
|
2016 | This takes place when the first watcher is created. |
|
|
2017 | |
|
|
2018 | For example, to bind a debug shell on a unix domain socket in |
|
|
2019 | F<< /tmp/debug<pid>.sock >>, you could use this: |
|
|
2020 | |
|
|
2021 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
|
|
2022 | |
|
|
2023 | Note that creating sockets in F</tmp> is very unsafe on multiuser |
|
|
2024 | systems. |
|
|
2025 | |
|
|
2026 | =item C<PERL_ANYEVENT_DEBUG_WRAP> |
|
|
2027 | |
|
|
2028 | Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for |
|
|
2029 | debugging purposes. See C<AnyEvent::Debug::wrap> for details. |
|
|
2030 | |
1873 | =item C<PERL_ANYEVENT_MODEL> |
2031 | =item C<PERL_ANYEVENT_MODEL> |
1874 | |
2032 | |
1875 | This can be used to specify the event model to be used by AnyEvent, before |
2033 | This can be used to specify the event model to be used by AnyEvent, before |
1876 | auto detection and -probing kicks in. It must be a string consisting |
2034 | auto detection and -probing kicks in. |
1877 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
2035 | |
|
|
2036 | It normally is a string consisting entirely of ASCII letters (e.g. C<EV> |
|
|
2037 | or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the |
1878 | and the resulting module name is loaded and if the load was successful, |
2038 | resulting module name is loaded and - if the load was successful - used as |
1879 | used as event model. If it fails to load AnyEvent will proceed with |
2039 | event model backend. If it fails to load then AnyEvent will proceed with |
1880 | auto detection and -probing. |
2040 | auto detection and -probing. |
1881 | |
2041 | |
1882 | This functionality might change in future versions. |
2042 | If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then |
|
|
2043 | nothing gets prepended and the module name is used as-is (hint: C<::> at |
|
|
2044 | the end of a string designates a module name and quotes it appropriately). |
1883 | |
2045 | |
1884 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
2046 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
1885 | could start your program like this: |
2047 | could start your program like this: |
1886 | |
2048 | |
1887 | PERL_ANYEVENT_MODEL=Perl perl ... |
2049 | PERL_ANYEVENT_MODEL=Perl perl ... |
1888 | |
2050 | |
1889 | =item C<PERL_ANYEVENT_PROTOCOLS> |
2051 | =item C<PERL_ANYEVENT_PROTOCOLS> |
… | |
… | |
2279 | (even when used without AnyEvent), but most event loops have acceptable |
2441 | (even when used without AnyEvent), but most event loops have acceptable |
2280 | performance with or without AnyEvent. |
2442 | performance with or without AnyEvent. |
2281 | |
2443 | |
2282 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2444 | =item * The overhead AnyEvent adds is usually much smaller than the overhead of |
2283 | the actual event loop, only with extremely fast event loops such as EV |
2445 | the actual event loop, only with extremely fast event loops such as EV |
2284 | adds AnyEvent significant overhead. |
2446 | does AnyEvent add significant overhead. |
2285 | |
2447 | |
2286 | =item * You should avoid POE like the plague if you want performance or |
2448 | =item * You should avoid POE like the plague if you want performance or |
2287 | reasonable memory usage. |
2449 | reasonable memory usage. |
2288 | |
2450 | |
2289 | =back |
2451 | =back |
… | |
… | |
2588 | |
2750 | |
2589 | =item L<Time::HiRes> |
2751 | =item L<Time::HiRes> |
2590 | |
2752 | |
2591 | This module is part of perl since release 5.008. It will be used when the |
2753 | This module is part of perl since release 5.008. It will be used when the |
2592 | chosen event library does not come with a timing source of its own. The |
2754 | chosen event library does not come with a timing source of its own. The |
2593 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
2755 | pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to |
2594 | try to use a monotonic clock for timing stability. |
2756 | try to use a monotonic clock for timing stability. |
2595 | |
2757 | |
2596 | =back |
2758 | =back |
2597 | |
2759 | |
2598 | |
2760 | |
… | |
… | |
2664 | |
2826 | |
2665 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2827 | Tutorial/Introduction: L<AnyEvent::Intro>. |
2666 | |
2828 | |
2667 | FAQ: L<AnyEvent::FAQ>. |
2829 | FAQ: L<AnyEvent::FAQ>. |
2668 | |
2830 | |
2669 | Utility functions: L<AnyEvent::Util>. |
2831 | Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log> |
|
|
2832 | (simply logging). |
2670 | |
2833 | |
2671 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
2834 | Development/Debugging: L<AnyEvent::Strict> (stricter checking), |
2672 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2835 | L<AnyEvent::Debug> (interactive shell, watcher tracing). |
|
|
2836 | |
|
|
2837 | Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, |
|
|
2838 | L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, |
|
|
2839 | L<Qt>, L<POE>, L<FLTK>. |
2673 | |
2840 | |
2674 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2841 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2675 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2842 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2676 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2843 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2677 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2844 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>, |
|
|
2845 | L<AnyEvent::Impl::FLTK>. |
2678 | |
2846 | |
2679 | Non-blocking file handles, sockets, TCP clients and |
2847 | Non-blocking handles, pipes, stream sockets, TCP clients and |
2680 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2848 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2681 | |
2849 | |
2682 | Asynchronous DNS: L<AnyEvent::DNS>. |
2850 | Asynchronous DNS: L<AnyEvent::DNS>. |
2683 | |
2851 | |
2684 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV L<Coro::Event >, |
2852 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
2685 | |
2853 | |
2686 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>, |
2854 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>, |
2687 | L<AnyEvent::HTTP>. |
2855 | L<AnyEvent::HTTP>. |
2688 | |
2856 | |
2689 | |
2857 | |