… | |
… | |
46 | in a tutorial or some gentle introduction, have a look at the |
46 | in a tutorial or some gentle introduction, have a look at the |
47 | L<AnyEvent::Intro> manpage. |
47 | L<AnyEvent::Intro> manpage. |
48 | |
48 | |
49 | =head1 SUPPORT |
49 | =head1 SUPPORT |
50 | |
50 | |
|
|
51 | An FAQ document is available as L<AnyEvent::FAQ>. |
|
|
52 | |
51 | There is a mailinglist for discussing all things AnyEvent, and an IRC |
53 | There also is a mailinglist for discussing all things AnyEvent, and an IRC |
52 | channel, too. |
54 | channel, too. |
53 | |
55 | |
54 | See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software |
56 | See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software |
55 | Repository>, at L<http://anyevent.schmorp.de>, for more info. |
57 | Repository>, at L<http://anyevent.schmorp.de>, for more info. |
56 | |
58 | |
… | |
… | |
83 | 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 |
84 | 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. |
85 | |
87 | |
86 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
88 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
87 | 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 |
88 | 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 |
89 | 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 |
90 | 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 |
91 | 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 |
92 | 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, |
93 | to AnyEvent, too, so it is future-proof). |
95 | so it is future-proof). |
94 | |
96 | |
95 | 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 |
96 | 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 |
97 | 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 |
98 | 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 |
… | |
… | |
119 | 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> |
120 | module. |
122 | module. |
121 | |
123 | |
122 | 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 |
123 | 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 |
124 | following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>, |
126 | following modules is already loaded: L<EV>, L<AnyEvent::Loop>, |
125 | 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 |
126 | 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 |
127 | 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 |
128 | available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so |
130 | available, the pure-perl L<AnyEvent::Loop> should always work, so |
129 | the other two are not normally tried. |
131 | the other two are not normally tried. |
130 | |
132 | |
131 | Because AnyEvent first checks for modules that are already loaded, loading |
133 | Because AnyEvent first checks for modules that are already loaded, loading |
132 | an event model explicitly before first using AnyEvent will likely make |
134 | an event model explicitly before first using AnyEvent will likely make |
133 | that model the default. For example: |
135 | that model the default. For example: |
… | |
… | |
140 | 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 |
141 | 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, |
142 | as very few modules hardcode event loops without announcing this very |
144 | as very few modules hardcode event loops without announcing this very |
143 | loudly. |
145 | loudly. |
144 | |
146 | |
145 | The pure-perl implementation of AnyEvent is called |
147 | The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like |
146 | 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 |
147 | explicitly and enjoy the high availability of that event loop :) |
149 | availability of that event loop :) |
148 | |
150 | |
149 | =head1 WATCHERS |
151 | =head1 WATCHERS |
150 | |
152 | |
151 | 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 |
152 | 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 |
… | |
… | |
354 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
356 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
355 | account. |
357 | account. |
356 | |
358 | |
357 | =item AnyEvent->now_update |
359 | =item AnyEvent->now_update |
358 | |
360 | |
359 | 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 |
360 | 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 >>, |
361 | AnyEvent->now >>, above). |
363 | above). |
362 | |
364 | |
363 | 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 |
364 | this "current" time will differ substantially from the real time, which |
366 | this "current" time will differ substantially from the real time, which |
365 | might affect timers and time-outs. |
367 | might affect timers and time-outs. |
366 | |
368 | |
… | |
… | |
480 | 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 |
481 | watcher before you C<fork> the child (alternatively, you can call |
483 | watcher before you C<fork> the child (alternatively, you can call |
482 | C<AnyEvent::detect>). |
484 | C<AnyEvent::detect>). |
483 | |
485 | |
484 | 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 |
485 | 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 |
486 | mentioned in the description of signal watchers apply. |
488 | problems mentioned in the description of signal watchers apply. |
487 | |
489 | |
488 | Example: fork a process and wait for it |
490 | Example: fork a process and wait for it |
489 | |
491 | |
490 | my $done = AnyEvent->condvar; |
492 | my $done = AnyEvent->condvar; |
491 | |
493 | |
… | |
… | |
858 | 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 |
859 | pure-perl implementation, which is available everywhere as it comes with |
861 | pure-perl implementation, which is available everywhere as it comes with |
860 | AnyEvent itself. |
862 | AnyEvent itself. |
861 | |
863 | |
862 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
864 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
863 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
865 | AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable. |
864 | |
866 | |
865 | =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. |
866 | |
868 | |
867 | 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 |
868 | 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 |
… | |
… | |
874 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
876 | AnyEvent::Impl::Glib based on Glib, slow but very stable. |
875 | AnyEvent::Impl::Tk based on Tk, very broken. |
877 | AnyEvent::Impl::Tk based on Tk, very broken. |
876 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
878 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
877 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
879 | AnyEvent::Impl::POE based on POE, very slow, some limitations. |
878 | 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::FLTK based on FLTK. |
879 | |
884 | |
880 | =item Backends with special needs. |
885 | =item Backends with special needs. |
881 | |
886 | |
882 | Qt requires the Qt::Application to be instantiated first, but will |
887 | Qt requires the Qt::Application to be instantiated first, but will |
883 | otherwise be picked up automatically. As long as the main program |
888 | otherwise be picked up automatically. As long as the main program |
884 | instantiates the application before any AnyEvent watchers are created, |
889 | instantiates the application before any AnyEvent watchers are created, |
885 | everything should just work. |
890 | everything should just work. |
886 | |
891 | |
887 | AnyEvent::Impl::Qt based on Qt. |
892 | AnyEvent::Impl::Qt based on Qt. |
888 | |
|
|
889 | Support for IO::Async can only be partial, as it is too broken and |
|
|
890 | architecturally limited to even support the AnyEvent API. It also |
|
|
891 | is the only event loop that needs the loop to be set explicitly, so |
|
|
892 | it can only be used by a main program knowing about AnyEvent. See |
|
|
893 | L<AnyEvent::Impl::IOAsync> for the gory details. |
|
|
894 | |
|
|
895 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
|
|
896 | |
893 | |
897 | =item Event loops that are indirectly supported via other backends. |
894 | =item Event loops that are indirectly supported via other backends. |
898 | |
895 | |
899 | Some event loops can be supported via other modules: |
896 | Some event loops can be supported via other modules: |
900 | |
897 | |
… | |
… | |
1008 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
1005 | # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent |
1009 | # as soon as it is |
1006 | # as soon as it is |
1010 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
1007 | push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; |
1011 | } |
1008 | } |
1012 | |
1009 | |
|
|
1010 | =item AnyEvent::postpone { BLOCK } |
|
|
1011 | |
|
|
1012 | Arranges for the block to be executed as soon as possible, but not before |
|
|
1013 | the call itself returns. In practise, the block will be executed just |
|
|
1014 | before the event loop polls for new events, or shortly afterwards. |
|
|
1015 | |
|
|
1016 | This function never returns anything (to make the C<return postpone { ... |
|
|
1017 | }> idiom more useful. |
|
|
1018 | |
|
|
1019 | To understand the usefulness of this function, consider a function that |
|
|
1020 | asynchronously does something for you and returns some transaction |
|
|
1021 | object or guard to let you cancel the operation. For example, |
|
|
1022 | C<AnyEvent::Socket::tcp_connect>: |
|
|
1023 | |
|
|
1024 | # start a conenction attempt unless one is active |
|
|
1025 | $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub { |
|
|
1026 | delete $self->{connect_guard}; |
|
|
1027 | ... |
|
|
1028 | }; |
|
|
1029 | |
|
|
1030 | Imagine that this function could instantly call the callback, for |
|
|
1031 | example, because it detects an obvious error such as a negative port |
|
|
1032 | number. Invoking the callback before the function returns causes problems |
|
|
1033 | however: the callback will be called and will try to delete the guard |
|
|
1034 | object. But since the function hasn't returned yet, there is nothing to |
|
|
1035 | delete. When the function eventually returns it will assign the guard |
|
|
1036 | object to C<< $self->{connect_guard} >>, where it will likely never be |
|
|
1037 | deleted, so the program thinks it is still trying to connect. |
|
|
1038 | |
|
|
1039 | This is where C<AnyEvent::postpone> should be used. Instead of calling the |
|
|
1040 | callback directly on error: |
|
|
1041 | |
|
|
1042 | $cb->(undef), return # signal error to callback, BAD! |
|
|
1043 | if $some_error_condition; |
|
|
1044 | |
|
|
1045 | It should use C<postpone>: |
|
|
1046 | |
|
|
1047 | AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later |
|
|
1048 | if $some_error_condition; |
|
|
1049 | |
1013 | =back |
1050 | =back |
1014 | |
1051 | |
1015 | =head1 WHAT TO DO IN A MODULE |
1052 | =head1 WHAT TO DO IN A MODULE |
1016 | |
1053 | |
1017 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
1054 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
1050 | modules might create watchers when they are loaded, and AnyEvent will |
1087 | modules might create watchers when they are loaded, and AnyEvent will |
1051 | decide on the event model to use as soon as it creates watchers, and it |
1088 | decide on the event model to use as soon as it creates watchers, and it |
1052 | might choose the wrong one unless you load the correct one yourself. |
1089 | might choose the wrong one unless you load the correct one yourself. |
1053 | |
1090 | |
1054 | You can chose to use a pure-perl implementation by loading the |
1091 | You can chose to use a pure-perl implementation by loading the |
1055 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
1092 | C<AnyEvent::Loop> module, which gives you similar behaviour |
1056 | everywhere, but letting AnyEvent chose the model is generally better. |
1093 | everywhere, but letting AnyEvent chose the model is generally better. |
1057 | |
1094 | |
1058 | =head2 MAINLOOP EMULATION |
1095 | =head2 MAINLOOP EMULATION |
1059 | |
1096 | |
1060 | Sometimes (often for short test scripts, or even standalone programs who |
1097 | Sometimes (often for short test scripts, or even standalone programs who |
… | |
… | |
1155 | |
1192 | |
1156 | package AnyEvent; |
1193 | package AnyEvent; |
1157 | |
1194 | |
1158 | # basically a tuned-down version of common::sense |
1195 | # basically a tuned-down version of common::sense |
1159 | sub common_sense { |
1196 | sub common_sense { |
1160 | # from common:.sense 3.3 |
1197 | # from common:.sense 3.4 |
1161 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; |
1198 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; |
1162 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1199 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1163 | $^H |= 0x00000600; |
1200 | $^H |= 0x00000600; |
1164 | } |
1201 | } |
1165 | |
1202 | |
1166 | BEGIN { AnyEvent::common_sense } |
1203 | BEGIN { AnyEvent::common_sense } |
1167 | |
1204 | |
1168 | use Carp (); |
1205 | use Carp (); |
1169 | |
1206 | |
1170 | our $VERSION = '5.271'; |
1207 | our $VERSION = '5.34'; |
1171 | our $MODEL; |
1208 | our $MODEL; |
1172 | |
1209 | |
1173 | our $AUTOLOAD; |
1210 | our $AUTOLOAD; |
1174 | our @ISA; |
1211 | our @ISA; |
1175 | |
1212 | |
… | |
… | |
1200 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1237 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
1201 | } |
1238 | } |
1202 | |
1239 | |
1203 | my @models = ( |
1240 | my @models = ( |
1204 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1241 | [EV:: => AnyEvent::Impl::EV:: , 1], |
1205 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], |
1242 | [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], |
1206 | # everything below here will not (normally) be autoprobed |
1243 | # everything below here will not (normally) be autoprobed |
1207 | # as the pureperl backend should work everywhere |
1244 | # as the pure perl backend should work everywhere |
1208 | # and is usually faster |
1245 | # and is usually faster |
1209 | [Event:: => AnyEvent::Impl::Event::, 1], |
1246 | [Event:: => AnyEvent::Impl::Event::, 1], |
1210 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1247 | [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers |
1211 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1248 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1212 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1249 | [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package |
1213 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1250 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
1214 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1251 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1215 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1252 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1216 | [Wx:: => AnyEvent::Impl::POE::], |
1253 | [Wx:: => AnyEvent::Impl::POE::], |
1217 | [Prima:: => AnyEvent::Impl::POE::], |
1254 | [Prima:: => AnyEvent::Impl::POE::], |
1218 | # IO::Async is just too broken - we would need workarounds for its |
|
|
1219 | # byzantine signal and broken child handling, among others. |
|
|
1220 | # IO::Async is rather hard to detect, as it doesn't have any |
|
|
1221 | # obvious default class. |
|
|
1222 | [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1223 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1255 | [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], |
1224 | [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1256 | [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], |
1225 | [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program |
1257 | [FLTK:: => AnyEvent::Impl::FLTK::], |
1226 | ); |
1258 | ); |
1227 | |
1259 | |
1228 | our %method = map +($_ => 1), |
1260 | our %method = map +($_ => 1), |
1229 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
1261 | qw(io timer time now now_update signal child idle condvar DESTROY); |
1230 | |
1262 | |
1231 | our @post_detect; |
1263 | our @post_detect; |
1232 | |
1264 | |
1233 | sub post_detect(&) { |
1265 | sub post_detect(&) { |
1234 | my ($cb) = @_; |
1266 | my ($cb) = @_; |
… | |
… | |
1289 | last; |
1321 | last; |
1290 | } |
1322 | } |
1291 | } |
1323 | } |
1292 | |
1324 | |
1293 | $MODEL |
1325 | $MODEL |
1294 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
1326 | or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; |
1295 | } |
1327 | } |
1296 | } |
1328 | } |
1297 | |
1329 | |
1298 | @models = (); # free probe data |
1330 | @models = (); # free probe data |
1299 | |
1331 | |
1300 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1332 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1301 | unshift @ISA, $MODEL; |
1333 | unshift @ISA, $MODEL; |
1302 | |
1334 | |
1303 | # now nuke some methods that are overriden by the backend. |
1335 | # now nuke some methods that are overridden by the backend. |
1304 | # SUPER is not allowed. |
1336 | # SUPER is not allowed. |
1305 | for (qw(time signal child idle)) { |
1337 | for (qw(time signal child idle)) { |
1306 | undef &{"AnyEvent::Base::$_"} |
1338 | undef &{"AnyEvent::Base::$_"} |
1307 | if defined &{"$MODEL\::$_"}; |
1339 | if defined &{"$MODEL\::$_"}; |
1308 | } |
1340 | } |
1309 | |
1341 | |
1310 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
1342 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
|
|
1343 | eval { require AnyEvent::Strict }; |
|
|
1344 | warn "AnyEvent: cannot load AnyEvent::Strict: $@" |
|
|
1345 | if $@ && $VERBOSE; |
|
|
1346 | } |
1311 | |
1347 | |
1312 | (shift @post_detect)->() while @post_detect; |
1348 | (shift @post_detect)->() while @post_detect; |
1313 | |
1349 | |
1314 | *post_detect = sub(&) { |
1350 | *post_detect = sub(&) { |
1315 | shift->(); |
1351 | shift->(); |
… | |
… | |
1328 | |
1364 | |
1329 | detect; |
1365 | detect; |
1330 | |
1366 | |
1331 | my $class = shift; |
1367 | my $class = shift; |
1332 | $class->$func (@_); |
1368 | $class->$func (@_); |
|
|
1369 | } |
|
|
1370 | |
|
|
1371 | our $POSTPONE_W; |
|
|
1372 | our @POSTPONE; |
|
|
1373 | |
|
|
1374 | sub _postpone_exec { |
|
|
1375 | undef $POSTPONE_W; |
|
|
1376 | (pop @POSTPONE)->() |
|
|
1377 | while @POSTPONE; |
|
|
1378 | } |
|
|
1379 | |
|
|
1380 | sub postpone(&) { |
|
|
1381 | push @POSTPONE, shift; |
|
|
1382 | |
|
|
1383 | $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); |
|
|
1384 | |
|
|
1385 | () |
1333 | } |
1386 | } |
1334 | |
1387 | |
1335 | # utility function to dup a filehandle. this is used by many backends |
1388 | # utility function to dup a filehandle. this is used by many backends |
1336 | # to support binding more than one watcher per filehandle (they usually |
1389 | # to support binding more than one watcher per filehandle (they usually |
1337 | # allow only one watcher per fd, so we dup it to get a different one). |
1390 | # allow only one watcher per fd, so we dup it to get a different one). |
… | |
… | |
1399 | } |
1452 | } |
1400 | |
1453 | |
1401 | sub time() { |
1454 | sub time() { |
1402 | AnyEvent->time |
1455 | AnyEvent->time |
1403 | } |
1456 | } |
|
|
1457 | |
|
|
1458 | *postpone = \&AnyEvent::postpone; |
1404 | |
1459 | |
1405 | package AnyEvent::Base; |
1460 | package AnyEvent::Base; |
1406 | |
1461 | |
1407 | # default implementations for many methods |
1462 | # default implementations for many methods |
1408 | |
1463 | |
… | |
… | |
1427 | |
1482 | |
1428 | *now = \&time; |
1483 | *now = \&time; |
1429 | |
1484 | |
1430 | sub now_update { } |
1485 | sub now_update { } |
1431 | |
1486 | |
|
|
1487 | sub _poll { |
|
|
1488 | Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; |
|
|
1489 | } |
|
|
1490 | |
1432 | # default implementation for ->condvar |
1491 | # default implementation for ->condvar |
|
|
1492 | # in fact, the default should not be overwritten |
1433 | |
1493 | |
1434 | sub condvar { |
1494 | sub condvar { |
1435 | eval q{ # poor man's autoloading {} |
1495 | eval q{ # poor man's autoloading {} |
1436 | *condvar = sub { |
1496 | *condvar = sub { |
1437 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1497 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
… | |
… | |
1622 | # default implementation for ->child |
1682 | # default implementation for ->child |
1623 | |
1683 | |
1624 | our %PID_CB; |
1684 | our %PID_CB; |
1625 | our $CHLD_W; |
1685 | our $CHLD_W; |
1626 | our $CHLD_DELAY_W; |
1686 | our $CHLD_DELAY_W; |
1627 | our $WNOHANG; |
|
|
1628 | |
1687 | |
1629 | # used by many Impl's |
1688 | # used by many Impl's |
1630 | sub _emit_childstatus($$) { |
1689 | sub _emit_childstatus($$) { |
1631 | my (undef, $rpid, $rstatus) = @_; |
1690 | my (undef, $rpid, $rstatus) = @_; |
1632 | |
1691 | |
… | |
… | |
1639 | eval q{ # poor man's autoloading {} |
1698 | eval q{ # poor man's autoloading {} |
1640 | *_sigchld = sub { |
1699 | *_sigchld = sub { |
1641 | my $pid; |
1700 | my $pid; |
1642 | |
1701 | |
1643 | AnyEvent->_emit_childstatus ($pid, $?) |
1702 | AnyEvent->_emit_childstatus ($pid, $?) |
1644 | while ($pid = waitpid -1, $WNOHANG) > 0; |
1703 | while ($pid = waitpid -1, WNOHANG) > 0; |
1645 | }; |
1704 | }; |
1646 | |
1705 | |
1647 | *child = sub { |
1706 | *child = sub { |
1648 | my (undef, %arg) = @_; |
1707 | my (undef, %arg) = @_; |
1649 | |
1708 | |
1650 | defined (my $pid = $arg{pid} + 0) |
1709 | my $pid = $arg{pid}; |
1651 | or Carp::croak "required option 'pid' is missing"; |
1710 | my $cb = $arg{cb}; |
1652 | |
1711 | |
1653 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1712 | $PID_CB{$pid}{$cb+0} = $cb; |
1654 | |
|
|
1655 | # WNOHANG is almost cetrainly 1 everywhere |
|
|
1656 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
|
|
1657 | ? 1 |
|
|
1658 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
|
|
1659 | |
1713 | |
1660 | unless ($CHLD_W) { |
1714 | unless ($CHLD_W) { |
1661 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1715 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1662 | # child could be a zombie already, so make at least one round |
1716 | # child could be a zombie already, so make at least one round |
1663 | &_sigchld; |
1717 | &_sigchld; |
1664 | } |
1718 | } |
1665 | |
1719 | |
1666 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1720 | bless [$pid, $cb+0], "AnyEvent::Base::child" |
1667 | }; |
1721 | }; |
1668 | |
1722 | |
1669 | *AnyEvent::Base::child::DESTROY = sub { |
1723 | *AnyEvent::Base::child::DESTROY = sub { |
1670 | my ($pid, $cb) = @{$_[0]}; |
1724 | my ($pid, $icb) = @{$_[0]}; |
1671 | |
1725 | |
1672 | delete $PID_CB{$pid}{$cb}; |
1726 | delete $PID_CB{$pid}{$icb}; |
1673 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1727 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1674 | |
1728 | |
1675 | undef $CHLD_W unless keys %PID_CB; |
1729 | undef $CHLD_W unless keys %PID_CB; |
1676 | }; |
1730 | }; |
1677 | }; |
1731 | }; |
… | |
… | |
1749 | |
1803 | |
1750 | sub _send { |
1804 | sub _send { |
1751 | # nop |
1805 | # nop |
1752 | } |
1806 | } |
1753 | |
1807 | |
|
|
1808 | sub _wait { |
|
|
1809 | AnyEvent->_poll until $_[0]{_ae_sent}; |
|
|
1810 | } |
|
|
1811 | |
1754 | sub send { |
1812 | sub send { |
1755 | my $cv = shift; |
1813 | my $cv = shift; |
1756 | $cv->{_ae_sent} = [@_]; |
1814 | $cv->{_ae_sent} = [@_]; |
1757 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
1815 | (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; |
1758 | $cv->_send; |
1816 | $cv->_send; |
… | |
… | |
1765 | |
1823 | |
1766 | sub ready { |
1824 | sub ready { |
1767 | $_[0]{_ae_sent} |
1825 | $_[0]{_ae_sent} |
1768 | } |
1826 | } |
1769 | |
1827 | |
1770 | sub _wait { |
|
|
1771 | $WAITING |
|
|
1772 | and !$_[0]{_ae_sent} |
|
|
1773 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; |
|
|
1774 | |
|
|
1775 | local $WAITING = 1; |
|
|
1776 | AnyEvent->one_event while !$_[0]{_ae_sent}; |
|
|
1777 | } |
|
|
1778 | |
|
|
1779 | sub recv { |
1828 | sub recv { |
|
|
1829 | unless ($_[0]{_ae_sent}) { |
|
|
1830 | $WAITING |
|
|
1831 | and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted"; |
|
|
1832 | |
|
|
1833 | local $WAITING = 1; |
1780 | $_[0]->_wait; |
1834 | $_[0]->_wait; |
|
|
1835 | } |
1781 | |
1836 | |
1782 | Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; |
1837 | $_[0]{_ae_croak} |
1783 | wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] |
1838 | and Carp::croak $_[0]{_ae_croak}; |
|
|
1839 | |
|
|
1840 | wantarray |
|
|
1841 | ? @{ $_[0]{_ae_sent} } |
|
|
1842 | : $_[0]{_ae_sent}[0] |
1784 | } |
1843 | } |
1785 | |
1844 | |
1786 | sub cb { |
1845 | sub cb { |
1787 | my $cv = shift; |
1846 | my $cv = shift; |
1788 | |
1847 | |
… | |
… | |
1804 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
1863 | &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; |
1805 | } |
1864 | } |
1806 | |
1865 | |
1807 | # undocumented/compatibility with pre-3.4 |
1866 | # undocumented/compatibility with pre-3.4 |
1808 | *broadcast = \&send; |
1867 | *broadcast = \&send; |
1809 | *wait = \&_wait; |
1868 | *wait = \&recv; |
1810 | |
1869 | |
1811 | =head1 ERROR AND EXCEPTION HANDLING |
1870 | =head1 ERROR AND EXCEPTION HANDLING |
1812 | |
1871 | |
1813 | In general, AnyEvent does not do any error handling - it relies on the |
1872 | In general, AnyEvent does not do any error handling - it relies on the |
1814 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
1873 | caller to do that if required. The L<AnyEvent::Strict> module (see also |
… | |
… | |
1877 | used as event model. If it fails to load AnyEvent will proceed with |
1936 | used as event model. If it fails to load AnyEvent will proceed with |
1878 | auto detection and -probing. |
1937 | auto detection and -probing. |
1879 | |
1938 | |
1880 | This functionality might change in future versions. |
1939 | This functionality might change in future versions. |
1881 | |
1940 | |
1882 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1941 | For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you |
1883 | could start your program like this: |
1942 | could start your program like this: |
1884 | |
1943 | |
1885 | PERL_ANYEVENT_MODEL=Perl perl ... |
1944 | PERL_ANYEVENT_MODEL=Perl perl ... |
1886 | |
1945 | |
1887 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1946 | =item C<PERL_ANYEVENT_PROTOCOLS> |
… | |
… | |
2586 | |
2645 | |
2587 | =item L<Time::HiRes> |
2646 | =item L<Time::HiRes> |
2588 | |
2647 | |
2589 | This module is part of perl since release 5.008. It will be used when the |
2648 | This module is part of perl since release 5.008. It will be used when the |
2590 | chosen event library does not come with a timing source of its own. The |
2649 | chosen event library does not come with a timing source of its own. The |
2591 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
2650 | pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to |
2592 | try to use a monotonic clock for timing stability. |
2651 | try to use a monotonic clock for timing stability. |
2593 | |
2652 | |
2594 | =back |
2653 | =back |
2595 | |
2654 | |
2596 | |
2655 | |
… | |
… | |
2658 | pronounced). |
2717 | pronounced). |
2659 | |
2718 | |
2660 | |
2719 | |
2661 | =head1 SEE ALSO |
2720 | =head1 SEE ALSO |
2662 | |
2721 | |
|
|
2722 | Tutorial/Introduction: L<AnyEvent::Intro>. |
|
|
2723 | |
|
|
2724 | FAQ: L<AnyEvent::FAQ>. |
|
|
2725 | |
2663 | Utility functions: L<AnyEvent::Util>. |
2726 | Utility functions: L<AnyEvent::Util>. |
2664 | |
2727 | |
2665 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
2728 | Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
2666 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2729 | L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
2667 | |
2730 | |
2668 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2731 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
2669 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2732 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
2670 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2733 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
2671 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
2734 | L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. |
… | |
… | |
2673 | Non-blocking file handles, sockets, TCP clients and |
2736 | Non-blocking file handles, sockets, TCP clients and |
2674 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2737 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. |
2675 | |
2738 | |
2676 | Asynchronous DNS: L<AnyEvent::DNS>. |
2739 | Asynchronous DNS: L<AnyEvent::DNS>. |
2677 | |
2740 | |
2678 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, |
2741 | Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
2679 | L<Coro::Event>, |
|
|
2680 | |
2742 | |
2681 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, |
2743 | Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>, |
2682 | L<AnyEvent::HTTP>. |
2744 | L<AnyEvent::HTTP>. |
2683 | |
2745 | |
2684 | |
2746 | |
2685 | =head1 AUTHOR |
2747 | =head1 AUTHOR |
2686 | |
2748 | |