--- IO-AIO/README 2008/05/29 03:35:03 1.31 +++ IO-AIO/README 2008/11/20 09:01:40 1.34 @@ -177,8 +177,8 @@ 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 - argument when the given syscall has been executed asynchronously. + error, unlike perl, which usually delivers "false") as its sole argument + 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. @@ -201,7 +201,7 @@ 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 @@ -453,10 +453,10 @@ 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 - with mode 0200 and copies the contents of the source file into it - using "aio_sendfile", followed by restoring atime, mtime, access - mode and uid/gid, in that order. + This is a composite request that creates the destination file with + mode 0200 and copies the contents of the source file into it using + "aio_sendfile", followed by restoring atime, mtime, access mode and + 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 @@ -467,9 +467,9 @@ 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. - If rename files with "EXDEV", it copies the file with "aio_copy" - and, if that is successful, unlinking the $srcpath. + This is a composite request that tries to rename(2) the file first; + if rename fails with "EXDEV", it copies the file with "aio_copy" + 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 @@ -544,9 +544,21 @@ 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 @@ -660,10 +672,11 @@ "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. - And in the callbacks of those requests, you can add further requests to - the group. And only when all those requests have finished will the the - group itself finish. + That means after creating a group you have some time to add requests + (precisely before the callback has been invoked, which is only done + within the "poll_cb"). And in the callbacks of those requests, you can + add further requests to the group. And only when all those requests have + finished will the the group itself finish. add $grp ... $grp->add (...) @@ -716,7 +729,8 @@ 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: @@ -737,6 +751,9 @@ 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