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.332 by root, Tue Aug 31 23:32:40 2010 UTC vs.
Revision 1.384 by root, Mon Sep 5 07:21:54 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>, L<AnyEvent::Impl::Perl>, 126following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
125L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one 127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
126found is used. If none are detected, the module tries to load the first 128found is used. If none are detected, the module tries to load the first
127four modules in the order given; but note that if L<EV> is not 129four modules in the order given; but note that if L<EV> is not
128available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so 130available, the pure-perl L<AnyEvent::Loop> should always work, so
129the other two are not normally tried. 131the other two are not normally tried.
130 132
131Because AnyEvent first checks for modules that are already loaded, loading 133Because AnyEvent first checks for modules that are already loaded, loading
132an event model explicitly before first using AnyEvent will likely make 134an event model explicitly before first using AnyEvent will likely make
133that model the default. For example: 135that model the default. For example:
140The 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
141starts 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,
142as very few modules hardcode event loops without announcing this very 144as very few modules hardcode event loops without announcing this very
143loudly. 145loudly.
144 146
145The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
146C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148other event modules you can load it explicitly and enjoy the high
147explicitly and enjoy the high availability of that event loop :) 149availability of that event loop :)
148 150
149=head1 WATCHERS 151=head1 WATCHERS
150 152
151AnyEvent 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
152stores 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
354difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
355account. 357account.
356 358
357=item AnyEvent->now_update 359=item AnyEvent->now_update
358 360
359Some 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
360the current time for each loop iteration (see the discussion of L<< 362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
361AnyEvent->now >>, above). 363above).
362 364
363When 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
364this "current" time will differ substantially from the real time, which 366this "current" time will differ substantially from the real time, which
365might affect timers and time-outs. 367might affect timers and time-outs.
366 368
480thing 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
481watcher before you C<fork> the child (alternatively, you can call 483watcher before you C<fork> the child (alternatively, you can call
482C<AnyEvent::detect>). 484C<AnyEvent::detect>).
483 485
484As 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
485emulated 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
486mentioned in the description of signal watchers apply. 488problems mentioned in the description of signal watchers apply.
487 489
488Example: fork a process and wait for it 490Example: fork a process and wait for it
489 491
490 my $done = AnyEvent->condvar; 492 my $done = AnyEvent->condvar;
491 493
858use. 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
859pure-perl implementation, which is available everywhere as it comes with 861pure-perl implementation, which is available everywhere as it comes with
860AnyEvent itself. 862AnyEvent 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
867These 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
868is 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
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 (fltk 2 binding).
879 884
880=item Backends with special needs. 885=item Backends with special needs.
881 886
882Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
883otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
884instantiates the application before any AnyEvent watchers are created, 889instantiates the application before any AnyEvent watchers are created,
885everything should just work. 890everything should just work.
886 891
887 AnyEvent::Impl::Qt based on Qt. 892 AnyEvent::Impl::Qt based on Qt.
888
889Support for IO::Async can only be partial, as it is too broken and
890architecturally limited to even support the AnyEvent API. It also
891is the only event loop that needs the loop to be set explicitly, so
892it can only be used by a main program knowing about AnyEvent. See
893L<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
899Some event loops can be supported via other modules: 896Some event loops can be supported via other modules:
900 897
936 933
937Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
938if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
939have 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
940runtime, 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).
941 942
942If you need to do some initialisation before AnyEvent watchers are 943If you need to do some initialisation before AnyEvent watchers are
943created, use C<post_detect>. 944created, use C<post_detect>.
944 945
945=item $guard = AnyEvent::post_detect { BLOCK } 946=item $guard = AnyEvent::post_detect { BLOCK }
1008 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1009 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1009 # as soon as it is 1010 # as soon as it is
1010 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1011 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1011 } 1012 }
1012 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
1013=back 1072=back
1014 1073
1015=head1 WHAT TO DO IN A MODULE 1074=head1 WHAT TO DO IN A MODULE
1016 1075
1017As 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
1050modules might create watchers when they are loaded, and AnyEvent will 1109modules might create watchers when they are loaded, and AnyEvent will
1051decide 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
1052might choose the wrong one unless you load the correct one yourself. 1111might choose the wrong one unless you load the correct one yourself.
1053 1112
1054You can chose to use a pure-perl implementation by loading the 1113You can chose to use a pure-perl implementation by loading the
1055C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1114C<AnyEvent::Loop> module, which gives you similar behaviour
1056everywhere, but letting AnyEvent chose the model is generally better. 1115everywhere, but letting AnyEvent chose the model is generally better.
1057 1116
1058=head2 MAINLOOP EMULATION 1117=head2 MAINLOOP EMULATION
1059 1118
1060Sometimes (often for short test scripts, or even standalone programs who 1119Sometimes (often for short test scripts, or even standalone programs who
1073 1132
1074 1133
1075=head1 OTHER MODULES 1134=head1 OTHER MODULES
1076 1135
1077The following is a non-exhaustive list of additional modules that use 1136The following is a non-exhaustive list of additional modules that use
1078AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1137AnyEvent as a client and can therefore be mixed easily with other
1079modules 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
1080come 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 :)
1081 1143
1082=over 4 1144=over 4
1083 1145
1084=item L<AnyEvent::Util> 1146=item L<AnyEvent::Util>
1085 1147
1105=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>
1106 1168
1107Implement event-based interfaces to the protocols of the same name (for 1169Implement event-based interfaces to the protocols of the same name (for
1108the 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
1109Client Protocol). 1171Client Protocol).
1110
1111=item L<AnyEvent::Handle::UDP>
1112
1113Here be danger!
1114
1115As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1116there are so many things wrong with AnyEvent::Handle::UDP, most notably
1117its use of a stream-based API with a protocol that isn't streamable, that
1118the only way to improve it is to delete it.
1119
1120It features data corruption (but typically only under load) and general
1121confusion. On top, the author is not only clueless about UDP but also
1122fact-resistant - some gems of his understanding: "connect doesn't work
1123with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1124packets", "I don't need to implement proper error checking as UDP doesn't
1125support error checking" and so on - he doesn't even understand what's
1126wrong with his module when it is explained to him.
1127
1128=item L<AnyEvent::DBI>
1129
1130Executes L<DBI> requests asynchronously in a proxy process for you,
1131notifying you in an event-based way when the operation is finished.
1132 1172
1133=item L<AnyEvent::AIO> 1173=item L<AnyEvent::AIO>
1134 1174
1135Truly 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
1136toolbox of every event programmer. AnyEvent::AIO transparently fuses 1176toolbox of every event programmer. AnyEvent::AIO transparently fuses
1137L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1177L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1138file I/O, and much more. 1178file I/O, and much more.
1139 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
1140=item L<AnyEvent::HTTPD> 1198=item L<AnyEvent::HTTPD>
1141 1199
1142A simple embedded webserver. 1200A simple embedded webserver.
1143 1201
1144=item L<AnyEvent::FastPing> 1202=item L<AnyEvent::FastPing>
1145 1203
1146The fastest ping in the west. 1204The fastest ping in the west.
1147 1205
1148=item L<Coro> 1206=item L<Coro>
1149 1207
1150Has 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 };
1151 1221
1152=back 1222=back
1153 1223
1154=cut 1224=cut
1155 1225
1156package AnyEvent; 1226package AnyEvent;
1157 1227
1158# basically a tuned-down version of common::sense 1228# basically a tuned-down version of common::sense
1159sub common_sense { 1229sub common_sense {
1160 # from common:.sense 3.3 1230 # from common:.sense 3.4
1161 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; 1231 ${^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) 1232 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1163 $^H |= 0x00000600; 1233 $^H |= 0x00000600;
1164} 1234}
1165 1235
1166BEGIN { AnyEvent::common_sense } 1236BEGIN { AnyEvent::common_sense }
1167 1237
1168use Carp (); 1238use Carp ();
1169 1239
1170our $VERSION = '5.271'; 1240our $VERSION = '6.02';
1171our $MODEL; 1241our $MODEL;
1172
1173our $AUTOLOAD;
1174our @ISA; 1242our @ISA;
1175
1176our @REGISTRY; 1243our @REGISTRY;
1177
1178our $VERBOSE; 1244our $VERBOSE;
1245our $MAX_SIGNAL_LATENCY = 10;
1246our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1179 1247
1180BEGIN { 1248BEGIN {
1181 require "AnyEvent/constants.pl"; 1249 require "AnyEvent/constants.pl";
1182 1250
1183 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1251 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1184 1252
1185 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1253 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1186 if ${^TAINT}; 1254 if ${^TAINT};
1187 1255
1188 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1256 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1257 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1189 1258
1190} 1259 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1260 if ${^TAINT};
1191 1261
1192our $MAX_SIGNAL_LATENCY = 10; 1262 # $ENV{PERL_ANYEVENT_xxx} now valid
1193 1263
1194our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1264 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1195 1265
1196{
1197 my $idx; 1266 my $idx;
1198 $PROTOCOL{$_} = ++$idx 1267 $PROTOCOL{$_} = ++$idx
1199 for reverse split /\s*,\s*/, 1268 for reverse split /\s*,\s*/,
1200 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1269 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1201} 1270}
1202 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
1203my @models = ( 1351our @models = (
1204 [EV:: => AnyEvent::Impl::EV:: , 1], 1352 [EV:: => AnyEvent::Impl::EV:: , 1],
1205 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1353 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
1206 # everything below here will not (normally) be autoprobed 1354 # everything below here will not (normally) be autoprobed
1207 # as the pureperl backend should work everywhere 1355 # as the pure perl backend should work everywhere
1208 # and is usually faster 1356 # and is usually faster
1209 [Event:: => AnyEvent::Impl::Event::, 1], 1357 [Event:: => AnyEvent::Impl::Event::, 1],
1210 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1358 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1211 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1359 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1212 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1360 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1213 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1361 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1214 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1362 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1215 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1363 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1216 [Wx:: => AnyEvent::Impl::POE::], 1364 [Wx:: => AnyEvent::Impl::POE::],
1217 [Prima:: => AnyEvent::Impl::POE::], 1365 [Prima:: => AnyEvent::Impl::POE::],
1218 # IO::Async is just too broken - we would need workarounds for its 1366 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1219 # byzantine signal and broken child handling, among others. 1367 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1220 # IO::Async is rather hard to detect, as it doesn't have any 1368 [FLTK:: => AnyEvent::Impl::FLTK::],
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
1224 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1225 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1226); 1369);
1227 1370
1228our %method = map +($_ => 1), 1371our @isa_hook;
1372
1373sub _isa_set {
1374 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1375
1376 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1377 for 1 .. $#pkg;
1378
1379 grep $_ && $_->[1], @isa_hook
1380 and AE::_reset ();
1381}
1382
1383# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1384sub _isa_hook($$;$) {
1385 my ($i, $pkg, $reset_ae) = @_;
1386
1387 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1388
1389 _isa_set;
1390}
1391
1392# all autoloaded methods reserve the complete glob, not just the method slot.
1393# due to bugs in perls method cache implementation.
1229 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1394our @methods = qw(io timer time now now_update signal child idle condvar);
1230
1231our @post_detect;
1232
1233sub post_detect(&) {
1234 my ($cb) = @_;
1235
1236 push @post_detect, $cb;
1237
1238 defined wantarray
1239 ? bless \$cb, "AnyEvent::Util::postdetect"
1240 : ()
1241}
1242
1243sub AnyEvent::Util::postdetect::DESTROY {
1244 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1245}
1246 1395
1247sub detect() { 1396sub detect() {
1397 return $MODEL if $MODEL; # some programs keep references to detect
1398
1399 local $!; # for good measure
1400 local $SIG{__DIE__}; # we use eval
1401
1248 # free some memory 1402 # free some memory
1249 *detect = sub () { $MODEL }; 1403 *detect = sub () { $MODEL };
1404 # undef &func doesn't correctly update the method cache. grmbl.
1405 # so we delete the whole glob. grmbl.
1406 # otoh, perl doesn't let me undef an active usb, but it lets me free
1407 # a glob with an active sub. hrm. i hope it works, but perl is
1408 # usually buggy in this department. sigh.
1409 delete @{"AnyEvent::"}{@methods};
1410 undef @methods;
1250 1411
1251 local $!; # for good measure
1252 local $SIG{__DIE__};
1253
1254 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1412 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1255 my $model = "AnyEvent::Impl::$1"; 1413 my $model = $1;
1414 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1256 if (eval "require $model") { 1415 if (eval "require $model") {
1416 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1257 $MODEL = $model; 1417 $MODEL = $model;
1258 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1259 } else { 1418 } else {
1260 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1419 AnyEvent::log 4 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1261 } 1420 }
1262 } 1421 }
1263 1422
1264 # check for already loaded models 1423 # check for already loaded models
1265 unless ($MODEL) { 1424 unless ($MODEL) {
1266 for (@REGISTRY, @models) { 1425 for (@REGISTRY, @models) {
1267 my ($package, $model) = @$_; 1426 my ($package, $model) = @$_;
1268 if (${"$package\::VERSION"} > 0) { 1427 if (${"$package\::VERSION"} > 0) {
1269 if (eval "require $model") { 1428 if (eval "require $model") {
1429 AnyEvent::log 7 => "autodetected model '$model', using it.";
1270 $MODEL = $model; 1430 $MODEL = $model;
1271 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1272 last; 1431 last;
1273 } 1432 }
1274 } 1433 }
1275 } 1434 }
1276 1435
1282 $autoload 1441 $autoload
1283 and eval "require $package" 1442 and eval "require $package"
1284 and ${"$package\::VERSION"} > 0 1443 and ${"$package\::VERSION"} > 0
1285 and eval "require $model" 1444 and eval "require $model"
1286 ) { 1445 ) {
1446 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1287 $MODEL = $model; 1447 $MODEL = $model;
1288 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1289 last; 1448 last;
1290 } 1449 }
1291 } 1450 }
1292 1451
1293 $MODEL 1452 $MODEL
1294 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1453 or AnyEvent::log fatal => "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1295 } 1454 }
1296 } 1455 }
1297 1456
1298 @models = (); # free probe data 1457 # free memory only needed for probing
1458 undef @models;
1459 undef @REGISTRY;
1299 1460
1300 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1461 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1301 unshift @ISA, $MODEL;
1302 1462
1303 # now nuke some methods that are overriden by the backend. 1463 # now nuke some methods that are overridden by the backend.
1304 # SUPER is not allowed. 1464 # SUPER usage is not allowed in these.
1305 for (qw(time signal child idle)) { 1465 for (qw(time signal child idle)) {
1306 undef &{"AnyEvent::Base::$_"} 1466 undef &{"AnyEvent::Base::$_"}
1307 if defined &{"$MODEL\::$_"}; 1467 if defined &{"$MODEL\::$_"};
1308 } 1468 }
1309 1469
1310 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; 1470 _isa_set;
1471
1472 # we're officially open!
1473
1474 if ($ENV{PERL_ANYEVENT_STRICT}) {
1475 require AnyEvent::Strict;
1476 }
1477
1478 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1479 require AnyEvent::Debug;
1480 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1481 }
1482
1483 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1484 require AnyEvent::Socket;
1485 require AnyEvent::Debug;
1486
1487 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1488 $shell =~ s/\$\$/$$/g;
1489
1490 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1491 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1492 }
1493
1494 # now the anyevent environment is set up as the user told us to, so
1495 # call the actual user code - post detects
1311 1496
1312 (shift @post_detect)->() while @post_detect; 1497 (shift @post_detect)->() while @post_detect;
1498 undef @post_detect;
1313 1499
1314 *post_detect = sub(&) { 1500 *post_detect = sub(&) {
1315 shift->(); 1501 shift->();
1316 1502
1317 undef 1503 undef
1318 }; 1504 };
1319 1505
1320 $MODEL 1506 $MODEL
1321} 1507}
1322 1508
1323sub AUTOLOAD { 1509for my $name (@methods) {
1324 (my $func = $AUTOLOAD) =~ s/.*://; 1510 *$name = sub {
1325
1326 $method{$func}
1327 or Carp::croak "$func: not a valid AnyEvent class method";
1328
1329 detect; 1511 detect;
1330 1512 # we use goto because
1331 my $class = shift; 1513 # a) it makes the thunk more transparent
1332 $class->$func (@_); 1514 # b) it allows us to delete the thunk later
1515 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1516 };
1333} 1517}
1334 1518
1335# utility function to dup a filehandle. this is used by many backends 1519# utility function to dup a filehandle. this is used by many backends
1336# to support binding more than one watcher per filehandle (they usually 1520# 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). 1521# allow only one watcher per fd, so we dup it to get a different one).
1361 1545
1362package AE; 1546package AE;
1363 1547
1364our $VERSION = $AnyEvent::VERSION; 1548our $VERSION = $AnyEvent::VERSION;
1365 1549
1550sub _reset() {
1551 eval q{
1366# fall back to the main API by default - backends and AnyEvent::Base 1552 # fall back to the main API by default - backends and AnyEvent::Base
1367# implementations can overwrite these. 1553 # implementations can overwrite these.
1368 1554
1369sub io($$$) { 1555 sub io($$$) {
1370 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1556 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1371} 1557 }
1372 1558
1373sub timer($$$) { 1559 sub timer($$$) {
1374 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1560 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1375} 1561 }
1376 1562
1377sub signal($$) { 1563 sub signal($$) {
1378 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1564 AnyEvent->signal (signal => $_[0], cb => $_[1])
1379} 1565 }
1380 1566
1381sub child($$) { 1567 sub child($$) {
1382 AnyEvent->child (pid => $_[0], cb => $_[1]) 1568 AnyEvent->child (pid => $_[0], cb => $_[1])
1383} 1569 }
1384 1570
1385sub idle($) { 1571 sub idle($) {
1386 AnyEvent->idle (cb => $_[0]) 1572 AnyEvent->idle (cb => $_[0]);
1387} 1573 }
1388 1574
1389sub cv(;&) { 1575 sub cv(;&) {
1390 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1576 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1391} 1577 }
1392 1578
1393sub now() { 1579 sub now() {
1394 AnyEvent->now 1580 AnyEvent->now
1395} 1581 }
1396 1582
1397sub now_update() { 1583 sub now_update() {
1398 AnyEvent->now_update 1584 AnyEvent->now_update
1399} 1585 }
1400 1586
1401sub time() { 1587 sub time() {
1402 AnyEvent->time 1588 AnyEvent->time
1589 }
1590
1591 *postpone = \&AnyEvent::postpone;
1592 *log = \&AnyEvent::log;
1593 };
1594 die if $@;
1403} 1595}
1596
1597BEGIN { _reset }
1404 1598
1405package AnyEvent::Base; 1599package AnyEvent::Base;
1406 1600
1407# default implementations for many methods 1601# default implementations for many methods
1408 1602
1409sub time { 1603sub time {
1410 eval q{ # poor man's autoloading {} 1604 eval q{ # poor man's autoloading {}
1411 # probe for availability of Time::HiRes 1605 # probe for availability of Time::HiRes
1412 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1606 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1413 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1607 *time = sub { Time::HiRes::time () };
1414 *AE::time = \&Time::HiRes::time; 1608 *AE::time = \& Time::HiRes::time ;
1609 *now = \&time;
1610 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1415 # if (eval "use POSIX (); (POSIX::times())... 1611 # if (eval "use POSIX (); (POSIX::times())...
1416 } else { 1612 } else {
1613 *time = sub { CORE::time };
1614 *AE::time = sub (){ CORE::time };
1615 *now = \&time;
1417 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1616 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1418 *AE::time = sub (){ time }; # epic fail
1419 } 1617 }
1420
1421 *time = sub { AE::time }; # different prototypes
1422 }; 1618 };
1423 die if $@; 1619 die if $@;
1424 1620
1425 &time 1621 &time
1426} 1622}
1427 1623
1428*now = \&time; 1624*now = \&time;
1429
1430sub now_update { } 1625sub now_update { }
1431 1626
1627sub _poll {
1628 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1629}
1630
1432# default implementation for ->condvar 1631# default implementation for ->condvar
1632# in fact, the default should not be overwritten
1433 1633
1434sub condvar { 1634sub condvar {
1435 eval q{ # poor man's autoloading {} 1635 eval q{ # poor man's autoloading {}
1436 *condvar = sub { 1636 *condvar = sub {
1437 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1637 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1515 1715
1516sub signal { 1716sub signal {
1517 eval q{ # poor man's autoloading {} 1717 eval q{ # poor man's autoloading {}
1518 # probe for availability of Async::Interrupt 1718 # probe for availability of Async::Interrupt
1519 if (_have_async_interrupt) { 1719 if (_have_async_interrupt) {
1520 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1720 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1521 1721
1522 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1722 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1523 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1723 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1524 1724
1525 } else { 1725 } else {
1526 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1726 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1527 1727
1528 if (AnyEvent::WIN32) { 1728 if (AnyEvent::WIN32) {
1529 require AnyEvent::Util; 1729 require AnyEvent::Util;
1530 1730
1531 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1731 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1607 : sysread $SIGPIPE_R, (my $dummy), 9; 1807 : sysread $SIGPIPE_R, (my $dummy), 9;
1608 1808
1609 while (%SIG_EV) { 1809 while (%SIG_EV) {
1610 for (keys %SIG_EV) { 1810 for (keys %SIG_EV) {
1611 delete $SIG_EV{$_}; 1811 delete $SIG_EV{$_};
1612 $_->() for values %{ $SIG_CB{$_} || {} }; 1812 &$_ for values %{ $SIG_CB{$_} || {} };
1613 } 1813 }
1614 } 1814 }
1615 }; 1815 };
1616 }; 1816 };
1617 die if $@; 1817 die if $@;
1622# default implementation for ->child 1822# default implementation for ->child
1623 1823
1624our %PID_CB; 1824our %PID_CB;
1625our $CHLD_W; 1825our $CHLD_W;
1626our $CHLD_DELAY_W; 1826our $CHLD_DELAY_W;
1627our $WNOHANG;
1628 1827
1629# used by many Impl's 1828# used by many Impl's
1630sub _emit_childstatus($$) { 1829sub _emit_childstatus($$) {
1631 my (undef, $rpid, $rstatus) = @_; 1830 my (undef, $rpid, $rstatus) = @_;
1632 1831
1639 eval q{ # poor man's autoloading {} 1838 eval q{ # poor man's autoloading {}
1640 *_sigchld = sub { 1839 *_sigchld = sub {
1641 my $pid; 1840 my $pid;
1642 1841
1643 AnyEvent->_emit_childstatus ($pid, $?) 1842 AnyEvent->_emit_childstatus ($pid, $?)
1644 while ($pid = waitpid -1, $WNOHANG) > 0; 1843 while ($pid = waitpid -1, WNOHANG) > 0;
1645 }; 1844 };
1646 1845
1647 *child = sub { 1846 *child = sub {
1648 my (undef, %arg) = @_; 1847 my (undef, %arg) = @_;
1649 1848
1650 defined (my $pid = $arg{pid} + 0) 1849 my $pid = $arg{pid};
1651 or Carp::croak "required option 'pid' is missing"; 1850 my $cb = $arg{cb};
1652 1851
1653 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1852 $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 1853
1660 unless ($CHLD_W) { 1854 unless ($CHLD_W) {
1661 $CHLD_W = AE::signal CHLD => \&_sigchld; 1855 $CHLD_W = AE::signal CHLD => \&_sigchld;
1662 # child could be a zombie already, so make at least one round 1856 # child could be a zombie already, so make at least one round
1663 &_sigchld; 1857 &_sigchld;
1664 } 1858 }
1665 1859
1666 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1860 bless [$pid, $cb+0], "AnyEvent::Base::child"
1667 }; 1861 };
1668 1862
1669 *AnyEvent::Base::child::DESTROY = sub { 1863 *AnyEvent::Base::child::DESTROY = sub {
1670 my ($pid, $cb) = @{$_[0]}; 1864 my ($pid, $icb) = @{$_[0]};
1671 1865
1672 delete $PID_CB{$pid}{$cb}; 1866 delete $PID_CB{$pid}{$icb};
1673 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1867 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1674 1868
1675 undef $CHLD_W unless keys %PID_CB; 1869 undef $CHLD_W unless keys %PID_CB;
1676 }; 1870 };
1677 }; 1871 };
1690 1884
1691 my ($cb, $w, $rcb) = $arg{cb}; 1885 my ($cb, $w, $rcb) = $arg{cb};
1692 1886
1693 $rcb = sub { 1887 $rcb = sub {
1694 if ($cb) { 1888 if ($cb) {
1695 $w = _time; 1889 $w = AE::time;
1696 &$cb; 1890 &$cb;
1697 $w = _time - $w; 1891 $w = AE::time - $w;
1698 1892
1699 # never use more then 50% of the time for the idle watcher, 1893 # never use more then 50% of the time for the idle watcher,
1700 # within some limits 1894 # within some limits
1701 $w = 0.0001 if $w < 0.0001; 1895 $w = 0.0001 if $w < 0.0001;
1702 $w = 5 if $w > 5; 1896 $w = 5 if $w > 5;
1725 1919
1726package AnyEvent::CondVar; 1920package AnyEvent::CondVar;
1727 1921
1728our @ISA = AnyEvent::CondVar::Base::; 1922our @ISA = AnyEvent::CondVar::Base::;
1729 1923
1924# only to be used for subclassing
1925sub new {
1926 my $class = shift;
1927 bless AnyEvent->condvar (@_), $class
1928}
1929
1730package AnyEvent::CondVar::Base; 1930package AnyEvent::CondVar::Base;
1731 1931
1732#use overload 1932#use overload
1733# '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1933# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1734# fallback => 1; 1934# fallback => 1;
1743 1943
1744sub _send { 1944sub _send {
1745 # nop 1945 # nop
1746} 1946}
1747 1947
1948sub _wait {
1949 AnyEvent->_poll until $_[0]{_ae_sent};
1950}
1951
1748sub send { 1952sub send {
1749 my $cv = shift; 1953 my $cv = shift;
1750 $cv->{_ae_sent} = [@_]; 1954 $cv->{_ae_sent} = [@_];
1751 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb}; 1955 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1752 $cv->_send; 1956 $cv->_send;
1759 1963
1760sub ready { 1964sub ready {
1761 $_[0]{_ae_sent} 1965 $_[0]{_ae_sent}
1762} 1966}
1763 1967
1764sub _wait {
1765 $WAITING
1766 and !$_[0]{_ae_sent}
1767 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1768
1769 local $WAITING = 1;
1770 AnyEvent->one_event while !$_[0]{_ae_sent};
1771}
1772
1773sub recv { 1968sub recv {
1969 unless ($_[0]{_ae_sent}) {
1970 $WAITING
1971 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1972
1973 local $WAITING = 1;
1774 $_[0]->_wait; 1974 $_[0]->_wait;
1975 }
1775 1976
1776 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1977 $_[0]{_ae_croak}
1777 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1978 and Carp::croak $_[0]{_ae_croak};
1979
1980 wantarray
1981 ? @{ $_[0]{_ae_sent} }
1982 : $_[0]{_ae_sent}[0]
1778} 1983}
1779 1984
1780sub cb { 1985sub cb {
1781 my $cv = shift; 1986 my $cv = shift;
1782 1987
1798 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 2003 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1799} 2004}
1800 2005
1801# undocumented/compatibility with pre-3.4 2006# undocumented/compatibility with pre-3.4
1802*broadcast = \&send; 2007*broadcast = \&send;
1803*wait = \&_wait; 2008*wait = \&recv;
1804 2009
1805=head1 ERROR AND EXCEPTION HANDLING 2010=head1 ERROR AND EXCEPTION HANDLING
1806 2011
1807In general, AnyEvent does not do any error handling - it relies on the 2012In general, AnyEvent does not do any error handling - it relies on the
1808caller to do that if required. The L<AnyEvent::Strict> module (see also 2013caller to do that if required. The L<AnyEvent::Strict> module (see also
1820$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2025$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1821so on. 2026so on.
1822 2027
1823=head1 ENVIRONMENT VARIABLES 2028=head1 ENVIRONMENT VARIABLES
1824 2029
1825The following environment variables are used by this module or its 2030AnyEvent supports a number of environment variables that tune the
1826submodules. 2031runtime behaviour. They are usually evaluated when AnyEvent is
2032loaded, initialised, or a submodule that uses them is loaded. Many of
2033them also cause AnyEvent to load additional modules - for example,
2034C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2035loaded.
1827 2036
1828Note that AnyEvent will remove I<all> environment variables starting with 2037All the environment variables documented here start with
1829C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2038C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1830enabled. 2039namespace. Other modules are encouraged (but by no means required) to use
2040C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2041namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2042be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2043variables starting with C<AE_>, see below).
2044
2045All variables can also be set via the C<AE_> prefix, that is, instead
2046of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2047case there is a clash btween anyevent and another program that uses
2048C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2049variable to the empty string, as those variables take precedence.
2050
2051When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2052to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2053exists. If taint mode is on, then AnyEvent will remove I<all> environment
2054variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2055with C<undef> or the empty string, if the corresaponding C<AE_> variable
2056is set).
2057
2058The exact algorithm is currently:
2059
2060 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2061 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2062 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2063
2064This ensures that child processes will not see the C<AE_> variables.
2065
2066The following environment variables are currently known to AnyEvent:
1831 2067
1832=over 4 2068=over 4
1833 2069
1834=item C<PERL_ANYEVENT_VERBOSE> 2070=item C<PERL_ANYEVENT_VERBOSE>
1835 2071
1836By default, AnyEvent will be completely silent except in fatal 2072By default, AnyEvent will only log messages with loglevel C<3>
1837conditions. You can set this environment variable to make AnyEvent more 2073(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2074environment variable to a numerical loglevel to make AnyEvent more (or
1838talkative. 2075less) talkative.
1839 2076
2077If you want to do more than just set the global logging level
2078you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2079complex specifications.
2080
2081When set to C<0> (C<off>), then no messages whatsoever will be logged with
2082the default logging settings.
2083
1840When set to C<1> or higher, causes AnyEvent to warn about unexpected 2084When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
1841conditions, such as not being able to load the event model specified by 2085unexpected conditions, such as not being able to load the event model
1842C<PERL_ANYEVENT_MODEL>. 2086specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2087exception - this is the minimum recommended level.
1843 2088
1844When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2089When set to C<7> or higher (info), cause AnyEvent to report which event model it
1845model it chooses. 2090chooses.
1846 2091
1847When set to C<8> or higher, then AnyEvent will report extra information on 2092When set to C<8> or higher (debug), then AnyEvent will report extra information on
1848which optional modules it loads and how it implements certain features. 2093which optional modules it loads and how it implements certain features.
2094
2095=item C<PERL_ANYEVENT_LOG>
2096
2097Accepts rather complex logging specifications. For example, you could log
2098all C<debug> messages of some module to stderr, warnings and above to
2099stderr, and errors and above to syslog, with:
2100
2101 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2102
2103For the rather extensive details, see L<AnyEvent::Log>.
2104
2105This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2106so will take effect even before AnyEvent has initialised itself.
2107
2108Note that specifying this environment variable causes the L<AnyEvent::Log>
2109module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2110using the latter saves a few hundred kB of memory until the first message
2111is being logged.
1849 2112
1850=item C<PERL_ANYEVENT_STRICT> 2113=item C<PERL_ANYEVENT_STRICT>
1851 2114
1852AnyEvent does not do much argument checking by default, as thorough 2115AnyEvent does not do much argument checking by default, as thorough
1853argument checking is very costly. Setting this variable to a true value 2116argument checking is very costly. Setting this variable to a true value
1860Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2123Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1861>>, it is definitely recommended to keep it off in production. Keeping 2124>>, it is definitely recommended to keep it off in production. Keeping
1862C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2125C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1863can be very useful, however. 2126can be very useful, however.
1864 2127
2128=item C<PERL_ANYEVENT_DEBUG_SHELL>
2129
2130If this env variable is nonempty, then its contents will be interpreted by
2131C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2132replacing every occurance of C<$$> by the process pid). The shell object
2133is saved in C<$AnyEvent::Debug::SHELL>.
2134
2135This happens when the first watcher is created.
2136
2137For example, to bind a debug shell on a unix domain socket in
2138F<< /tmp/debug<pid>.sock >>, you could use this:
2139
2140 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2141 # connect with e.g.: socat readline /tmp/debug123.sock
2142
2143Or to bind to tcp port 4545 on localhost:
2144
2145 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2146 # connect with e.g.: telnet localhost 4545
2147
2148Note that creating sockets in F</tmp> or on localhost is very unsafe on
2149multiuser systems.
2150
2151=item C<PERL_ANYEVENT_DEBUG_WRAP>
2152
2153Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2154debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2155
1865=item C<PERL_ANYEVENT_MODEL> 2156=item C<PERL_ANYEVENT_MODEL>
1866 2157
1867This can be used to specify the event model to be used by AnyEvent, before 2158This can be used to specify the event model to be used by AnyEvent, before
1868auto detection and -probing kicks in. It must be a string consisting 2159auto detection and -probing kicks in.
1869entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2160
2161It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2162or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1870and the resulting module name is loaded and if the load was successful, 2163resulting module name is loaded and - if the load was successful - used as
1871used as event model. If it fails to load AnyEvent will proceed with 2164event model backend. If it fails to load then AnyEvent will proceed with
1872auto detection and -probing. 2165auto detection and -probing.
1873 2166
1874This functionality might change in future versions. 2167If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2168nothing gets prepended and the module name is used as-is (hint: C<::> at
2169the end of a string designates a module name and quotes it appropriately).
1875 2170
1876For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2171For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1877could start your program like this: 2172could start your program like this:
1878 2173
1879 PERL_ANYEVENT_MODEL=Perl perl ... 2174 PERL_ANYEVENT_MODEL=Perl perl ...
1880 2175
1881=item C<PERL_ANYEVENT_PROTOCOLS> 2176=item C<PERL_ANYEVENT_PROTOCOLS>
1897but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2192but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1898- only support IPv4, never try to resolve or contact IPv6 2193- only support IPv4, never try to resolve or contact IPv6
1899addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2194addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1900IPv6, but prefer IPv6 over IPv4. 2195IPv6, but prefer IPv6 over IPv4.
1901 2196
2197=item C<PERL_ANYEVENT_HOSTS>
2198
2199This variable, if specified, overrides the F</etc/hosts> file used by
2200L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2201from that file instead.
2202
1902=item C<PERL_ANYEVENT_EDNS0> 2203=item C<PERL_ANYEVENT_EDNS0>
1903 2204
1904Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2205Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1905for DNS. This extension is generally useful to reduce DNS traffic, but 2206DNS. This extension is generally useful to reduce DNS traffic, especially
1906some (broken) firewalls drop such DNS packets, which is why it is off by 2207when DNSSEC is involved, but some (broken) firewalls drop such DNS
1907default. 2208packets, which is why it is off by default.
1908 2209
1909Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2210Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1910EDNS0 in its DNS requests. 2211EDNS0 in its DNS requests.
1911 2212
1912=item C<PERL_ANYEVENT_MAX_FORKS> 2213=item C<PERL_ANYEVENT_MAX_FORKS>
1920resolver - this is the maximum number of parallel DNS requests that are 2221resolver - this is the maximum number of parallel DNS requests that are
1921sent to the DNS server. 2222sent to the DNS server.
1922 2223
1923=item C<PERL_ANYEVENT_RESOLV_CONF> 2224=item C<PERL_ANYEVENT_RESOLV_CONF>
1924 2225
1925The file to use instead of F</etc/resolv.conf> (or OS-specific 2226The absolute path to a F<resolv.conf>-style file to use instead of
1926configuration) in the default resolver. When set to the empty string, no 2227F</etc/resolv.conf> (or the OS-specific configuration) in the default
1927default config will be used. 2228resolver, or the empty string to select the default configuration.
1928 2229
1929=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2230=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1930 2231
1931When neither C<ca_file> nor C<ca_path> was specified during 2232When neither C<ca_file> nor C<ca_path> was specified during
1932L<AnyEvent::TLS> context creation, and either of these environment 2233L<AnyEvent::TLS> context creation, and either of these environment
1933variables exist, they will be used to specify CA certificate locations 2234variables are nonempty, they will be used to specify CA certificate
1934instead of a system-dependent default. 2235locations instead of a system-dependent default.
1935 2236
1936=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2237=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1937 2238
1938When these are set to C<1>, then the respective modules are not 2239When these are set to C<1>, then the respective modules are not
1939loaded. Mostly good for testing AnyEvent itself. 2240loaded. Mostly good for testing AnyEvent itself.
2271(even when used without AnyEvent), but most event loops have acceptable 2572(even when used without AnyEvent), but most event loops have acceptable
2272performance with or without AnyEvent. 2573performance with or without AnyEvent.
2273 2574
2274=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2575=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2275the actual event loop, only with extremely fast event loops such as EV 2576the actual event loop, only with extremely fast event loops such as EV
2276adds AnyEvent significant overhead. 2577does AnyEvent add significant overhead.
2277 2578
2278=item * You should avoid POE like the plague if you want performance or 2579=item * You should avoid POE like the plague if you want performance or
2279reasonable memory usage. 2580reasonable memory usage.
2280 2581
2281=back 2582=back
2580 2881
2581=item L<Time::HiRes> 2882=item L<Time::HiRes>
2582 2883
2583This module is part of perl since release 5.008. It will be used when the 2884This module is part of perl since release 5.008. It will be used when the
2584chosen event library does not come with a timing source of its own. The 2885chosen event library does not come with a timing source of its own. The
2585pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2886pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2586try to use a monotonic clock for timing stability. 2887try to use a monotonic clock for timing stability.
2587 2888
2588=back 2889=back
2589 2890
2590 2891
2652pronounced). 2953pronounced).
2653 2954
2654 2955
2655=head1 SEE ALSO 2956=head1 SEE ALSO
2656 2957
2657Utility functions: L<AnyEvent::Util>. 2958Tutorial/Introduction: L<AnyEvent::Intro>.
2658 2959
2659Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2960FAQ: L<AnyEvent::FAQ>.
2660L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2961
2962Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2963(simply logging).
2964
2965Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2966L<AnyEvent::Debug> (interactive shell, watcher tracing).
2967
2968Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2969L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2970L<Qt>, L<POE>, L<FLTK>.
2661 2971
2662Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2972Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2663L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2973L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2664L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2974L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2665L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2975L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2976L<AnyEvent::Impl::FLTK>.
2666 2977
2667Non-blocking file handles, sockets, TCP clients and 2978Non-blocking handles, pipes, stream sockets, TCP clients and
2668servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2979servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2669 2980
2670Asynchronous DNS: L<AnyEvent::DNS>. 2981Asynchronous DNS: L<AnyEvent::DNS>.
2671 2982
2672Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, 2983Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2673L<Coro::Event>,
2674 2984
2675Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>, 2985Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2676L<AnyEvent::HTTP>. 2986L<AnyEvent::HTTP>.
2677 2987
2678 2988
2679=head1 AUTHOR 2989=head1 AUTHOR
2680 2990

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines