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

Comparing IO-AIO/README (file contents):
Revision 1.50 by root, Sun Oct 9 08:24:49 2011 UTC vs.
Revision 1.51 by root, Sat Apr 7 00:50:33 2012 UTC

     documentation.
        aio_wd $pathname, $callback->($wd)
        aio_open $pathname, $flags, $mode, $callback->($fh)
        aio_close $fh, $callback->($status)
+       aio_seek  $fh,$offset,$whence, $callback->($offs)
        aio_read  $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
        aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
        aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
        aio_readahead $fh,$offset,$length, $callback->($retval)
        aio_stat  $fh_or_path, $callback->($status)
        aio_lstat $fh, $callback->($status)
        aio_statvfs $fh_or_path, $callback->($statvfs)
        aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
        aio_chown $fh_or_path, $uid, $gid, $callback->($status)
+       aio_chmod $fh_or_path, $mode, $callback->($status)
        aio_truncate $fh_or_path, $offset, $callback->($status)
-       aio_chmod $fh_or_path, $mode, $callback->($status)
        aio_unlink $pathname, $callback->($status)
        aio_mknod $pathname, $mode, $dev, $callback->($status)
        aio_link $srcpath, $dstpath, $callback->($status)
        aio_symlink $srcpath, $dstpath, $callback->($status)
        aio_readlink $pathname, $callback->($link)
        IO::AIO::madvise $scalar, $offset, $length, $advice
        IO::AIO::mprotect $scalar, $offset, $length, $protect
        IO::AIO::munlock $scalar, $offset = 0, $length = undef
        IO::AIO::munlockall
-  AIO REQUEST FUNCTIONS
+  API NOTES
     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 be
     called after the syscall has been executed in an asynchronous fashion.
     else to ensure your scalar has the correct contents.
     This works, btw. independent of the internal UTF-8 bit, which IO::AIO
     handles correctly whether it is set or not.
+  AIO REQUEST FUNCTIONS
     $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.
         The default priority is 0, the minimum and maximum priorities are -4
         will use dup2 to overwrite the file descriptor with the write-end of
         a pipe (the pipe fd will be created on demand and will be cached).
         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_seek $fh, $offset, $whence, $callback->($offs)
+        Seeks the filehandle to the new $offset, similarly to perl's
+        "sysseek". The $whence can use the traditional values (0 for
+        "IO::AIO::SEEK_SET", 1 for "IO::AIO::SEEK_CUR" or 2 for
+        "IO::AIO::SEEK_END").
+        The resulting absolute offset will be passed to the callback, or -1
+        in case of an error.
+        In theory, the $whence constants could be different than the
+        corresponding values from Fcntl, but perl guarantees they are the
+        same, so don't panic.
     aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
     aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
         Reads or writes $length bytes from or to the specified $fh and
         $offset into the scalar given by $data and offset $dataoffset and
         Example: asynchronously lock all current and future pages into
         memory.
            aio_mlockall IO::AIO::MCL_FUTURE;
+    aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
+        Queries the extents of the given file (by calling the Linux FIEMAP
+        ioctl, see <http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for
+        details). If the "ioctl" is not available on your OS, then this
+        rquiest will fail with "ENOSYS".
+        $start is the starting offset to query extents for, $length is the
+        size of the range to query - if it is "undef", then the whole file
+        will be queried.
+        $flags is a combination of flags ("IO::AIO::FIEMAP_FLAG_SYNC" or
+        "IO::AIO::FIEMAP_FLAG_XATTR" - "IO::AIO::FIEMAP_FLAGS_COMPAT" is
+        also exported), and is normally 0 or "IO::AIO::FIEMAP_FLAG_SYNC" to
+        query the data portion.
+        $count is the maximum number of extent records to return. If it is
+        "undef", then IO::AIO queries all extents of the file. As a very
+        special case, if it is 0, then the callback receives the number of
+        extents instead of the extents themselves.
+        If an error occurs, the callback receives no arguments. The special
+        "errno" value "IO::AIO::EBADR" is available to test for flag errors.
+        Otherwise, the callback receives an array reference with extent
+        structures. Each extent structure is an array reference itself, with
+        the following members:
+           [$logical, $physical, $length, $flags]
+        Flags is any combination of the following flag values (typically
+        either 0 or "IO::AIO::FIEMAP_EXTENT_LAST"):
+        "IO::AIO::FIEMAP_EXTENT_LAST", "IO::AIO::FIEMAP_EXTENT_UNKNOWN",
+        "IO::AIO::FIEMAP_EXTENT_DELALLOC", "IO::AIO::FIEMAP_EXTENT_ENCODED",
+        "IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED",
+        "IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED",
+        "IO::AIO::FIEMAP_EXTENT_DATA_INLINE",
+        "IO::AIO::FIEMAP_EXTENT_DATA_TAIL",
+        "IO::AIO::FIEMAP_EXTENT_UNWRITTEN", "IO::AIO::FIEMAP_EXTENT_MERGED"
+        or "IO::AIO::FIEMAP_EXTENT_SHARED".
     aio_group $callback->(...)
         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 with a
         definite callback and the ability to cancel the whole request with

Diff Legend

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

Comparing IO-AIO/README (file contents): Revision 1.50 by root, Sun Oct 9 08:24:49 2011 UTC vs. Revision 1.51 by root, Sat Apr 7 00:50:33 2012 UTC

Diff Legend

Comparing IO-AIO/README (file contents):
Revision 1.50 by root, Sun Oct 9 08:24:49 2011 UTC vs.
Revision 1.51 by root, Sat Apr 7 00:50:33 2012 UTC