ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.35 by root, Mon Aug 22 23:20:37 2005 UTC vs.
Revision 1.38 by root, Sun Aug 28 10:51:33 2005 UTC

63use base 'Exporter'; 63use base 'Exporter';
64 64
65use Fcntl (); 65use Fcntl ();
66 66
67BEGIN { 67BEGIN {
68 $VERSION = 1.5; 68 $VERSION = 1.6;
69 69
70 @EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink 70 @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close stat
71 aio_aio_lstat aio_unlink aio_rmdir aio_readdir aio_symlink
71 aio_rmdir aio_symlink aio_fsync aio_fdatasync aio_readahead); 72 aio_fsync aio_fdatasync aio_readahead);
72 @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); 73 @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel
74 max_outstanding nreqs);
73 75
74 require XSLoader; 76 require XSLoader;
75 XSLoader::load IO::AIO, $VERSION; 77 XSLoader::load IO::AIO, $VERSION;
76} 78}
77 79
175This call tries to make use of a native C<sendfile> syscall to provide 177This call tries to make use of a native C<sendfile> syscall to provide
176zero-copy operation. For this to work, C<$out_fh> should refer to a 178zero-copy operation. For this to work, C<$out_fh> should refer to a
177socket, and C<$in_fh> should refer to mmap'able file. 179socket, and C<$in_fh> should refer to mmap'able file.
178 180
179If the native sendfile call fails or is not implemented, it will be 181If the native sendfile call fails or is not implemented, it will be
180emulated, so you can call C<aio_sendfile> on any filehandles regardless of 182emulated, so you can call C<aio_sendfile> on any type of filehandle
181the limitations of the OS. 183regardless of the limitations of the operating system.
182 184
183Please note, however, that C<aio_sendfile> can read more bytes from 185Please note, however, that C<aio_sendfile> can read more bytes from
184C<$in_fh> than are written, and there is no way to find out how many 186C<$in_fh> than are written, and there is no way to find out how many
185bytes have been read form C<aio_sendfile> alone, as C<aio_sendfile> only 187bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
186provides the number of bytes written to C<$out_fh>. Only if the return 188provides the number of bytes written to C<$out_fh>. Only if the result
187value (the value provided to the callback) equals C<$length> one can 189value equals C<$length> one can assume that C<$length> bytes have been
188assume that C<$length> bytes have been read. 190read.
189 191
190=item aio_readahead $fh,$offset,$length, $callback 192=item aio_readahead $fh,$offset,$length, $callback
191 193
192C<aio_readahead> populates the page cache with data from a file so that 194C<aio_readahead> populates the page cache with data from a file so that
193subsequent reads from that file will not block on disk I/O. The C<$offset> 195subsequent reads from that file will not block on disk I/O. The C<$offset>
231=item aio_rmdir $pathname, $callback 233=item aio_rmdir $pathname, $callback
232 234
233Asynchronously rmdir (delete) a directory and call the callback with the 235Asynchronously rmdir (delete) a directory and call the callback with the
234result code. 236result code.
235 237
238=item aio_readdir $pathname $callback
239
240Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
241directory (i.e. opendir + readdir + closedir). The entries will not be
242sorted, and will B<NOT> include the C<.> and C<..> entries.
243
244The callback a single argument which is either C<undef> or an array-ref
245with the filenames.
246
236=item aio_fsync $fh, $callback 247=item aio_fsync $fh, $callback
237 248
238Asynchronously call fsync on the given filehandle and call the callback 249Asynchronously call fsync on the given filehandle and call the callback
239with the fsync result code. 250with the fsync result code.
240 251

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines