[ViewVC] Diff of: cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.238 by root, Thu Oct 11 05:01:56 2012 UTC vs.
Revision 1.249 by root, Wed Jul 30 22:00:04 2014 UTC

…		…
68	=head2 EXAMPLE	68	=head2 EXAMPLE
69		69
70	This is a simple example that uses the EV module and loads	70	This is a simple example that uses the EV module and loads
71	F</etc/passwd> asynchronously:	71	F</etc/passwd> asynchronously:
72		72
73	use Fcntl;
74	use EV;	73	use EV;
75	use IO::AIO;	74	use IO::AIO;
76		75
77	# register the IO::AIO callback with EV	76	# register the IO::AIO callback with EV
78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;	77	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
…		…
168	use common::sense;	167	use common::sense;
169		168
170	use base 'Exporter';	169	use base 'Exporter';
171		170
172	BEGIN {	171	BEGIN {
173	our $VERSION = '4.18';	172	our $VERSION = 4.31;
174		173
175	our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close	174	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	175	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync	176	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate	177	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate
…		…
228	aio_unlink $pathname, $callback->($status)	227	aio_unlink $pathname, $callback->($status)
229	aio_mknod $pathname, $mode, $dev, $callback->($status)	228	aio_mknod $pathname, $mode, $dev, $callback->($status)
230	aio_link $srcpath, $dstpath, $callback->($status)	229	aio_link $srcpath, $dstpath, $callback->($status)
231	aio_symlink $srcpath, $dstpath, $callback->($status)	230	aio_symlink $srcpath, $dstpath, $callback->($status)
232	aio_readlink $pathname, $callback->($link)	231	aio_readlink $pathname, $callback->($link)
233	aio_realpath $pathname, $callback->($link)	232	aio_realpath $pathname, $callback->($path)
234	aio_rename $srcpath, $dstpath, $callback->($status)	233	aio_rename $srcpath, $dstpath, $callback->($status)
235	aio_mkdir $pathname, $mode, $callback->($status)	234	aio_mkdir $pathname, $mode, $callback->($status)
236	aio_rmdir $pathname, $callback->($status)	235	aio_rmdir $pathname, $callback->($status)
237	aio_readdir $pathname, $callback->($entries)	236	aio_readdir $pathname, $callback->($entries)
238	aio_readdirx $pathname, $flags, $callback->($entries, $flags)	237	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
…		…
603	namemax => 255,	602	namemax => 255,
604	frsize => 1024,	603	frsize => 1024,
605	fsid => 1810	604	fsid => 1810
606	}	605	}
607		606
608	Here is a (likely partial) list of fsid values used by Linux - it is safe	607	Here is a (likely partial - send me updates!) list of fsid values used by
609	to hardcode these when the $^O is C<linux>:	608	Linux - it is safe to hardcode these when C<$^O> is C<linux>:
610		609
611	0x0000adf5 adfs	610	0x0000adf5 adfs
612	0x0000adff affs	611	0x0000adff affs
613	0x5346414f afs	612	0x5346414f afs
614	0x09041934 anon-inode filesystem	613	0x09041934 anon-inode filesystem
…		…
723	Works like truncate(2) or ftruncate(2).	722	Works like truncate(2) or ftruncate(2).
724		723
725		724
726	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)	725	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
727		726
728	Allocates or freed disk space according to the C<$mode> argument. See the	727	Allocates or frees disk space according to the C<$mode> argument. See the
729	linux C<fallocate> docuemntation for details.	728	linux C<fallocate> documentation for details.
730		729
731	C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>	730	C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>
732	to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \|	731	to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \|
733	IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.	732	IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
734		733
…		…
783		782
784		783
785	=item aio_realpath $pathname, $callback->($path)	784	=item aio_realpath $pathname, $callback->($path)
786		785
787	Asynchronously make the path absolute and resolve any symlinks in	786	Asynchronously make the path absolute and resolve any symlinks in
788	C<$path>. The resulting path only consists of directories (Same as	787	C<$path>. The resulting path only consists of directories (same as
789	L<Cwd::realpath>).	788	L<Cwd::realpath>).
790		789
791	This request can be used to get the absolute path of the current working	790	This request can be used to get the absolute path of the current working
792	directory by passing it a path of F<.> (a single dot).	791	directory by passing it a path of F<.> (a single dot).
793		792
794		793
795	=item aio_rename $srcpath, $dstpath, $callback->($status)	794	=item aio_rename $srcpath, $dstpath, $callback->($status)
796		795
797	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	796	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
798	rename(2) and call the callback with the result code.	797	rename(2) and call the callback with the result code.
		798
		799	On systems that support the AIO::WD working directory abstraction
		800	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		801	of failing, C<rename> is called on the absolute path of C<$wd>.
