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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.229 by root, Wed Jul 25 16:32:30 2012 UTC vs.
Revision 1.250 by root, Mon Aug 18 04:26:02 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.15';	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_fallocate	177	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate
179	aio_pathsync aio_readahead aio_fiemap	178	aio_pathsync aio_readahead aio_fiemap
180	aio_rename aio_link aio_move aio_copy aio_group	179	aio_rename aio_link aio_move aio_copy aio_group
181	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown	180	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
182	aio_chmod aio_utime aio_truncate	181	aio_chmod aio_utime aio_truncate
183	aio_msync aio_mtouch aio_mlock aio_mlockall	182	aio_msync aio_mtouch aio_mlock aio_mlockall
…		…
202		201
203	=head1 FUNCTIONS	202	=head1 FUNCTIONS
204		203
205	=head2 QUICK OVERVIEW	204	=head2 QUICK OVERVIEW
206		205
207	This section simply lists the prototypes of the most important functions	206	This section simply lists the prototypes most of the functions for
208	for quick reference. See the following sections for function-by-function	207	quick reference. See the following sections for function-by-function
209	documentation.	208	documentation.
210		209
211	aio_wd $pathname, $callback->($wd)	210	aio_wd $pathname, $callback->($wd)
212	aio_open $pathname, $flags, $mode, $callback->($fh)	211	aio_open $pathname, $flags, $mode, $callback->($fh)
213	aio_close $fh, $callback->($status)	212	aio_close $fh, $callback->($status)
…		…
222	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	221	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
223	aio_chown $fh_or_path, $uid, $gid, $callback->($status)	222	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
224	aio_chmod $fh_or_path, $mode, $callback->($status)	223	aio_chmod $fh_or_path, $mode, $callback->($status)
225	aio_truncate $fh_or_path, $offset, $callback->($status)	224	aio_truncate $fh_or_path, $offset, $callback->($status)
226	aio_allocate $fh, $mode, $offset, $len, $callback->($status)	225	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		226	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
227	aio_unlink $pathname, $callback->($status)	227	aio_unlink $pathname, $callback->($status)
228	aio_mknod $pathname, $mode, $dev, $callback->($status)	228	aio_mknod $pathname, $mode, $dev, $callback->($status)
229	aio_link $srcpath, $dstpath, $callback->($status)	229	aio_link $srcpath, $dstpath, $callback->($status)
230	aio_symlink $srcpath, $dstpath, $callback->($status)	230	aio_symlink $srcpath, $dstpath, $callback->($status)
231	aio_readlink $pathname, $callback->($link)	231	aio_readlink $pathname, $callback->($link)
232	aio_realpath $pathname, $callback->($link)	232	aio_realpath $pathname, $callback->($path)
233	aio_rename $srcpath, $dstpath, $callback->($status)	233	aio_rename $srcpath, $dstpath, $callback->($status)
234	aio_mkdir $pathname, $mode, $callback->($status)	234	aio_mkdir $pathname, $mode, $callback->($status)
235	aio_rmdir $pathname, $callback->($status)	235	aio_rmdir $pathname, $callback->($status)
236	aio_readdir $pathname, $callback->($entries)	236	aio_readdir $pathname, $callback->($entries)
237	aio_readdirx $pathname, $flags, $callback->($entries, $flags)	237	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
…		…
361		361
362		362
363	=item aio_open $pathname, $flags, $mode, $callback->($fh)	363	=item aio_open $pathname, $flags, $mode, $callback->($fh)
364		364
365	Asynchronously open or create a file and call the callback with a newly	365	Asynchronously open or create a file and call the callback with a newly
366	created filehandle for the file.	366	created filehandle for the file (or C<undef> in case of an error).
367		367
368	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	368	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
369	for an explanation.	369	for an explanation.
370		370
371	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	371	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
…		…
602	namemax => 255,	602	namemax => 255,
603	frsize => 1024,	603	frsize => 1024,
604	fsid => 1810	604	fsid => 1810
605	}	605	}
606		606
		607	Here is a (likely partial - send me updates!) list of fsid values used by
		608	Linux - it is safe to hardcode these when C<$^O> is C<linux>:
		609
		610	0x0000adf5 adfs
		611	0x0000adff affs
		612	0x5346414f afs
		613	0x09041934 anon-inode filesystem
		614	0x00000187 autofs
		615	0x42465331 befs
		616	0x1badface bfs
		617	0x42494e4d binfmt_misc
		618	0x9123683e btrfs
		619	0x0027e0eb cgroupfs
		620	0xff534d42 cifs
		621	0x73757245 coda
		622	0x012ff7b7 coh
		623	0x28cd3d45 cramfs
		624	0x453dcd28 cramfs-wend (wrong endianness)
		625	0x64626720 debugfs
		626	0x00001373 devfs
		627	0x00001cd1 devpts
		628	0x0000f15f ecryptfs
		629	0x00414a53 efs
		630	0x0000137d ext
		631	0x0000ef53 ext2/ext3
		632	0x0000ef51 ext2
		633	0x00004006 fat
		634	0x65735546 fuseblk
		635	0x65735543 fusectl
		636	0x0bad1dea futexfs
		637	0x01161970 gfs2
		638	0x47504653 gpfs
		639	0x00004244 hfs
		640	0xf995e849 hpfs
		641	0x958458f6 hugetlbfs
		642	0x2bad1dea inotifyfs
		643	0x00009660 isofs
		644	0x000072b6 jffs2
		645	0x3153464a jfs
		646	0x6b414653 k-afs
		647	0x0bd00bd0 lustre
		648	0x0000137f minix
		649	0x0000138f minix 30 char names
		650	0x00002468 minix v2
		651	0x00002478 minix v2 30 char names
		652	0x00004d5a minix v3
		653	0x19800202 mqueue
		654	0x00004d44 msdos
		655	0x0000564c novell
		656	0x00006969 nfs
		657	0x6e667364 nfsd
		658	0x00003434 nilfs
		659	0x5346544e ntfs
		660	0x00009fa1 openprom
		661	0x7461636F ocfs2
		662	0x00009fa0 proc
		663	0x6165676c pstorefs
		664	0x0000002f qnx4
		665	0x858458f6 ramfs
		666	0x52654973 reiserfs
		667	0x00007275 romfs
		668	0x67596969 rpc_pipefs
		669	0x73636673 securityfs
		670	0xf97cff8c selinux
		671	0x0000517b smb
		672	0x534f434b sockfs
		673	0x73717368 squashfs
		674	0x62656572 sysfs
		675	0x012ff7b6 sysv2
		676	0x012ff7b5 sysv4
		677	0x01021994 tmpfs
		678	0x15013346 udf
		679	0x00011954 ufs
		680	0x54190100 ufs byteswapped
		681	0x00009fa2 usbdevfs
		682	0x01021997 v9fs
		683	0xa501fcf5 vxfs
		684	0xabba1974 xenfs
		685	0x012ff7b4 xenix
		686	0x58465342 xfs
		687	0x012fd16d xia
