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

Comparing IO-AIO/README (file contents):
Revision 1.54 by root, Sun Jan 6 11:48:14 2013 UTC vs.
Revision 1.58 by root, Sun May 1 17:19:39 2016 UTC

   EXAMPLE
     This is a simple example that uses the EV module and loads /etc/passwd
     asynchronously:
-       use Fcntl;
        use EV;
        use IO::AIO;
        # register the IO::AIO callback with EV
        my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
              # file contents now in $contents
              print $contents;
              # exit event loop and program
-             EV::unloop;
+             EV::break;
           };
        };
        # possibly queue up other requests, or open GUI windows,
        # check for sockets etc. etc.
        # process events as long as there are some:
-       EV::loop;
+       EV::run;
 REQUEST ANATOMY AND LIFETIME
     Every "aio_*" function creates a request. which is a C data structure
     not directly visible to Perl.
        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)
-       aio_realpath $pathname, $callback->($link)
+       aio_realpath $pathname, $callback->($path)
        aio_rename $srcpath, $dstpath, $callback->($status)
        aio_mkdir $pathname, $mode, $callback->($status)
        aio_rmdir $pathname, $callback->($status)
        aio_readdir $pathname, $callback->($entries)
        aio_readdirx $pathname, $flags, $callback->($entries, $flags)
        aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
        aio_load $pathname, $data, $callback->($status)
        aio_copy $srcpath, $dstpath, $callback->($status)
        aio_move $srcpath, $dstpath, $callback->($status)
        aio_rmtree $pathname, $callback->($status)
+       aio_fcntl $fh, $cmd, $arg, $callback->($status)
+       aio_ioctl $fh, $request, $buf, $callback->($status)
        aio_sync $callback->($status)
        aio_syncfs $fh, $callback->($status)
        aio_fsync $fh, $callback->($status)
        aio_fdatasync $fh, $callback->($status)
        aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
         "O_APPEND"), the following POSIX and non-POSIX constants are
         available (missing ones on your system are, as usual, 0):
         "O_ASYNC", "O_DIRECT", "O_NOATIME", "O_CLOEXEC", "O_NOCTTY",
         "O_NOFOLLOW", "O_NONBLOCK", "O_EXEC", "O_SEARCH", "O_DIRECTORY",
-        "O_DSYNC", "O_RSYNC", "O_SYNC" and "O_TTY_INIT".
+        "O_DSYNC", "O_RSYNC", "O_SYNC", "O_PATH", "O_TMPFILE", and
+        "O_TTY_INIT".
     aio_close $fh, $callback->($status)
         Asynchronously close a file and call the callback with the result
         code.
               namemax => 255,
               frsize  => 1024,
               fsid    => 1810
            }
-        Here is a (likely partial) list of fsid values used by Linux - it is
+        Here is a (likely partial - send me updates!) list of fsid values
-        safe to hardcode these when the $^O is "linux":
+        used by Linux - it is safe to hardcode these when $^O is "linux":
            0x0000adf5 adfs
            0x0000adff affs
            0x5346414f afs
            0x09041934 anon-inode filesystem
            0x00001373 devfs
            0x00001cd1 devpts
            0x0000f15f ecryptfs
            0x00414a53 efs
            0x0000137d ext
-           0x0000ef53 ext2/ext3
+           0x0000ef53 ext2/ext3/ext4
            0x0000ef51 ext2
+           0xf2f52010 f2fs
            0x00004006 fat
            0x65735546 fuseblk
            0x65735543 fusectl
            0x0bad1dea futexfs
            0x01161970 gfs2
            0x47504653 gpfs
            0x00004244 hfs
            0xf995e849 hpfs
+           0x00c0ffee hostfs
            0x958458f6 hugetlbfs
            0x2bad1dea inotifyfs
            0x00009660 isofs
            0x000072b6 jffs2
            0x3153464a jfs
            0x00009fa1 openprom
            0x7461636F ocfs2
            0x00009fa0 proc
            0x6165676c pstorefs
            0x0000002f qnx4
