[ViewVC] Diff of: cvs/IO-AIO/README

Comparing IO-AIO/README (file contents):
Revision 1.29 by root, Wed Apr 16 16:45:30 2008 UTC vs.
Revision 1.35 by root, Tue Apr 21 20:06:05 2009 UTC

      $req->cancel; # cancel request if still in queue
      my $grp = aio_group sub { print "all stats done\n" };
      add $grp aio_stat "..." for ...;
-     # AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...)
+     # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
-     open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
+     use AnyEvent::AIO;
-     my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
      # EV integration
      my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
      # Event integration
     All the "aio_*" calls are more or less thin wrappers around the syscall
     with the same name (sans "aio_"). The arguments are similar or
     identical, and they all accept an additional (and optional) $callback
     argument which must be a code reference. This code reference will get
     called with the syscall return code (e.g. most syscalls return -1 on
-    error, unlike perl, which usually delivers "false") as it's sole
+    error, unlike perl, which usually delivers "false") as its sole argument
-    argument when the given syscall has been executed asynchronously.
+    after the given syscall has been executed asynchronously.
     All functions expecting a filehandle keep a copy of the filehandle
     internally until the request has finished.
     All functions return request objects of type IO::AIO::REQ that allow
     the user environment, d) use Glib::filename_from_unicode on unicode
     filenames or e) use something else to ensure your scalar has the correct
     contents.
     This works, btw. independent of the internal UTF-8 bit, which IO::AIO
-    handles correctly wether it is set or not.
+    handles correctly whether it is set or not.
     $prev_pri = aioreq_pri [$pri]
         Returns the priority value that would be used for the next request
         and, if $pri is given, sets the priority for the next aio request.
         Or in other words: the file descriptor will be closed, but it will
         not be free for reuse until the perl filehandle is closed.
     aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
     aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
-        Reads or writes $length bytes from the specified $fh and $offset
+        Reads or writes $length bytes from or to the specified $fh and
-        into the scalar given by $data and offset $dataoffset and calls the
+        $offset into the scalar given by $data and offset $dataoffset and
-        callback without the actual number of bytes read (or -1 on error,
+        calls the callback without the actual number of bytes read (or -1 on
-        just like the syscall).
+        error, just like the syscall).
+        "aio_read" will, like "sysread", shrink or grow the $data scalar to
+        offset plus the actual number of bytes read.
         If $offset is undefined, then the current file descriptor offset
         will be used (and updated), otherwise the file descriptor offset
         will not be changed by these calls.
     aio_copy $srcpath, $dstpath, $callback->($status)
         Try to copy the *file* (directories not supported as either source
         or destination) from $srcpath to $dstpath and call the callback with
         the 0 (error) or -1 ok.
-        This is a composite request that it creates the destination file
+        This is a composite request that creates the destination file with
-        with mode 0200 and copies the contents of the source file into it
+        mode 0200 and copies the contents of the source file into it using
-        using "aio_sendfile", followed by restoring atime, mtime, access
+        "aio_sendfile", followed by restoring atime, mtime, access mode and
-        mode and uid/gid, in that order.
+        uid/gid, in that order.
         If an error occurs, the partial destination file will be unlinked,
         if possible, except when setting atime, mtime, access mode and
         uid/gid, where errors are being ignored.
     aio_move $srcpath, $dstpath, $callback->($status)
         Try to move the *file* (directories not supported as either source
         or destination) from $srcpath to $dstpath and call the callback with
         the 0 (error) or -1 ok.
-        This is a composite request that tries to rename(2) the file first.
+        This is a composite request that tries to rename(2) the file first;
-        If rename files with "EXDEV", it copies the file with "aio_copy"
+        if rename fails with "EXDEV", it copies the file with "aio_copy"
-        and, if that is successful, unlinking the $srcpath.
+        and, if that is successful, unlinks the $srcpath.
     aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
         Scans a directory (similar to "aio_readdir") but additionally tries
         to efficiently separate the entries of directory $path into two sets
         of names, directories you can recurse into (directories), and ones
         callback with the fdatasync result code.
         If this call isn't available because your OS lacks it or it couldn't
         be detected, it will be emulated by calling "fsync" instead.
+    aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
+        Sync the data portion of the file specified by $offset and $length
+        to disk (but NOT the metadata), by calling the Linux-specific
+        sync_file_range call. If sync_file_range is not available or it
+        returns ENOSYS, then fdatasync or fsync is being substituted.
+        $flags can be a combination of
+        "IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE",
+        "IO::AIO::SYNC_FILE_RANGE_WRITE" and
+        "IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER": refer to the sync_file_range
+        manpage for details.
     aio_pathsync $path, $callback->($status)
         This request tries to open, fsync and close the given path. This is
