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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.155 by root, Fri Jun 6 07:07:01 2008 UTC vs.
Revision 1.167 by root, Tue Jul 8 23:44:51 2008 UTC

 =head2 I/O WATCHERS
 You can create an I/O watcher by calling the C<< AnyEvent->io >> method
 with the following mandatory key-value pairs as arguments:
-C<fh> the Perl I<file handle> (I<not> file descriptor) to watch
+C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events
-for events. C<poll> must be a string that is either C<r> or C<w>,
+(AnyEvent might or might not keep a reference to this file handle). C<poll>
-which creates a watcher waiting for "r"eadable or "w"ritable events,
+must be a string that is either C<r> or C<w>, which creates a watcher
-respectively. C<cb> is the callback to invoke each time the file handle
+waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the
-becomes ready.
+callback to invoke each time the file handle becomes ready.
 Although the callback might get passed parameters, their value and
 presence is undefined and you cannot rely on them. Portable AnyEvent
 callbacks cannot use arguments passed to I/O watcher callbacks.
 Some event loops issue spurious readyness notifications, so you should
 always use non-blocking calls when reading/writing from/to your file
 handles.
-Example:
-   # wait for readability of STDIN, then read a line and disable the watcher
+Example: wait for readability of STDIN, then read a line and disable the
+watcher.
    my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
       chomp (my $input = <STDIN>);
       warn "read: $input\n";
       undef $w;
    });
 Although the callback might get passed parameters, their value and
 presence is undefined and you cannot rely on them. Portable AnyEvent
 callbacks cannot use arguments passed to time watcher callbacks.
-The timer callback will be invoked at most once: if you want a repeating
+The callback will normally be invoked once only. If you specify another
-timer you have to create a new watcher (this is a limitation by both Tk
+parameter, C<interval>, as a strictly positive number (> 0), then the
-and Glib).
+callback will be invoked regularly at that interval (in fractional
+seconds) after the first invocation. If C<interval> is specified with a
+false value, then it is treated as if it were missing.
-Example:
+The callback will be rescheduled before invoking the callback, but no
+attempt is done to avoid timer drift in most backends, so the interval is
+only approximate.
-   # fire an event after 7.7 seconds
+Example: fire an event after 7.7 seconds.
    my $w = AnyEvent->timer (after => 7.7, cb => sub {
       warn "timeout\n";
    });
    # to cancel the timer:
    undef $w;
-Example 2:
-   # fire an event after 0.5 seconds, then roughly every second
+Example 2: fire an event after 0.5 seconds, then roughly every second.
-   my $w;
-   my $cb = sub {
-      # cancel the old timer while creating a new one
-      $w = AnyEvent->timer (after => 1, cb => $cb);
+   my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
+      warn "timeout\n";
    };
-   # start the "loop" by creating the first watcher
-   $w = AnyEvent->timer (after => 0.5, cb => $cb);
 =head3 TIMING ISSUES
 There are two ways to handle timers: based on real time (relative, "fire
 in 10 seconds") and based on wallclock time (absolute, "fire at 12
 =back
 =head2 SIGNAL WATCHERS
 You can watch for signals using a signal watcher, C<signal> is the signal
-I<name> without any C<SIG> prefix, C<cb> is the Perl callback to
+I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
-be invoked whenever a signal occurs.
+callback to be invoked whenever a signal occurs.
 Although the callback might get passed parameters, their value and
 presence is undefined and you cannot rely on them. Portable AnyEvent
 callbacks cannot use arguments passed to signal watcher callbacks.
 =item L<AnyEvent::Util>
 Contains various utility functions that replace often-used but blocking
 functions such as C<inet_aton> by event-/callback-based versions.
-=item L<AnyEvent::Handle>
-Provide read and write buffers and manages watchers for reads and writes.
 =item L<AnyEvent::Socket>
 Provides various utility functions for (internet protocol) sockets,
 addresses and name resolution. Also functions to create non-blocking tcp
 connections or tcp servers, with IPv6 and SRV record support and more.
+=item L<AnyEvent::Handle>
+Provide read and write buffers, manages watchers for reads and writes,
+supports raw and formatted I/O, I/O queued and fully transparent and
+non-blocking SSL/TLS.
 =item L<AnyEvent::DNS>
 Provides rich asynchronous DNS resolver capabilities.
 =item L<AnyEvent::HTTP>
 =item L<AnyEvent::FastPing>
 The fastest ping in the west.
+=item L<AnyEvent::DBI>
+Executes L<DBI> requests asynchronously in a proxy process.
+=item L<AnyEvent::AIO>
+Truly asynchronous I/O, should be in the toolbox of every event
+programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
+together.
+=item L<AnyEvent::BDB>
+Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
+L<BDB> and AnyEvent together.
+=item L<AnyEvent::GPSD>
+A non-blocking interface to gpsd, a daemon delivering GPS information.
+=item L<AnyEvent::IGS>
+A non-blocking interface to the Internet Go Server protocol (used by
+L<App::IGS>).
 =item L<Net::IRC3>
 AnyEvent based IRC client module family.
 =item L<Net::XMPP2>
 =item L<Coro>
 Has special support for AnyEvent via L<Coro::AnyEvent>.
-=item L<AnyEvent::AIO>, L<IO::AIO>
-Truly asynchronous I/O, should be in the toolbox of every event
-programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
-together.
-=item L<AnyEvent::BDB>, L<BDB>
-Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
-IO::AIO and AnyEvent together.
 =item L<IO::Lambda>
 The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
 =back
 no warnings;
 use strict;
 use Carp;
-our $VERSION = 4.14;
+our $VERSION = 4.2;
 our $MODEL;
 our $AUTOLOAD;
 our @ISA;
             $MODEL
               or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
          }
       }