607		688
608	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	689	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
609		690
610	Works like perl's C<utime> function (including the special case of $atime	691	Works like perl's C<utime> function (including the special case of $atime
611	and $mtime being undef). Fractional times are supported if the underlying	692	and $mtime being undef). Fractional times are supported if the underlying
…		…
641	Works like truncate(2) or ftruncate(2).	722	Works like truncate(2) or ftruncate(2).
642		723
643		724
644	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)	725	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
645		726
646	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
647	linux C<fallocate> docuemntation for details.	728	linux C<fallocate> documentation for details.
648		729
649	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>
650	to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \|	731	to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \|
651	IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.	732	IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
652		733
…		…
701		782
702		783
703	=item aio_realpath $pathname, $callback->($path)	784	=item aio_realpath $pathname, $callback->($path)
704		785
705	Asynchronously make the path absolute and resolve any symlinks in	786	Asynchronously make the path absolute and resolve any symlinks in
706	C<$path>. The resulting path only consists of directories (Same as	787	C<$path>. The resulting path only consists of directories (same as
707	L<Cwd::realpath>).	788	L<Cwd::realpath>).
708		789
709	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
710	directory by passing it a path of F<.> (a single dot).	791	directory by passing it a path of F<.> (a single dot).
711		792
712		793
713	=item aio_rename $srcpath, $dstpath, $callback->($status)	794	=item aio_rename $srcpath, $dstpath, $callback->($status)
714		795
715	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
716	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>.
717		802
718		803
719	=item aio_mkdir $pathname, $mode, $callback->($status)	804	=item aio_mkdir $pathname, $mode, $callback->($status)
720		805
721	Asynchronously mkdir (create) a directory and call the callback with	806	Asynchronously mkdir (create) a directory and call the callback with
…		…
725		810
726	=item aio_rmdir $pathname, $callback->($status)	811	=item aio_rmdir $pathname, $callback->($status)
727		812
728	Asynchronously rmdir (delete) a directory and call the callback with the	813	Asynchronously rmdir (delete) a directory and call the callback with the
729	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>.
730		819
731		820
732	=item aio_readdir $pathname, $callback->($entries)	821	=item aio_readdir $pathname, $callback->($entries)
733		822
734	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
…		…
1099	}	1188	}
1100		1189
1101	=item aio_rmtree $pathname, $callback->($status)	1190	=item aio_rmtree $pathname, $callback->($status)
1102		1191
1103	Delete a directory tree starting (and including) C<$path>, return the	1192	Delete a directory tree starting (and including) C<$path>, return the
1104	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
1105	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
1106	everything else.	1195	everything else.
1107		1196
1108	=cut	1197	=cut
1109		1198
…		…
1229		1318
1230	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
1231	scalars.	1320	scalars.
1232		1321
1233	It touches (reads or writes) all memory pages in the specified	1322	It touches (reads or writes) all memory pages in the specified
1234	range inside the scalar. All caveats and parameters are the same	1323	range inside the scalar. All caveats and parameters are the same
1235	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
1236	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
1237	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
1238	writing an octet from it, which dirties the page).	1327	writing an octet from it, which dirties the page).
1239		1328
1240	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1329	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1241		1330
1242	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
…		…
1276		1365
1277	aio_mlockall IO::AIO::MCL_FUTURE;	1366	aio_mlockall IO::AIO::MCL_FUTURE;
1278		1367
1279	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)	1368	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1280		1369
1281	Queries the extents of the given file (by calling the Linux FIEMAP ioctl,	1370	Queries the extents of the given file (by calling the Linux C<FIEMAP>
1282	see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the	1371	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1283	C<ioctl> is not available on your OS, then this rquiest will fail with	1372	the ioctl is not available on your OS, then this request will fail with
1284	C<ENOSYS>.	1373	C<ENOSYS>.
1285		1374
1286	C<$start> is the starting offset to query extents for, C<$length> is the	1375	C<$start> is the starting offset to query extents for, C<$length> is the
1287	size of the range to query - if it is C<undef>, then the whole file will	1376	size of the range to query - if it is C<undef>, then the whole file will
1288	be queried.	1377	be queried.
…		…
1291	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also	1380	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1292	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query	1381	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1293	the data portion.	1382	the data portion.
1294		1383
1295	C<$count> is the maximum number of extent records to return. If it is	1384	C<$count> is the maximum number of extent records to return. If it is
1296	C<undef>, then IO::AIO queries all extents of the file. As a very special	1385	C<undef>, then IO::AIO queries all extents of the range. As a very special
1297	case, if it is C<0>, then the callback receives the number of extents	1386	case, if it is C<0>, then the callback receives the number of extents
1298	instead of the extents themselves.	1387	instead of the extents themselves (which is unreliable, see below).
1299		1388
1300	If an error occurs, the callback receives no arguments. The special	1389	If an error occurs, the callback receives no arguments. The special
1301	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.	1390	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1302		1391
1303	Otherwise, the callback receives an array reference with extent	1392	Otherwise, the callback receives an array reference with extent
…		…
1305	following members:	1394	following members:
1306		1395
1307	[$logical, $physical, $length, $flags]	1396	[$logical, $physical, $length, $flags]
1308		1397
1309	Flags is any combination of the following flag values (typically either C<0>	1398	Flags is any combination of the following flag values (typically either C<0>
1310	or C<IO::AIO::FIEMAP_EXTENT_LAST>):	1399	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1311		1400
1312	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,	1401	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1313	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,	1402	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1314	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,	1403	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1315	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,	1404	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1316	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or	1405	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1317	C<IO::AIO::FIEMAP_EXTENT_SHARED>.	1406	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1318		1407
		1408	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1409	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1410	it to return all extents of a range for files with large number of
		1411	extents. The code works around all these issues if C<$count> is undef.
		1412
1319	=item aio_group $callback->(...)	1413	=item aio_group $callback->(...)
1320		1414
1321	This is a very special aio request: Instead of doing something, it is a	1415	This is a very special aio request: Instead of doing something, it is a
1322	container for other aio requests, which is useful if you want to bundle	1416	container for other aio requests, which is useful if you want to bundle
1323	many requests into a single, composite, request with a definite callback	1417	many requests into a single, composite, request with a definite callback
…		…
1406	aio_stat [$etcdir, "passwd"], sub {	1500	aio_stat [$etcdir, "passwd"], sub {
1407	# yay	1501	# yay
1408	};	1502	};
1409	};	1503	};
1410		1504
1411	That C<aio_wd> is a request and not a normal function shows that creating	1505	The fact that C<aio_wd> is a request and not a normal function shows that
1412	an IO::AIO::WD object is itself a potentially blocking operation, which is	1506	creating an IO::AIO::WD object is itself a potentially blocking operation,
1413	why it is done asynchronously.	1507	which is why it is done asynchronously.
1414		1508
1415	To stat the directory obtained with C<aio_wd> above, one could write	1509	To stat the directory obtained with C<aio_wd> above, one could write
1416	either of the following three request calls:	1510	either of the following three request calls:
1417		1511
1418	aio_lstat "/etc" , sub { ... # pathname as normal string	1512	aio_lstat "/etc" , sub { ... # pathname as normal string
…		…
1438	will still point to the original directory. Most functions accepting a	1532	will still point to the original directory. Most functions accepting a
1439	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
1440	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
1441	string form of the pathname.	1535	string form of the pathname.
1442		1536
1443	So this fucntionality is mainly useful to get some protection against	1537	So this functionality is mainly useful to get some protection against
1444	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
1445	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
1446	(e.g. when stat'ing all files in a directory).	1540	(e.g. when stat'ing all files in a directory).
1447		1541
1448	The following functions implement this working directory abstraction:	1542	The following functions implement this working directory abstraction:
…		…
1461	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
1462	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
1463	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
1464	expected way.	1558	expected way.
1465		1559
1466	If this call isn't available because your OS lacks it or it couldn't be
1467	detected, it will be emulated by calling C<fsync> instead.
1468
1469	=item IO::AIO::CWD	1560	=item IO::AIO::CWD
1470		1561
1471	This is a compiletime constant (object) that represents the process	1562	This is a compiletime constant (object) that represents the process
1472	current working directory.	1563	current working directory.
1473		1564
1474	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
1475	if the pathname would be specified directly, without a directory object,	1566	the pathname would be specified directly, without a directory object. For
1476	e.g., these calls are functionally identical:	1567	example, these calls are functionally identical:
1477		1568
1478	aio_stat "somefile", sub { ... };	1569	aio_stat "somefile", sub { ... };
1479	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };	1570	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1480		1571
1481	=back	1572	=back
1482		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.
1483		1583
1484	=head2 IO::AIO::REQ CLASS	1584	=head2 IO::AIO::REQ CLASS
1485		1585
1486	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
1487	called in non-void context.	1587	called in non-void context.
…		…
1665		1765
1666	See C<poll_cb> for an example.	1766	See C<poll_cb> for an example.
1667		1767
1668	=item IO::AIO::poll_cb	1768	=item IO::AIO::poll_cb
1669		1769
1670	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
1671	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
1672	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
1673	reason. Returns immediately when no events are outstanding. The amount of	1776	reason. Returns immediately when no events are outstanding. The amount
1674	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>,
1675	C<IO::AIO::max_poll_time>.	1778	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1676		1779
1677	If not all requests were processed for whatever reason, the filehandle	1780	If not all requests were processed for whatever reason, the poll file
1678	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
1679	do anything special to have it called later.	1782	don't have to do anything special to have it called later.
1680		1783
1681	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
1682	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
1683	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
1684	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
…		…
1693	poll => 'r', async => 1,	1796	poll => 'r', async => 1,
1694	cb => \&IO::AIO::poll_cb);	1797	cb => \&IO::AIO::poll_cb);
1695		1798
1696	=item IO::AIO::poll_wait	1799	=item IO::AIO::poll_wait
1697		1800
1698	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
1699	phase, wait till the result filehandle becomes ready for reading (simply	1802	requests are outstanding anymore.
1700	does a C<select> on the filehandle. This is useful if you want to	1803
1701	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.
1702		1806
1703	See C<nreqs> for an example.	1807	See C<nreqs> for an example.
1704		1808
1705	=item IO::AIO::poll	1809	=item IO::AIO::poll
1706		1810
…		…
1827		1931
1828	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
1829	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
1830	use an C<aio_group> together with a feed callback.	1934	use an C<aio_group> together with a feed callback.
1831		1935
1832	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
1833	a lot of files, you can write somehting like this:	1937	a lot of files, you can write somehting like this:
1834		1938
1835	IO::AIO::max_outstanding 32;	1939	IO::AIO::max_outstanding 32;
1836		1940
1837	for my $path (...) {	1941	for my $path (...) {
…		…
1877		1981
1878	=back	1982	=back
1879		1983
1880	=head3 MISCELLANEOUS FUNCTIONS	1984	=head3 MISCELLANEOUS FUNCTIONS
1881		1985
1882	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
1883	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.
1884		1990
1885	=over 4	1991	=over 4
1886		1992
1887	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	1993	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1888		1994
…		…
2006		2112
2007	See the C<splice(2)> manpage for details.	2113	See the C<splice(2)> manpage for details.
2008		2114
2009	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags	2115	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2010		2116
2011	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
2012	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.
2013		2126
2014	=back	2127	=back
2015		2128
2016	=cut	2129	=cut
2017		2130

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.229 by root, Wed Jul 25 16:32:30 2012 UTC vs. Revision 1.250 by root, Mon Aug 18 04:26:02 2014 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.229 by root, Wed Jul 25 16:32:30 2012 UTC vs.
Revision 1.250 by root, Mon Aug 18 04:26:02 2014 UTC