799		802
800		803
801	=item aio_mkdir $pathname, $mode, $callback->($status)	804	=item aio_mkdir $pathname, $mode, $callback->($status)
802		805
803	Asynchronously mkdir (create) a directory and call the callback with	806	Asynchronously mkdir (create) a directory and call the callback with
…		…
807		810
808	=item aio_rmdir $pathname, $callback->($status)	811	=item aio_rmdir $pathname, $callback->($status)
809		812
810	Asynchronously rmdir (delete) a directory and call the callback with the	813	Asynchronously rmdir (delete) a directory and call the callback with the
811	result code.	814	result code.
		815
		816	On systems that support the AIO::WD working directory abstraction
		817	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		818	C<rmdir> is called on the absolute path of C<$wd>.
812		819
813		820
814	=item aio_readdir $pathname, $callback->($entries)	821	=item aio_readdir $pathname, $callback->($entries)
815		822
816	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	823	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
…		…
1181	}	1188	}
1182		1189
1183	=item aio_rmtree $pathname, $callback->($status)	1190	=item aio_rmtree $pathname, $callback->($status)
1184		1191
1185	Delete a directory tree starting (and including) C<$path>, return the	1192	Delete a directory tree starting (and including) C<$path>, return the
1186	status of the final C<rmdir> only. This is a composite request that	1193	status of the final C<rmdir> only. This is a composite request that
1187	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1194	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1188	everything else.	1195	everything else.
1189		1196
1190	=cut	1197	=cut
1191		1198
…		…
1311		1318
1312	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1319	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1313	scalars.	1320	scalars.
1314		1321
1315	It touches (reads or writes) all memory pages in the specified	1322	It touches (reads or writes) all memory pages in the specified
1316	range inside the scalar. All caveats and parameters are the same	1323	range inside the scalar. All caveats and parameters are the same
1317	as for C<aio_msync>, above, except for flags, which must be either	1324	as for C<aio_msync>, above, except for flags, which must be either
1318	C<0> (which reads all pages and ensures they are instantiated) or	1325	C<0> (which reads all pages and ensures they are instantiated) or
1319	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and	1326	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1320	writing an octet from it, which dirties the page).	1327	writing an octet from it, which dirties the page).
1321		1328
1322	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1329	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1323		1330
1324	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1331	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
…		…
1525	will still point to the original directory. Most functions accepting a	1532	will still point to the original directory. Most functions accepting a
1526	pathname will use the directory fd on newer systems, and the string on	1533	pathname will use the directory fd on newer systems, and the string on
1527	older systems. Some functions (such as realpath) will always rely on the	1534	older systems. Some functions (such as realpath) will always rely on the
1528	string form of the pathname.	1535	string form of the pathname.
1529		1536
1530	So this fucntionality is mainly useful to get some protection against	1537	So this functionality is mainly useful to get some protection against
1531	C<chdir>, to easily get an absolute path out of a relative path for future	1538	C<chdir>, to easily get an absolute path out of a relative path for future
1532	reference, and to speed up doing many operations in the same directory	1539	reference, and to speed up doing many operations in the same directory
1533	(e.g. when stat'ing all files in a directory).	1540	(e.g. when stat'ing all files in a directory).
1534		1541
1535	The following functions implement this working directory abstraction:	1542	The following functions implement this working directory abstraction:
…		…
1548	passing C<undef> as working directory component of a pathname fails the	1555	passing C<undef> as working directory component of a pathname fails the
1549	request with C<ENOENT>, there is often no need for error checking in the	1556	request with C<ENOENT>, there is often no need for error checking in the
1550	C<aio_wd> callback, as future requests using the value will fail in the	1557	C<aio_wd> callback, as future requests using the value will fail in the
1551	expected way.	1558	expected way.
1552		1559
1553	If this call isn't available because your OS lacks it or it couldn't be
1554	detected, it will be emulated by calling C<fsync> instead.
1555
1556	=item IO::AIO::CWD	1560	=item IO::AIO::CWD
1557		1561
1558	This is a compiletime constant (object) that represents the process	1562	This is a compiletime constant (object) that represents the process
1559	current working directory.	1563	current working directory.
1560		1564
1561	Specifying this object as working directory object for a pathname is as	1565	Specifying this object as working directory object for a pathname is as if
1562	if the pathname would be specified directly, without a directory object,	1566	the pathname would be specified directly, without a directory object. For
1563	e.g., these calls are functionally identical:	1567	example, these calls are functionally identical:
1564		1568
1565	aio_stat "somefile", sub { ... };	1569	aio_stat "somefile", sub { ... };
1566	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };	1570	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1567		1571
1568	=back	1572	=back
1569		1573
		1574	To recover the path associated with an IO::AIO::WD object, you can use
		1575	C<aio_realpath>:
		1576
		1577	aio_realpath $wd, sub {
		1578	warn "path is $_[0]\n";
		1579	};
		1580
		1581	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1582	sometimes, fall back to using an absolue path.