+           0x68191122 qnx6
            0x858458f6 ramfs
            0x52654973 reiserfs
            0x00007275 romfs
            0x67596969 rpc_pipefs
            0x73636673 securityfs
     aio_truncate $fh_or_path, $offset, $callback->($status)
         Works like truncate(2) or ftruncate(2).
     aio_allocate $fh, $mode, $offset, $len, $callback->($status)
-        Allocates or freed disk space according to the $mode argument. See
+        Allocates or frees disk space according to the $mode argument. See
-        the linux "fallocate" docuemntation for details.
+        the linux "fallocate" documentation for details.
-        $mode can currently be 0 or "IO::AIO::FALLOC_FL_KEEP_SIZE" to
+        $mode is usually 0 or "IO::AIO::FALLOC_FL_KEEP_SIZE" to allocate
-        allocate space, or "IO::AIO::FALLOC_FL_PUNCH_HOLE |
+        space, or "IO::AIO::FALLOC_FL_PUNCH_HOLE |
         IO::AIO::FALLOC_FL_KEEP_SIZE", to deallocate a file range.
+        IO::AIO also supports "FALLOC_FL_COLLAPSE_RANGE", to remove a range
+        (without leaving a hole) and "FALLOC_FL_ZERO_RANGE", to zero a range
+        (see your fallocate(2) manpage).
         The file system block size used by "fallocate" is presumably the
         "f_bsize" returned by "statvfs".
         If "fallocate" isn't available or cannot be emulated (currently no
         Delete a directory tree starting (and including) $path, return the
         status of the final "rmdir" only. This is a composite request that
         uses "aio_scandir" to recurse into and rmdir directories, and unlink
         everything else.
+    aio_fcntl $fh, $cmd, $arg, $callback->($status)
+    aio_ioctl $fh, $request, $buf, $callback->($status)
+        These work just like the "fcntl" and "ioctl" built-in functions,
+        except they execute asynchronously and pass the return value to the
+        callback.
+        Both calls can be used for a lot of things, some of which make more
+        sense to run asynchronously in their own thread, while some others
+        make less sense. For example, calls that block waiting for external
+        events, such as locking, will also lock down an I/O thread while it
+        is waiting, which can deadlock the whole I/O system. At the same
+        time, there might be no alternative to using a thread to wait.
+        So in general, you should only use these calls for things that do
+        (filesystem) I/O, not for things that wait for other events
+        (network, other processes), although if you are careful and know
+        what you are doing, you still can.
     aio_sync $callback->($status)
         Asynchronously call sync and call the callback when finished.
     aio_fsync $fh, $callback->($status)
         Asynchronously call fsync on the given filehandle and call the
           aio_stat [$etcdir, "passwd"], sub {
              # yay
           };
        };
