--- IO-AIO/AIO.pm 2008/05/12 00:32:42 1.127 +++ IO-AIO/AIO.pm 2008/09/30 14:07:59 1.136 @@ -195,7 +195,7 @@ use base 'Exporter'; BEGIN { - our $VERSION = '3.02'; + our $VERSION = '3.1'; our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir @@ -226,7 +226,7 @@ and they all accept an additional (and optional) C<$callback> argument which must be a code reference. This code reference will get called with the syscall return code (e.g. most syscalls return C<-1> on error, unlike -perl, which usually delivers "false") as it's sole argument when the given +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 @@ -250,7 +250,7 @@ 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. =over 4 @@ -567,7 +567,7 @@ destination) from C<$srcpath> to C<$dstpath> and call the callback with the C<0> (error) or C<-1> ok. -This is a composite request that it creates the destination file with +This is a composite request that creates the destination file with mode 0200 and copies the contents of the source file into it using C, followed by restoring atime, mtime, access mode and uid/gid, in that order. @@ -860,7 +860,7 @@ =item 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 operations +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, @@ -1015,10 +1015,11 @@ C 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 C). 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. =over 4 @@ -1119,12 +1120,14 @@ =item 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 immediately -when no events are outstanding. The amount of events processed depends on -the settings of C and C. +regularly. Returns C<0> if all events could be processed, or C<-1> if it +returned earlier for whatever reason. Returns immediately when no events +are outstanding. The amount of events processed depends on the settings of +C and C. If not all requests were processed for whatever reason, the filehandle -will still be ready when C returns. +will still be ready when C 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: