[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.358 by root, Sat Aug 13 02:35:32 2011 UTC vs.
Revision 1.371 by root, Wed Aug 24 23:59:10 2011 UTC

 =head1 NAME
 AnyEvent - the DBI of event loop programming
-EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
+EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
-and POE are various supported event loops/environments.
+FLTK and POE are various supported event loops/environments.
 =head1 SYNOPSIS
    use AnyEvent;
 Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
 if necessary. You should only call this function right before you would
 have created an AnyEvent watcher anyway, that is, as late as possible at
 runtime, and not e.g. during initialisation of your module.
+The effect of calling this function is as if a watcher had been created
+(specifically, actions that happen "when the first watcher is created"
+happen when calling detetc as well).
 If you need to do some initialisation before AnyEvent watchers are
 created, use C<post_detect>.
 =item $guard = AnyEvent::post_detect { BLOCK }
 It should use C<postpone>:
    AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
       if $some_error_condition;
+=item AnyEvent::log $level, $msg[, @args]
+Log the given C<$msg> at the given C<$level>.
+Loads AnyEvent::Log on first use and calls C<AnyEvent::Log::log> -
+consequently, look at the L<AnyEvent::Log> documentation for details.
+If you want to sprinkle loads of logging calls around your code, consider
+creating a logger callback with the C<AnyEvent::Log::logger> function.
 =back
 =head1 WHAT TO DO IN A MODULE
 As a module author, you should C<use AnyEvent> and call AnyEvent methods
 =head1 OTHER MODULES
 The following is a non-exhaustive list of additional modules that use
-AnyEvent as a client and can therefore be mixed easily with other AnyEvent
+AnyEvent as a client and can therefore be mixed easily with other
-modules and other event loops in the same program. Some of the modules
+AnyEvent modules and other event loops in the same program. Some of the
-come as part of AnyEvent, the others are available via CPAN.
+modules come as part of AnyEvent, the others are available via CPAN (see
+L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
+a longer non-exhaustive list), and the list is heavily biased towards
+modules of the AnyEvent author himself :)
 =over 4
 =item L<AnyEvent::Util>
 BEGIN { AnyEvent::common_sense }
 use Carp ();
-our $VERSION = '5.34';
+our $VERSION = '6.01';
 our $MODEL;
 our @ISA;
 our @REGISTRY;
    eval "sub TAINT (){" . (${^TAINT}*1) . "}";
    delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
       if ${^TAINT};
+   $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
+      for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
+   @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
+      if ${^TAINT};
    $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
 }
 our $MAX_SIGNAL_LATENCY = 10;
 our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
    push @POSTPONE, shift;
    $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
    ()
+}
+sub log($$;@) {
+   require AnyEvent::Log;
+   # AnyEvent::Log overwrites this function
+   goto &log;
 }
 our @models = (
    [EV::                   => AnyEvent::Impl::EV::   , 1],
    [AnyEvent::Loop::       => AnyEvent::Impl::Perl:: , 1],
    [IO::Async::Loop::      => AnyEvent::Impl::IOAsync::],  # a bitch to autodetect
    [Cocoa::EventLoop::     => AnyEvent::Impl::Cocoa::],
    [FLTK::                 => AnyEvent::Impl::FLTK2::],
 );
+our @isa_hook;
+sub _isa_set {
+   my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
+   @{"$pkg[$_-1]::ISA"} = $pkg[$_]
+      for 1 .. $#pkg;
+   grep $_ && $_->[1], @isa_hook
+      and AE::_reset ();
+}
+# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
+sub _isa_hook($$;$) {
+   my ($i, $pkg, $reset_ae) = @_;
+   $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
+   _isa_set;
+}
 # all autoloaded methods reserve the complete glob, not just the method slot.
 # due to bugs in perls method cache implementation.
 our @methods = qw(io timer time now now_update signal child idle condvar);
 sub detect() {
+   return $MODEL if $MODEL; # some programs keep references to detect
    local $!; # for good measure
    local $SIG{__DIE__}; # we use eval
    # free some memory
    *detect = sub () { $MODEL };
    if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
       my $model = $1;
       $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
       if (eval "require $model") {
          $MODEL = $model;
-         warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
+         AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it."
+            if $VERBOSE >= 7;
       } else {
-         warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
+         AnyEvent::log warn => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
       }
    }
    # check for already loaded models
    unless ($MODEL) {
       for (@REGISTRY, @models) {
          my ($package, $model) = @$_;
          if (${"$package\::VERSION"} > 0) {
             if (eval "require $model") {
                $MODEL = $model;
-               warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
+               AnyEvent::log 7 => "autodetected model '$model', using it."
+                  if $VERBOSE >= 7;
                last;
             }
          }
       }
                and eval "require $package"
                and ${"$package\::VERSION"} > 0
                and eval "require $model"
             ) {
                $MODEL = $model;
-               warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
+               AnyEvent::log 7 => "autoloaded model '$model', using it."
+                  if $VERBOSE >= 7;
                last;
             }
          }
          $MODEL
