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.105 by root, Sun Mar 25 00:20:27 2007 UTC vs.
Revision 1.106 by root, Fri Jun 1 05:51:21 2007 UTC

190use strict 'vars'; 190use strict 'vars';
191 191
192use base 'Exporter'; 192use base 'Exporter';
193 193
194BEGIN { 194BEGIN {
195 our $VERSION = '2.33'; 195 our $VERSION = '2.4';
196 196
197 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 197 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
198 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 198 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
199 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link 199 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link
200 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir); 200 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir
201 aio_chown aio_chmod aio_utime);
201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 202 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 203 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
203 min_parallel max_parallel max_idle 204 min_parallel max_parallel max_idle
204 nreqs nready npending nthreads 205 nreqs nready npending nthreads
205 max_poll_time max_poll_reqs); 206 max_poll_time max_poll_reqs);
271 aio_read $_[0], ..., sub { 272 aio_read $_[0], ..., sub {
272 ... 273 ...
273 }; 274 };
274 }; 275 };
275 276
277
276=item aioreq_nice $pri_adjust 278=item aioreq_nice $pri_adjust
277 279
278Similar to C<aioreq_pri>, but subtracts the given value from the current 280Similar to C<aioreq_pri>, but subtracts the given value from the current
279priority, so the effect is cumulative. 281priority, so the effect is cumulative.
282
280 283
281=item aio_open $pathname, $flags, $mode, $callback->($fh) 284=item aio_open $pathname, $flags, $mode, $callback->($fh)
282 285
283Asynchronously open or create a file and call the callback with a newly 286Asynchronously open or create a file and call the callback with a newly
284created filehandle for the file. 287created filehandle for the file.
305 } else { 308 } else {
306 die "open failed: $!\n"; 309 die "open failed: $!\n";
307 } 310 }
308 }; 311 };
309 312
313
310=item aio_close $fh, $callback->($status) 314=item aio_close $fh, $callback->($status)
311 315
312Asynchronously close a file and call the callback with the result 316Asynchronously close a file and call the callback with the result
313code. I<WARNING:> although accepted, you should not pass in a perl 317code. I<WARNING:> although accepted, you should not pass in a perl
314filehandle here, as perl will likely close the file descriptor another 318filehandle here, as perl will likely close the file descriptor another
316C<close> or just let filehandles go out of scope. 320C<close> or just let filehandles go out of scope.
317 321
318This is supposed to be a bug in the API, so that might change. It's 322This is supposed to be a bug in the API, so that might change. It's
319therefore best to avoid this function. 323therefore best to avoid this function.
320 324
325
321=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 326=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
322 327
323=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 328=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
324 329
325Reads or writes C<length> bytes from the specified C<fh> and C<offset> 330Reads or writes C<length> bytes from the specified C<fh> and C<offset>
336 341
337 aio_read $fh, 7, 15, $buffer, 0, sub { 342 aio_read $fh, 7, 15, $buffer, 0, sub {
338 $_[0] > 0 or die "read error: $!"; 343 $_[0] > 0 or die "read error: $!";
339 print "read $_[0] bytes: <$buffer>\n"; 344 print "read $_[0] bytes: <$buffer>\n";
340 }; 345 };
346
341 347
342=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 348=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
343 349
344Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 350Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
345reading at byte offset C<$in_offset>, and starts writing at the current 351reading at byte offset C<$in_offset>, and starts writing at the current
359C<$in_fh> than are written, and there is no way to find out how many 365C<$in_fh> than are written, and there is no way to find out how many
360bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 366bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
361provides the number of bytes written to C<$out_fh>. Only if the result 367provides the number of bytes written to C<$out_fh>. Only if the result
362value equals C<$length> one can assume that C<$length> bytes have been 368value equals C<$length> one can assume that C<$length> bytes have been
363read. 369read.
370
364 371
365=item aio_readahead $fh,$offset,$length, $callback->($retval) 372=item aio_readahead $fh,$offset,$length, $callback->($retval)
366 373
367C<aio_readahead> populates the page cache with data from a file so that 374C<aio_readahead> populates the page cache with data from a file so that
368subsequent reads from that file will not block on disk I/O. The C<$offset> 375subsequent reads from that file will not block on disk I/O. The C<$offset>
374file. The current file offset of the file is left unchanged. 381file. The current file offset of the file is left unchanged.
375 382
376If that syscall doesn't exist (likely if your OS isn't Linux) it will be 383If that syscall doesn't exist (likely if your OS isn't Linux) it will be
377emulated by simply reading the data, which would have a similar effect. 384emulated by simply reading the data, which would have a similar effect.
378 385
386
379=item aio_stat $fh_or_path, $callback->($status) 387=item aio_stat $fh_or_path, $callback->($status)
380 388
381=item aio_lstat $fh, $callback->($status) 389=item aio_lstat $fh, $callback->($status)
382 390
383Works like perl's C<stat> or C<lstat> in void context. The callback will 391Works like perl's C<stat> or C<lstat> in void context. The callback will
396 aio_stat "/etc/passwd", sub { 404 aio_stat "/etc/passwd", sub {
397 $_[0] and die "stat failed: $!"; 405 $_[0] and die "stat failed: $!";
398 print "size is ", -s _, "\n"; 406 print "size is ", -s _, "\n";
399 }; 407 };
400 408
409
410=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
411
412Works like perl's C<utime> function (including the special case of $atime
413and $mtime being undef). Fractional times are supported if the underlying
414syscalls support them.
415
416When called with a pathname, uses utimes(2) if available, otherwise
417utime(2). If called on a file descriptor, uses futimes(2) if available,
418otherwise returns ENOSYS, so this is not portable.
419
420Examples:
421
422 # set atime and mtime to current time:
423 aio_utime "path", undef, undef;
424 # set atime to current time and mtime to beginning of the epoch:
425 aio_utime "path", time, undef; # undef==0
426
427
428=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
429
430Works like perl's C<chown> function, except that C<undef> for either $uid
431or $gid is being interpreted as "do not change" (but -1 can also be used).
432
433Examples:
434
435 # same as "chown root path" in the shell:
436 aio_chown "path", 0, -1;
437 # same as above:
438 aio_chown "path", 0, undef;
439
440
441=item aio_chmod $fh_or_path, $mode, $callback->($status)
442
443Works like perl's C<chmod> function.
444
445
401=item aio_unlink $pathname, $callback->($status) 446=item aio_unlink $pathname, $callback->($status)
402 447
403Asynchronously unlink (delete) a file and call the callback with the 448Asynchronously unlink (delete) a file and call the callback with the
404result code. 449result code.
405 450
451
406=item aio_mknod $path, $mode, $dev, $callback->($status) 452=item aio_mknod $path, $mode, $dev, $callback->($status)
407 453
408[EXPERIMENTAL] 454[EXPERIMENTAL]
409 455
410Asynchronously create a device node (or fifo). See mknod(2). 456Asynchronously create a device node (or fifo). See mknod(2).
411 457
412The only (POSIX-) portable way of calling this function is: 458The only (POSIX-) portable way of calling this function is:
413 459
414 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 460 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
461
415 462
416=item aio_link $srcpath, $dstpath, $callback->($status) 463=item aio_link $srcpath, $dstpath, $callback->($status)
417 464
418Asynchronously create a new link to the existing object at C<$srcpath> at 465Asynchronously create a new link to the existing object at C<$srcpath> at
419the path C<$dstpath> and call the callback with the result code. 466the path C<$dstpath> and call the callback with the result code.
420 467
468
421=item aio_symlink $srcpath, $dstpath, $callback->($status) 469=item aio_symlink $srcpath, $dstpath, $callback->($status)
422 470
423Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 471Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
424the path C<$dstpath> and call the callback with the result code. 472the path C<$dstpath> and call the callback with the result code.
473
425 474
426=item aio_readlink $path, $callback->($link) 475=item aio_readlink $path, $callback->($link)
427 476
428Asynchronously read the symlink specified by C<$path> and pass it to 477Asynchronously read the symlink specified by C<$path> and pass it to
429the callback. If an error occurs, nothing or undef gets passed to the 478the callback. If an error occurs, nothing or undef gets passed to the
430callback. 479callback.
431 480
481
432=item aio_rename $srcpath, $dstpath, $callback->($status) 482=item aio_rename $srcpath, $dstpath, $callback->($status)
433 483
434Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 484Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
435rename(2) and call the callback with the result code. 485rename(2) and call the callback with the result code.
486
436 487
437=item aio_mkdir $pathname, $mode, $callback->($status) 488=item aio_mkdir $pathname, $mode, $callback->($status)
438 489
439Asynchronously mkdir (create) a directory and call the callback with 490Asynchronously mkdir (create) a directory and call the callback with
440the result code. C<$mode> will be modified by the umask at the time the 491the result code. C<$mode> will be modified by the umask at the time the
441request is executed, so do not change your umask. 492request is executed, so do not change your umask.
442 493
494
443=item aio_rmdir $pathname, $callback->($status) 495=item aio_rmdir $pathname, $callback->($status)
444 496
445Asynchronously rmdir (delete) a directory and call the callback with the 497Asynchronously rmdir (delete) a directory and call the callback with the
446result code. 498result code.
499
447 500
448=item aio_readdir $pathname, $callback->($entries) 501=item aio_readdir $pathname, $callback->($entries)
449 502
450Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 503Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
451directory (i.e. opendir + readdir + closedir). The entries will not be 504directory (i.e. opendir + readdir + closedir). The entries will not be
452sorted, and will B<NOT> include the C<.> and C<..> entries. 505sorted, and will B<NOT> include the C<.> and C<..> entries.
453 506
454The callback a single argument which is either C<undef> or an array-ref 507The callback a single argument which is either C<undef> or an array-ref
455with the filenames. 508with the filenames.
509
456 510
457=item aio_load $path, $data, $callback->($status) 511=item aio_load $path, $data, $callback->($status)
458 512
459This is a composite request that tries to fully load the given file into 513This is a composite request that tries to fully load the given file into
460memory. Status is the same as with aio_read. 514memory. Status is the same as with aio_read.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines