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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.239 by root, Thu Dec 13 02:26:28 2012 UTC vs.
Revision 1.248 by root, Sun Jul 27 22:10:53 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
…		…
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
…		…
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.
799		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>.
		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
804	the result code. C<$mode> will be modified by the umask at the time the	807	the result code. C<$mode> will be modified by the umask at the time the
…		…
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
…		…
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
…		…
1572		1576
1573	aio_realpath $wd, sub {	1577	aio_realpath $wd, sub {
1574	warn "path is $_[0]\n";	1578	warn "path is $_[0]\n";
1575	};	1579	};
1576		1580
		1581	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1582	sometimes, fall back to using an absolue path.
1577		1583
1578	=head2 IO::AIO::REQ CLASS	1584	=head2 IO::AIO::REQ CLASS
1579		1585
1580	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
1581	called in non-void context.	1587	called in non-void context.
…		…
1759		1765
1760	See C<poll_cb> for an example.	1766	See C<poll_cb> for an example.
1761		1767
1762	=item IO::AIO::poll_cb	1768	=item IO::AIO::poll_cb
1763		1769
1764	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
1765	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
1766	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
1767	reason. Returns immediately when no events are outstanding. The amount of	1776	reason. Returns immediately when no events are outstanding. The amount
1768	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>,
1769	C<IO::AIO::max_poll_time>.	1778	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1770		1779
1771	If not all requests were processed for whatever reason, the filehandle	1780	If not all requests were processed for whatever reason, the poll file
1772	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
1773	do anything special to have it called later.	1782	don't have to do anything special to have it called later.
1774		1783
1775	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
1776	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
1777	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
1778	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
…		…
1787	poll => 'r', async => 1,	1796	poll => 'r', async => 1,
1788	cb => \&IO::AIO::poll_cb);	1797	cb => \&IO::AIO::poll_cb);
1789		1798
1790	=item IO::AIO::poll_wait	1799	=item IO::AIO::poll_wait
1791		1800
1792	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
1793	phase, wait till the result filehandle becomes ready for reading (simply	1802	requests are outstanding anymore.
1794	does a C<select> on the filehandle. This is useful if you want to	1803
1795	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.
1796		1806
1797	See C<nreqs> for an example.	1807	See C<nreqs> for an example.
1798		1808
1799	=item IO::AIO::poll	1809	=item IO::AIO::poll
1800		1810
…		…
1921		1931
1922	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
1923	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
1924	use an C<aio_group> together with a feed callback.	1934	use an C<aio_group> together with a feed callback.
1925		1935
1926	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
1927	a lot of files, you can write somehting like this:	1937	a lot of files, you can write somehting like this:
1928		1938
1929	IO::AIO::max_outstanding 32;	1939	IO::AIO::max_outstanding 32;
1930		1940
1931	for my $path (...) {	1941	for my $path (...) {
…		…
1971		1981
1972	=back	1982	=back
1973		1983
1974	=head3 MISCELLANEOUS FUNCTIONS	1984	=head3 MISCELLANEOUS FUNCTIONS
1975		1985
1976	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
1977	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.
1978		1990
1979	=over 4	1991	=over 4
1980		1992
1981	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	1993	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1982		1994
…		…
2100		2112
2101	See the C<splice(2)> manpage for details.	2113	See the C<splice(2)> manpage for details.
2102		2114
2103	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags	2115	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2104		2116
2105	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
2106	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.
2107		2126
2108	=back	2127	=back
2109		2128
2110	=cut	2129	=cut
2111		2130

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.239 by root, Thu Dec 13 02:26:28 2012 UTC vs. Revision 1.248 by root, Sun Jul 27 22:10:53 2014 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.239 by root, Thu Dec 13 02:26:28 2012 UTC vs.
Revision 1.248 by root, Sun Jul 27 22:10:53 2014 UTC