| 1 |
=head1 NAME |
| 2 |
|
| 3 |
Coro::AIO - truly asynchronous file and directory I/O |
| 4 |
|
| 5 |
=head1 SYNOPSIS |
| 6 |
|
| 7 |
use Coro::AIO; |
| 8 |
|
| 9 |
# can now use any of the aio requests your IO::AIO module supports. |
| 10 |
|
| 11 |
# read 1MB of /etc/passwd, without blocking other coroutines |
| 12 |
my $fh = aio_open "/etc/passwd", O_RDONLY, 0 |
| 13 |
or die "/etc/passwd: $!"; |
| 14 |
aio_read $fh, 0, 1_000_000, my $buf, 0 |
| 15 |
or die "aio_read: $!"; |
| 16 |
aio_close $fh; |
| 17 |
|
| 18 |
=head1 DESCRIPTION |
| 19 |
|
| 20 |
This module is an L<AnyEvent> user, you need to make sure that you use and |
| 21 |
run a supported event loop. |
| 22 |
|
| 23 |
This module implements a thin wrapper around L<IO::AIO>. All of |
| 24 |
the functions that expect a callback are being wrapped by this module. |
| 25 |
|
| 26 |
The API is exactly the same as that of the corresponding IO::AIO |
| 27 |
routines, except that you have to specify I<all> arguments, even the |
| 28 |
ones optional in IO::AIO, I<except> the callback argument. Instead of |
| 29 |
calling a callback, the routines return the values normally passed to the |
| 30 |
callback. Everything else, including C<$!> and perls stat cache, are set |
| 31 |
as expected after these functions return. |
| 32 |
|
| 33 |
You can mix calls to C<IO::AIO> functions with calls to this module. You |
| 34 |
I<must not>, however, call these routines from within IO::AIO callbacks, |
| 35 |
as this causes a deadlock. Start a coro inside the callback instead. |
| 36 |
|
| 37 |
This module also loads L<AnyEvent::AIO> to integrate into the event loop |
| 38 |
in use, so please refer to its (and L<AnyEvent>'s) documentation on how it |
| 39 |
selects an appropriate event module. |
| 40 |
|
| 41 |
All other functions exported by default by IO::AIO (e.g. C<aioreq_pri>) |
| 42 |
will be exported by default by Coro::AIO, too. |
| 43 |
|
| 44 |
Functions that can be optionally imported from IO::AIO can be imported |
| 45 |
from Coro::AIO or can be called directly, e.g. C<Coro::AIO::nreqs>. |
| 46 |
|
| 47 |
You cannot specify priorities with C<aioreq_pri> if your coroutine has a |
| 48 |
non-zero priority, as this module overwrites the request priority with the |
| 49 |
current coroutine priority in that case. |
| 50 |
|
| 51 |
For your convenience, here are the changed function signatures for most |
| 52 |
of the requests, for documentation of these functions please have a look |
| 53 |
at L<IO::AIO|the IO::AIO manual>. Note that requests added by newer |
| 54 |
versions of L<IO::AIO> will be automatically wrapped as well. |
| 55 |
|
| 56 |
=over 4 |
| 57 |
|
| 58 |
=cut |
| 59 |
|
| 60 |
package Coro::AIO; |
| 61 |
|
| 62 |
use common::sense; |
| 63 |
|
| 64 |
use IO::AIO 3.1 (); |
| 65 |
use AnyEvent::AIO (); |
| 66 |
|
| 67 |
use Coro (); |
| 68 |
use Coro::AnyEvent (); |
| 69 |
|
| 70 |
use base Exporter::; |
| 71 |
|
| 72 |
our $VERSION = 6.37; |
| 73 |
|
| 74 |
our @EXPORT = (@IO::AIO::EXPORT, qw(aio_wait)); |
| 75 |
our @EXPORT_OK = @IO::AIO::EXPORT_OK; |
| 76 |
our $AUTOLOAD; |
| 77 |
|
| 78 |
{ |
| 79 |
my @reqs = @IO::AIO::AIO_REQ ? @IO::AIO::AIO_REQ : @IO::AIO::EXPORT; |
| 80 |
my %reqs = map +($_ => 1), @reqs; |
| 81 |
|
| 82 |
eval |
| 83 |
join "", |
| 84 |
map "sub $_(" . (prototype "IO::AIO::$_") . ");", |
| 85 |
grep !$reqs{$_}, |
| 86 |
@IO::AIO::EXPORT, @EXPORT_OK; |
| 87 |
|
| 88 |
for my $sub (@reqs) { |
| 89 |
push @EXPORT, $sub; |
| 90 |
|
| 91 |
my $iosub = "IO::AIO::$sub"; |
| 92 |
my $proto = prototype $iosub; |
| 93 |
|
| 94 |
$proto =~ s/;//g; # we do not support optional arguments |
| 95 |
$proto =~ s/^(\$*)\$$/$1/ or die "$iosub($proto): unable to remove callback slot from prototype"; |
| 96 |
|
| 97 |
_register "Coro::AIO::$sub", $proto, \&{$iosub}; |
| 98 |
} |
| 99 |
|
| 100 |
_register "Coro::AIO::aio_wait", '$', \&IO::AIO::REQ::cb; |
| 101 |
} |
| 102 |
|
| 103 |
sub AUTOLOAD { |
| 104 |
(my $func = $AUTOLOAD) =~ s/^.*:://; |
| 105 |
*$AUTOLOAD = \&{"IO::AIO::$func"}; |
| 106 |
goto &$AUTOLOAD; |
| 107 |
} |
| 108 |
|
| 109 |
=item @results = aio_wait $req |
| 110 |
|
| 111 |
This is not originally an IO::AIO request: what it does is to wait for |
| 112 |
C<$req> to finish and return the results. This is most useful with |
| 113 |
C<aio_group> requests. |
| 114 |
|
| 115 |
Is currently implemented by replacing the C<$req> callback (and is very |
| 116 |
much like a wrapper around C<< $req->cb () >>). |
| 117 |
|
| 118 |
=item $fh = aio_open $pathname, $flags, $mode |
| 119 |
|
| 120 |
=item $status = aio_close $fh |
| 121 |
|
| 122 |
=item $retval = aio_read $fh,$offset,$length, $data,$dataoffset |
| 123 |
|
| 124 |
=item $retval = aio_write $fh,$offset,$length, $data,$dataoffset |
| 125 |
|
| 126 |
=item $retval = aio_sendfile $out_fh, $in_fh, $in_offset, $length |
| 127 |
|
| 128 |
=item $retval = aio_readahead $fh,$offset,$length |
| 129 |
|
| 130 |
=item $status = aio_stat $fh_or_path |
| 131 |
|
| 132 |
=item $status = aio_lstat $fh |
| 133 |
|
| 134 |
=item $status = aio_unlink $pathname |
| 135 |
|
| 136 |
=item $status = aio_rmdir $pathname |
| 137 |
|
| 138 |
=item $entries = aio_readdir $pathname |
| 139 |
|
| 140 |
=item ($dirs, $nondirs) = aio_scandir $path, $maxreq |
| 141 |
|
| 142 |
=item $status = aio_fsync $fh |
| 143 |
|
| 144 |
=item $status = aio_fdatasync $fh |
| 145 |
|
| 146 |
=item ... = aio_xxx ... |
| 147 |
|
| 148 |
Any additional aio requests follow the same scheme: same parameters except |
| 149 |
you must not specify a callback but instead get the callback arguments as |
| 150 |
return values. |
| 151 |
|
| 152 |
=back |
| 153 |
|
| 154 |
=head1 SEE ALSO |
| 155 |
|
| 156 |
L<Coro::Socket> and L<Coro::Handle> for non-blocking socket operation. |
| 157 |
|
| 158 |
=head1 AUTHOR |
| 159 |
|
| 160 |
Marc Lehmann <schmorp@schmorp.de> |
| 161 |
http://home.schmorp.de/ |
| 162 |
|
| 163 |
=cut |
| 164 |
|
| 165 |
1 |