-        a composite request intended tosync directories after directory
+        a composite request intended to sync directories after directory
         operations (E.g. rename). This might not work on all operating
         systems or have any specific effect, but usually it makes sure that
         directory changes get written to disc. It works for anything that
         can be opened for read-only, not just directories.
     Their lifetime, simplified, looks like this: when they are empty, they
     will finish very quickly. If they contain only requests that are in the
     "done" state, they will also finish. Otherwise they will continue to
     exist.
-    That means after creating a group you have some time to add requests.
+    That means after creating a group you have some time to add requests
-    And in the callbacks of those requests, you can add further requests to
+    (precisely before the callback has been invoked, which is only done
-    the group. And only when all those requests have finished will the the
+    within the "poll_cb"). And in the callbacks of those requests, you can
-    group itself finish.
+    add further requests to the group. And only when all those requests have
+    finished will the the group itself finish.
     add $grp ...
     $grp->add (...)
         Add one or more requests to the group. Any type of IO::AIO::REQ can
         be added, including other groups, as long as you do not create
         does not impose any limits).
         If the feed does not queue more requests when called, it will be
         automatically removed from the group.
-        If the feed limit is 0, it will be set to 2 automatically.
+        If the feed limit is 0 when this method is called, it will be set to
+        2 automatically.
         Example:
            # stat all files in @files, but only ever use four aio requests concurrently:
     limit $grp $num
         Sets the feeder limit for the group: The feeder will be called
         whenever the group contains less than this many requests.
         Setting the limit to 0 will pause the feeding process.
+        The default value for the limit is 0, but note that setting a feeder
+        automatically bumps it up to 2.
   SUPPORT FUNCTIONS
    EVENT PROCESSING AND EVENT LOOP INTEGRATION
     $fileno = IO::AIO::poll_fileno
         Return the *request result pipe file descriptor*. This filehandle
         See "poll_cb" for an example.
     IO::AIO::poll_cb
         Process some outstanding events on the result pipe. You have to call
-        this regularly. Returns the number of events processed. Returns
+        this regularly. Returns 0 if all events could be processed, or -1 if
-        immediately when no events are outstanding. The amount of events
+        it returned earlier for whatever reason. Returns immediately when no
+        events are outstanding. The amount of events processed depends on
-        processed depends on the settings of "IO::AIO::max_poll_req" and
+        the settings of "IO::AIO::max_poll_req" and
         "IO::AIO::max_poll_time".
         If not all requests were processed for whatever reason, the
-        filehandle will still be ready when "poll_cb" returns.
+        filehandle will still be ready when "poll_cb" returns, so normally
+        you don't have to do anything special to have it called later.
         Example: Install an Event watcher that automatically calls
         IO::AIO::poll_cb with high priority:
            Event->io (fd => IO::AIO::poll_fileno,
         The default is probably ok in most situations, especially if thread
         creation is fast. If thread creation is very slow on your system you
         might want to use larger values.
-    $oldmaxreqs = IO::AIO::max_outstanding $maxreqs
+    IO::AIO::max_outstanding $maxreqs
         This is a very bad function to use in interactive programs because
         it blocks, and a bad way to reduce concurrency because it is
         inexact: Better use an "aio_group" together with a feed callback.
         Sets the maximum number of outstanding requests to $nreqs. If you do
         The default value is very large, so there is no practical limit on
         the number of outstanding requests.
         You can still queue as many requests as you want. Therefore,
-        "max_oustsanding" is mainly useful in simple scripts (with low
+        "max_outstanding" is mainly useful in simple scripts (with low
         values) or as a stop gap to shield against fatal memory overflow
         (with large values).
    STATISTICAL INFORMATION
     IO::AIO::nreqs
 KNOWN BUGS
     Known bugs will be fixed in the next release.
 SEE ALSO
-    Coro::AIO.
+    AnyEvent::AIO for easy integration into event loops, Coro::AIO for a
+    more natural syntax.
 AUTHOR
      Marc Lehmann <schmorp@schmorp.de>
      http://home.schmorp.de/

Diff Legend

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

Comparing IO-AIO/README (file contents): Revision 1.29 by root, Wed Apr 16 16:45:30 2008 UTC vs. Revision 1.35 by root, Tue Apr 21 20:06:05 2009 UTC

Diff Legend

Comparing IO-AIO/README (file contents):
Revision 1.29 by root, Wed Apr 16 16:45:30 2008 UTC vs.
Revision 1.35 by root, Tue Apr 21 20:06:05 2009 UTC