ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.330 by root, Tue Aug 31 00:59:55 2010 UTC vs.
Revision 1.386 by root, Mon Sep 26 11:32:19 2011 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - the DBI of event loop programming 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6and POE are various supported event loops/environments. 6FLTK 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
46in a tutorial or some gentle introduction, have a look at the 46in a tutorial or some gentle introduction, have a look at the
47L<AnyEvent::Intro> manpage. 47L<AnyEvent::Intro> manpage.
48 48
49=head1 SUPPORT 49=head1 SUPPORT
50 50
51An FAQ document is available as L<AnyEvent::FAQ>.
52
51There is a mailinglist for discussing all things AnyEvent, and an IRC 53There also is a mailinglist for discussing all things AnyEvent, and an IRC
52channel, too. 54channel, too.
53 55
54See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software 56See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
55Repository>, at L<http://anyevent.schmorp.de>, for more info. 57Repository>, at L<http://anyevent.schmorp.de>, for more info.
56 58
83that isn't them. What's worse, all the potential users of your 85that isn't them. What's worse, all the potential users of your
84module are I<also> forced to use the same event loop you use. 86module are I<also> forced to use the same event loop you use.
85 87
86AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 88AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
87fine. AnyEvent + Tk works fine etc. etc. but none of these work together 89fine. AnyEvent + Tk works fine etc. etc. but none of these work together
88with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if 90with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
89your module uses one of those, every user of your module has to use it, 91uses one of those, every user of your module has to use it, too. But if
90too. But if your module uses AnyEvent, it works transparently with all 92your module uses AnyEvent, it works transparently with all event models it
91event models it supports (including stuff like IO::Async, as long as those 93supports (including stuff like IO::Async, as long as those use one of the
92use one of the supported event loops. It is easy to add new event loops 94supported event loops. It is easy to add new event loops to AnyEvent, too,
93to AnyEvent, too, so it is future-proof). 95so it is future-proof).
94 96
95In addition to being free of having to use I<the one and only true event 97In addition to being free of having to use I<the one and only true event
96model>, AnyEvent also is free of bloat and policy: with POE or similar 98model>, AnyEvent also is free of bloat and policy: with POE or similar
97modules, you get an enormous amount of code and strict rules you have to 99modules, you get an enormous amount of code and strict rules you have to
98follow. AnyEvent, on the other hand, is lean and to the point, by only 100follow. AnyEvent, on the other hand, is lean and to the point, by only
119The interface itself is vaguely similar, but not identical to the L<Event> 121The interface itself is vaguely similar, but not identical to the L<Event>
120module. 122module.
121 123
122During the first call of any watcher-creation method, the module tries 124During the first call of any watcher-creation method, the module tries
123to detect the currently loaded event loop by probing whether one of the 125to detect the currently loaded event loop by probing whether one of the
124following modules is already loaded: L<EV>, 126following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
125L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, 127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
126L<POE>. The first one found is used. If none are found, the module tries 128found is used. If none are detected, the module tries to load the first
127to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl 129four modules in the order given; but note that if L<EV> is not
128adaptor should always succeed) in the order given. The first one that can 130available, the pure-perl L<AnyEvent::Loop> should always work, so
129be successfully loaded will be used. If, after this, still none could be 131the other two are not normally tried.
130found, AnyEvent will fall back to a pure-perl event loop, which is not
131very efficient, but should work everywhere.
132 132
133Because AnyEvent first checks for modules that are already loaded, loading 133Because AnyEvent first checks for modules that are already loaded, loading
134an event model explicitly before first using AnyEvent will likely make 134an event model explicitly before first using AnyEvent will likely make
135that model the default. For example: 135that model the default. For example:
136 136
142The I<likely> means that, if any module loads another event model and 142The I<likely> means that, if any module loads another event model and
143starts using it, all bets are off - this case should be very rare though, 143starts using it, all bets are off - this case should be very rare though,
144as very few modules hardcode event loops without announcing this very 144as very few modules hardcode event loops without announcing this very
145loudly. 145loudly.
146 146
147The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
148C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148other event modules you can load it explicitly and enjoy the high
149explicitly and enjoy the high availability of that event loop :) 149availability of that event loop :)
150 150
151=head1 WATCHERS 151=head1 WATCHERS
152 152
153AnyEvent has the central concept of a I<watcher>, which is an object that 153AnyEvent has the central concept of a I<watcher>, which is an object that
154stores relevant data for each kind of event you are waiting for, such as 154stores relevant data for each kind of event you are waiting for, such as
356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
357account. 357account.
358 358
359=item AnyEvent->now_update 359=item AnyEvent->now_update
360 360
361Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache 361Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362the current time for each loop iteration (see the discussion of L<< 362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363AnyEvent->now >>, above). 363above).
364 364
365When a callback runs for a long time (or when the process sleeps), then 365When a callback runs for a long time (or when the process sleeps), then
366this "current" time will differ substantially from the real time, which 366this "current" time will differ substantially from the real time, which
367might affect timers and time-outs. 367might affect timers and time-outs.
368 368
482thing in an AnyEvent program, you I<have> to create at least one 482thing in an AnyEvent program, you I<have> to create at least one
483watcher before you C<fork> the child (alternatively, you can call 483watcher before you C<fork> the child (alternatively, you can call
484C<AnyEvent::detect>). 484C<AnyEvent::detect>).
485 485
486As most event loops do not support waiting for child events, they will be 486As most event loops do not support waiting for child events, they will be
487emulated by AnyEvent in most cases, in which the latency and race problems 487emulated by AnyEvent in most cases, in which case the latency and race
488mentioned in the description of signal watchers apply. 488problems mentioned in the description of signal watchers apply.
489 489
490Example: fork a process and wait for it 490Example: fork a process and wait for it
491 491
492 my $done = AnyEvent->condvar; 492 my $done = AnyEvent->condvar;
493 493
860use. If EV is not installed, then AnyEvent will fall back to its own 860use. If EV is not installed, then AnyEvent will fall back to its own
861pure-perl implementation, which is available everywhere as it comes with 861pure-perl implementation, which is available everywhere as it comes with
862AnyEvent itself. 862AnyEvent 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
869These will be used if they are already loaded when the first watcher 869These will be used if they are already loaded when the first watcher
870is created, in which case it is assumed that the application is using 870is 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::FLTK based on FLTK (fltk 2 binding).
881 884
882=item Backends with special needs. 885=item Backends with special needs.
883 886
884Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
885otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
886instantiates the application before any AnyEvent watchers are created, 889instantiates the application before any AnyEvent watchers are created,
887everything should just work. 890everything should just work.
888 891
889 AnyEvent::Impl::Qt based on Qt. 892 AnyEvent::Impl::Qt based on Qt.
890
891Support for IO::Async can only be partial, as it is too broken and
892architecturally limited to even support the AnyEvent API. It also
893is the only event loop that needs the loop to be set explicitly, so
894it can only be used by a main program knowing about AnyEvent. See
895L<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
901Some event loops can be supported via other modules: 896Some event loops can be supported via other modules:
902 897
938 933
939Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
940if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
941have created an AnyEvent watcher anyway, that is, as late as possible at 936have created an AnyEvent watcher anyway, that is, as late as possible at
942runtime, and not e.g. during initialisation of your module. 937runtime, and not e.g. during initialisation of your module.
938
939The effect of calling this function is as if a watcher had been created
940(specifically, actions that happen "when the first watcher is created"
941happen when calling detetc as well).
943 942
944If you need to do some initialisation before AnyEvent watchers are 943If you need to do some initialisation before AnyEvent watchers are
945created, use C<post_detect>. 944created, 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
1016Arranges for the block to be executed as soon as possible, but not before
1017the call itself returns. In practise, the block will be executed just
1018before the event loop polls for new events, or shortly afterwards.
1019
1020This function never returns anything (to make the C<return postpone { ...
1021}> idiom more useful.
1022
1023To understand the usefulness of this function, consider a function that
1024asynchronously does something for you and returns some transaction
1025object or guard to let you cancel the operation. For example,
1026C<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
1034Imagine that this function could instantly call the callback, for
1035example, because it detects an obvious error such as a negative port
1036number. Invoking the callback before the function returns causes problems
1037however: the callback will be called and will try to delete the guard
1038object. But since the function hasn't returned yet, there is nothing to
1039delete. When the function eventually returns it will assign the guard
1040object to C<< $self->{connect_guard} >>, where it will likely never be
1041deleted, so the program thinks it is still trying to connect.
1042
1043This is where C<AnyEvent::postpone> should be used. Instead of calling the
1044callback directly on error:
1045
1046 $cb->(undef), return # signal error to callback, BAD!
1047 if $some_error_condition;
1048
1049It 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
1056Log the given C<$msg> at the given C<$level>.
1057
1058If L<AnyEvent::Log> is not loaded then this function makes a simple test
1059to see whether the message will be logged. If the test succeeds it will
1060load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1061the L<AnyEvent::Log> documentation for details.
1062
1063If the test fails it will simply return. Right now this happens when a
1064numerical loglevel is used and it is larger than the level specified via
1065C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1066
1067If you want to sprinkle loads of logging calls around your code, consider
1068creating a logger callback with the C<AnyEvent::Log::logger> function,
1069which can reduce typing, codesize and can reduce the logging overhead
1070enourmously.
1071
1015=back 1072=back
1016 1073
1017=head1 WHAT TO DO IN A MODULE 1074=head1 WHAT TO DO IN A MODULE
1018 1075
1019As a module author, you should C<use AnyEvent> and call AnyEvent methods 1076As a module author, you should C<use AnyEvent> and call AnyEvent methods
1052modules might create watchers when they are loaded, and AnyEvent will 1109modules might create watchers when they are loaded, and AnyEvent will
1053decide on the event model to use as soon as it creates watchers, and it 1110decide on the event model to use as soon as it creates watchers, and it
1054might choose the wrong one unless you load the correct one yourself. 1111might choose the wrong one unless you load the correct one yourself.
1055 1112
1056You can chose to use a pure-perl implementation by loading the 1113You can chose to use a pure-perl implementation by loading the
1057C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1114C<AnyEvent::Loop> module, which gives you similar behaviour
1058everywhere, but letting AnyEvent chose the model is generally better. 1115everywhere, but letting AnyEvent chose the model is generally better.
1059 1116
1060=head2 MAINLOOP EMULATION 1117=head2 MAINLOOP EMULATION
1061 1118
1062Sometimes (often for short test scripts, or even standalone programs who 1119Sometimes (often for short test scripts, or even standalone programs who
1075 1132
1076 1133
1077=head1 OTHER MODULES 1134=head1 OTHER MODULES
1078 1135
1079The following is a non-exhaustive list of additional modules that use 1136The following is a non-exhaustive list of additional modules that use
1080AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1137AnyEvent as a client and can therefore be mixed easily with other
1081modules and other event loops in the same program. Some of the modules 1138AnyEvent modules and other event loops in the same program. Some of the
1082come as part of AnyEvent, the others are available via CPAN. 1139modules come as part of AnyEvent, the others are available via CPAN (see
1140L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1141a longer non-exhaustive list), and the list is heavily biased towards
1142modules of the AnyEvent author himself :)
1083 1143
1084=over 4 1144=over 4
1085 1145
1086=item L<AnyEvent::Util> 1146=item L<AnyEvent::Util>
1087 1147
1107=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> 1167=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1108 1168
1109Implement event-based interfaces to the protocols of the same name (for 1169Implement event-based interfaces to the protocols of the same name (for
1110the curious, IGS is the International Go Server and FCP is the Freenet 1170the curious, IGS is the International Go Server and FCP is the Freenet
1111Client Protocol). 1171Client Protocol).
1112
1113=item L<AnyEvent::Handle::UDP>
1114
1115Here be danger!
1116
1117As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1118there are so many things wrong with AnyEvent::Handle::UDP, most notably
1119its use of a stream-based API with a protocol that isn't streamable, that
1120the only way to improve it is to delete it.
1121
1122It features data corruption (but typically only under load) and general
1123confusion. On top, the author is not only clueless about UDP but also
1124fact-resistant - some gems of his understanding: "connect doesn't work
1125with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1126packets", "I don't need to implement proper error checking as UDP doesn't
1127support error checking" and so on - he doesn't even understand what's
1128wrong with his module when it is explained to him.
1129
1130=item L<AnyEvent::DBI>
1131
1132Executes L<DBI> requests asynchronously in a proxy process for you,
1133notifying you in an event-based way when the operation is finished.
1134 1172
1135=item L<AnyEvent::AIO> 1173=item L<AnyEvent::AIO>
1136 1174
1137Truly asynchronous (as opposed to non-blocking) I/O, should be in the 1175Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1138toolbox of every event programmer. AnyEvent::AIO transparently fuses 1176toolbox of every event programmer. AnyEvent::AIO transparently fuses
1139L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1177L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1140file I/O, and much more. 1178file I/O, and much more.
1141 1179
1180=item L<AnyEvent::Filesys::Notify>
1181
1182AnyEvent is good for non-blocking stuff, but it can't detect file or
1183path changes (e.g. "watch this directory for new files", "watch this
1184file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1185do just that in a portbale fashion, supporting inotify on GNU/Linux and
1186some weird, without doubt broken, stuff on OS X to monitor files. It can
1187fall back to blocking scans at regular intervals transparently on other
1188platforms, so it's about as portable as it gets.
1189
1190(I haven't used it myself, but I haven't heard anybody complaining about
1191it yet).
1192
1193=item L<AnyEvent::DBI>
1194
1195Executes L<DBI> requests asynchronously in a proxy process for you,
1196notifying you in an event-based way when the operation is finished.
1197
1142=item L<AnyEvent::HTTPD> 1198=item L<AnyEvent::HTTPD>
1143 1199
1144A simple embedded webserver. 1200A simple embedded webserver.
1145 1201
1146=item L<AnyEvent::FastPing> 1202=item L<AnyEvent::FastPing>
1147 1203
1148The fastest ping in the west. 1204The fastest ping in the west.
1149 1205
1150=item L<Coro> 1206=item L<Coro>
1151 1207
1152Has special support for AnyEvent via L<Coro::AnyEvent>. 1208Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1209to simply invert the flow control - don't call us, we will call you:
1210
1211 async {
1212 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1213 print "5 seconds later!\n";
1214
1215 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1216 my $line = <STDIN>; # works for ttys
1217
1218 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1219 my ($body, $hdr) = Coro::rouse_wait;
1220 };
1153 1221
1154=back 1222=back
1155 1223
1156=cut 1224=cut
1157 1225
1158package AnyEvent; 1226package AnyEvent;
1159 1227
1160# basically a tuned-down version of common::sense 1228# basically a tuned-down version of common::sense
1161sub common_sense { 1229sub common_sense {
1162 # from common:.sense 1.0 1230 # from common:.sense 3.4
1163 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00"; 1231 ${^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) 1232 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1165 $^H |= 0x00000600; 1233 $^H |= 0x00000600;
1166} 1234}
1167 1235
1168BEGIN { AnyEvent::common_sense } 1236BEGIN { AnyEvent::common_sense }
1169 1237
1170use Carp (); 1238use Carp ();
1171 1239
1172our $VERSION = '5.271'; 1240our $VERSION = '6.02';
1173our $MODEL; 1241our $MODEL;
1174
1175our $AUTOLOAD;
1176our @ISA; 1242our @ISA;
1177
1178our @REGISTRY; 1243our @REGISTRY;
1179
1180our $VERBOSE; 1244our $VERBOSE;
1245our $MAX_SIGNAL_LATENCY = 10;
1246our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1181 1247
1182BEGIN { 1248BEGIN {
1183 require "AnyEvent/constants.pl"; 1249 require "AnyEvent/constants.pl";
1184 1250
1185 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1251 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1186 1252
1187 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1253 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1188 if ${^TAINT}; 1254 if ${^TAINT};
1189 1255
1190 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1256 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1257 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1191 1258
1192} 1259 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1260 if ${^TAINT};
1193 1261
1194our $MAX_SIGNAL_LATENCY = 10; 1262 # $ENV{PERL_ANYEVENT_xxx} now valid
1195 1263
1196our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1264 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1197 1265
1198{
1199 my $idx; 1266 my $idx;
1200 $PROTOCOL{$_} = ++$idx 1267 $PROTOCOL{$_} = ++$idx
1201 for reverse split /\s*,\s*/, 1268 for reverse split /\s*,\s*/,
1202 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1269 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1203} 1270}
1204 1271
1272our @post_detect;
1273
1274sub post_detect(&) {
1275 my ($cb) = @_;
1276
1277 push @post_detect, $cb;
1278
1279 defined wantarray
1280 ? bless \$cb, "AnyEvent::Util::postdetect"
1281 : ()
1282}
1283
1284sub AnyEvent::Util::postdetect::DESTROY {
1285 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1286}
1287
1288our $POSTPONE_W;
1289our @POSTPONE;
1290
1291sub _postpone_exec {
1292 undef $POSTPONE_W;
1293
1294 &{ shift @POSTPONE }
1295 while @POSTPONE;
1296}
1297
1298sub postpone(&) {
1299 push @POSTPONE, shift;
1300
1301 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1302
1303 ()
1304}
1305
1306sub log($$;@) {
1307 # only load the big bloated module when we actually are about to log something
1308 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
1309 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1310 # AnyEvent::Log overwrites this function
1311 goto &log;
1312 }
1313
1314 0 # not logged
1315}
1316
1317sub logger($;$) {
1318 package AnyEvent::Log;
1319
1320 my ($level, $renabled) = @_;
1321
1322 $$renabled = $level <= $VERBOSE;
1323
1324 my $pkg = (caller)[0];
1325
1326 my $logger = [$pkg, $level, $renabled];
1327
1328 our %LOGGER;
1329 $LOGGER{$logger+0} = $logger;
1330
1331 require AnyEvent::Util;
1332 my $guard = AnyEvent::Util::guard (sub {
1333 # "clean up"
1334 delete $LOGGER{$logger+0};
1335 });
1336
1337 sub {
1338 return 0 unless $$renabled;
1339
1340 $guard if 0; # keep guard alive, but don't cause runtime overhead
1341 require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1342 package AnyEvent::Log;
1343 _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1344 }
1345}
1346
1347if (length $ENV{PERL_ANYEVENT_LOG}) {
1348 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1349}
1350
1205my @models = ( 1351our @models = (
1206 [EV:: => AnyEvent::Impl::EV:: , 1], 1352 [EV:: => AnyEvent::Impl::EV::],
1207 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1353 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1208 # everything below here will not (normally) be autoprobed 1354 # everything below here will not (normally) be autoprobed
1209 # as the pureperl backend should work everywhere 1355 # as the pure perl backend should work everywhere
1210 # and is usually faster 1356 # and is usually faster
1357 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1211 [Event:: => AnyEvent::Impl::Event::, 1], 1358 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1212 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1359 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1360 # everything below here should not be autoloaded
1213 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1361 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1214 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1215 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1362 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1216 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1363 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1217 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1364 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1218 [Wx:: => AnyEvent::Impl::POE::], 1365 [Wx:: => AnyEvent::Impl::POE::],
1219 [Prima:: => AnyEvent::Impl::POE::], 1366 [Prima:: => AnyEvent::Impl::POE::],
1220 # IO::Async is just too broken - we would need workarounds for its 1367 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1221 # byzantine signal and broken child handling, among others. 1368 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1222 # IO::Async is rather hard to detect, as it doesn't have any 1369 [FLTK:: => AnyEvent::Impl::FLTK::],
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); 1370);
1229 1371
1230our %method = map +($_ => 1), 1372our @isa_hook;
1373
1374sub _isa_set {
1375 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1376
1377 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1378 for 1 .. $#pkg;
1379
1380 grep $_ && $_->[1], @isa_hook
1381 and AE::_reset ();
1382}
1383
1384# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1385sub _isa_hook($$;$) {
1386 my ($i, $pkg, $reset_ae) = @_;
1387
1388 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1389
1390 _isa_set;
1391}
1392
1393# all autoloaded methods reserve the complete glob, not just the method slot.
1394# due to bugs in perls method cache implementation.
1231 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1395our @methods = qw(io timer time now now_update signal child idle condvar);
1232
1233our @post_detect;
1234
1235sub post_detect(&) {
1236 my ($cb) = @_;
1237
1238 push @post_detect, $cb;
1239
1240 defined wantarray
1241 ? bless \$cb, "AnyEvent::Util::postdetect"
1242 : ()
1243}
1244
1245sub AnyEvent::Util::postdetect::DESTROY {
1246 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1247}
1248 1396
1249sub detect() { 1397sub detect() {
1398 return $MODEL if $MODEL; # some programs keep references to detect
1399
1400 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1401 # the author knows about the problems and what it does to AnyEvent as a whole
1402 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1403 # anyway.
1404 AnyEvent::log fatal => "AnyEvent: IO::Async::Loop::AnyEvent detected - this module is broken by design,\n"
1405 . "abuses internals and breaks AnyEvent, will not continue."
1406 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1407
1408 local $!; # for good measure
1409 local $SIG{__DIE__}; # we use eval
1410
1250 # free some memory 1411 # free some memory
1251 *detect = sub () { $MODEL }; 1412 *detect = sub () { $MODEL };
1413 # undef &func doesn't correctly update the method cache. grmbl.
1414 # so we delete the whole glob. grmbl.
1415 # otoh, perl doesn't let me undef an active usb, but it lets me free
1416 # a glob with an active sub. hrm. i hope it works, but perl is
1417 # usually buggy in this department. sigh.
1418 delete @{"AnyEvent::"}{@methods};
1419 undef @methods;
1252 1420
1253 local $!; # for good measure
1254 local $SIG{__DIE__};
1255
1256 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1421 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1257 my $model = "AnyEvent::Impl::$1"; 1422 my $model = $1;
1423 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1258 if (eval "require $model") { 1424 if (eval "require $model") {
1425 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1259 $MODEL = $model; 1426 $MODEL = $model;
1260 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1261 } else { 1427 } else {
1262 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1428 AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1263 } 1429 }
1264 } 1430 }
1265 1431
1266 # check for already loaded models 1432 # check for already loaded models
1267 unless ($MODEL) { 1433 unless ($MODEL) {
1268 for (@REGISTRY, @models) { 1434 for (@REGISTRY, @models) {
1269 my ($package, $model) = @$_; 1435 my ($package, $model) = @$_;
1270 if (${"$package\::VERSION"} > 0) { 1436 if (${"$package\::VERSION"} > 0) {
1271 if (eval "require $model") { 1437 if (eval "require $model") {
1438 AnyEvent::log 7 => "autodetected model '$model', using it.";
1272 $MODEL = $model; 1439 $MODEL = $model;
1273 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1274 last; 1440 last;
1275 } 1441 }
1276 } 1442 }
1277 } 1443 }
1278 1444
1279 unless ($MODEL) { 1445 unless ($MODEL) {
1280 # try to autoload a model 1446 # try to autoload a model
1281 for (@REGISTRY, @models) { 1447 for (@REGISTRY, @models) {
1282 my ($package, $model, $autoload) = @$_; 1448 my ($package, $model) = @$_;
1283 if ( 1449 if (
1284 $autoload
1285 and eval "require $package" 1450 eval "require $package"
1286 and ${"$package\::VERSION"} > 0 1451 and ${"$package\::VERSION"} > 0
1287 and eval "require $model" 1452 and eval "require $model"
1288 ) { 1453 ) {
1454 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1289 $MODEL = $model; 1455 $MODEL = $model;
1290 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1291 last; 1456 last;
1292 } 1457 }
1293 } 1458 }
1294 1459
1295 $MODEL 1460 $MODEL
1296 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1461 or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1297 } 1462 }
1298 } 1463 }
1299 1464
1300 @models = (); # free probe data 1465 # free memory only needed for probing
1466 undef @models;
1467 undef @REGISTRY;
1301 1468
1302 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1469 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1303 unshift @ISA, $MODEL;
1304 1470
1305 # now nuke some methods that are overriden by the backend. 1471 # now nuke some methods that are overridden by the backend.
1306 # SUPER is not allowed. 1472 # SUPER usage is not allowed in these.
1307 for (qw(time signal child idle)) { 1473 for (qw(time signal child idle)) {
1308 undef &{"AnyEvent::Base::$_"} 1474 undef &{"AnyEvent::Base::$_"}
1309 if defined &{"$MODEL\::$_"}; 1475 if defined &{"$MODEL\::$_"};
1310 } 1476 }
1311 1477
1312 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; 1478 _isa_set;
1479
1480 # we're officially open!
1481
1482 if ($ENV{PERL_ANYEVENT_STRICT}) {
1483 require AnyEvent::Strict;
1484 }
1485
1486 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1487 require AnyEvent::Debug;
1488 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1489 }
1490
1491 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1492 require AnyEvent::Socket;
1493 require AnyEvent::Debug;
1494
1495 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1496 $shell =~ s/\$\$/$$/g;
1497
1498 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1499 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1500 }
1501
1502 # now the anyevent environment is set up as the user told us to, so
1503 # call the actual user code - post detects
1313 1504
1314 (shift @post_detect)->() while @post_detect; 1505 (shift @post_detect)->() while @post_detect;
1506 undef @post_detect;
1315 1507
1316 *post_detect = sub(&) { 1508 *post_detect = sub(&) {
1317 shift->(); 1509 shift->();
1318 1510
1319 undef 1511 undef
1320 }; 1512 };
1321 1513
1322 $MODEL 1514 $MODEL
1323} 1515}
1324 1516
1325sub AUTOLOAD { 1517for my $name (@methods) {
1326 (my $func = $AUTOLOAD) =~ s/.*://; 1518 *$name = sub {
1327
1328 $method{$func}
1329 or Carp::croak "$func: not a valid AnyEvent class method";
1330
1331 detect; 1519 detect;
1332 1520 # we use goto because
1333 my $class = shift; 1521 # a) it makes the thunk more transparent
1334 $class->$func (@_); 1522 # b) it allows us to delete the thunk later
1523 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1524 };
1335} 1525}
1336 1526
1337# utility function to dup a filehandle. this is used by many backends 1527# utility function to dup a filehandle. this is used by many backends
1338# to support binding more than one watcher per filehandle (they usually 1528# 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). 1529# allow only one watcher per fd, so we dup it to get a different one).
1363 1553
1364package AE; 1554package AE;
1365 1555
1366our $VERSION = $AnyEvent::VERSION; 1556our $VERSION = $AnyEvent::VERSION;
1367 1557
1558sub _reset() {
1559 eval q{
1368# fall back to the main API by default - backends and AnyEvent::Base 1560 # fall back to the main API by default - backends and AnyEvent::Base
1369# implementations can overwrite these. 1561 # implementations can overwrite these.
1370 1562
1371sub io($$$) { 1563 sub io($$$) {
1372 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1564 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1373} 1565 }
1374 1566
1375sub timer($$$) { 1567 sub timer($$$) {
1376 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1568 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1377} 1569 }
1378 1570
1379sub signal($$) { 1571 sub signal($$) {
1380 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1572 AnyEvent->signal (signal => $_[0], cb => $_[1])
1381} 1573 }
1382 1574
1383sub child($$) { 1575 sub child($$) {
1384 AnyEvent->child (pid => $_[0], cb => $_[1]) 1576 AnyEvent->child (pid => $_[0], cb => $_[1])
1385} 1577 }
1386 1578
1387sub idle($) { 1579 sub idle($) {
1388 AnyEvent->idle (cb => $_[0]) 1580 AnyEvent->idle (cb => $_[0]);
1389} 1581 }
1390 1582
1391sub cv(;&) { 1583 sub cv(;&) {
1392 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1584 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1393} 1585 }
1394 1586
1395sub now() { 1587 sub now() {
1396 AnyEvent->now 1588 AnyEvent->now
1397} 1589 }
1398 1590
1399sub now_update() { 1591 sub now_update() {
1400 AnyEvent->now_update 1592 AnyEvent->now_update
1401} 1593 }
1402 1594
1403sub time() { 1595 sub time() {
1404 AnyEvent->time 1596 AnyEvent->time
1597 }
1598
1599 *postpone = \&AnyEvent::postpone;
1600 *log = \&AnyEvent::log;
1601 };
1602 die if $@;
1405} 1603}
1604
1605BEGIN { _reset }
1406 1606
1407package AnyEvent::Base; 1607package AnyEvent::Base;
1408 1608
1409# default implementations for many methods 1609# default implementations for many methods
1410 1610
1411sub time { 1611sub time {
1412 eval q{ # poor man's autoloading {} 1612 eval q{ # poor man's autoloading {}
1413 # probe for availability of Time::HiRes 1613 # probe for availability of Time::HiRes
1414 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1614 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1415 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1615 *time = sub { Time::HiRes::time () };
1416 *AE::time = \&Time::HiRes::time; 1616 *AE::time = \& Time::HiRes::time ;
1617 *now = \&time;
1618 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1417 # if (eval "use POSIX (); (POSIX::times())... 1619 # if (eval "use POSIX (); (POSIX::times())...
1418 } else { 1620 } else {
1621 *time = sub { CORE::time };
1622 *AE::time = sub (){ CORE::time };
1623 *now = \&time;
1419 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1624 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1420 *AE::time = sub (){ time }; # epic fail
1421 } 1625 }
1422
1423 *time = sub { AE::time }; # different prototypes
1424 }; 1626 };
1425 die if $@; 1627 die if $@;
1426 1628
1427 &time 1629 &time
1428} 1630}
1429 1631
1430*now = \&time; 1632*now = \&time;
1431
1432sub now_update { } 1633sub now_update { }
1433 1634
1635sub _poll {
1636 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1637}
1638
1434# default implementation for ->condvar 1639# default implementation for ->condvar
1640# in fact, the default should not be overwritten
1435 1641
1436sub condvar { 1642sub condvar {
1437 eval q{ # poor man's autoloading {} 1643 eval q{ # poor man's autoloading {}
1438 *condvar = sub { 1644 *condvar = sub {
1439 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1645 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1517 1723
1518sub signal { 1724sub signal {
1519 eval q{ # poor man's autoloading {} 1725 eval q{ # poor man's autoloading {}
1520 # probe for availability of Async::Interrupt 1726 # probe for availability of Async::Interrupt
1521 if (_have_async_interrupt) { 1727 if (_have_async_interrupt) {
1522 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1728 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1523 1729
1524 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1730 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1525 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1731 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1526 1732
1527 } else { 1733 } else {
1528 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1734 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1529 1735
1530 if (AnyEvent::WIN32) { 1736 if (AnyEvent::WIN32) {
1531 require AnyEvent::Util; 1737 require AnyEvent::Util;
1532 1738
1533 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1739 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1609 : sysread $SIGPIPE_R, (my $dummy), 9; 1815 : sysread $SIGPIPE_R, (my $dummy), 9;
1610 1816
1611 while (%SIG_EV) { 1817 while (%SIG_EV) {
1612 for (keys %SIG_EV) { 1818 for (keys %SIG_EV) {
1613 delete $SIG_EV{$_}; 1819 delete $SIG_EV{$_};
1614 $_->() for values %{ $SIG_CB{$_} || {} }; 1820 &$_ for values %{ $SIG_CB{$_} || {} };
1615 } 1821 }
1616 } 1822 }
1617 }; 1823 };
1618 }; 1824 };
1619 die if $@; 1825 die if $@;
1624# default implementation for ->child 1830# default implementation for ->child
1625 1831
1626our %PID_CB; 1832our %PID_CB;
1627our $CHLD_W; 1833our $CHLD_W;
1628our $CHLD_DELAY_W; 1834our $CHLD_DELAY_W;
1629our $WNOHANG;
1630 1835
1631# used by many Impl's 1836# used by many Impl's
1632sub _emit_childstatus($$) { 1837sub _emit_childstatus($$) {
1633 my (undef, $rpid, $rstatus) = @_; 1838 my (undef, $rpid, $rstatus) = @_;
1634 1839
1641 eval q{ # poor man's autoloading {} 1846 eval q{ # poor man's autoloading {}
1642 *_sigchld = sub { 1847 *_sigchld = sub {
1643 my $pid; 1848 my $pid;
1644 1849
1645 AnyEvent->_emit_childstatus ($pid, $?) 1850 AnyEvent->_emit_childstatus ($pid, $?)
1646 while ($pid = waitpid -1, $WNOHANG) > 0; 1851 while ($pid = waitpid -1, WNOHANG) > 0;
1647 }; 1852 };
1648 1853
1649 *child = sub { 1854 *child = sub {
1650 my (undef, %arg) = @_; 1855 my (undef, %arg) = @_;
1651 1856
1652 defined (my $pid = $arg{pid} + 0) 1857 my $pid = $arg{pid};
1653 or Carp::croak "required option 'pid' is missing"; 1858 my $cb = $arg{cb};
1654 1859
1655 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1860 $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 1861
1662 unless ($CHLD_W) { 1862 unless ($CHLD_W) {
1663 $CHLD_W = AE::signal CHLD => \&_sigchld; 1863 $CHLD_W = AE::signal CHLD => \&_sigchld;
1664 # child could be a zombie already, so make at least one round 1864 # child could be a zombie already, so make at least one round
1665 &_sigchld; 1865 &_sigchld;
1666 } 1866 }
1667 1867
1668 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1868 bless [$pid, $cb+0], "AnyEvent::Base::child"
1669 }; 1869 };
1670 1870
1671 *AnyEvent::Base::child::DESTROY = sub { 1871 *AnyEvent::Base::child::DESTROY = sub {
1672 my ($pid, $cb) = @{$_[0]}; 1872 my ($pid, $icb) = @{$_[0]};
1673 1873
1674 delete $PID_CB{$pid}{$cb}; 1874 delete $PID_CB{$pid}{$icb};
1675 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1875 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1676 1876
1677 undef $CHLD_W unless keys %PID_CB; 1877 undef $CHLD_W unless keys %PID_CB;
1678 }; 1878 };
1679 }; 1879 };
1692 1892
1693 my ($cb, $w, $rcb) = $arg{cb}; 1893 my ($cb, $w, $rcb) = $arg{cb};
1694 1894
1695 $rcb = sub { 1895 $rcb = sub {
1696 if ($cb) { 1896 if ($cb) {
1697 $w = _time; 1897 $w = AE::time;
1698 &$cb; 1898 &$cb;
1699 $w = _time - $w; 1899 $w = AE::time - $w;
1700 1900
1701 # never use more then 50% of the time for the idle watcher, 1901 # never use more then 50% of the time for the idle watcher,
1702 # within some limits 1902 # within some limits
1703 $w = 0.0001 if $w < 0.0001; 1903 $w = 0.0001 if $w < 0.0001;
1704 $w = 5 if $w > 5; 1904 $w = 5 if $w > 5;
1727 1927
1728package AnyEvent::CondVar; 1928package AnyEvent::CondVar;
1729 1929
1730our @ISA = AnyEvent::CondVar::Base::; 1930our @ISA = AnyEvent::CondVar::Base::;
1731 1931
1932# only to be used for subclassing
1933sub new {
1934 my $class = shift;
1935 bless AnyEvent->condvar (@_), $class
1936}
1937
1732package AnyEvent::CondVar::Base; 1938package AnyEvent::CondVar::Base;
1733 1939
1734#use overload 1940#use overload
1735# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1941# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1736# fallback => 1; 1942# fallback => 1;
1745 1951
1746sub _send { 1952sub _send {
1747 # nop 1953 # nop
1748} 1954}
1749 1955
1956sub _wait {
1957 AnyEvent->_poll until $_[0]{_ae_sent};
1958}
1959
1750sub send { 1960sub send {
1751 my $cv = shift; 1961 my $cv = shift;
1752 $cv->{_ae_sent} = [@_]; 1962 $cv->{_ae_sent} = [@_];
1753 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1963 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1754 $cv->_send; 1964 $cv->_send;
1761 1971
1762sub ready { 1972sub ready {
1763 $_[0]{_ae_sent} 1973 $_[0]{_ae_sent}
1764} 1974}
1765 1975
1766sub _wait {
1767 $WAITING
1768 and !$_[0]{_ae_sent}
1769 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1770
1771 local $WAITING = 1;
1772 AnyEvent->one_event while !$_[0]{_ae_sent};
1773}
1774
1775sub recv { 1976sub recv {
1977 unless ($_[0]{_ae_sent}) {
1978 $WAITING
1979 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1980
1981 local $WAITING = 1;
1776 $_[0]->_wait; 1982 $_[0]->_wait;
1983 }
1777 1984
1778 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1985 $_[0]{_ae_croak}
1779 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1986 and Carp::croak $_[0]{_ae_croak};
1987
1988 wantarray
1989 ? @{ $_[0]{_ae_sent} }
1990 : $_[0]{_ae_sent}[0]
1780} 1991}
1781 1992
1782sub cb { 1993sub cb {
1783 my $cv = shift; 1994 my $cv = shift;
1784 1995
1800 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 2011 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1801} 2012}
1802 2013
1803# undocumented/compatibility with pre-3.4 2014# undocumented/compatibility with pre-3.4
1804*broadcast = \&send; 2015*broadcast = \&send;
1805*wait = \&_wait; 2016*wait = \&recv;
1806 2017
1807=head1 ERROR AND EXCEPTION HANDLING 2018=head1 ERROR AND EXCEPTION HANDLING
1808 2019
1809In general, AnyEvent does not do any error handling - it relies on the 2020In general, AnyEvent does not do any error handling - it relies on the
1810caller to do that if required. The L<AnyEvent::Strict> module (see also 2021caller to do that if required. The L<AnyEvent::Strict> module (see also
1822$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2033$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1823so on. 2034so on.
1824 2035
1825=head1 ENVIRONMENT VARIABLES 2036=head1 ENVIRONMENT VARIABLES
1826 2037
1827The following environment variables are used by this module or its 2038AnyEvent supports a number of environment variables that tune the
1828submodules. 2039runtime behaviour. They are usually evaluated when AnyEvent is
2040loaded, initialised, or a submodule that uses them is loaded. Many of
2041them also cause AnyEvent to load additional modules - for example,
2042C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2043loaded.
1829 2044
1830Note that AnyEvent will remove I<all> environment variables starting with 2045All the environment variables documented here start with
1831C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2046C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1832enabled. 2047namespace. Other modules are encouraged (but by no means required) to use
2048C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2049namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2050be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2051variables starting with C<AE_>, see below).
2052
2053All variables can also be set via the C<AE_> prefix, that is, instead
2054of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2055case there is a clash btween anyevent and another program that uses
2056C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2057variable to the empty string, as those variables take precedence.
2058
2059When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2060to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2061exists. If taint mode is on, then AnyEvent will remove I<all> environment
2062variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2063with C<undef> or the empty string, if the corresaponding C<AE_> variable
2064is set).
2065
2066The exact algorithm is currently:
2067
2068 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2069 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2070 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2071
2072This ensures that child processes will not see the C<AE_> variables.
2073
2074The following environment variables are currently known to AnyEvent:
1833 2075
1834=over 4 2076=over 4
1835 2077
1836=item C<PERL_ANYEVENT_VERBOSE> 2078=item C<PERL_ANYEVENT_VERBOSE>
1837 2079
1838By default, AnyEvent will be completely silent except in fatal 2080By default, AnyEvent will only log messages with loglevel C<3>
1839conditions. You can set this environment variable to make AnyEvent more 2081(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2082environment variable to a numerical loglevel to make AnyEvent more (or
1840talkative. 2083less) talkative.
1841 2084
2085If you want to do more than just set the global logging level
2086you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2087complex specifications.
2088
2089When set to C<0> (C<off>), then no messages whatsoever will be logged with
2090the default logging settings.
2091
1842When set to C<1> or higher, causes AnyEvent to warn about unexpected 2092When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1843conditions, such as not being able to load the event model specified by 2093unexpected conditions, such as not being able to load the event model
1844C<PERL_ANYEVENT_MODEL>. 2094specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2095exception - this is the minimum recommended level.
1845 2096
1846When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2097When set to C<7> or higher (info), cause AnyEvent to report which event model it
1847model it chooses. 2098chooses.
1848 2099
1849When set to C<8> or higher, then AnyEvent will report extra information on 2100When set to C<8> or higher (debug), then AnyEvent will report extra information on
1850which optional modules it loads and how it implements certain features. 2101which optional modules it loads and how it implements certain features.
2102
2103=item C<PERL_ANYEVENT_LOG>
2104
2105Accepts rather complex logging specifications. For example, you could log
2106all C<debug> messages of some module to stderr, warnings and above to
2107stderr, and errors and above to syslog, with:
2108
2109 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2110
2111For the rather extensive details, see L<AnyEvent::Log>.
2112
2113This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2114so will take effect even before AnyEvent has initialised itself.
2115
2116Note that specifying this environment variable causes the L<AnyEvent::Log>
2117module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2118using the latter saves a few hundred kB of memory until the first message
2119is being logged.
1851 2120
1852=item C<PERL_ANYEVENT_STRICT> 2121=item C<PERL_ANYEVENT_STRICT>
1853 2122
1854AnyEvent does not do much argument checking by default, as thorough 2123AnyEvent does not do much argument checking by default, as thorough
1855argument checking is very costly. Setting this variable to a true value 2124argument checking is very costly. Setting this variable to a true value
1862Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2131Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1863>>, it is definitely recommended to keep it off in production. Keeping 2132>>, it is definitely recommended to keep it off in production. Keeping
1864C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2133C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1865can be very useful, however. 2134can be very useful, however.
1866 2135
2136=item C<PERL_ANYEVENT_DEBUG_SHELL>
2137
2138If this env variable is nonempty, then its contents will be interpreted by
2139C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2140replacing every occurance of C<$$> by the process pid). The shell object
2141is saved in C<$AnyEvent::Debug::SHELL>.
2142
2143This happens when the first watcher is created.
2144
2145For example, to bind a debug shell on a unix domain socket in
2146F<< /tmp/debug<pid>.sock >>, you could use this:
2147
2148 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2149 # connect with e.g.: socat readline /tmp/debug123.sock
2150
2151Or to bind to tcp port 4545 on localhost:
2152
2153 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2154 # connect with e.g.: telnet localhost 4545
2155
2156Note that creating sockets in F</tmp> or on localhost is very unsafe on
2157multiuser systems.
2158
2159=item C<PERL_ANYEVENT_DEBUG_WRAP>
2160
2161Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2162debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2163
1867=item C<PERL_ANYEVENT_MODEL> 2164=item C<PERL_ANYEVENT_MODEL>
1868 2165
1869This can be used to specify the event model to be used by AnyEvent, before 2166This can be used to specify the event model to be used by AnyEvent, before
1870auto detection and -probing kicks in. It must be a string consisting 2167auto detection and -probing kicks in.
1871entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2168
2169It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2170or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1872and the resulting module name is loaded and if the load was successful, 2171resulting module name is loaded and - if the load was successful - used as
1873used as event model. If it fails to load AnyEvent will proceed with 2172event model backend. If it fails to load then AnyEvent will proceed with
1874auto detection and -probing. 2173auto detection and -probing.
1875 2174
1876This functionality might change in future versions. 2175If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2176nothing gets prepended and the module name is used as-is (hint: C<::> at
2177the end of a string designates a module name and quotes it appropriately).
1877 2178
1878For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2179For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1879could start your program like this: 2180could start your program like this:
1880 2181
1881 PERL_ANYEVENT_MODEL=Perl perl ... 2182 PERL_ANYEVENT_MODEL=Perl perl ...
1882 2183
1883=item C<PERL_ANYEVENT_PROTOCOLS> 2184=item C<PERL_ANYEVENT_PROTOCOLS>
1899but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2200but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1900- only support IPv4, never try to resolve or contact IPv6 2201- only support IPv4, never try to resolve or contact IPv6
1901addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2202addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1902IPv6, but prefer IPv6 over IPv4. 2203IPv6, but prefer IPv6 over IPv4.
1903 2204
2205=item C<PERL_ANYEVENT_HOSTS>
2206
2207This variable, if specified, overrides the F</etc/hosts> file used by
2208L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2209from that file instead.
2210
1904=item C<PERL_ANYEVENT_EDNS0> 2211=item C<PERL_ANYEVENT_EDNS0>
1905 2212
1906Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2213Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1907for DNS. This extension is generally useful to reduce DNS traffic, but 2214DNS. This extension is generally useful to reduce DNS traffic, especially
1908some (broken) firewalls drop such DNS packets, which is why it is off by 2215when DNSSEC is involved, but some (broken) firewalls drop such DNS
1909default. 2216packets, which is why it is off by default.
1910 2217
1911Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2218Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1912EDNS0 in its DNS requests. 2219EDNS0 in its DNS requests.
1913 2220
1914=item C<PERL_ANYEVENT_MAX_FORKS> 2221=item C<PERL_ANYEVENT_MAX_FORKS>
1922resolver - this is the maximum number of parallel DNS requests that are 2229resolver - this is the maximum number of parallel DNS requests that are
1923sent to the DNS server. 2230sent to the DNS server.
1924 2231
1925=item C<PERL_ANYEVENT_RESOLV_CONF> 2232=item C<PERL_ANYEVENT_RESOLV_CONF>
1926 2233
1927The file to use instead of F</etc/resolv.conf> (or OS-specific 2234The absolute path to a F<resolv.conf>-style file to use instead of
1928configuration) in the default resolver. When set to the empty string, no 2235F</etc/resolv.conf> (or the OS-specific configuration) in the default
1929default config will be used. 2236resolver, or the empty string to select the default configuration.
1930 2237
1931=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2238=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1932 2239
1933When neither C<ca_file> nor C<ca_path> was specified during 2240When neither C<ca_file> nor C<ca_path> was specified during
1934L<AnyEvent::TLS> context creation, and either of these environment 2241L<AnyEvent::TLS> context creation, and either of these environment
1935variables exist, they will be used to specify CA certificate locations 2242variables are nonempty, they will be used to specify CA certificate
1936instead of a system-dependent default. 2243locations instead of a system-dependent default.
1937 2244
1938=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2245=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1939 2246
1940When these are set to C<1>, then the respective modules are not 2247When these are set to C<1>, then the respective modules are not
1941loaded. Mostly good for testing AnyEvent itself. 2248loaded. Mostly good for testing AnyEvent itself.
2273(even when used without AnyEvent), but most event loops have acceptable 2580(even when used without AnyEvent), but most event loops have acceptable
2274performance with or without AnyEvent. 2581performance with or without AnyEvent.
2275 2582
2276=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2583=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2277the actual event loop, only with extremely fast event loops such as EV 2584the actual event loop, only with extremely fast event loops such as EV
2278adds AnyEvent significant overhead. 2585does AnyEvent add significant overhead.
2279 2586
2280=item * You should avoid POE like the plague if you want performance or 2587=item * You should avoid POE like the plague if you want performance or
2281reasonable memory usage. 2588reasonable memory usage.
2282 2589
2283=back 2590=back
2582 2889
2583=item L<Time::HiRes> 2890=item L<Time::HiRes>
2584 2891
2585This module is part of perl since release 5.008. It will be used when the 2892This module is part of perl since release 5.008. It will be used when the
2586chosen event library does not come with a timing source of its own. The 2893chosen event library does not come with a timing source of its own. The
2587pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2894pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2588try to use a monotonic clock for timing stability. 2895try to use a monotonic clock for timing stability.
2589 2896
2590=back 2897=back
2591 2898
2592 2899
2654pronounced). 2961pronounced).
2655 2962
2656 2963
2657=head1 SEE ALSO 2964=head1 SEE ALSO
2658 2965
2659Utility functions: L<AnyEvent::Util>. 2966Tutorial/Introduction: L<AnyEvent::Intro>.
2660 2967
2661Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2968FAQ: L<AnyEvent::FAQ>.
2662L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2969
2970Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2971(simply logging).
2972
2973Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2974L<AnyEvent::Debug> (interactive shell, watcher tracing).
2975
2976Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2977L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2978L<Qt>, L<POE>, L<FLTK>.
2663 2979
2664Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2980Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2665L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2981L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2666L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2982L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2667L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2983L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2984L<AnyEvent::Impl::FLTK>.
2668 2985
2669Non-blocking file handles, sockets, TCP clients and 2986Non-blocking handles, pipes, stream sockets, TCP clients and
2670servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2987servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2671 2988
2672Asynchronous DNS: L<AnyEvent::DNS>. 2989Asynchronous DNS: L<AnyEvent::DNS>.
2673 2990
2674Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 2991Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2675L<Coro::Event>,
2676 2992
2677Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 2993Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2678L<AnyEvent::HTTP>. 2994L<AnyEvent::HTTP>.
2679 2995
2680 2996
2681=head1 AUTHOR 2997=head1 AUTHOR
2682 2998

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines