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.133 by root, Sat Sep 6 07:14:52 2008 UTC vs.
Revision 1.138 by root, Sun Oct 12 21:51:33 2008 UTC

193use strict 'vars'; 193use strict 'vars';
194 194
195use base 'Exporter'; 195use base 'Exporter';
196 196
197BEGIN { 197BEGIN {
198 our $VERSION = '3.07'; 198 our $VERSION = '3.1';
199 199
200 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 200 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
202 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 202 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
203 aio_fdatasync aio_pathsync aio_readahead 203 aio_fdatasync aio_pathsync aio_readahead
224All the C<aio_*> calls are more or less thin wrappers around the syscall 224All the C<aio_*> calls are more or less thin wrappers around the syscall
225with the same name (sans C<aio_>). The arguments are similar or identical, 225with the same name (sans C<aio_>). The arguments are similar or identical,
226and they all accept an additional (and optional) C<$callback> argument 226and they all accept an additional (and optional) C<$callback> argument
227which must be a code reference. This code reference will get called with 227which must be a code reference. This code reference will get called with
228the syscall return code (e.g. most syscalls return C<-1> on error, unlike 228the syscall return code (e.g. most syscalls return C<-1> on error, unlike
229perl, which usually delivers "false") as it's sole argument when the given 229perl, which usually delivers "false") as its sole argument after the given
230syscall has been executed asynchronously. 230syscall has been executed asynchronously.
231 231
232All functions expecting a filehandle keep a copy of the filehandle 232All functions expecting a filehandle keep a copy of the filehandle
233internally until the request has finished. 233internally until the request has finished.
234 234
248your pathnames to the locale (or other) encoding in effect in the user 248your pathnames to the locale (or other) encoding in effect in the user
249environment, d) use Glib::filename_from_unicode on unicode filenames or e) 249environment, d) use Glib::filename_from_unicode on unicode filenames or e)
250use something else to ensure your scalar has the correct contents. 250use something else to ensure your scalar has the correct contents.
251 251
252This works, btw. independent of the internal UTF-8 bit, which IO::AIO 252This works, btw. independent of the internal UTF-8 bit, which IO::AIO
253handles correctly wether it is set or not. 253handles correctly whether it is set or not.
254 254
255=over 4 255=over 4
256 256
257=item $prev_pri = aioreq_pri [$pri] 257=item $prev_pri = aioreq_pri [$pri]
258 258
565 565
566Try to copy the I<file> (directories not supported as either source or 566Try to copy the I<file> (directories not supported as either source or
567destination) from C<$srcpath> to C<$dstpath> and call the callback with 567destination) from C<$srcpath> to C<$dstpath> and call the callback with
568the C<0> (error) or C<-1> ok. 568the C<0> (error) or C<-1> ok.
569 569
570This is a composite request that it creates the destination file with 570This is a composite request that creates the destination file with
571mode 0200 and copies the contents of the source file into it using 571mode 0200 and copies the contents of the source file into it using
572C<aio_sendfile>, followed by restoring atime, mtime, access mode and 572C<aio_sendfile>, followed by restoring atime, mtime, access mode and
573uid/gid, in that order. 573uid/gid, in that order.
574 574
575If an error occurs, the partial destination file will be unlinked, if 575If an error occurs, the partial destination file will be unlinked, if
631 631
632Try to move the I<file> (directories not supported as either source or 632Try to move the I<file> (directories not supported as either source or
633destination) from C<$srcpath> to C<$dstpath> and call the callback with 633destination) from C<$srcpath> to C<$dstpath> and call the callback with
634the C<0> (error) or C<-1> ok. 634the C<0> (error) or C<-1> ok.
635 635
636This is a composite request that tries to rename(2) the file first. If 636This is a composite request that tries to rename(2) the file first; if
637rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 637rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
638that is successful, unlinking the C<$srcpath>. 638that is successful, unlinks the C<$srcpath>.
639 639
640=cut 640=cut
641 641
642sub aio_move($$;$) { 642sub aio_move($$;$) {
643 my ($src, $dst, $cb) = @_; 643 my ($src, $dst, $cb) = @_;
858detected, it will be emulated by calling C<fsync> instead. 858detected, it will be emulated by calling C<fsync> instead.
859 859
860=item aio_pathsync $path, $callback->($status) 860=item aio_pathsync $path, $callback->($status)
861 861
862This request tries to open, fsync and close the given path. This is a 862This request tries to open, fsync and close the given path. This is a
863composite request intended tosync directories after directory operations 863composite request intended to sync directories after directory operations
864(E.g. rename). This might not work on all operating systems or have any 864(E.g. rename). This might not work on all operating systems or have any
865specific effect, but usually it makes sure that directory changes get 865specific effect, but usually it makes sure that directory changes get
866written to disc. It works for anything that can be opened for read-only, 866written to disc. It works for anything that can be opened for read-only,
867not just directories. 867not just directories.
868 868
1076not impose any limits). 1076not impose any limits).
1077 1077
1078If the feed does not queue more requests when called, it will be 1078If the feed does not queue more requests when called, it will be
1079automatically removed from the group. 1079automatically removed from the group.
1080 1080
1081If the feed limit is C<0>, it will be set to C<2> automatically. 1081If the feed limit is C<0> when this method is called, it will be set to
1082C<2> automatically.
1082 1083
1083Example: 1084Example:
1084 1085
1085 # stat all files in @files, but only ever use four aio requests concurrently: 1086 # stat all files in @files, but only ever use four aio requests concurrently:
1086 1087
1097 1098
1098Sets the feeder limit for the group: The feeder will be called whenever 1099Sets the feeder limit for the group: The feeder will be called whenever
1099the group contains less than this many requests. 1100the group contains less than this many requests.
1100 1101
1101Setting the limit to C<0> will pause the feeding process. 1102Setting the limit to C<0> will pause the feeding process.
1103
1104The default value for the limit is C<0>, but note that setting a feeder
1105automatically bumps it up to C<2>.
1102 1106
1103=back 1107=back
1104 1108
1105=head2 SUPPORT FUNCTIONS 1109=head2 SUPPORT FUNCTIONS
1106 1110

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines