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.236 by root, Fri Aug 24 15:33:06 2012 UTC vs.
Revision 1.240 by root, Mon Dec 17 06:18:39 2012 UTC

… …
168use common::sense; 168use common::sense;
169 169
170use base 'Exporter'; 170use base 'Exporter';
171 171
172BEGIN { 172BEGIN {
173 our $VERSION = '4.16'; 173 our $VERSION = '4.18';
174 174
175 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close 175 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync 177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate 178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate
… …
783 783
784 784
785=item aio_realpath $pathname, $callback->($path) 785=item aio_realpath $pathname, $callback->($path)
786 786
787Asynchronously make the path absolute and resolve any symlinks in 787Asynchronously make the path absolute and resolve any symlinks in
788C<$path>. The resulting path only consists of directories (Same as 788C<$path>. The resulting path only consists of directories (same as
789L<Cwd::realpath>). 789L<Cwd::realpath>).
790 790
791This request can be used to get the absolute path of the current working 791This request can be used to get the absolute path of the current working
792directory by passing it a path of F<.> (a single dot). 792directory by passing it a path of F<.> (a single dot).
793 793
… …
1181} 1181}
1182 1182
1183=item aio_rmtree $pathname, $callback->($status) 1183=item aio_rmtree $pathname, $callback->($status)
1184 1184
1185Delete a directory tree starting (and including) C<$path>, return the 1185Delete a directory tree starting (and including) C<$path>, return the
1186status of the final C<rmdir> only. This is a composite request that 1186status of the final C<rmdir> only. This is a composite request that
1187uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1187uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1188everything else. 1188everything else.
1189 1189
1190=cut 1190=cut
1191 1191
… …
1311 1311
1312This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1312This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1313scalars. 1313scalars.
1314 1314
1315It touches (reads or writes) all memory pages in the specified 1315It touches (reads or writes) all memory pages in the specified
1316range inside the scalar. All caveats and parameters are the same 1316range inside the scalar. All caveats and parameters are the same
1317as for C<aio_msync>, above, except for flags, which must be either 1317as for C<aio_msync>, above, except for flags, which must be either
1318C<0> (which reads all pages and ensures they are instantiated) or 1318C<0> (which reads all pages and ensures they are instantiated) or
1319C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1319C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1320writing an octet from it, which dirties the page). 1320writing an octet from it, which dirties the page).
1321 1321
1322=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1322=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1323 1323
1324This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1324This is a rather advanced IO::AIO call, which works best on mmap(2)ed
… …
1525will still point to the original directory. Most functions accepting a 1525will still point to the original directory. Most functions accepting a
1526pathname will use the directory fd on newer systems, and the string on 1526pathname will use the directory fd on newer systems, and the string on
1527older systems. Some functions (such as realpath) will always rely on the 1527older systems. Some functions (such as realpath) will always rely on the
1528string form of the pathname. 1528string form of the pathname.
1529 1529
1530So this fucntionality is mainly useful to get some protection against 1530So this functionality is mainly useful to get some protection against
1531C<chdir>, to easily get an absolute path out of a relative path for future 1531C<chdir>, to easily get an absolute path out of a relative path for future
1532reference, and to speed up doing many operations in the same directory 1532reference, and to speed up doing many operations in the same directory
1533(e.g. when stat'ing all files in a directory). 1533(e.g. when stat'ing all files in a directory).
1534 1534
1535The following functions implement this working directory abstraction: 1535The following functions implement this working directory abstraction:
… …
1556=item IO::AIO::CWD 1556=item IO::AIO::CWD
1557 1557
1558This is a compiletime constant (object) that represents the process 1558This is a compiletime constant (object) that represents the process
1559current working directory. 1559current working directory.
1560 1560
1561Specifying this object as working directory object for a pathname is as 1561Specifying this object as working directory object for a pathname is as if
1562if the pathname would be specified directly, without a directory object, 1562the pathname would be specified directly, without a directory object. For
1563e.g., these calls are functionally identical: 1563example, these calls are functionally identical:
1564 1564
1565 aio_stat "somefile", sub { ... }; 1565 aio_stat "somefile", sub { ... };
1566 aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; 1566 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1567 1567
1568=back 1568=back
1569
1570To recover the path associated with an IO::AIO::WD object, you can use
1571C<aio_realpath>:
1572
1573 aio_realpath $wd, sub {
1574 warn "path is $_[0]\n";
1575 };
1569 1576
1570 1577
1571=head2 IO::AIO::REQ CLASS 1578=head2 IO::AIO::REQ CLASS
1572 1579
1573All non-aggregate C<aio_*> functions return an object of this class when 1580All non-aggregate C<aio_*> functions return an object of this class when
… …
1752 1759
1753See C<poll_cb> for an example. 1760See C<poll_cb> for an example.
1754 1761
1755=item IO::AIO::poll_cb 1762=item IO::AIO::poll_cb
1756 1763
1757Process some outstanding events on the result pipe. You have to call 1764Process some requests that have reached the result phase (i.e. they have
1765been executed but the results are not yet reported). You have to call
1766this "regularly" to finish outstanding requests.
1767
1758this regularly. Returns C<0> if all events could be processed (or there 1768Returns C<0> if all events could be processed (or there were no
1759were no events to process), or C<-1> if it returned earlier for whatever 1769events to process), or C<-1> if it returned earlier for whatever
1760reason. Returns immediately when no events are outstanding. The amount of 1770reason. Returns immediately when no events are outstanding. The amount
1761events processed depends on the settings of C<IO::AIO::max_poll_req> and 1771of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1762C<IO::AIO::max_poll_time>. 1772C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1763 1773
1764If not all requests were processed for whatever reason, the filehandle 1774If not all requests were processed for whatever reason, the poll file
1765will still be ready when C<poll_cb> returns, so normally you don't have to 1775descriptor will still be ready when C<poll_cb> returns, so normally you
1766do anything special to have it called later. 1776don't have to do anything special to have it called later.
1767 1777
1768Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes 1778Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1769ready, it can be beneficial to call this function from loops which submit 1779ready, it can be beneficial to call this function from loops which submit
1770a lot of requests, to make sure the results get processed when they become 1780a lot of requests, to make sure the results get processed when they become
1771available and not just when the loop is finished and the event loop takes 1781available and not just when the loop is finished and the event loop takes
… …
1780 poll => 'r', async => 1, 1790 poll => 'r', async => 1,
1781 cb => \&IO::AIO::poll_cb); 1791 cb => \&IO::AIO::poll_cb);
1782 1792
1783=item IO::AIO::poll_wait 1793=item IO::AIO::poll_wait
1784 1794
1785If there are any outstanding requests and none of them in the result 1795Wait until either at least one request is in the result phase or no
1786phase, wait till the result filehandle becomes ready for reading (simply 1796requests are outstanding anymore.
1787does a C<select> on the filehandle. This is useful if you want to 1797
1788synchronously wait for some requests to finish). 1798This is useful if you want to synchronously wait for some requests to
1799become ready, without actually handling them.
1789 1800
1790See C<nreqs> for an example. 1801See C<nreqs> for an example.
1791 1802
1792=item IO::AIO::poll 1803=item IO::AIO::poll
1793 1804

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines