[ViewVC] Diff of: cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.54 by root, Sun Oct 22 00:19:05 2006 UTC vs.
Revision 1.55 by root, Sun Oct 22 00:49:29 2006 UTC

 use strict 'vars';
 use base 'Exporter';
 BEGIN {
-   our $VERSION = '1.99';
+   our $VERSION = '2.0';
    our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
                     aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
                     aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move
                     aio_group);
 syscall has been executed asynchronously.
 All functions expecting a filehandle keep a copy of the filehandle
 internally until the request has finished.
-All non-composite requests (requests that are not broken down into
-multiple requests) return objects of type L<IO::AIO::REQ> that allow
+All requests return objects of type L<IO::AIO::REQ> that allow further
-further manipulation of running requests.
+manipulation of those requests while they are in-flight.
 The pathnames you pass to these routines I<must> be absolute and
 encoded in byte form. The reason for the former is that at the time the
 request is being executed, the current working directory could have
 changed. Alternatively, you can make sure that you never change the
 =cut
 sub aio_move($$$) {
    my ($src, $dst, $cb) = @_;
+   my $grp = aio_group;
-   aio_rename $src, $dst, sub {
+   add $grp aio_rename $src, $dst, sub {
       if ($_[0] && $! == EXDEV) {
-         aio_open $src, O_RDONLY, 0, sub {
+         add $grp aio_open $src, O_RDONLY, 0, sub {
             if (my $src_fh = $_[0]) {
                my @stat = stat $src_fh;
-               aio_open $dst, O_WRONLY, 0200, sub {
+               add $grp aio_open $dst, O_WRONLY, 0200, sub {
                   if (my $dst_fh = $_[0]) {
-                     aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
+                     add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
                         close $src_fh;
                         if ($_[0] == $stat[7]) {
                            utime $stat[8], $stat[9], $dst;
                            chmod $stat[2] & 07777, $dst_fh;
                            chown $stat[4], $stat[5], $dst_fh;
                            close $dst_fh;
-                           aio_unlink $src, sub {
+                           add $grp aio_unlink $src, sub {
                               $cb->($_[0]);
                            };
                         } else {
                            my $errno = $!;
-                           aio_unlink $dst, sub {
+                           add $grp aio_unlink $dst, sub {
                               $! = $errno;
                               $cb->(-1);
                            };
                         }
                      };
          };
       } else {
          $cb->($_[0]);
       }
    };
+   $grp
 }
 =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
 Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
 =cut
 sub aio_scandir($$$) {
    my ($path, $maxreq, $cb) = @_;
+   my $grp = aio_group;
    $maxreq = 8 if $maxreq <= 0;
    # stat once
-   aio_stat $path, sub {
+   add $grp aio_stat $path, sub {
       return $cb->() if $_[0];
       my $now = time;
       my $hash1 = join ":", (stat _)[0,1,3,7,9];
       # read the directory entries
-      aio_readdir $path, sub {
+      add $grp aio_readdir $path, sub {
          my $entries = shift
             or return $cb->();
          # stat the dir another time
-         aio_stat $path, sub {
+         add $grp aio_stat $path, sub {
             my $hash2 = join ":", (stat _)[0,1,3,7,9];
             my $ndirs;
             # take the slow route if anything looks fishy
             $schedcb = sub {
                if (@$entries) {
                   if ($nreq < $maxreq) {
                      my $ent = pop @$entries;
                      $nreq++;
-                     aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
+                     add $grp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
                   }
                } elsif (!$nreq) {
                   # finished
                   undef $statcb;
                   undef $schedcb;
                   $nreq--;
                   push @nondirs, $entry;
                   &$schedcb;
                } else {
                   # need to check for real directory
-                  aio_lstat "$path/$entry", sub {
+                  add $grp aio_lstat "$path/$entry", sub {
                      $nreq--;
                      if (-d _) {
                         push @dirs, $entry;
             &$schedcb while @$entries && $nreq < $maxreq;
          };
       };
    };
+   $grp
 }
 =item aio_fsync $fh, $callback->($status)
 Asynchronously call fsync on the given filehandle and call the callback
 If this call isn't available because your OS lacks it or it couldn't be
 detected, it will be emulated by calling C<fsync> instead.
 =item aio_group $callback->()
+[EXPERIMENTAL]
+This is a very special aio request: Instead of doing something, it is a
+container for other aio requests, which is useful if you want to bundle
+many requests into a single, composite, request.
+Returns an object of class L<IO::AIO::GRP>. See its documentation below
+for more info.
+Example:
+   my $grp = aio_group sub {
+      print "all stats done\n";
+   };
+   add $grp
+      (aio_stat ...),
+      (aio_stat ...),
+      ...;
 =item aio_sleep $fractional_seconds, $callback->()  *NOT EXPORTED*
 Mainly used for debugging and benchmarking, this aio request puts one of
 the request workers to sleep for the given time.
 untouched. That means that requests that currently execute will not be
 stopped and resources held by the request will not be freed prematurely.
 =back
+=head2 IO::AIO::GRP CLASS
+This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to
+objects of this class, too.
+A IO::AIO::GRP object is a special request that can contain multiple other
+aio requests.
+You create one by calling the C<aio_group> constructing function with a
+callback that will be called when all contained requests have entered the
+C<done> state:
+   my $grp = aio_group sub {
+      print "all requests are done\n";
+   };
+You add requests by calling the C<add> method with one or more
+C<IO::AIO::REQ> objects:
+   $grp->add (aio_unlink "...");
+   add $grp aio_stat "...", sub { ... };
+This makes it very easy to create composite requests (see the source of
+C<aio_move> for an application) that work and feel like simple requests.
+The IO::AIO::GRP objects will be cleaned up during calls to
+C<IO::AIO::poll_cb>, just like any other request.
+They can be canceled like any other request. Canceling will cancel not
+just the request itself, but also all requests it contains.
+They can also can also be added to other IO::AIO::GRP objects.
+Their lifetime, simplified, looks like this: when they are empty, they
+will finish very quickly. If they contain only requests that are in the
+C<done> state, they will also finish. Otherwise they will continue to
+exist.
+=over 4
+=item $grp->add (...)
+=item add $grp ...
+Add one or more
+Cancels the request, if possible. Has the effect of skipping execution
+when entering the B<execute> state and skipping calling the callback when
+entering the the B<result> state, but will leave the request otherwise
+untouched. That means that requests that currently execute will not be
+stopped and resources held by the request will not be freed prematurely.
+=back
 =head2 SUPPORT FUNCTIONS
 =over 4
 =item $fileno = IO::AIO::poll_fileno

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.54 by root, Sun Oct 22 00:19:05 2006 UTC vs. Revision 1.55 by root, Sun Oct 22 00:49:29 2006 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.54 by root, Sun Oct 22 00:19:05 2006 UTC vs.
Revision 1.55 by root, Sun Oct 22 00:49:29 2006 UTC