-      unshift @ISA, $MODEL;
       push @{"$MODEL\::ISA"}, "AnyEvent::Base";
+      if ($ENV{PERL_ANYEVENT_STRICT}) {
+         unshift @AnyEvent::Base::Strict::ISA, $MODEL;
+         unshift @ISA, AnyEvent::Base::Strict::
+      } else {
+         unshift @ISA, $MODEL;
+      }
       (shift @post_detect)->() while @post_detect;
    }
    $MODEL
 sub AnyEvent::Base::Signal::DESTROY {
    my ($signal, $cb) = @{$_[0]};
    delete $SIG_CB{$signal}{$cb};
-   $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };
+   delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
 }
 # default implementation for ->child
 our %PID_CB;
 # undocumented/compatibility with pre-3.4
 *broadcast = \&send;
 *wait      = \&_wait;
+package AnyEvent::Base::Strict;
+use Carp qw(croak);
+# supply checks for argument validity for many functions
+sub io {
+   my $class = shift;
+   my %arg = @_;
+   ref $arg{cb}
+      or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'";
+   delete $arg{cb};
+   fileno $arg{fh}
+      or croak "AnyEvent->io called with illegal fh argument '$arg{fh}'";
+   delete $arg{fh};
+   $arg{poll} =~ /^[rw]$/
+      or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'";
+   delete $arg{poll};
+   croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg
+      if keys %arg;
+   $class->SUPER::io (@_)
+}
+sub timer {
+   my $class = shift;
+   my %arg = @_;
+   ref $arg{cb}
+      or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'";
+   delete $arg{cb};
+   exists $arg{after}
+      or croak "AnyEvent->timer called without mandatory 'after' parameter";
+   delete $arg{after};
+   $arg{interval} > 0 || !$arg{interval}
+      or croak "AnyEvent->timer called with illegal interval argument '$arg{interval}'";
+   delete $arg{interval};
+   croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg
+      if keys %arg;
+   $class->SUPER::timer (@_)
+}
+sub signal {
+   my $class = shift;
+   my %arg = @_;
+   ref $arg{cb}
+      or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
+   delete $arg{cb};
+   eval "require POSIX; defined &POSIX::SIG$arg{signal}"
+      or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'";
+   delete $arg{signal};
+   croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
+      if keys %arg;
+   $class->SUPER::signal (@_)
+}
+sub child {
+   my $class = shift;
+   my %arg = @_;
+   ref $arg{cb}
+      or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
+   delete $arg{cb};
+   $arg{pid} =~ /^-?\d+$/
+      or croak "AnyEvent->signal called with illegal pid value '$arg{pid}'";
+   delete $arg{pid};
+   croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
+      if keys %arg;
+   $class->SUPER::child (@_)
+}
+sub condvar {
+   my $class = shift;
+   my %arg = @_;
+   !exists $arg{cb} or ref $arg{cb}
+      or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'";
+   delete $arg{cb};
+   croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg
+      if keys %arg;
+   $class->SUPER::condvar (@_)
+}
+sub time {
+   my $class = shift;
+   @_
+      and croak "AnyEvent->time wrongly called with paramaters";
+   $class->SUPER::time (@_)
+}
+sub now {
+   my $class = shift;
+   @_
+      and croak "AnyEvent->now wrongly called with paramaters";
+   $class->SUPER::now (@_)
+}
 =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
 This is an advanced topic that you do not normally need to use AnyEvent in
 a module. This section is only of use to event loop authors who want to
 provide AnyEvent compatibility.
 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
 model it chooses.
+=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
+will cause AnyEvent to thoroughly check the arguments passed to most
+method calls and croaks if it finds any problems. In other words, enables
+"strict" mode.  Unlike C<use strict> it is definitely recommended ot keep
+it off in production.
 =item C<PERL_ANYEVENT_MODEL>
 This can be used to specify the event model to be used by AnyEvent, before
 auto detection and -probing kicks in. It must be a string consisting
    use AnyEvent;
 Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
 be used to probe what backend is used and gain other information (which is
-probably even less useful to an attacker than PERL_ANYEVENT_MODEL).
+probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
+$ENV{PERL_ANYEGENT_STRICT}.
+=head1 BUGS
+Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
+to work around. If you suffer from memleaks, first upgrade to Perl 5.10
+and check wether the leaks still show up. (Perl 5.10.0 has other annoying
+mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
+pronounced).
 =head1 SEE ALSO
 Utility functions: L<AnyEvent::Util>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.155 by root, Fri Jun 6 07:07:01 2008 UTC vs. Revision 1.167 by root, Tue Jul 8 23:44:51 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.155 by root, Fri Jun 6 07:07:01 2008 UTC vs.
Revision 1.167 by root, Tue Jul 8 23:44:51 2008 UTC