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.358 by root, Sat Aug 13 02:35:32 2011 UTC vs.
Revision 1.365 by root, Tue Aug 16 14:47:26 2011 UTC

… …
934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
935if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
936have created an AnyEvent watcher anyway, that is, as late as possible at 936have created an AnyEvent watcher anyway, that is, as late as possible at
937runtime, and not e.g. during initialisation of your module. 937runtime, and not e.g. during initialisation of your module.
938 938
939The effect of calling this function is as if a watcher had been created
940(specifically, actions that happen "when the first watcher is created"
941happen when calling detetc as well).
942
939If you need to do some initialisation before AnyEvent watchers are 943If you need to do some initialisation before AnyEvent watchers are
940created, use C<post_detect>. 944created, use C<post_detect>.
941 945
942=item $guard = AnyEvent::post_detect { BLOCK } 946=item $guard = AnyEvent::post_detect { BLOCK }
943 947
… …
1045It should use C<postpone>: 1049It should use C<postpone>:
1046 1050
1047 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later 1051 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1048 if $some_error_condition; 1052 if $some_error_condition;
1049 1053
1054=item AnyEvent::log $level, $msg[, @args]
1055
1056Log the given C<$msg> at the given C<$level>.
1057
1058Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> -
1059consequently, look at the L<AnyEvent::Log> documentation for details.
1060
1050=back 1061=back
1051 1062
1052=head1 WHAT TO DO IN A MODULE 1063=head1 WHAT TO DO IN A MODULE
1053 1064
1054As a module author, you should C<use AnyEvent> and call AnyEvent methods 1065As a module author, you should C<use AnyEvent> and call AnyEvent methods
… …
1202 1213
1203BEGIN { AnyEvent::common_sense } 1214BEGIN { AnyEvent::common_sense }
1204 1215
1205use Carp (); 1216use Carp ();
1206 1217
1207our $VERSION = '5.34'; 1218our $VERSION = '6.01';
1208our $MODEL; 1219our $MODEL;
1209 1220
1210our @ISA; 1221our @ISA;
1211 1222
1212our @REGISTRY; 1223our @REGISTRY;
… …
1220 1231
1221 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1232 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1222 if ${^TAINT}; 1233 if ${^TAINT};
1223 1234
1224 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1235 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1225
1226} 1236}
1227 1237
1228our $MAX_SIGNAL_LATENCY = 10; 1238our $MAX_SIGNAL_LATENCY = 10;
1229 1239
1230our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1240our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
… …
1266 push @POSTPONE, shift; 1276 push @POSTPONE, shift;
1267 1277
1268 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec); 1278 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1269 1279
1270 () 1280 ()
1281}
1282
1283sub log($$;@) {
1284 require AnyEvent::Log;
1285 # AnyEvent::Log overwrites this function
1286 goto &log;
1271} 1287}
1272 1288
1273our @models = ( 1289our @models = (
1274 [EV:: => AnyEvent::Impl::EV:: , 1], 1290 [EV:: => AnyEvent::Impl::EV:: , 1],
1275 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1], 1291 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
… …
1288 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect 1304 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1289 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1305 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1290 [FLTK:: => AnyEvent::Impl::FLTK2::], 1306 [FLTK:: => AnyEvent::Impl::FLTK2::],
1291); 1307);
1292 1308
1309our @isa_hook;
1310
1311sub _isa_set {
1312 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1313
1314 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1315 for 1 .. $#pkg;
1316
1317 grep $_ && $_->[1], @isa_hook
1318 and AE::_reset ();
1319}
1320
1321# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1322sub _isa_hook($$;$) {
1323 my ($i, $pkg, $reset_ae) = @_;
1324
1325 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1326
1327 _isa_set;
1328}
1329
1293# all autoloaded methods reserve the complete glob, not just the method slot. 1330# all autoloaded methods reserve the complete glob, not just the method slot.
1294# due to bugs in perls method cache implementation. 1331# due to bugs in perls method cache implementation.
1295our @methods = qw(io timer time now now_update signal child idle condvar); 1332our @methods = qw(io timer time now now_update signal child idle condvar);
1296 1333
1297sub detect() { 1334sub detect() {
1335 return $MODEL if $MODEL; # some programs keep references to detect
1336
1298 local $!; # for good measure 1337 local $!; # for good measure
1299 local $SIG{__DIE__}; # we use eval 1338 local $SIG{__DIE__}; # we use eval
1300 1339
1301 # free some memory 1340 # free some memory
1302 *detect = sub () { $MODEL }; 1341 *detect = sub () { $MODEL };
… …
1311 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) { 1350 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1312 my $model = $1; 1351 my $model = $1;
1313 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//; 1352 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1314 if (eval "require $model") { 1353 if (eval "require $model") {
1315 $MODEL = $model; 1354 $MODEL = $model;
1316 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1355 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
1356 if $VERBOSE >= 7;
1317 } else { 1357 } else {
1318 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1358 AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1319 } 1359 }
1320 } 1360 }
1321 1361
1322 # check for already loaded models 1362 # check for already loaded models
1323 unless ($MODEL) { 1363 unless ($MODEL) {
1324 for (@REGISTRY, @models) { 1364 for (@REGISTRY, @models) {
1325 my ($package, $model) = @$_; 1365 my ($package, $model) = @$_;
1326 if (${"$package\::VERSION"} > 0) { 1366 if (${"$package\::VERSION"} > 0) {
1327 if (eval "require $model") { 1367 if (eval "require $model") {
1328 $MODEL = $model; 1368 $MODEL = $model;
1329 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1369 AnyEvent::log 7 => "autodetected model '$model', using it."
1370 if $VERBOSE >= 7;
1330 last; 1371 last;
1331 } 1372 }
1332 } 1373 }
1333 } 1374 }
1334 1375
… …
1341 and eval "require $package" 1382 and eval "require $package"
1342 and ${"$package\::VERSION"} > 0 1383 and ${"$package\::VERSION"} > 0
1343 and eval "require $model" 1384 and eval "require $model"
1344 ) { 1385 ) {
1345 $MODEL = $model; 1386 $MODEL = $model;
1346 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; 1387 AnyEvent::log 7 => "autoloaded model '$model', using it."
1388 if $VERBOSE >= 7;
1347 last; 1389 last;
1348 } 1390 }
1349 } 1391 }
1350 1392
1351 $MODEL 1393 $MODEL
1352 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1394 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1353 } 1395 }
1354 } 1396 }
1355 1397
1356 # free memory only needed for probing 1398 # free memory only needed for probing
1357 undef @models; 1399 undef @models;
1358 undef @REGISTRY; 1400 undef @REGISTRY;
1359 1401
1360 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1402 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1361 unshift @ISA, $MODEL;
1362 1403
1363 # now nuke some methods that are overridden by the backend. 1404 # now nuke some methods that are overridden by the backend.
1364 # SUPER usage is not allowed in these. 1405 # SUPER usage is not allowed in these.
1365 for (qw(time signal child idle)) { 1406 for (qw(time signal child idle)) {
1366 undef &{"AnyEvent::Base::$_"} 1407 undef &{"AnyEvent::Base::$_"}
1367 if defined &{"$MODEL\::$_"}; 1408 if defined &{"$MODEL\::$_"};
1368 } 1409 }
1369 1410
1411 _isa_set;
1412
1370 if ($ENV{PERL_ANYEVENT_STRICT}) { 1413 if ($ENV{PERL_ANYEVENT_STRICT}) {
1371 require AnyEvent::Strict; 1414 require AnyEvent::Strict;
1372 } 1415 }
1373 1416
1374 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) { 1417 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
… …
1378 1421
1379 if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) { 1422 if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1380 require AnyEvent::Socket; 1423 require AnyEvent::Socket;
1381 require AnyEvent::Debug; 1424 require AnyEvent::Debug;
1382 1425
1426 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1427 $shell =~ s/\$\$/$$/g;
1428
1383 my ($host, $service) = AnyEvent::Socket::parse_hostport ($ENV{PERL_ANYEVENT_DEBUG_SHELL}); 1429 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1384 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service); 1430 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1385 } 1431 }
1386 1432
1387 (shift @post_detect)->() while @post_detect; 1433 (shift @post_detect)->() while @post_detect;
1388 undef @post_detect; 1434 undef @post_detect;
… …
1477 sub time() { 1523 sub time() {
1478 AnyEvent->time 1524 AnyEvent->time
1479 } 1525 }
1480 1526
1481 *postpone = \&AnyEvent::postpone; 1527 *postpone = \&AnyEvent::postpone;
1528 *log = \&AnyEvent::log;
1482 }; 1529 };
1483 die if $@; 1530 die if $@;
1484} 1531}
1485 1532
1486BEGIN { _reset } 1533BEGIN { _reset }
… …
1491 1538
1492sub time { 1539sub time {
1493 eval q{ # poor man's autoloading {} 1540 eval q{ # poor man's autoloading {}
1494 # probe for availability of Time::HiRes 1541 # probe for availability of Time::HiRes
1495 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1542 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1496 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1543 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
1544 if $AnyEvent::VERBOSE >= 8;
1545 *time = sub { Time::HiRes::time () };
1497 *AE::time = \&Time::HiRes::time; 1546 *AE::time = \& Time::HiRes::time ;
1498 # if (eval "use POSIX (); (POSIX::times())... 1547 # if (eval "use POSIX (); (POSIX::times())...
1499 } else { 1548 } else {
1500 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1549 AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
1550 *time = sub { CORE::time };
1501 *AE::time = sub (){ time }; # epic fail 1551 *AE::time = sub (){ CORE::time };
1502 } 1552 }
1503 1553
1504 *time = sub { AE::time }; # different prototypes 1554 *now = \&time;
1505 }; 1555 };
1506 die if $@; 1556 die if $@;
1507 1557
1508 &time 1558 &time
1509} 1559}
1510 1560
1511*now = \&time; 1561*now = \&time;
1512
1513sub now_update { } 1562sub now_update { }
1514 1563
1515sub _poll { 1564sub _poll {
1516 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; 1565 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1517} 1566}
… …
1603 1652
1604sub signal { 1653sub signal {
1605 eval q{ # poor man's autoloading {} 1654 eval q{ # poor man's autoloading {}
1606 # probe for availability of Async::Interrupt 1655 # probe for availability of Async::Interrupt
1607 if (_have_async_interrupt) { 1656 if (_have_async_interrupt) {
1608 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1657 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
1658 if $AnyEvent::VERBOSE >= 8;
1609 1659
1610 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1660 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1611 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1661 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1612 1662
1613 } else { 1663 } else {
1614 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1664 AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
1665 if $AnyEvent::VERBOSE >= 8;
1615 1666
1616 if (AnyEvent::WIN32) { 1667 if (AnyEvent::WIN32) {
1617 require AnyEvent::Util; 1668 require AnyEvent::Util;
1618 1669
1619 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1670 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
… …
1928 1979
1929By default, AnyEvent will be completely silent except in fatal 1980By default, AnyEvent will be completely silent except in fatal
1930conditions. You can set this environment variable to make AnyEvent more 1981conditions. You can set this environment variable to make AnyEvent more
1931talkative. 1982talkative.
1932 1983
1933When set to C<1> or higher, causes AnyEvent to warn about unexpected 1984When set to C<5> or higher, causes AnyEvent to warn about unexpected
1934conditions, such as not being able to load the event model specified by 1985conditions, such as not being able to load the event model specified by
1935C<PERL_ANYEVENT_MODEL>. 1986C<PERL_ANYEVENT_MODEL>.
1936 1987
1937When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1988When set to C<7> or higher, cause AnyEvent to report to STDERR which event
1938model it chooses. 1989model it chooses.
1939 1990
1940When set to C<8> or higher, then AnyEvent will report extra information on 1991When set to C<8> or higher, then AnyEvent will report extra information on
1941which optional modules it loads and how it implements certain features. 1992which optional modules it loads and how it implements certain features.
1942 1993
… …
1955C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2006C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1956can be very useful, however. 2007can be very useful, however.
1957 2008
1958=item C<PERL_ANYEVENT_DEBUG_SHELL> 2009=item C<PERL_ANYEVENT_DEBUG_SHELL>
1959 2010
1960If this env variable is set, then its contents will be 2011If this env variable is set, then its contents will be interpreted by
1961interpreted by C<AnyEvent::Socket::parse_hostport> and an 2012C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
1962C<AnyEvent::Debug::shell> is bound on that port. The shell object is saved 2013C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
1963in C<$AnyEvent::Debug::SHELL>. 2014that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
2015
2016This takes place when the first watcher is created.
1964 2017
1965For example, to bind a debug shell on a unix domain socket in 2018For example, to bind a debug shell on a unix domain socket in
1966F</tmp/debug.sock>, you could use this: 2019F<< /tmp/debug<pid>.sock >>, you could use this:
1967 2020
1968 PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug.sock perlprog 2021 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2022
2023Note that creating sockets in F</tmp> is very unsafe on multiuser
2024systems.
1969 2025
1970=item C<PERL_ANYEVENT_DEBUG_WRAP> 2026=item C<PERL_ANYEVENT_DEBUG_WRAP>
1971 2027
1972Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for 2028Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
1973debugging purposes. See C<AnyEvent::Debug::wrap> for details. 2029debugging purposes. See C<AnyEvent::Debug::wrap> for details.
… …
2385(even when used without AnyEvent), but most event loops have acceptable 2441(even when used without AnyEvent), but most event loops have acceptable
2386performance with or without AnyEvent. 2442performance with or without AnyEvent.
2387 2443
2388=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2444=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2389the actual event loop, only with extremely fast event loops such as EV 2445the actual event loop, only with extremely fast event loops such as EV
2390adds AnyEvent significant overhead. 2446does AnyEvent add significant overhead.
2391 2447
2392=item * You should avoid POE like the plague if you want performance or 2448=item * You should avoid POE like the plague if you want performance or
2393reasonable memory usage. 2449reasonable memory usage.
2394 2450
2395=back 2451=back
… …
2770 2826
2771Tutorial/Introduction: L<AnyEvent::Intro>. 2827Tutorial/Introduction: L<AnyEvent::Intro>.
2772 2828
2773FAQ: L<AnyEvent::FAQ>. 2829FAQ: L<AnyEvent::FAQ>.
2774 2830
2775Utility functions: L<AnyEvent::Util>. 2831Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2832(simply logging).
2776 2833
2834Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2835L<AnyEvent::Debug> (interactive shell, watcher tracing).
2836
2777Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>, 2837Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2778L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2838L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2839L<Qt>, L<POE>, L<FLTK>.
2779 2840
2780Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2841Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2781L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2842L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2782L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2843L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2783L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 2844L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
2845L<AnyEvent::Impl::FLTK>.
2784 2846
2785Non-blocking file handles, sockets, TCP clients and 2847Non-blocking handles, pipes, stream sockets, TCP clients and
2786servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2848servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2787 2849
2788Asynchronous DNS: L<AnyEvent::DNS>. 2850Asynchronous DNS: L<AnyEvent::DNS>.
2789 2851
2790Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 2852Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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