-    That "aio_wd" is a request and not a normal function shows that creating
+    The fact that "aio_wd" is a request and not a normal function shows that
-    an IO::AIO::WD object is itself a potentially blocking operation, which
+    creating an IO::AIO::WD object is itself a potentially blocking
-    is why it is done asynchronously.
+    operation, which is why it is done asynchronously.
     To stat the directory obtained with "aio_wd" above, one could write
     either of the following three request calls:
        aio_lstat "/etc"    , sub { ...  # pathname as normal string
         instead of a working directory object and $! is set appropriately.
         Since passing "undef" as working directory component of a pathname
         fails the request with "ENOENT", there is often no need for error
         checking in the "aio_wd" callback, as future requests using the
         value will fail in the expected way.
-        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.
     IO::AIO::CWD
         This is a compiletime constant (object) that represents the process
         current working directory.
         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.
-        It's main use is in scripts without an event loop - when you want to
+        Its main use is in scripts without an event loop - when you want to
         stat a lot of files, you can write somehting like this:
            IO::AIO::max_outstanding 32;
            for my $path (...) {
     IO::AIO::npending
         Returns the number of requests currently in the pending state
         (executed, but not yet processed by poll_cb).
    MISCELLANEOUS FUNCTIONS
-    IO::AIO implements some functions that might be useful, but are not
+    IO::AIO implements some functions that are useful when you want to use
-    asynchronous.
+    some "Advanced I/O" function not available to in Perl, without going the
+    "Asynchronous I/O" route. Many of these have an asynchronous "aio_*"
+    counterpart.
     IO::AIO::sendfile $ofh, $ifh, $offset, $count
         Calls the "eio_sendfile_sync" function, which is like
         "aio_sendfile", but is blocking (this makes most sense if you know
         the input data is likely cached already and the output filehandle is
         "IO::AIO::PROT_EXEC", "IO::AIO::PROT_READ" and/or
         "IO::AIO::PROT_WRITE",
         $flags can be a combination of "IO::AIO::MAP_SHARED" or
         "IO::AIO::MAP_PRIVATE", or a number of system-specific flags (when
-        not available, the are defined as 0): "IO::AIO::MAP_ANONYMOUS"
+        not available, the are 0): "IO::AIO::MAP_ANONYMOUS" (which is set to
-        (which is set to "MAP_ANON" if your system only provides this
+        "MAP_ANON" if your system only provides this constant),
+        "IO::AIO::MAP_LOCKED", "IO::AIO::MAP_NORESERVE",
-        constant), "IO::AIO::MAP_HUGETLB", "IO::AIO::MAP_LOCKED",
+        "IO::AIO::MAP_POPULATE", "IO::AIO::MAP_NONBLOCK",
+        "IO::AIO::MAP_FIXED", "IO::AIO::MAP_GROWSDOWN",
-        "IO::AIO::MAP_NORESERVE", "IO::AIO::MAP_POPULATE" or
+        "IO::AIO::MAP_32BIT", "IO::AIO::MAP_HUGETLB" or
-        "IO::AIO::MAP_NONBLOCK"
+        "IO::AIO::MAP_STACK".
         If $fh is "undef", then a file descriptor of -1 is passed.
         $offset is the offset from the start of the file - it generally must
         be a multiple of "IO::AIO::PAGESIZE" and defaults to 0.
         "IO::AIO::SPLICE_F_MORE" and "IO::AIO::SPLICE_F_GIFT".
         See the splice(2) manpage for details.
     IO::AIO::tee $r_fh, $w_fh, $length, $flags
-        Calls the GNU/Linux tee(2) syscall, see it's manpage and the
+        Calls the GNU/Linux tee(2) syscall, see its manpage and the
         description for "IO::AIO::splice" above for details.
+    $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
+        Attempts to query or change the pipe buffer size. Obviously works
+        only on pipes, and currently works only on GNU/Linux systems, and
+        fails with -1/"ENOSYS" everywhere else. If anybody knows how to
+        influence pipe buffer size on other systems, drop me a note.
+    ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
+        This is a direct interface to the Linux pipe2(2) system call. If
+        $flags is missing or 0, then this should be the same as a call to
+        perl's built-in "pipe" function and create a new pipe, and works on
+        systems that lack the pipe2 syscall. On win32, this case invokes
+        "_pipe (..., 4096, O_BINARY)".
+        If $flags is non-zero, it tries to invoke the pipe2 system call with
+        the given flags (Linux 2.6.27, glibc 2.9).
+        On success, the read and write file handles are returned.
+        On error, nothing will be returned. If the pipe2 syscall is missing
+        and $flags is non-zero, fails with "ENOSYS".
+        Please refer to pipe2(2) for more info on the $flags, but at the
+        time of this writing, "IO::AIO::O_CLOEXEC", "IO::AIO::O_NONBLOCK"
+        and "IO::AIO::O_DIRECT" (Linux 3.4, for packet-based pipes) were
+        supported.
 EVENT LOOP INTEGRATION
     It is recommended to use AnyEvent::AIO to integrate IO::AIO
     automatically into many event loops:

Diff Legend

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

Comparing IO-AIO/README (file contents): Revision 1.54 by root, Sun Jan 6 11:48:14 2013 UTC vs. Revision 1.58 by root, Sun May 1 17:19:39 2016 UTC

Diff Legend

Comparing IO-AIO/README (file contents):
Revision 1.54 by root, Sun Jan 6 11:48:14 2013 UTC vs.
Revision 1.58 by root, Sun May 1 17:19:39 2016 UTC