1570		1583
1571	=head2 IO::AIO::REQ CLASS	1584	=head2 IO::AIO::REQ CLASS
1572		1585
1573	All non-aggregate C<aio_*> functions return an object of this class when	1586	All non-aggregate C<aio_*> functions return an object of this class when
1574	called in non-void context.	1587	called in non-void context.
…		…
1752		1765
1753	See C<poll_cb> for an example.	1766	See C<poll_cb> for an example.
1754		1767
1755	=item IO::AIO::poll_cb	1768	=item IO::AIO::poll_cb
1756		1769
1757	Process some outstanding events on the result pipe. You have to call	1770	Process some requests that have reached the result phase (i.e. they have
		1771	been executed but the results are not yet reported). You have to call
		1772	this "regularly" to finish outstanding requests.
		1773
1758	this regularly. Returns C<0> if all events could be processed (or there	1774	Returns C<0> if all events could be processed (or there were no
1759	were no events to process), or C<-1> if it returned earlier for whatever	1775	events to process), or C<-1> if it returned earlier for whatever
1760	reason. Returns immediately when no events are outstanding. The amount of	1776	reason. Returns immediately when no events are outstanding. The amount
1761	events processed depends on the settings of C<IO::AIO::max_poll_req> and	1777	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1762	C<IO::AIO::max_poll_time>.	1778	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1763		1779
1764	If not all requests were processed for whatever reason, the filehandle	1780	If not all requests were processed for whatever reason, the poll file
1765	will still be ready when C<poll_cb> returns, so normally you don't have to	1781	descriptor will still be ready when C<poll_cb> returns, so normally you
1766	do anything special to have it called later.	1782	don't have to do anything special to have it called later.
1767		1783
1768	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes	1784	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1769	ready, it can be beneficial to call this function from loops which submit	1785	ready, it can be beneficial to call this function from loops which submit
1770	a lot of requests, to make sure the results get processed when they become	1786	a lot of requests, to make sure the results get processed when they become
1771	available and not just when the loop is finished and the event loop takes	1787	available and not just when the loop is finished and the event loop takes
…		…
1780	poll => 'r', async => 1,	1796	poll => 'r', async => 1,
1781	cb => \&IO::AIO::poll_cb);	1797	cb => \&IO::AIO::poll_cb);
1782		1798
1783	=item IO::AIO::poll_wait	1799	=item IO::AIO::poll_wait
1784		1800
1785	If there are any outstanding requests and none of them in the result	1801	Wait until either at least one request is in the result phase or no
1786	phase, wait till the result filehandle becomes ready for reading (simply	1802	requests are outstanding anymore.
1787	does a C<select> on the filehandle. This is useful if you want to	1803
1788	synchronously wait for some requests to finish).	1804	This is useful if you want to synchronously wait for some requests to
		1805	become ready, without actually handling them.
1789		1806
1790	See C<nreqs> for an example.	1807	See C<nreqs> for an example.
1791		1808
1792	=item IO::AIO::poll	1809	=item IO::AIO::poll
1793		1810
…		…
1914		1931
1915	This is a very bad function to use in interactive programs because it	1932	This is a very bad function to use in interactive programs because it
1916	blocks, and a bad way to reduce concurrency because it is inexact: Better	1933	blocks, and a bad way to reduce concurrency because it is inexact: Better
1917	use an C<aio_group> together with a feed callback.	1934	use an C<aio_group> together with a feed callback.
1918		1935
1919	It's main use is in scripts without an event loop - when you want to stat	1936	Its main use is in scripts without an event loop - when you want to stat
1920	a lot of files, you can write somehting like this:	1937	a lot of files, you can write somehting like this:
1921		1938
1922	IO::AIO::max_outstanding 32;	1939	IO::AIO::max_outstanding 32;
1923		1940
1924	for my $path (...) {	1941	for my $path (...) {
…		…
1964		1981
1965	=back	1982	=back
1966		1983
1967	=head3 MISCELLANEOUS FUNCTIONS	1984	=head3 MISCELLANEOUS FUNCTIONS
1968		1985
1969	IO::AIO implements some functions that might be useful, but are not	1986	IO::AIO implements some functions that are useful when you want to use
1970	asynchronous.	1987	some "Advanced I/O" function not available to in Perl, without going the
		1988	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
		1989	counterpart.
1971		1990
1972	=over 4	1991	=over 4
1973		1992
1974	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	1993	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1975		1994
…		…
2093		2112
2094	See the C<splice(2)> manpage for details.	2113	See the C<splice(2)> manpage for details.
2095		2114
2096	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags	2115	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2097		2116
2098	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the	2117	Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
2099	description for C<IO::AIO::splice> above for details.	2118	description for C<IO::AIO::splice> above for details.
		2119
		2120	=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		2121
		2122	Attempts to query or change the pipe buffer size. Obviously works only
		2123	on pipes, and currently works only on GNU/Linux systems, and fails with
		2124	C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
		2125	size on other systems, drop me a note.
2100		2126
2101	=back	2127	=back
2102		2128
2103	=cut	2129	=cut
2104		2130

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.238 by root, Thu Oct 11 05:01:56 2012 UTC vs. Revision 1.249 by root, Wed Jul 30 22:00:04 2014 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.238 by root, Thu Oct 11 05:01:56 2012 UTC vs.
Revision 1.249 by root, Wed Jul 30 22:00:04 2014 UTC