-           or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n";
+           or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
       }
    }
    # free memory only needed for probing
    undef @models;
    undef @REGISTRY;
    push @{"$MODEL\::ISA"}, "AnyEvent::Base";
-   unshift @ISA, $MODEL;
    # now nuke some methods that are overridden by the backend.
    # SUPER usage is not allowed in these.
    for (qw(time signal child idle)) {
       undef &{"AnyEvent::Base::$_"}
          if defined &{"$MODEL\::$_"};
    }
+   _isa_set;
+   # we're officially open!
+   if (length $ENV{PERL_ANYEVENT_LOG}) {
+      require AnyEvent::Log; # AnyEvent::Log does the thing for us
+   }
    if ($ENV{PERL_ANYEVENT_STRICT}) {
       require AnyEvent::Strict;
    }
    if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
       require AnyEvent::Debug;
       AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
    }
-   if (exists $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
+   if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
       require AnyEvent::Socket;
       require AnyEvent::Debug;
+      my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
+      $shell =~ s/\$\$/$$/g;
-      my ($host, $service) = AnyEvent::Socket::parse_hostport ($ENV{PERL_ANYEVENT_DEBUG_SHELL});
+      my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
       $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
    }
+   # now the anyevent environment is set up as the user told us to, so
+   # call the actual user code - post detects
    (shift @post_detect)->() while @post_detect;
    undef @post_detect;
    *post_detect = sub(&) {
       sub time() {
          AnyEvent->time
       }
       *postpone = \&AnyEvent::postpone;
+      *log      = \&AnyEvent::log;
    };
    die if $@;
 }
 BEGIN { _reset }
 sub time {
    eval q{ # poor man's autoloading {}
       # probe for availability of Time::HiRes
       if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
-         warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
+         AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy."
+            if $AnyEvent::VERBOSE >= 8;
+         *time     = sub { Time::HiRes::time () };
-         *AE::time = \&Time::HiRes::time;
+         *AE::time = \&    Time::HiRes::time     ;
          # if (eval "use POSIX (); (POSIX::times())...
       } else {
-         warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
+         AnyEvent::log critical => "using built-in time(), WARNING, no sub-second resolution!";
+         *time     = sub   { CORE::time };
-         *AE::time = sub (){ time }; # epic fail
+         *AE::time = sub (){ CORE::time };
       }
-      *time = sub { AE::time }; # different prototypes
+      *now = \&time;
    };
    die if $@;
    &time
 }
 *now = \&time;
 sub now_update { }
 sub _poll {
    Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
 }
 sub signal {
    eval q{ # poor man's autoloading {}
       # probe for availability of Async::Interrupt
       if (_have_async_interrupt) {
-         warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
+         AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling."
+            if $AnyEvent::VERBOSE >= 8;
          $SIGPIPE_R = new Async::Interrupt::EventPipe;
          $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
       } else {
-         warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
+         AnyEvent::log 8 => "using emulated perl signal handling with latency timer."
+            if $AnyEvent::VERBOSE >= 8;
          if (AnyEvent::WIN32) {
             require AnyEvent::Util;
             ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
 $Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
 so on.
 =head1 ENVIRONMENT VARIABLES
-The following environment variables are used by this module or its
+AnyEvent supports a number of environment variables that tune the
-submodules.
+runtime behaviour. They are usually evaluated when AnyEvent is
+loaded, initialised, or a submodule that uses them is loaded. Many of
+them also cause AnyEvent to load additional modules - for example,
+C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
+loaded.
-Note that AnyEvent will remove I<all> environment variables starting with
+All the environment variables documented here start with
-C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
+C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
-enabled.
+namespace. Other modules are encouraged (but by no means required) to use
+C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
+namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
+be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
+variables starting with C<AE_>, see below).
+All variables can also be set via the C<AE_> prefix, that is, instead
+of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
+case there is a clash btween anyevent and another program that uses
+C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
+variable to the empty string, as those variables take precedence.
+When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
+to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
+exists. If taint mode is on, then AnyEvent will remove I<all> environment
+variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
+with C<undef> or the empty string, if the corresaponding C<AE_> variable
+is set).
+The exact algorithm is currently:
+   1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
+   2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
+   3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
+This ensures that child processes will not see the C<AE_> variables.
+The following environment variables are currently known to AnyEvent:
 =over 4
 =item C<PERL_ANYEVENT_VERBOSE>
 By default, AnyEvent will be completely silent except in fatal
 conditions. You can set this environment variable to make AnyEvent more
-talkative.
+talkative. If you want to do more than just set the global logging level
+you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
+complex specifications.
-When set to C<1> or higher, causes AnyEvent to warn about unexpected
+When set to C<5> or higher, causes AnyEvent to warn about unexpected
 conditions, such as not being able to load the event model specified by
 C<PERL_ANYEVENT_MODEL>.
-When set to C<2> or higher, cause AnyEvent to report to STDERR which event
+When set to C<7> or higher, cause AnyEvent to report to STDERR which event
 model it chooses.
 When set to C<8> or higher, then AnyEvent will report extra information on
 which optional modules it loads and how it implements certain features.
+=item C<PERL_ANYEVENT_LOG>
+Accepts rather complex logging specifications. For example, you could log
+all C<debug> messages of some module to stderr, warnings and above to
+stderr, and errors and above to syslog, with:
+   PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
+For the rather extensive details, see L<AnyEvent::Log>.
+Note that specifying this environment variable causes the L<AnyEvent::Log>
+module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
+using the latter saves a few hundred kB of memory until the first message
+is being logged.
 =item C<PERL_ANYEVENT_STRICT>
 AnyEvent does not do much argument checking by default, as thorough
 argument checking is very costly. Setting this variable to a true value
 C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
 can be very useful, however.
 =item C<PERL_ANYEVENT_DEBUG_SHELL>
-If this env variable is set, then its contents will be
+If this env variable is set, then its contents will be interpreted by
-interpreted by C<AnyEvent::Socket::parse_hostport> and an
+C<AnyEvent::Socket::parse_hostport> (after replacing every occurance of
-C<AnyEvent::Debug::shell> is bound on that port. The shell object is saved
+C<$$> by the process pid) and an C<AnyEvent::Debug::shell> is bound on
-in C<$AnyEvent::Debug::SHELL>.
+that port. The shell object is saved in C<$AnyEvent::Debug::SHELL>.
+This takes place when the first watcher is created.
 For example, to bind a debug shell on a unix domain socket in
-F</tmp/debug.sock>, you could use this:
+F<< /tmp/debug<pid>.sock >>, you could use this:
-   PERL_ANYEVENT_DEBUG_SHELL=unix/:/tmp/debug.sock perlprog
+   PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
+Note that creating sockets in F</tmp> is very unsafe on multiuser
+systems.
 =item C<PERL_ANYEVENT_DEBUG_WRAP>
 Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
 debugging purposes. See C<AnyEvent::Debug::wrap> for details.
 addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
 IPv6, but prefer IPv6 over IPv4.
 =item C<PERL_ANYEVENT_EDNS0>
-Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
+Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
-for DNS. This extension is generally useful to reduce DNS traffic, but
+DNS. This extension is generally useful to reduce DNS traffic, especially
-some (broken) firewalls drop such DNS packets, which is why it is off by
+when DNSSEC is involved, but some (broken) firewalls drop such DNS
-default.
+packets, which is why it is off by default.
 Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
 EDNS0 in its DNS requests.
 =item C<PERL_ANYEVENT_MAX_FORKS>
 resolver - this is the maximum number of parallel DNS requests that are
 sent to the DNS server.
 =item C<PERL_ANYEVENT_RESOLV_CONF>
-The file to use instead of F</etc/resolv.conf> (or OS-specific
+The absolute path to a F<resolv.conf>-style file to use instead of
-configuration) in the default resolver. When set to the empty string, no
+F</etc/resolv.conf> (or the OS-specific configuration) in the default
-default config will be used.
+resolver, or the empty string to select the default configuration.
 =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
 When neither C<ca_file> nor C<ca_path> was specified during
 L<AnyEvent::TLS> context creation, and either of these environment
-variables exist, they will be used to specify CA certificate locations
+variables are nonempty, they will be used to specify CA certificate
-instead of a system-dependent default.
+locations instead of a system-dependent default.
 =item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
 When these are set to C<1>, then the respective modules are not
 loaded. Mostly good for testing AnyEvent itself.
 (even when used without AnyEvent), but most event loops have acceptable
 performance with or without AnyEvent.
 =item * The overhead AnyEvent adds is usually much smaller than the overhead of
 the actual event loop, only with extremely fast event loops such as EV
-adds AnyEvent significant overhead.
+does AnyEvent add significant overhead.
 =item * You should avoid POE like the plague if you want performance or
 reasonable memory usage.
 =back
 Tutorial/Introduction: L<AnyEvent::Intro>.
 FAQ: L<AnyEvent::FAQ>.
-Utility functions: L<AnyEvent::Util>.
+Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
+(simply logging).
+Development/Debugging: L<AnyEvent::Strict> (stricter checking),
+L<AnyEvent::Debug> (interactive shell, watcher tracing).
-Event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>, L<Glib::EV>,
+Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
-L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
+L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
+L<Qt>, L<POE>, L<FLTK>.
 Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
 L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
 L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
-L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
+L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
+L<AnyEvent::Impl::FLTK>.
-Non-blocking file handles, sockets, TCP clients and
+Non-blocking handles, pipes, stream sockets, TCP clients and
 servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
 Asynchronous DNS: L<AnyEvent::DNS>.
 Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.358 by root, Sat Aug 13 02:35:32 2011 UTC vs. Revision 1.371 by root, Wed Aug 24 23:59:10 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.358 by root, Sat Aug 13 02:35:32 2011 UTC vs.
Revision 1.371 by root, Wed Aug 24 23:59:10 2011 UTC