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.371 by root, Wed Aug 24 23:59:10 2011 UTC vs.
Revision 1.381 by root, Thu Sep 1 22:09:25 2011 UTC

… …
878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879 AnyEvent::Impl::POE based on POE, very slow, some limitations. 879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
880 AnyEvent::Impl::Irssi used when running within irssi. 880 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async. 881 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. 882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding). 883 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
884 884
885=item Backends with special needs. 885=item Backends with special needs.
886 886
887Qt requires the Qt::Application to be instantiated first, but will 887Qt requires the Qt::Application to be instantiated first, but will
888otherwise be picked up automatically. As long as the main program 888otherwise be picked up automatically. As long as the main program
… …
1053 1053
1054=item AnyEvent::log $level, $msg[, @args] 1054=item AnyEvent::log $level, $msg[, @args]
1055 1055
1056Log the given C<$msg> at the given C<$level>. 1056Log the given C<$msg> at the given C<$level>.
1057 1057
1058Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> - 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
1059consequently, look at the L<AnyEvent::Log> documentation for details. 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}>.
1060 1066
1061If you want to sprinkle loads of logging calls around your code, consider 1067If you want to sprinkle loads of logging calls around your code, consider
1062creating a logger callback with the C<AnyEvent::Log::logger> function. 1068creating a logger callback with the C<AnyEvent::Log::logger> function,
1069which can reduce typing, codesize and can reduce the logging overhead
1070enourmously.
1063 1071
1064=back 1072=back
1065 1073
1066=head1 WHAT TO DO IN A MODULE 1074=head1 WHAT TO DO IN A MODULE
1067 1075
… …
1160 1168
1161Implement event-based interfaces to the protocols of the same name (for 1169Implement event-based interfaces to the protocols of the same name (for
1162the 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
1163Client Protocol). 1171Client Protocol).
1164 1172
1165=item L<AnyEvent::Handle::UDP>
1166
1167Here be danger!
1168
1169As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1170there are so many things wrong with AnyEvent::Handle::UDP, most notably
1171its use of a stream-based API with a protocol that isn't streamable, that
1172the only way to improve it is to delete it.
1173
1174It features data corruption (but typically only under load) and general
1175confusion. On top, the author is not only clueless about UDP but also
1176fact-resistant - some gems of his understanding: "connect doesn't work
1177with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1178packets", "I don't need to implement proper error checking as UDP doesn't
1179support error checking" and so on - he doesn't even understand what's
1180wrong with his module when it is explained to him.
1181
1182=item L<AnyEvent::DBI>
1183
1184Executes L<DBI> requests asynchronously in a proxy process for you,
1185notifying you in an event-based way when the operation is finished.
1186
1187=item L<AnyEvent::AIO> 1173=item L<AnyEvent::AIO>
1188 1174
1189Truly 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
1190toolbox of every event programmer. AnyEvent::AIO transparently fuses 1176toolbox of every event programmer. AnyEvent::AIO transparently fuses
1191L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1177L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1192file I/O, and much more. 1178file I/O, and much more.
1193 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
1194=item L<AnyEvent::HTTPD> 1198=item L<AnyEvent::HTTPD>
1195 1199
1196A simple embedded webserver. 1200A simple embedded webserver.
1197 1201
1198=item L<AnyEvent::FastPing> 1202=item L<AnyEvent::FastPing>
1199 1203
1200The fastest ping in the west. 1204The fastest ping in the west.
1201 1205
1202=item L<Coro> 1206=item L<Coro>
1203 1207
1204Has 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 };
1205 1221
1206=back 1222=back
1207 1223
1208=cut 1224=cut
1209 1225
… …
1219 1235
1220BEGIN { AnyEvent::common_sense } 1236BEGIN { AnyEvent::common_sense }
1221 1237
1222use Carp (); 1238use Carp ();
1223 1239
1224our $VERSION = '6.01'; 1240our $VERSION = '6.02';
1225our $MODEL; 1241our $MODEL;
1226 1242
1227our @ISA; 1243our @ISA;
1228 1244
1229our @REGISTRY; 1245our @REGISTRY;
… …
1242 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV; 1258 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1243 1259
1244 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = () 1260 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1245 if ${^TAINT}; 1261 if ${^TAINT};
1246 1262
1247 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1263 # $ENV{PERL_ANYEVENT_xxx} now valid
1264
1265 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1248} 1266}
1249 1267
1250our $MAX_SIGNAL_LATENCY = 10; 1268our $MAX_SIGNAL_LATENCY = 10;
1251 1269
1252our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1270our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
… …
1291 1309
1292 () 1310 ()
1293} 1311}
1294 1312
1295sub log($$;@) { 1313sub log($$;@) {
1314 # only load the big bloated module when we actually are about to log something
1315 if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
1296 require AnyEvent::Log; 1316 require AnyEvent::Log;
1297 # AnyEvent::Log overwrites this function 1317 # AnyEvent::Log overwrites this function
1298 goto &log; 1318 goto &log;
1319 }
1320
1321 0 # not logged
1322}
1323
1324if (length $ENV{PERL_ANYEVENT_LOG}) {
1325 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1299} 1326}
1300 1327
1301our @models = ( 1328our @models = (
1302 [EV:: => AnyEvent::Impl::EV:: , 1], 1329 [EV:: => AnyEvent::Impl::EV:: , 1],
1303 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], 1330 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
… …
1313 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1340 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1314 [Wx:: => AnyEvent::Impl::POE::], 1341 [Wx:: => AnyEvent::Impl::POE::],
1315 [Prima:: => AnyEvent::Impl::POE::], 1342 [Prima:: => AnyEvent::Impl::POE::],
1316 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect 1343 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1317 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1344 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1318 [FLTK:: => AnyEvent::Impl::FLTK2::], 1345 [FLTK:: => AnyEvent::Impl::FLTK::],
1319); 1346);
1320 1347
1321our @isa_hook; 1348our @isa_hook;
1322 1349
1323sub _isa_set { 1350sub _isa_set {
… …
1361 1388
1362 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { 1389 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1363 my $model = $1; 1390 my $model = $1;
1364 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; 1391 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1365 if (eval "require $model") { 1392 if (eval "require $model") {
1393 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1366 $MODEL = $model; 1394 $MODEL = $model;
1367 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
1368 if $VERBOSE >= 7;
1369 } else { 1395 } else {
1370 AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; 1396 AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1371 } 1397 }
1372 } 1398 }
1373 1399
1374 # check for already loaded models 1400 # check for already loaded models
1375 unless ($MODEL) { 1401 unless ($MODEL) {
1376 for (@REGISTRY, @models) { 1402 for (@REGISTRY, @models) {
1377 my ($package, $model) = @$_; 1403 my ($package, $model) = @$_;
1378 if (${"$package\::VERSION"} > 0) { 1404 if (${"$package\::VERSION"} > 0) {
1379 if (eval "require $model") { 1405 if (eval "require $model") {
1406 AnyEvent::log 7 => "autodetected model '$model', using it.";
1380 $MODEL = $model; 1407 $MODEL = $model;
1381 AnyEvent::log 7 => "autodetected model '$model', using it."
1382 if $VERBOSE >= 7;
1383 last; 1408 last;
1384 } 1409 }
1385 } 1410 }
1386 } 1411 }
1387 1412
… …
1393 $autoload 1418 $autoload
1394 and eval "require $package" 1419 and eval "require $package"
1395 and ${"$package\::VERSION"} > 0 1420 and ${"$package\::VERSION"} > 0
1396 and eval "require $model" 1421 and eval "require $model"
1397 ) { 1422 ) {
1423 AnyEvent::log 7 => "autoloaded model '$model', using it.";
1398 $MODEL = $model; 1424 $MODEL = $model;
1399 AnyEvent::log 7 => "autoloaded model '$model', using it."
1400 if $VERBOSE >= 7;
1401 last; 1425 last;
1402 } 1426 }
1403 } 1427 }
1404 1428
1405 $MODEL 1429 $MODEL
… …
1421 } 1445 }
1422 1446
1423 _isa_set; 1447 _isa_set;
1424 1448
1425 # we're officially open! 1449 # we're officially open!
1426
1427 if (length $ENV{PERL_ANYEVENT_LOG}) {
1428 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1429 }
1430 1450
1431 if ($ENV{PERL_ANYEVENT_STRICT}) { 1451 if ($ENV{PERL_ANYEVENT_STRICT}) {
1432 require AnyEvent::Strict; 1452 require AnyEvent::Strict;
1433 } 1453 }
1434 1454
… …
1559 1579
1560sub time { 1580sub time {
1561 eval q{ # poor man's autoloading {} 1581 eval q{ # poor man's autoloading {}
1562 # probe for availability of Time::HiRes 1582 # probe for availability of Time::HiRes
1563 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1583 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1564 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
1565 if $AnyEvent::VERBOSE >= 8;
1566 *time = sub { Time::HiRes::time () }; 1584 *time = sub { Time::HiRes::time () };
1567 *AE::time = \& Time::HiRes::time ; 1585 *AE::time = \& Time::HiRes::time ;
1586 *now = \&time;
1587 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1568 # if (eval "use POSIX (); (POSIX::times())... 1588 # if (eval "use POSIX (); (POSIX::times())...
1569 } else { 1589 } else {
1570 AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
1571 *time = sub { CORE::time }; 1590 *time = sub { CORE::time };
1572 *AE::time = sub (){ CORE::time }; 1591 *AE::time = sub (){ CORE::time };
1592 *now = \&time;
1593 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1573 } 1594 }
1574
1575 *now = \&time;
1576 }; 1595 };
1577 die if $@; 1596 die if $@;
1578 1597
1579 &time 1598 &time
1580} 1599}
… …
1673 1692
1674sub signal { 1693sub signal {
1675 eval q{ # poor man's autoloading {} 1694 eval q{ # poor man's autoloading {}
1676 # probe for availability of Async::Interrupt 1695 # probe for availability of Async::Interrupt
1677 if (_have_async_interrupt) { 1696 if (_have_async_interrupt) {
1678 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling." 1697 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1679 if $AnyEvent::VERBOSE >= 8;
1680 1698
1681 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1699 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1682 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1700 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1683 1701
1684 } else { 1702 } else {
1685 AnyEvent::log 8 => "using emulated perl signal handling with latency timer." 1703 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1686 if $AnyEvent::VERBOSE >= 8;
1687 1704
1688 if (AnyEvent::WIN32) { 1705 if (AnyEvent::WIN32) {
1689 require AnyEvent::Util; 1706 require AnyEvent::Util;
1690 1707
1691 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1708 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
… …
2027 2044
2028=over 4 2045=over 4
2029 2046
2030=item C<PERL_ANYEVENT_VERBOSE> 2047=item C<PERL_ANYEVENT_VERBOSE>
2031 2048
2032By default, AnyEvent will be completely silent except in fatal 2049By default, AnyEvent will only log messages with loglevel C<3>
2033conditions. You can set this environment variable to make AnyEvent more 2050(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2051environment variable to a numerical loglevel to make AnyEvent more (or
2052less) talkative.
2053
2034talkative. If you want to do more than just set the global logging level 2054If you want to do more than just set the global logging level
2035you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more 2055you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2036complex specifications. 2056complex specifications.
2037 2057
2058When set to C<0> (C<off>), then no messages whatsoever will be logged with
2059the default logging settings.
2060
2038When set to C<5> or higher, causes AnyEvent to warn about unexpected 2061When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
2039conditions, such as not being able to load the event model specified by 2062unexpected conditions, such as not being able to load the event model
2040C<PERL_ANYEVENT_MODEL>. 2063specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2064exception - this is the minimum recommended level.
2041 2065
2042When set to C<7> or higher, cause AnyEvent to report to STDERR which event 2066When set to C<7> or higher (info), cause AnyEvent to report which event model it
2043model it chooses. 2067chooses.
2044 2068
2045When set to C<8> or higher, then AnyEvent will report extra information on 2069When set to C<8> or higher (debug), then AnyEvent will report extra information on
2046which optional modules it loads and how it implements certain features. 2070which optional modules it loads and how it implements certain features.
2047 2071
2048=item C<PERL_ANYEVENT_LOG> 2072=item C<PERL_ANYEVENT_LOG>
2049 2073
2050Accepts rather complex logging specifications. For example, you could log 2074Accepts rather complex logging specifications. For example, you could log
… …
2052stderr, and errors and above to syslog, with: 2076stderr, and errors and above to syslog, with:
2053 2077
2054 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog 2078 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2055 2079
2056For the rather extensive details, see L<AnyEvent::Log>. 2080For the rather extensive details, see L<AnyEvent::Log>.
2081
2082This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2083so will take effect even before AnyEvent has initialised itself.
2057 2084
2058Note that specifying this environment variable causes the L<AnyEvent::Log> 2085Note that specifying this environment variable causes the L<AnyEvent::Log>
2059module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only 2086module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2060using the latter saves a few hundred kB of memory until the first message 2087using the latter saves a few hundred kB of memory until the first message
2061is being logged. 2088is being logged.
… …
2080If this env variable is set, then its contents will be interpreted by 2107If this env variable is set, then its contents will be interpreted by
2081C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of 2108C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
2082C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on 2109C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
2083that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>. 2110that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2084 2111
2085This takes place when the first watcher is created. 2112This happens when the first watcher is created.
2086 2113
2087For example, to bind a debug shell on a unix domain socket in 2114For example, to bind a debug shell on a unix domain socket in
2088F<< /tmp/debug<pid>.sock >>, you could use this: 2115F<< /tmp/debug<pid>.sock >>, you could use this:
2089 2116
2090 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog 2117 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
… …
2135Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, 2162Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
2136but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2163but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
2137- only support IPv4, never try to resolve or contact IPv6 2164- only support IPv4, never try to resolve or contact IPv6
2138addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2165addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
2139IPv6, but prefer IPv6 over IPv4. 2166IPv6, but prefer IPv6 over IPv4.
2167
2168=item C<PERL_ANYEVENT_HOSTS>
2169
2170This variable, if specified, overrides the F</etc/hosts> file used by
2171L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2172from that file instead.
2140 2173
2141=item C<PERL_ANYEVENT_EDNS0> 2174=item C<PERL_ANYEVENT_EDNS0>
2142 2175
2143Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for 2176Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
2144DNS. This extension is generally useful to reduce DNS traffic, especially 2177DNS. This extension is generally useful to reduce DNS traffic, especially

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines