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.375 by root, Thu Aug 25 05:39:47 2011 UTC vs.
Revision 1.382 by root, Thu Sep 1 23:46:26 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
1227our @ISA; 1242our @ISA;
1228
1229our @REGISTRY; 1243our @REGISTRY;
1230
1231our $VERBOSE; 1244our $VERBOSE;
1245our $MAX_SIGNAL_LATENCY = 10;
1246our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1232 1247
1233BEGIN { 1248BEGIN {
1234 require "AnyEvent/constants.pl"; 1249 require "AnyEvent/constants.pl";
1235 1250
1236 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1251 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
… …
1242 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV; 1257 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1243 1258
1244 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = () 1259 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1245 if ${^TAINT}; 1260 if ${^TAINT};
1246 1261
1247 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1262 # $ENV{PERL_ANYEVENT_xxx} now valid
1248}
1249 1263
1250our $MAX_SIGNAL_LATENCY = 10; 1264 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1251 1265
1252our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1253
1254{
1255 my $idx; 1266 my $idx;
1256 $PROTOCOL{$_} = ++$idx 1267 $PROTOCOL{$_} = ++$idx
1257 for reverse split /\s*,\s*/, 1268 for reverse split /\s*,\s*/,
1258 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1269 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1259} 1270}
… …
1291 1302
1292 () 1303 ()
1293} 1304}
1294 1305
1295sub log($$;@) { 1306sub log($$;@) {
1296 # only load the bug bloated module when we actually are about to log something 1307 # only load the big bloated module when we actually are about to log something
1297 if ($_[0] <= $VERBOSE) { 1308 if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
1298 require AnyEvent::Log; 1309 require AnyEvent::Log;
1299 # AnyEvent::Log overwrites this function 1310 # AnyEvent::Log overwrites this function
1300 goto &log; 1311 goto &log;
1301 } 1312 }
1313
1314 0 # not logged
1302} 1315}
1303 1316
1304if (length $ENV{PERL_ANYEVENT_LOG}) { 1317if (length $ENV{PERL_ANYEVENT_LOG}) {
1305 require AnyEvent::Log; # AnyEvent::Log does the thing for us 1318 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1306} 1319}
… …
1320 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1333 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1321 [Wx:: => AnyEvent::Impl::POE::], 1334 [Wx:: => AnyEvent::Impl::POE::],
1322 [Prima:: => AnyEvent::Impl::POE::], 1335 [Prima:: => AnyEvent::Impl::POE::],
1323 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect 1336 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1324 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1337 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1325 [FLTK:: => AnyEvent::Impl::FLTK2::], 1338 [FLTK:: => AnyEvent::Impl::FLTK::],
1326); 1339);
1327 1340
1328our @isa_hook; 1341our @isa_hook;
1329 1342
1330sub _isa_set { 1343sub _isa_set {
… …
1371 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; 1384 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1372 if (eval "require $model") { 1385 if (eval "require $model") {
1373 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."; 1386 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1374 $MODEL = $model; 1387 $MODEL = $model;
1375 } else { 1388 } else {
1376 AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@"; 1389 AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1377 } 1390 }
1378 } 1391 }
1379 1392
1380 # check for already loaded models 1393 # check for already loaded models
1381 unless ($MODEL) { 1394 unless ($MODEL) {
… …
1559 1572
1560sub time { 1573sub time {
1561 eval q{ # poor man's autoloading {} 1574 eval q{ # poor man's autoloading {}
1562 # probe for availability of Time::HiRes 1575 # probe for availability of Time::HiRes
1563 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1576 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 () }; 1577 *time = sub { Time::HiRes::time () };
1567 *AE::time = \& Time::HiRes::time ; 1578 *AE::time = \& Time::HiRes::time ;
1579 *now = \&time;
1580 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1568 # if (eval "use POSIX (); (POSIX::times())... 1581 # if (eval "use POSIX (); (POSIX::times())...
1569 } else { 1582 } else {
1570 AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
1571 *time = sub { CORE::time }; 1583 *time = sub { CORE::time };
1572 *AE::time = sub (){ CORE::time }; 1584 *AE::time = sub (){ CORE::time };
1585 *now = \&time;
1586 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1573 } 1587 }
1574
1575 *now = \&time;
1576 }; 1588 };
1577 die if $@; 1589 die if $@;
1578 1590
1579 &time 1591 &time
1580} 1592}
… …
1673 1685
1674sub signal { 1686sub signal {
1675 eval q{ # poor man's autoloading {} 1687 eval q{ # poor man's autoloading {}
1676 # probe for availability of Async::Interrupt 1688 # probe for availability of Async::Interrupt
1677 if (_have_async_interrupt) { 1689 if (_have_async_interrupt) {
1678 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling." 1690 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1679 if $AnyEvent::VERBOSE >= 8;
1680 1691
1681 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1692 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1682 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1693 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1683 1694
1684 } else { 1695 } else {
1685 AnyEvent::log 8 => "using emulated perl signal handling with latency timer." 1696 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1686 if $AnyEvent::VERBOSE >= 8;
1687 1697
1688 if (AnyEvent::WIN32) { 1698 if (AnyEvent::WIN32) {
1689 require AnyEvent::Util; 1699 require AnyEvent::Util;
1690 1700
1691 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1701 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
… …
2027 2037
2028=over 4 2038=over 4
2029 2039
2030=item C<PERL_ANYEVENT_VERBOSE> 2040=item C<PERL_ANYEVENT_VERBOSE>
2031 2041
2032By default, AnyEvent will be completely silent except in fatal 2042By default, AnyEvent will only log messages with loglevel C<3>
2033conditions. You can set this environment variable to make AnyEvent more 2043(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2044environment variable to a numerical loglevel to make AnyEvent more (or
2045less) talkative.
2046
2034talkative. If you want to do more than just set the global logging level 2047If 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 2048you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2036complex specifications. 2049complex specifications.
2037 2050
2051When set to C<0> (C<off>), then no messages whatsoever will be logged with
2052the default logging settings.
2053
2038When set to C<5> or higher, causes AnyEvent to warn about unexpected 2054When 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 2055unexpected conditions, such as not being able to load the event model
2040C<PERL_ANYEVENT_MODEL>. 2056specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2057exception - this is the minimum recommended level.
2041 2058
2042When set to C<7> or higher, cause AnyEvent to report to STDERR which event 2059When set to C<7> or higher (info), cause AnyEvent to report which event model it
2043model it chooses. 2060chooses.
2044 2061
2045When set to C<8> or higher, then AnyEvent will report extra information on 2062When 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. 2063which optional modules it loads and how it implements certain features.
2047 2064
2048=item C<PERL_ANYEVENT_LOG> 2065=item C<PERL_ANYEVENT_LOG>
2049 2066
2050Accepts rather complex logging specifications. For example, you could log 2067Accepts rather complex logging specifications. For example, you could log

Diff Legend

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