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.350 by root, Tue Aug 2 20:02:44 2011 UTC vs.
Revision 1.408 by root, Thu Dec 6 12:04:23 2012 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
121The 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>
122module. 122module.
123 123
124During the first call of any watcher-creation method, the module tries 124During the first call of any watcher-creation method, the module tries
125to 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
126following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>, 126following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
127L<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
128found 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
129four 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
130available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so 130available, the pure-perl L<AnyEvent::Loop> should always work, so
131the other two are not normally tried. 131the other two are not normally tried.
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:
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
415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's 415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416pure perl implementation). 416pure perl implementation).
417 417
418=head3 Safe/Unsafe Signals 418=head3 Safe/Unsafe Signals
419 419
420Perl signals can be either "safe" (synchronous to opcode handling) or 420Perl signals can be either "safe" (synchronous to opcode handling)
421"unsafe" (asynchronous) - the former might get delayed indefinitely, the 421or "unsafe" (asynchronous) - the former might delay signal delivery
422latter might corrupt your memory. 422indefinitely, the latter might corrupt your memory.
423 423
424AnyEvent signal handlers are, in addition, synchronous to the event loop, 424AnyEvent signal handlers are, in addition, synchronous to the event loop,
425i.e. they will not interrupt your running perl program but will only be 425i.e. they will not interrupt your running perl program but will only be
426called as part of the normal event handling (just like timer, I/O etc. 426called as part of the normal event handling (just like timer, I/O etc.
427callbacks, too). 427callbacks, too).
428 428
429=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
430 430
431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support
432callbacks to signals in a generic way, which is a pity, as you cannot 432attaching callbacks to signals in a generic way, which is a pity,
433do race-free signal handling in perl, requiring C libraries for 433as you cannot do race-free signal handling in perl, requiring
434this. AnyEvent will try to do its best, which means in some cases, 434C libraries for this. AnyEvent will try to do its best, which
435signals will be delayed. The maximum time a signal might be delayed is 435means in some cases, signals will be delayed. The maximum time
436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436a signal might be delayed is 10 seconds by default, but can
437variable can be changed only before the first signal watcher is created, 437be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
438and should be left alone otherwise. This variable determines how often 438C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
439AnyEvent polls for signals (in case a wake-up was missed). Higher values 439section for details.
440will cause fewer spurious wake-ups, which is better for power and CPU
441saving.
442 440
443All these problems can be avoided by installing the optional 441All these problems can be avoided by installing the optional
444L<Async::Interrupt> module, which works with most event loops. It will not 442L<Async::Interrupt> module, which works with most event loops. It will not
445work with inherently broken event loops such as L<Event> or L<Event::Lib> 443work with inherently broken event loops such as L<Event> or L<Event::Lib>
446(and not with L<POE> currently, as POE does its own workaround with 444(and not with L<POE> currently). For those, you just have to suffer the
447one-second latency). For those, you just have to suffer the delays. 445delays.
448 446
449=head2 CHILD PROCESS WATCHERS 447=head2 CHILD PROCESS WATCHERS
450 448
451 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 449 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
452 450
482thing in an AnyEvent program, you I<have> to create at least one 480thing in an AnyEvent program, you I<have> to create at least one
483watcher before you C<fork> the child (alternatively, you can call 481watcher before you C<fork> the child (alternatively, you can call
484C<AnyEvent::detect>). 482C<AnyEvent::detect>).
485 483
486As most event loops do not support waiting for child events, they will be 484As 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 485emulated by AnyEvent in most cases, in which case the latency and race
488mentioned in the description of signal watchers apply. 486problems mentioned in the description of signal watchers apply.
489 487
490Example: fork a process and wait for it 488Example: fork a process and wait for it
491 489
492 my $done = AnyEvent->condvar; 490 my $done = AnyEvent->condvar;
493 491
765 }; 763 };
766 } 764 }
767 765
768 $cv->end; 766 $cv->end;
769 767
768 ...
769
770 my $results = $cv->recv;
771
770This code fragment supposedly pings a number of hosts and calls 772This code fragment supposedly pings a number of hosts and calls
771C<send> after results for all then have have been gathered - in any 773C<send> after results for all then have have been gathered - in any
772order. To achieve this, the code issues a call to C<begin> when it starts 774order. To achieve this, the code issues a call to C<begin> when it starts
773each ping request and calls C<end> when it has received some result for 775each ping request and calls C<end> when it has received some result for
774it. Since C<begin> and C<end> only maintain a counter, the order in which 776it. Since C<begin> and C<end> only maintain a counter, the order in which
860use. If EV is not installed, then AnyEvent will fall back to its own 862use. If EV is not installed, then AnyEvent will fall back to its own
861pure-perl implementation, which is available everywhere as it comes with 863pure-perl implementation, which is available everywhere as it comes with
862AnyEvent itself. 864AnyEvent itself.
863 865
864 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 866 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 867 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866 868
867=item Backends that are transparently being picked up when they are used. 869=item Backends that are transparently being picked up when they are used.
868 870
869These will be used if they are already loaded when the first watcher 871These 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 872is created, in which case it is assumed that the application is using
878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 880 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879 AnyEvent::Impl::POE based on POE, very slow, some limitations. 881 AnyEvent::Impl::POE based on POE, very slow, some limitations.
880 AnyEvent::Impl::Irssi used when running within irssi. 882 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async. 883 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. 884 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK based on FLTK. 885 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
884 886
885=item Backends with special needs. 887=item Backends with special needs.
886 888
887Qt requires the Qt::Application to be instantiated first, but will 889Qt requires the Qt::Application to be instantiated first, but will
888otherwise be picked up automatically. As long as the main program 890otherwise be picked up automatically. As long as the main program
933 935
934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 936Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
935if necessary. You should only call this function right before you would 937if necessary. You should only call this function right before you would
936have created an AnyEvent watcher anyway, that is, as late as possible at 938have created an AnyEvent watcher anyway, that is, as late as possible at
937runtime, and not e.g. during initialisation of your module. 939runtime, and not e.g. during initialisation of your module.
940
941The effect of calling this function is as if a watcher had been created
942(specifically, actions that happen "when the first watcher is created"
943happen when calling detetc as well).
938 944
939If you need to do some initialisation before AnyEvent watchers are 945If you need to do some initialisation before AnyEvent watchers are
940created, use C<post_detect>. 946created, use C<post_detect>.
941 947
942=item $guard = AnyEvent::post_detect { BLOCK } 948=item $guard = AnyEvent::post_detect { BLOCK }
1005 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1011 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1006 # as soon as it is 1012 # as soon as it is
1007 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1013 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1008 } 1014 }
1009 1015
1016=item AnyEvent::postpone { BLOCK }
1017
1018Arranges for the block to be executed as soon as possible, but not before
1019the call itself returns. In practise, the block will be executed just
1020before the event loop polls for new events, or shortly afterwards.
1021
1022This function never returns anything (to make the C<return postpone { ...
1023}> idiom more useful.
1024
1025To understand the usefulness of this function, consider a function that
1026asynchronously does something for you and returns some transaction
1027object or guard to let you cancel the operation. For example,
1028C<AnyEvent::Socket::tcp_connect>:
1029
1030 # start a conenction attempt unless one is active
1031 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1032 delete $self->{connect_guard};
1033 ...
1034 };
1035
1036Imagine that this function could instantly call the callback, for
1037example, because it detects an obvious error such as a negative port
1038number. Invoking the callback before the function returns causes problems
1039however: the callback will be called and will try to delete the guard
1040object. But since the function hasn't returned yet, there is nothing to
1041delete. When the function eventually returns it will assign the guard
1042object to C<< $self->{connect_guard} >>, where it will likely never be
1043deleted, so the program thinks it is still trying to connect.
1044
1045This is where C<AnyEvent::postpone> should be used. Instead of calling the
1046callback directly on error:
1047
1048 $cb->(undef), return # signal error to callback, BAD!
1049 if $some_error_condition;
1050
1051It should use C<postpone>:
1052
1053 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1054 if $some_error_condition;
1055
1056=item AnyEvent::log $level, $msg[, @args]
1057
1058Log the given C<$msg> at the given C<$level>.
1059
1060If L<AnyEvent::Log> is not loaded then this function makes a simple test
1061to see whether the message will be logged. If the test succeeds it will
1062load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1063the L<AnyEvent::Log> documentation for details.
1064
1065If the test fails it will simply return. Right now this happens when a
1066numerical loglevel is used and it is larger than the level specified via
1067C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1068
1069If you want to sprinkle loads of logging calls around your code, consider
1070creating a logger callback with the C<AnyEvent::Log::logger> function,
1071which can reduce typing, codesize and can reduce the logging overhead
1072enourmously.
1073
1010=back 1074=back
1011 1075
1012=head1 WHAT TO DO IN A MODULE 1076=head1 WHAT TO DO IN A MODULE
1013 1077
1014As a module author, you should C<use AnyEvent> and call AnyEvent methods 1078As a module author, you should C<use AnyEvent> and call AnyEvent methods
1047modules might create watchers when they are loaded, and AnyEvent will 1111modules might create watchers when they are loaded, and AnyEvent will
1048decide on the event model to use as soon as it creates watchers, and it 1112decide on the event model to use as soon as it creates watchers, and it
1049might choose the wrong one unless you load the correct one yourself. 1113might choose the wrong one unless you load the correct one yourself.
1050 1114
1051You can chose to use a pure-perl implementation by loading the 1115You can chose to use a pure-perl implementation by loading the
1052C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1116C<AnyEvent::Loop> module, which gives you similar behaviour
1053everywhere, but letting AnyEvent chose the model is generally better. 1117everywhere, but letting AnyEvent chose the model is generally better.
1054 1118
1055=head2 MAINLOOP EMULATION 1119=head2 MAINLOOP EMULATION
1056 1120
1057Sometimes (often for short test scripts, or even standalone programs who 1121Sometimes (often for short test scripts, or even standalone programs who
1070 1134
1071 1135
1072=head1 OTHER MODULES 1136=head1 OTHER MODULES
1073 1137
1074The following is a non-exhaustive list of additional modules that use 1138The following is a non-exhaustive list of additional modules that use
1075AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1139AnyEvent as a client and can therefore be mixed easily with other
1076modules and other event loops in the same program. Some of the modules 1140AnyEvent modules and other event loops in the same program. Some of the
1077come as part of AnyEvent, the others are available via CPAN. 1141modules come as part of AnyEvent, the others are available via CPAN (see
1142L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1143a longer non-exhaustive list), and the list is heavily biased towards
1144modules of the AnyEvent author himself :)
1078 1145
1079=over 4 1146=over 4
1080 1147
1081=item L<AnyEvent::Util> 1148=item L<AnyEvent::Util>
1082 1149
1102=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> 1169=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1103 1170
1104Implement event-based interfaces to the protocols of the same name (for 1171Implement event-based interfaces to the protocols of the same name (for
1105the curious, IGS is the International Go Server and FCP is the Freenet 1172the curious, IGS is the International Go Server and FCP is the Freenet
1106Client Protocol). 1173Client Protocol).
1107
1108=item L<AnyEvent::Handle::UDP>
1109
1110Here be danger!
1111
1112As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1113there are so many things wrong with AnyEvent::Handle::UDP, most notably
1114its use of a stream-based API with a protocol that isn't streamable, that
1115the only way to improve it is to delete it.
1116
1117It features data corruption (but typically only under load) and general
1118confusion. On top, the author is not only clueless about UDP but also
1119fact-resistant - some gems of his understanding: "connect doesn't work
1120with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1121packets", "I don't need to implement proper error checking as UDP doesn't
1122support error checking" and so on - he doesn't even understand what's
1123wrong with his module when it is explained to him.
1124
1125=item L<AnyEvent::DBI>
1126
1127Executes L<DBI> requests asynchronously in a proxy process for you,
1128notifying you in an event-based way when the operation is finished.
1129 1174
1130=item L<AnyEvent::AIO> 1175=item L<AnyEvent::AIO>
1131 1176
1132Truly asynchronous (as opposed to non-blocking) I/O, should be in the 1177Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1133toolbox of every event programmer. AnyEvent::AIO transparently fuses 1178toolbox of every event programmer. AnyEvent::AIO transparently fuses
1134L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1179L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1135file I/O, and much more. 1180file I/O, and much more.
1136 1181
1182=item L<AnyEvent::Filesys::Notify>
1183
1184AnyEvent is good for non-blocking stuff, but it can't detect file or
1185path changes (e.g. "watch this directory for new files", "watch this
1186file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1187do just that in a portbale fashion, supporting inotify on GNU/Linux and
1188some weird, without doubt broken, stuff on OS X to monitor files. It can
1189fall back to blocking scans at regular intervals transparently on other
1190platforms, so it's about as portable as it gets.
1191
1192(I haven't used it myself, but I haven't heard anybody complaining about
1193it yet).
1194
1195=item L<AnyEvent::DBI>
1196
1197Executes L<DBI> requests asynchronously in a proxy process for you,
1198notifying you in an event-based way when the operation is finished.
1199
1137=item L<AnyEvent::HTTPD> 1200=item L<AnyEvent::HTTPD>
1138 1201
1139A simple embedded webserver. 1202A simple embedded webserver.
1140 1203
1141=item L<AnyEvent::FastPing> 1204=item L<AnyEvent::FastPing>
1142 1205
1143The fastest ping in the west. 1206The fastest ping in the west.
1144 1207
1145=item L<Coro> 1208=item L<Coro>
1146 1209
1147Has special support for AnyEvent via L<Coro::AnyEvent>. 1210Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1211to simply invert the flow control - don't call us, we will call you:
1212
1213 async {
1214 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1215 print "5 seconds later!\n";
1216
1217 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1218 my $line = <STDIN>; # works for ttys
1219
1220 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1221 my ($body, $hdr) = Coro::rouse_wait;
1222 };
1148 1223
1149=back 1224=back
1150 1225
1151=cut 1226=cut
1152 1227
1153package AnyEvent; 1228package AnyEvent;
1154 1229
1155# basically a tuned-down version of common::sense 1230# basically a tuned-down version of common::sense
1156sub common_sense { 1231sub common_sense {
1157 # from common:.sense 3.4 1232 # from common:.sense 3.5
1233 local $^W;
1158 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00"; 1234 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1159 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) 1235 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1160 $^H |= 0x00000600; 1236 $^H |= 0x00000600;
1161} 1237}
1162 1238
1163BEGIN { AnyEvent::common_sense } 1239BEGIN { AnyEvent::common_sense }
1164 1240
1165use Carp (); 1241use Carp ();
1166 1242
1167our $VERSION = '5.34'; 1243our $VERSION = '7.04';
1168our $MODEL; 1244our $MODEL;
1169
1170our $AUTOLOAD;
1171our @ISA; 1245our @ISA;
1172
1173our @REGISTRY; 1246our @REGISTRY;
1174
1175our $VERBOSE; 1247our $VERBOSE;
1248our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1249our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
1176 1250
1177BEGIN { 1251BEGIN {
1178 require "AnyEvent/constants.pl"; 1252 require "AnyEvent/constants.pl";
1179 1253
1180 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1254 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1181 1255
1182 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1256 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1183 if ${^TAINT}; 1257 if ${^TAINT};
1184 1258
1185 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1259 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1260 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1186 1261
1187} 1262 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1263 if ${^TAINT};
1188 1264
1189our $MAX_SIGNAL_LATENCY = 10; 1265 # $ENV{PERL_ANYEVENT_xxx} now valid
1190 1266
1191our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1267 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1192 1268
1193{
1194 my $idx; 1269 my $idx;
1195 $PROTOCOL{$_} = ++$idx 1270 $PROTOCOL{$_} = ++$idx
1196 for reverse split /\s*,\s*/, 1271 for reverse split /\s*,\s*/,
1197 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1272 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1198} 1273}
1199 1274
1275our @post_detect;
1276
1277sub post_detect(&) {
1278 my ($cb) = @_;
1279
1280 push @post_detect, $cb;
1281
1282 defined wantarray
1283 ? bless \$cb, "AnyEvent::Util::postdetect"
1284 : ()
1285}
1286
1287sub AnyEvent::Util::postdetect::DESTROY {
1288 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1289}
1290
1291our $POSTPONE_W;
1292our @POSTPONE;
1293
1294sub _postpone_exec {
1295 undef $POSTPONE_W;
1296
1297 &{ shift @POSTPONE }
1298 while @POSTPONE;
1299}
1300
1301sub postpone(&) {
1302 push @POSTPONE, shift;
1303
1304 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1305
1306 ()
1307}
1308
1309sub log($$;@) {
1310 # only load the big bloated module when we actually are about to log something
1311 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
1312 local ($!, $@);
1313 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1314 # AnyEvent::Log overwrites this function
1315 goto &log;
1316 }
1317
1318 0 # not logged
1319}
1320
1321sub _logger($;$) {
1322 my ($level, $renabled) = @_;
1323
1324 $$renabled = $level <= $VERBOSE;
1325
1326 my $logger = [(caller)[0], $level, $renabled];
1327
1328 $AnyEvent::Log::LOGGER{$logger+0} = $logger;
1329
1330# return unless defined wantarray;
1331#
1332# require AnyEvent::Util;
1333# my $guard = AnyEvent::Util::guard (sub {
1334# # "clean up"
1335# delete $LOGGER{$logger+0};
1336# });
1337#
1338# sub {
1339# return 0 unless $$renabled;
1340#
1341# $guard if 0; # keep guard alive, but don't cause runtime overhead
1342# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1343# package AnyEvent::Log;
1344# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1345# }
1346}
1347
1348if (length $ENV{PERL_ANYEVENT_LOG}) {
1349 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1350}
1351
1200my @models = ( 1352our @models = (
1201 [EV:: => AnyEvent::Impl::EV:: , 1], 1353 [EV:: => AnyEvent::Impl::EV::],
1202 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1354 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1203 # everything below here will not (normally) be autoprobed 1355 # everything below here will not (normally) be autoprobed
1204 # as the pureperl backend should work everywhere 1356 # as the pure perl backend should work everywhere
1205 # and is usually faster 1357 # and is usually faster
1358 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1206 [Event:: => AnyEvent::Impl::Event::, 1], 1359 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1207 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1360 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1361 # everything below here should not be autoloaded
1208 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1362 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1209 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1210 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1363 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1211 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1364 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1212 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1365 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1213 [Wx:: => AnyEvent::Impl::POE::], 1366 [Wx:: => AnyEvent::Impl::POE::],
1214 [Prima:: => AnyEvent::Impl::POE::], 1367 [Prima:: => AnyEvent::Impl::POE::],
1215 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1368 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1216 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1369 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1217 [FLTK:: => AnyEvent::Impl::FLTK::], 1370 [FLTK:: => AnyEvent::Impl::FLTK::],
1218); 1371);
1219 1372
1220our %method = map +($_ => 1), 1373our @isa_hook;
1374
1375sub _isa_set {
1376 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1377
1378 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1379 for 1 .. $#pkg;
1380
1381 grep $_ && $_->[1], @isa_hook
1382 and AE::_reset ();
1383}
1384
1385# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1386sub _isa_hook($$;$) {
1387 my ($i, $pkg, $reset_ae) = @_;
1388
1389 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1390
1391 _isa_set;
1392}
1393
1394# all autoloaded methods reserve the complete glob, not just the method slot.
1395# due to bugs in perls method cache implementation.
1221 qw(io timer time now now_update signal child idle condvar DESTROY); 1396our @methods = qw(io timer time now now_update signal child idle condvar);
1222
1223our @post_detect;
1224
1225sub post_detect(&) {
1226 my ($cb) = @_;
1227
1228 push @post_detect, $cb;
1229
1230 defined wantarray
1231 ? bless \$cb, "AnyEvent::Util::postdetect"
1232 : ()
1233}
1234
1235sub AnyEvent::Util::postdetect::DESTROY {
1236 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1237}
1238 1397
1239sub detect() { 1398sub detect() {
1399 return $MODEL if $MODEL; # some programs keep references to detect
1400
1401 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1402 # the author knows about the problems and what it does to AnyEvent as a whole
1403 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1404 # anyway.
1405 AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n"
1406 . "design, abuses internals and breaks AnyEvent - will not continue."
1407 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1408
1409 local $!; # for good measure
1410 local $SIG{__DIE__}; # we use eval
1411
1240 # free some memory 1412 # free some memory
1241 *detect = sub () { $MODEL }; 1413 *detect = sub () { $MODEL };
1414 # undef &func doesn't correctly update the method cache. grmbl.
1415 # so we delete the whole glob. grmbl.
1416 # otoh, perl doesn't let me undef an active usb, but it lets me free
1417 # a glob with an active sub. hrm. i hope it works, but perl is
1418 # usually buggy in this department. sigh.
1419 delete @{"AnyEvent::"}{@methods};
1420 undef @methods;
1242 1421
1243 local $!; # for good measure
1244 local $SIG{__DIE__};
1245
1246 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1422 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1247 my $model = "AnyEvent::Impl::$1"; 1423 my $model = $1;
1424 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1248 if (eval "require $model") { 1425 if (eval "require $model") {
1426 AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1249 $MODEL = $model; 1427 $MODEL = $model;
1250 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1251 } else { 1428 } else {
1252 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1429 AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1253 } 1430 }
1254 } 1431 }
1255 1432
1256 # check for already loaded models 1433 # check for already loaded models
1257 unless ($MODEL) { 1434 unless ($MODEL) {
1258 for (@REGISTRY, @models) { 1435 for (@REGISTRY, @models) {
1259 my ($package, $model) = @$_; 1436 my ($package, $model) = @$_;
1260 if (${"$package\::VERSION"} > 0) { 1437 if (${"$package\::VERSION"} > 0) {
1261 if (eval "require $model") { 1438 if (eval "require $model") {
1439 AnyEvent::log 7 => "Autodetected model '$model', using it.";
1262 $MODEL = $model; 1440 $MODEL = $model;
1263 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1441 last;
1442 } else {
1443 AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@";
1444 }
1445 }
1446 }
1447
1448 unless ($MODEL) {
1449 # try to autoload a model
1450 for (@REGISTRY, @models) {
1451 my ($package, $model) = @$_;
1452 if (
1453 eval "require $package"
1454 and ${"$package\::VERSION"} > 0
1455 and eval "require $model"
1456 ) {
1457 AnyEvent::log 7 => "Autoloaded model '$model', using it.";
1458 $MODEL = $model;
1264 last; 1459 last;
1265 } 1460 }
1266 } 1461 }
1267 }
1268
1269 unless ($MODEL) {
1270 # try to autoload a model
1271 for (@REGISTRY, @models) {
1272 my ($package, $model, $autoload) = @$_;
1273 if (
1274 $autoload
1275 and eval "require $package"
1276 and ${"$package\::VERSION"} > 0
1277 and eval "require $model"
1278 ) {
1279 $MODEL = $model;
1280 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1281 last;
1282 }
1283 }
1284 1462
1285 $MODEL 1463 $MODEL
1286 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1464 or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?";
1287 } 1465 }
1288 } 1466 }
1289 1467
1290 @models = (); # free probe data 1468 # free memory only needed for probing
1469 undef @models;
1470 undef @REGISTRY;
1291 1471
1292 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1472 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293 unshift @ISA, $MODEL;
1294 1473
1295 # now nuke some methods that are overridden by the backend. 1474 # now nuke some methods that are overridden by the backend.
1296 # SUPER is not allowed. 1475 # SUPER usage is not allowed in these.
1297 for (qw(time signal child idle)) { 1476 for (qw(time signal child idle)) {
1298 undef &{"AnyEvent::Base::$_"} 1477 undef &{"AnyEvent::Base::$_"}
1299 if defined &{"$MODEL\::$_"}; 1478 if defined &{"$MODEL\::$_"};
1300 } 1479 }
1301 1480
1481 _isa_set;
1482
1483 # we're officially open!
1484
1302 if ($ENV{PERL_ANYEVENT_STRICT}) { 1485 if ($ENV{PERL_ANYEVENT_STRICT}) {
1303 eval { require AnyEvent::Strict }; 1486 require AnyEvent::Strict;
1304 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305 if $@ && $VERBOSE;
1306 } 1487 }
1307 1488
1489 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1490 require AnyEvent::Debug;
1491 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1492 }
1493
1494 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1495 require AnyEvent::Socket;
1496 require AnyEvent::Debug;
1497
1498 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1499 $shell =~ s/\$\$/$$/g;
1500
1501 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1502 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1503 }
1504
1505 # now the anyevent environment is set up as the user told us to, so
1506 # call the actual user code - post detects
1507
1308 (shift @post_detect)->() while @post_detect; 1508 (shift @post_detect)->() while @post_detect;
1509 undef @post_detect;
1309 1510
1310 *post_detect = sub(&) { 1511 *post_detect = sub(&) {
1311 shift->(); 1512 shift->();
1312 1513
1313 undef 1514 undef
1314 }; 1515 };
1315 1516
1316 $MODEL 1517 $MODEL
1317} 1518}
1318 1519
1319sub AUTOLOAD { 1520for my $name (@methods) {
1320 (my $func = $AUTOLOAD) =~ s/.*://; 1521 *$name = sub {
1321
1322 $method{$func}
1323 or Carp::croak "$func: not a valid AnyEvent class method";
1324
1325 detect; 1522 detect;
1326 1523 # we use goto because
1327 my $class = shift; 1524 # a) it makes the thunk more transparent
1328 $class->$func (@_); 1525 # b) it allows us to delete the thunk later
1526 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1527 };
1329} 1528}
1330 1529
1331# utility function to dup a filehandle. this is used by many backends 1530# utility function to dup a filehandle. this is used by many backends
1332# to support binding more than one watcher per filehandle (they usually 1531# to support binding more than one watcher per filehandle (they usually
1333# allow only one watcher per fd, so we dup it to get a different one). 1532# allow only one watcher per fd, so we dup it to get a different one).
1357 1556
1358package AE; 1557package AE;
1359 1558
1360our $VERSION = $AnyEvent::VERSION; 1559our $VERSION = $AnyEvent::VERSION;
1361 1560
1561sub _reset() {
1562 eval q{
1362# fall back to the main API by default - backends and AnyEvent::Base 1563 # fall back to the main API by default - backends and AnyEvent::Base
1363# implementations can overwrite these. 1564 # implementations can overwrite these.
1364 1565
1365sub io($$$) { 1566 sub io($$$) {
1366 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1567 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1367} 1568 }
1368 1569
1369sub timer($$$) { 1570 sub timer($$$) {
1370 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1571 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1371} 1572 }
1372 1573
1373sub signal($$) { 1574 sub signal($$) {
1374 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1575 AnyEvent->signal (signal => $_[0], cb => $_[1])
1375} 1576 }
1376 1577
1377sub child($$) { 1578 sub child($$) {
1378 AnyEvent->child (pid => $_[0], cb => $_[1]) 1579 AnyEvent->child (pid => $_[0], cb => $_[1])
1379} 1580 }
1380 1581
1381sub idle($) { 1582 sub idle($) {
1382 AnyEvent->idle (cb => $_[0]) 1583 AnyEvent->idle (cb => $_[0]);
1383} 1584 }
1384 1585
1385sub cv(;&) { 1586 sub cv(;&) {
1386 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1587 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1387} 1588 }
1388 1589
1389sub now() { 1590 sub now() {
1390 AnyEvent->now 1591 AnyEvent->now
1391} 1592 }
1392 1593
1393sub now_update() { 1594 sub now_update() {
1394 AnyEvent->now_update 1595 AnyEvent->now_update
1395} 1596 }
1396 1597
1397sub time() { 1598 sub time() {
1398 AnyEvent->time 1599 AnyEvent->time
1600 }
1601
1602 *postpone = \&AnyEvent::postpone;
1603 *log = \&AnyEvent::log;
1604 };
1605 die if $@;
1399} 1606}
1607
1608BEGIN { _reset }
1400 1609
1401package AnyEvent::Base; 1610package AnyEvent::Base;
1402 1611
1403# default implementations for many methods 1612# default implementations for many methods
1404 1613
1405sub time { 1614sub time {
1406 eval q{ # poor man's autoloading {} 1615 eval q{ # poor man's autoloading {}
1407 # probe for availability of Time::HiRes 1616 # probe for availability of Time::HiRes
1408 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1617 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1409 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1618 *time = sub { Time::HiRes::time () };
1410 *AE::time = \&Time::HiRes::time; 1619 *AE::time = \& Time::HiRes::time ;
1620 *now = \&time;
1621 AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy.";
1411 # if (eval "use POSIX (); (POSIX::times())... 1622 # if (eval "use POSIX (); (POSIX::times())...
1412 } else { 1623 } else {
1413 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1624 *time = sub { CORE::time };
1414 *AE::time = sub (){ time }; # epic fail 1625 *AE::time = sub (){ CORE::time };
1626 *now = \&time;
1627 AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!";
1415 } 1628 }
1416
1417 *time = sub { AE::time }; # different prototypes
1418 }; 1629 };
1419 die if $@; 1630 die if $@;
1420 1631
1421 &time 1632 &time
1422} 1633}
1423 1634
1424*now = \&time; 1635*now = \&time;
1425
1426sub now_update { } 1636sub now_update { }
1427 1637
1638sub _poll {
1639 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1640}
1641
1428# default implementation for ->condvar 1642# default implementation for ->condvar
1643# in fact, the default should not be overwritten
1429 1644
1430sub condvar { 1645sub condvar {
1431 eval q{ # poor man's autoloading {} 1646 eval q{ # poor man's autoloading {}
1432 *condvar = sub { 1647 *condvar = sub {
1433 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1648 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1511 1726
1512sub signal { 1727sub signal {
1513 eval q{ # poor man's autoloading {} 1728 eval q{ # poor man's autoloading {}
1514 # probe for availability of Async::Interrupt 1729 # probe for availability of Async::Interrupt
1515 if (_have_async_interrupt) { 1730 if (_have_async_interrupt) {
1516 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1731 AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling.";
1517 1732
1518 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1733 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1519 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1734 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1520 1735
1521 } else { 1736 } else {
1522 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1737 AnyEvent::log 8 => "Using emulated perl signal handling with latency timer.";
1523 1738
1524 if (AnyEvent::WIN32) { 1739 if (AnyEvent::WIN32) {
1525 require AnyEvent::Util; 1740 require AnyEvent::Util;
1526 1741
1527 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1742 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1603 : sysread $SIGPIPE_R, (my $dummy), 9; 1818 : sysread $SIGPIPE_R, (my $dummy), 9;
1604 1819
1605 while (%SIG_EV) { 1820 while (%SIG_EV) {
1606 for (keys %SIG_EV) { 1821 for (keys %SIG_EV) {
1607 delete $SIG_EV{$_}; 1822 delete $SIG_EV{$_};
1608 $_->() for values %{ $SIG_CB{$_} || {} }; 1823 &$_ for values %{ $SIG_CB{$_} || {} };
1609 } 1824 }
1610 } 1825 }
1611 }; 1826 };
1612 }; 1827 };
1613 die if $@; 1828 die if $@;
1640 }; 1855 };
1641 1856
1642 *child = sub { 1857 *child = sub {
1643 my (undef, %arg) = @_; 1858 my (undef, %arg) = @_;
1644 1859
1645 defined (my $pid = $arg{pid} + 0) 1860 my $pid = $arg{pid};
1646 or Carp::croak "required option 'pid' is missing"; 1861 my $cb = $arg{cb};
1647 1862
1648 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1863 $PID_CB{$pid}{$cb+0} = $cb;
1649 1864
1650 unless ($CHLD_W) { 1865 unless ($CHLD_W) {
1651 $CHLD_W = AE::signal CHLD => \&_sigchld; 1866 $CHLD_W = AE::signal CHLD => \&_sigchld;
1652 # child could be a zombie already, so make at least one round 1867 # child could be a zombie already, so make at least one round
1653 &_sigchld; 1868 &_sigchld;
1654 } 1869 }
1655 1870
1656 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1871 bless [$pid, $cb+0], "AnyEvent::Base::child"
1657 }; 1872 };
1658 1873
1659 *AnyEvent::Base::child::DESTROY = sub { 1874 *AnyEvent::Base::child::DESTROY = sub {
1660 my ($pid, $cb) = @{$_[0]}; 1875 my ($pid, $icb) = @{$_[0]};
1661 1876
1662 delete $PID_CB{$pid}{$cb}; 1877 delete $PID_CB{$pid}{$icb};
1663 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1878 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1664 1879
1665 undef $CHLD_W unless keys %PID_CB; 1880 undef $CHLD_W unless keys %PID_CB;
1666 }; 1881 };
1667 }; 1882 };
1680 1895
1681 my ($cb, $w, $rcb) = $arg{cb}; 1896 my ($cb, $w, $rcb) = $arg{cb};
1682 1897
1683 $rcb = sub { 1898 $rcb = sub {
1684 if ($cb) { 1899 if ($cb) {
1685 $w = _time; 1900 $w = AE::time;
1686 &$cb; 1901 &$cb;
1687 $w = _time - $w; 1902 $w = AE::time - $w;
1688 1903
1689 # never use more then 50% of the time for the idle watcher, 1904 # never use more then 50% of the time for the idle watcher,
1690 # within some limits 1905 # within some limits
1691 $w = 0.0001 if $w < 0.0001; 1906 $w = 0.0001 if $w < 0.0001;
1692 $w = 5 if $w > 5; 1907 $w = 5 if $w > 5;
1740sub _send { 1955sub _send {
1741 # nop 1956 # nop
1742} 1957}
1743 1958
1744sub _wait { 1959sub _wait {
1745 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; 1960 AnyEvent->_poll until $_[0]{_ae_sent};
1746} 1961}
1747 1962
1748sub send { 1963sub send {
1749 my $cv = shift; 1964 my $cv = shift;
1750 $cv->{_ae_sent} = [@_]; 1965 $cv->{_ae_sent} = [@_];
1762} 1977}
1763 1978
1764sub recv { 1979sub recv {
1765 unless ($_[0]{_ae_sent}) { 1980 unless ($_[0]{_ae_sent}) {
1766 $WAITING 1981 $WAITING
1767 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; 1982 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1768 1983
1769 local $WAITING = 1; 1984 local $WAITING = 1;
1770 $_[0]->_wait; 1985 $_[0]->_wait;
1771 } 1986 }
1772 1987
1821$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2036$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1822so on. 2037so on.
1823 2038
1824=head1 ENVIRONMENT VARIABLES 2039=head1 ENVIRONMENT VARIABLES
1825 2040
1826The following environment variables are used by this module or its 2041AnyEvent supports a number of environment variables that tune the
1827submodules. 2042runtime behaviour. They are usually evaluated when AnyEvent is
2043loaded, initialised, or a submodule that uses them is loaded. Many of
2044them also cause AnyEvent to load additional modules - for example,
2045C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2046loaded.
1828 2047
1829Note that AnyEvent will remove I<all> environment variables starting with 2048All the environment variables documented here start with
1830C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2049C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1831enabled. 2050namespace. Other modules are encouraged (but by no means required) to use
2051C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2052namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2053be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2054variables starting with C<AE_>, see below).
2055
2056All variables can also be set via the C<AE_> prefix, that is, instead
2057of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2058case there is a clash btween anyevent and another program that uses
2059C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2060variable to the empty string, as those variables take precedence.
2061
2062When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2063to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2064exists. If taint mode is on, then AnyEvent will remove I<all> environment
2065variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2066with C<undef> or the empty string, if the corresaponding C<AE_> variable
2067is set).
2068
2069The exact algorithm is currently:
2070
2071 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2072 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2073 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2074
2075This ensures that child processes will not see the C<AE_> variables.
2076
2077The following environment variables are currently known to AnyEvent:
1832 2078
1833=over 4 2079=over 4
1834 2080
1835=item C<PERL_ANYEVENT_VERBOSE> 2081=item C<PERL_ANYEVENT_VERBOSE>
1836 2082
1837By default, AnyEvent will be completely silent except in fatal 2083By default, AnyEvent will log messages with loglevel C<4> (C<error>) or
1838conditions. You can set this environment variable to make AnyEvent more 2084higher (see L<AnyEvent::Log>). You can set this environment variable to a
1839talkative. 2085numerical loglevel to make AnyEvent more (or less) talkative.
1840 2086
2087If you want to do more than just set the global logging level
2088you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2089complex specifications.
2090
2091When set to C<0> (C<off>), then no messages whatsoever will be logged with
2092everything else at defaults.
2093
1841When set to C<1> or higher, causes AnyEvent to warn about unexpected 2094When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected
1842conditions, such as not being able to load the event model specified by 2095conditions, such as not being able to load the event model specified by
1843C<PERL_ANYEVENT_MODEL>. 2096C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
2097is the minimum recommended level for use during development.
1844 2098
1845When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2099When set to C<7> or higher (info), AnyEvent reports which event model it
1846model it chooses. 2100chooses.
1847 2101
1848When set to C<8> or higher, then AnyEvent will report extra information on 2102When set to C<8> or higher (debug), then AnyEvent will report extra
1849which optional modules it loads and how it implements certain features. 2103information on which optional modules it loads and how it implements
2104certain features.
2105
2106=item C<PERL_ANYEVENT_LOG>
2107
2108Accepts rather complex logging specifications. For example, you could log
2109all C<debug> messages of some module to stderr, warnings and above to
2110stderr, and errors and above to syslog, with:
2111
2112 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2113
2114For the rather extensive details, see L<AnyEvent::Log>.
2115
2116This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2117so will take effect even before AnyEvent has initialised itself.
2118
2119Note that specifying this environment variable causes the L<AnyEvent::Log>
2120module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2121using the latter saves a few hundred kB of memory unless a module
2122explicitly needs the extra features of AnyEvent::Log.
1850 2123
1851=item C<PERL_ANYEVENT_STRICT> 2124=item C<PERL_ANYEVENT_STRICT>
1852 2125
1853AnyEvent does not do much argument checking by default, as thorough 2126AnyEvent does not do much argument checking by default, as thorough
1854argument checking is very costly. Setting this variable to a true value 2127argument checking is very costly. Setting this variable to a true value
1861Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2134Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1862>>, it is definitely recommended to keep it off in production. Keeping 2135>>, it is definitely recommended to keep it off in production. Keeping
1863C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2136C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1864can be very useful, however. 2137can be very useful, however.
1865 2138
2139=item C<PERL_ANYEVENT_DEBUG_SHELL>
2140
2141If this env variable is nonempty, then its contents will be interpreted by
2142C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2143replacing every occurance of C<$$> by the process pid). The shell object
2144is saved in C<$AnyEvent::Debug::SHELL>.
2145
2146This happens when the first watcher is created.
2147
2148For example, to bind a debug shell on a unix domain socket in
2149F<< /tmp/debug<pid>.sock >>, you could use this:
2150
2151 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2152 # connect with e.g.: socat readline /tmp/debug123.sock
2153
2154Or to bind to tcp port 4545 on localhost:
2155
2156 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2157 # connect with e.g.: telnet localhost 4545
2158
2159Note that creating sockets in F</tmp> or on localhost is very unsafe on
2160multiuser systems.
2161
2162=item C<PERL_ANYEVENT_DEBUG_WRAP>
2163
2164Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2165debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2166
1866=item C<PERL_ANYEVENT_MODEL> 2167=item C<PERL_ANYEVENT_MODEL>
1867 2168
1868This can be used to specify the event model to be used by AnyEvent, before 2169This can be used to specify the event model to be used by AnyEvent, before
1869auto detection and -probing kicks in. It must be a string consisting 2170auto detection and -probing kicks in.
1870entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2171
2172It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2173or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1871and the resulting module name is loaded and if the load was successful, 2174resulting module name is loaded and - if the load was successful - used as
1872used as event model. If it fails to load AnyEvent will proceed with 2175event model backend. If it fails to load then AnyEvent will proceed with
1873auto detection and -probing. 2176auto detection and -probing.
1874 2177
1875This functionality might change in future versions. 2178If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2179nothing gets prepended and the module name is used as-is (hint: C<::> at
2180the end of a string designates a module name and quotes it appropriately).
1876 2181
1877For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2182For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1878could start your program like this: 2183could start your program like this:
1879 2184
1880 PERL_ANYEVENT_MODEL=Perl perl ... 2185 PERL_ANYEVENT_MODEL=Perl perl ...
2186
2187=item C<PERL_ANYEVENT_IO_MODEL>
2188
2189The current file I/O model - see L<AnyEvent::IO> for more info.
2190
2191At the moment, only C<Perl> (small, pure-perl, synchronous) and
2192C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if
2193L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>.
1881 2194
1882=item C<PERL_ANYEVENT_PROTOCOLS> 2195=item C<PERL_ANYEVENT_PROTOCOLS>
1883 2196
1884Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences 2197Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1885for IPv4 or IPv6. The default is unspecified (and might change, or be the result 2198for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1898but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2211but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1899- only support IPv4, never try to resolve or contact IPv6 2212- only support IPv4, never try to resolve or contact IPv6
1900addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2213addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1901IPv6, but prefer IPv6 over IPv4. 2214IPv6, but prefer IPv6 over IPv4.
1902 2215
2216=item C<PERL_ANYEVENT_HOSTS>
2217
2218This variable, if specified, overrides the F</etc/hosts> file used by
2219L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2220from that file instead.
2221
1903=item C<PERL_ANYEVENT_EDNS0> 2222=item C<PERL_ANYEVENT_EDNS0>
1904 2223
1905Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2224Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1906for DNS. This extension is generally useful to reduce DNS traffic, but 2225DNS. This extension is generally useful to reduce DNS traffic, especially
1907some (broken) firewalls drop such DNS packets, which is why it is off by 2226when DNSSEC is involved, but some (broken) firewalls drop such DNS
1908default. 2227packets, which is why it is off by default.
1909 2228
1910Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2229Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1911EDNS0 in its DNS requests. 2230EDNS0 in its DNS requests.
1912 2231
1913=item C<PERL_ANYEVENT_MAX_FORKS> 2232=item C<PERL_ANYEVENT_MAX_FORKS>
1919 2238
1920The default value for the C<max_outstanding> parameter for the default DNS 2239The default value for the C<max_outstanding> parameter for the default DNS
1921resolver - this is the maximum number of parallel DNS requests that are 2240resolver - this is the maximum number of parallel DNS requests that are
1922sent to the DNS server. 2241sent to the DNS server.
1923 2242
2243=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
2244
2245Perl has inherently racy signal handling (you can basically choose between
2246losing signals and memory corruption) - pure perl event loops (including
2247C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
2248have to poll regularly to avoid losing signals.
2249
2250Some event loops are racy, but don't poll regularly, and some event loops
2251are written in C but are still racy. For those event loops, AnyEvent
2252installs a timer that regularly wakes up the event loop.
2253
2254By default, the interval for this timer is C<10> seconds, but you can
2255override this delay with this environment variable (or by setting
2256the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
2257watchers).
2258
2259Lower values increase CPU (and energy) usage, higher values can introduce
2260long delays when reaping children or waiting for signals.
2261
2262The L<AnyEvent::Async> module, if available, will be used to avoid this
2263polling (with most event loops).
2264
1924=item C<PERL_ANYEVENT_RESOLV_CONF> 2265=item C<PERL_ANYEVENT_RESOLV_CONF>
1925 2266
1926The file to use instead of F</etc/resolv.conf> (or OS-specific 2267The absolute path to a F<resolv.conf>-style file to use instead of
1927configuration) in the default resolver. When set to the empty string, no 2268F</etc/resolv.conf> (or the OS-specific configuration) in the default
1928default config will be used. 2269resolver, or the empty string to select the default configuration.
1929 2270
1930=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2271=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1931 2272
1932When neither C<ca_file> nor C<ca_path> was specified during 2273When neither C<ca_file> nor C<ca_path> was specified during
1933L<AnyEvent::TLS> context creation, and either of these environment 2274L<AnyEvent::TLS> context creation, and either of these environment
1934variables exist, they will be used to specify CA certificate locations 2275variables are nonempty, they will be used to specify CA certificate
1935instead of a system-dependent default. 2276locations instead of a system-dependent default.
1936 2277
1937=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2278=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1938 2279
1939When these are set to C<1>, then the respective modules are not 2280When these are set to C<1>, then the respective modules are not
1940loaded. Mostly good for testing AnyEvent itself. 2281loaded. Mostly good for testing AnyEvent itself.
2272(even when used without AnyEvent), but most event loops have acceptable 2613(even when used without AnyEvent), but most event loops have acceptable
2273performance with or without AnyEvent. 2614performance with or without AnyEvent.
2274 2615
2275=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2616=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2276the actual event loop, only with extremely fast event loops such as EV 2617the actual event loop, only with extremely fast event loops such as EV
2277adds AnyEvent significant overhead. 2618does AnyEvent add significant overhead.
2278 2619
2279=item * You should avoid POE like the plague if you want performance or 2620=item * You should avoid POE like the plague if you want performance or
2280reasonable memory usage. 2621reasonable memory usage.
2281 2622
2282=back 2623=back
2581 2922
2582=item L<Time::HiRes> 2923=item L<Time::HiRes>
2583 2924
2584This module is part of perl since release 5.008. It will be used when the 2925This module is part of perl since release 5.008. It will be used when the
2585chosen event library does not come with a timing source of its own. The 2926chosen event library does not come with a timing source of its own. The
2586pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2927pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2587try to use a monotonic clock for timing stability. 2928try to use a monotonic clock for timing stability.
2588 2929
2589=back 2930=back
2590 2931
2591 2932
2657 2998
2658Tutorial/Introduction: L<AnyEvent::Intro>. 2999Tutorial/Introduction: L<AnyEvent::Intro>.
2659 3000
2660FAQ: L<AnyEvent::FAQ>. 3001FAQ: L<AnyEvent::FAQ>.
2661 3002
2662Utility functions: L<AnyEvent::Util>. 3003Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
3004(simply logging).
2663 3005
2664Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 3006Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2665L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 3007L<AnyEvent::Debug> (interactive shell, watcher tracing).
3008
3009Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
3010L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
3011L<Qt>, L<POE>, L<FLTK>.
2666 3012
2667Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 3013Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2668L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 3014L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2669L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 3015L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2670L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 3016L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
3017L<AnyEvent::Impl::FLTK>.
2671 3018
2672Non-blocking file handles, sockets, TCP clients and 3019Non-blocking handles, pipes, stream sockets, TCP clients and
2673servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 3020servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
3021
3022Asynchronous File I/O: L<AnyEvent::IO>.
2674 3023
2675Asynchronous DNS: L<AnyEvent::DNS>. 3024Asynchronous DNS: L<AnyEvent::DNS>.
2676 3025
2677Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 3026Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2678 3027
2681 3030
2682 3031
2683=head1 AUTHOR 3032=head1 AUTHOR
2684 3033
2685 Marc Lehmann <schmorp@schmorp.de> 3034 Marc Lehmann <schmorp@schmorp.de>
2686 http://home.schmorp.de/ 3035 http://anyevent.schmorp.de
2687 3036
2688=cut 3037=cut
2689 3038
26901 30391
2691 3040

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines