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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.224 by root, Sat Apr 7 00:50:33 2012 UTC vs.
Revision 1.240 by root, Mon Dec 17 06:18:39 2012 UTC

…		…
168	use common::sense;	168	use common::sense;
169		169
170	use base 'Exporter';	170	use base 'Exporter';
171		171
172	BEGIN {	172	BEGIN {
173	our $VERSION = '4.14';	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_fallocate	178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate
179	aio_pathsync aio_readahead aio_fiemap	179	aio_pathsync aio_readahead aio_fiemap
180	aio_rename aio_link aio_move aio_copy aio_group	180	aio_rename aio_link aio_move aio_copy aio_group
181	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown	181	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
182	aio_chmod aio_utime aio_truncate	182	aio_chmod aio_utime aio_truncate
183	aio_msync aio_mtouch aio_mlock aio_mlockall	183	aio_msync aio_mtouch aio_mlock aio_mlockall
…		…
202		202
203	=head1 FUNCTIONS	203	=head1 FUNCTIONS
204		204
205	=head2 QUICK OVERVIEW	205	=head2 QUICK OVERVIEW
206		206
207	This section simply lists the prototypes of the most important functions	207	This section simply lists the prototypes most of the functions for
208	for quick reference. See the following sections for function-by-function	208	quick reference. See the following sections for function-by-function
209	documentation.	209	documentation.
210		210
211	aio_wd $pathname, $callback->($wd)	211	aio_wd $pathname, $callback->($wd)
212	aio_open $pathname, $flags, $mode, $callback->($fh)	212	aio_open $pathname, $flags, $mode, $callback->($fh)
213	aio_close $fh, $callback->($status)	213	aio_close $fh, $callback->($status)
…		…
221	aio_statvfs $fh_or_path, $callback->($statvfs)	221	aio_statvfs $fh_or_path, $callback->($statvfs)
222	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	222	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
223	aio_chown $fh_or_path, $uid, $gid, $callback->($status)	223	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
224	aio_chmod $fh_or_path, $mode, $callback->($status)	224	aio_chmod $fh_or_path, $mode, $callback->($status)
225	aio_truncate $fh_or_path, $offset, $callback->($status)	225	aio_truncate $fh_or_path, $offset, $callback->($status)
		226	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		227	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
226	aio_unlink $pathname, $callback->($status)	228	aio_unlink $pathname, $callback->($status)
227	aio_mknod $pathname, $mode, $dev, $callback->($status)	229	aio_mknod $pathname, $mode, $dev, $callback->($status)
228	aio_link $srcpath, $dstpath, $callback->($status)	230	aio_link $srcpath, $dstpath, $callback->($status)
229	aio_symlink $srcpath, $dstpath, $callback->($status)	231	aio_symlink $srcpath, $dstpath, $callback->($status)
230	aio_readlink $pathname, $callback->($link)	232	aio_readlink $pathname, $callback->($link)
…		…
272	IO::AIO::nready	274	IO::AIO::nready
273	IO::AIO::npending	275	IO::AIO::npending
274		276
275	IO::AIO::sendfile $ofh, $ifh, $offset, $count	277	IO::AIO::sendfile $ofh, $ifh, $offset, $count
276	IO::AIO::fadvise $fh, $offset, $len, $advice	278	IO::AIO::fadvise $fh, $offset, $len, $advice
		279	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
		280	IO::AIO::munmap $scalar
277	IO::AIO::madvise $scalar, $offset, $length, $advice	281	IO::AIO::madvise $scalar, $offset, $length, $advice
278	IO::AIO::mprotect $scalar, $offset, $length, $protect	282	IO::AIO::mprotect $scalar, $offset, $length, $protect
279	IO::AIO::munlock $scalar, $offset = 0, $length = undef	283	IO::AIO::munlock $scalar, $offset = 0, $length = undef
280	IO::AIO::munlockall	284	IO::AIO::munlockall
281		285
…		…
358		362
359		363
360	=item aio_open $pathname, $flags, $mode, $callback->($fh)	364	=item aio_open $pathname, $flags, $mode, $callback->($fh)
361		365
362	Asynchronously open or create a file and call the callback with a newly	366	Asynchronously open or create a file and call the callback with a newly
363	created filehandle for the file.	367	created filehandle for the file (or C<undef> in case of an error).
364		368
365	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	369	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
366	for an explanation.	370	for an explanation.
367		371
368	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	372	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
…		…
424	case of an error.	428	case of an error.
425		429
426	In theory, the C<$whence> constants could be different than the	430	In theory, the C<$whence> constants could be different than the
427	corresponding values from L<Fcntl>, but perl guarantees they are the same,	431	corresponding values from L<Fcntl>, but perl guarantees they are the same,
428	so don't panic.	432	so don't panic.
		433
		434	As a GNU/Linux (and maybe Solaris) extension, also the constants
		435	C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
		436	could be found. No guarantees about suitability for use in C<aio_seek> or
		437	Perl's C<sysseek> can be made though, although I would naively assume they
		438	"just work".
429		439
430	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	440	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
431		441
432	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	442	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
433		443
…		…
593	namemax => 255,	603	namemax => 255,
594	frsize => 1024,	604	frsize => 1024,
595	fsid => 1810	605	fsid => 1810
596	}	606	}
597		607
		608	Here is a (likely partial) list of fsid values used by Linux - it is safe
		609	to hardcode these when the $^O is C<linux>:
		610
		611	0x0000adf5 adfs
		612	0x0000adff affs
		613	0x5346414f afs
		614	0x09041934 anon-inode filesystem
		615	0x00000187 autofs
		616	0x42465331 befs
		617	0x1badface bfs
		618	0x42494e4d binfmt_misc
		619	0x9123683e btrfs
		620	0x0027e0eb cgroupfs
		621	0xff534d42 cifs
		622	0x73757245 coda
		623	0x012ff7b7 coh
		624	0x28cd3d45 cramfs
		625	0x453dcd28 cramfs-wend (wrong endianness)
		626	0x64626720 debugfs
		627	0x00001373 devfs
		628	0x00001cd1 devpts
		629	0x0000f15f ecryptfs
		630	0x00414a53 efs
		631	0x0000137d ext
		632	0x0000ef53 ext2/ext3
		633	0x0000ef51 ext2
		634	0x00004006 fat
		635	0x65735546 fuseblk
		636	0x65735543 fusectl
		637	0x0bad1dea futexfs
		638	0x01161970 gfs2
		639	0x47504653 gpfs
		640	0x00004244 hfs
		641	0xf995e849 hpfs
		642	0x958458f6 hugetlbfs
		643	0x2bad1dea inotifyfs
		644	0x00009660 isofs
		645	0x000072b6 jffs2
		646	0x3153464a jfs
		647	0x6b414653 k-afs
		648	0x0bd00bd0 lustre
		649	0x0000137f minix
		650	0x0000138f minix 30 char names
		651	0x00002468 minix v2
		652	0x00002478 minix v2 30 char names
		653	0x00004d5a minix v3
		654	0x19800202 mqueue
		655	0x00004d44 msdos
		656	0x0000564c novell
		657	0x00006969 nfs
		658	0x6e667364 nfsd
		659	0x00003434 nilfs
		660	0x5346544e ntfs
		661	0x00009fa1 openprom
		662	0x7461636F ocfs2
		663	0x00009fa0 proc
		664	0x6165676c pstorefs
		665	0x0000002f qnx4
		666	0x858458f6 ramfs
		667	0x52654973 reiserfs
		668	0x00007275 romfs
		669	0x67596969 rpc_pipefs
		670	0x73636673 securityfs
		671	0xf97cff8c selinux
		672	0x0000517b smb
		673	0x534f434b sockfs
		674	0x73717368 squashfs
		675	0x62656572 sysfs
		676	0x012ff7b6 sysv2
		677	0x012ff7b5 sysv4
		678	0x01021994 tmpfs
		679	0x15013346 udf
		680	0x00011954 ufs
		681	0x54190100 ufs byteswapped
		682	0x00009fa2 usbdevfs
		683	0x01021997 v9fs
		684	0xa501fcf5 vxfs
		685	0xabba1974 xenfs
		686	0x012ff7b4 xenix
		687	0x58465342 xfs
		688	0x012fd16d xia
598		689
599	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	690	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
600		691
601	Works like perl's C<utime> function (including the special case of $atime	692	Works like perl's C<utime> function (including the special case of $atime
602	and $mtime being undef). Fractional times are supported if the underlying	693	and $mtime being undef). Fractional times are supported if the underlying
…		…
630	=item aio_truncate $fh_or_path, $offset, $callback->($status)	721	=item aio_truncate $fh_or_path, $offset, $callback->($status)
631		722
632	Works like truncate(2) or ftruncate(2).	723	Works like truncate(2) or ftruncate(2).
633		724
634		725
		726	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		727
		728	Allocates or freed disk space according to the C<$mode> argument. See the
		729	linux C<fallocate> docuemntation for details.
		730
		731	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 \|
		733	IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
		734
		735	The file system block size used by C<fallocate> is presumably the
		736	C<f_bsize> returned by C<statvfs>.
		737
		738	If C<fallocate> isn't available or cannot be emulated (currently no
		739	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
		740
		741
635	=item aio_chmod $fh_or_path, $mode, $callback->($status)	742	=item aio_chmod $fh_or_path, $mode, $callback->($status)
636		743
637	Works like perl's C<chmod> function.	744	Works like perl's C<chmod> function.
638		745
639		746
…		…
676		783
677		784
678	=item aio_realpath $pathname, $callback->($path)	785	=item aio_realpath $pathname, $callback->($path)
679		786
680	Asynchronously make the path absolute and resolve any symlinks in	787	Asynchronously make the path absolute and resolve any symlinks in
681	C<$path>. The resulting path only consists of directories (Same as	788	C<$path>. The resulting path only consists of directories (same as
682	L<Cwd::realpath>).	789	L<Cwd::realpath>).
683		790
684	This request can be used to get the absolute path of the current working	791	This request can be used to get the absolute path of the current working
685	directory by passing it a path of F<.> (a single dot).	792	directory by passing it a path of F<.> (a single dot).
686		793
…		…
1074	}	1181	}
1075		1182
1076	=item aio_rmtree $pathname, $callback->($status)	1183	=item aio_rmtree $pathname, $callback->($status)
1077		1184
1078	Delete a directory tree starting (and including) C<$path>, return the	1185	Delete a directory tree starting (and including) C<$path>, return the
1079	status of the final C<rmdir> only. This is a composite request that	1186	status of the final C<rmdir> only. This is a composite request that
1080	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1187	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1081	everything else.	1188	everything else.
1082		1189
1083	=cut	1190	=cut
1084		1191
…		…
1204		1311
1205	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1312	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1206	scalars.	1313	scalars.
1207		1314
1208	It touches (reads or writes) all memory pages in the specified	1315	It touches (reads or writes) all memory pages in the specified
1209	range inside the scalar. All caveats and parameters are the same	1316	range inside the scalar. All caveats and parameters are the same
1210	as for C<aio_msync>, above, except for flags, which must be either	1317	as for C<aio_msync>, above, except for flags, which must be either
1211	C<0> (which reads all pages and ensures they are instantiated) or	1318	C<0> (which reads all pages and ensures they are instantiated) or
1212	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and	1319	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1213	writing an octet from it, which dirties the page).	1320	writing an octet from it, which dirties the page).
1214		1321
1215	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1322	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1216		1323
1217	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1324	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
…		…
1251		1358
1252	aio_mlockall IO::AIO::MCL_FUTURE;	1359	aio_mlockall IO::AIO::MCL_FUTURE;
1253		1360
1254	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)	1361	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1255		1362
1256	Queries the extents of the given file (by calling the Linux FIEMAP ioctl,	1363	Queries the extents of the given file (by calling the Linux C<FIEMAP>
1257	see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the	1364	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1258	C<ioctl> is not available on your OS, then this rquiest will fail with	1365	the ioctl is not available on your OS, then this request will fail with
1259	C<ENOSYS>.	1366	C<ENOSYS>.
1260		1367
1261	C<$start> is the starting offset to query extents for, C<$length> is the	1368	C<$start> is the starting offset to query extents for, C<$length> is the
1262	size of the range to query - if it is C<undef>, then the whole file will	1369	size of the range to query - if it is C<undef>, then the whole file will
1263	be queried.	1370	be queried.
…		…
1266	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also	1373	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1267	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query	1374	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1268	the data portion.	1375	the data portion.
1269		1376
1270	C<$count> is the maximum number of extent records to return. If it is	1377	C<$count> is the maximum number of extent records to return. If it is
1271	C<undef>, then IO::AIO queries all extents of the file. As a very special	1378	C<undef>, then IO::AIO queries all extents of the range. As a very special
1272	case, if it is C<0>, then the callback receives the number of extents	1379	case, if it is C<0>, then the callback receives the number of extents
1273	instead of the extents themselves.	1380	instead of the extents themselves (which is unreliable, see below).
1274		1381
1275	If an error occurs, the callback receives no arguments. The special	1382	If an error occurs, the callback receives no arguments. The special
1276	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.	1383	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1277		1384
1278	Otherwise, the callback receives an array reference with extent	1385	Otherwise, the callback receives an array reference with extent
…		…
1280	following members:	1387	following members:
1281		1388
1282	[$logical, $physical, $length, $flags]	1389	[$logical, $physical, $length, $flags]
1283		1390
1284	Flags is any combination of the following flag values (typically either C<0>	1391	Flags is any combination of the following flag values (typically either C<0>
1285	or C<IO::AIO::FIEMAP_EXTENT_LAST>):	1392	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1286		1393
1287	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,	1394	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1288	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,	1395	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1289	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,	1396	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1290	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,	1397	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1291	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or	1398	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1292	C<IO::AIO::FIEMAP_EXTENT_SHARED>.	1399	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1400
		1401	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1402	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1403	it to return all extents of a range for files with large number of
		1404	extents. The code works around all these issues if C<$count> is undef.
1293		1405
1294	=item aio_group $callback->(...)	1406	=item aio_group $callback->(...)
1295		1407
1296	This is a very special aio request: Instead of doing something, it is a	1408	This is a very special aio request: Instead of doing something, it is a
1297	container for other aio requests, which is useful if you want to bundle	1409	container for other aio requests, which is useful if you want to bundle
…		…
1413	will still point to the original directory. Most functions accepting a	1525	will still point to the original directory. Most functions accepting a
1414	pathname will use the directory fd on newer systems, and the string on	1526	pathname will use the directory fd on newer systems, and the string on
1415	older systems. Some functions (such as realpath) will always rely on the	1527	older systems. Some functions (such as realpath) will always rely on the
1416	string form of the pathname.	1528	string form of the pathname.
1417		1529
1418	So this fucntionality is mainly useful to get some protection against	1530	So this functionality is mainly useful to get some protection against
1419	C<chdir>, to easily get an absolute path out of a relative path for future	1531	C<chdir>, to easily get an absolute path out of a relative path for future
1420	reference, and to speed up doing many operations in the same directory	1532	reference, and to speed up doing many operations in the same directory
1421	(e.g. when stat'ing all files in a directory).	1533	(e.g. when stat'ing all files in a directory).
1422		1534
1423	The following functions implement this working directory abstraction:	1535	The following functions implement this working directory abstraction:
…		…
1444	=item IO::AIO::CWD	1556	=item IO::AIO::CWD
1445		1557
1446	This is a compiletime constant (object) that represents the process	1558	This is a compiletime constant (object) that represents the process
1447	current working directory.	1559	current working directory.
1448		1560
1449	Specifying this object as working directory object for a pathname is as	1561	Specifying this object as working directory object for a pathname is as if
1450	if the pathname would be specified directly, without a directory object,	1562	the pathname would be specified directly, without a directory object. For
1451	e.g., these calls are functionally identical:	1563	example, these calls are functionally identical:
1452		1564
1453	aio_stat "somefile", sub { ... };	1565	aio_stat "somefile", sub { ... };
1454	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };	1566	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1455		1567
1456	=back	1568	=back
		1569
		1570	To recover the path associated with an IO::AIO::WD object, you can use
		1571	C<aio_realpath>:
		1572
		1573	aio_realpath $wd, sub {
		1574	warn "path is $_[0]\n";
		1575	};
1457		1576
1458		1577
1459	=head2 IO::AIO::REQ CLASS	1578	=head2 IO::AIO::REQ CLASS
1460		1579
1461	All non-aggregate C<aio_*> functions return an object of this class when	1580	All non-aggregate C<aio_*> functions return an object of this class when
…		…
1640		1759
1641	See C<poll_cb> for an example.	1760	See C<poll_cb> for an example.
1642		1761
1643	=item IO::AIO::poll_cb	1762	=item IO::AIO::poll_cb
1644		1763
1645	Process some outstanding events on the result pipe. You have to call	1764	Process some requests that have reached the result phase (i.e. they have
		1765	been executed but the results are not yet reported). You have to call
		1766	this "regularly" to finish outstanding requests.
		1767
1646	this regularly. Returns C<0> if all events could be processed (or there	1768	Returns C<0> if all events could be processed (or there were no
1647	were no events to process), or C<-1> if it returned earlier for whatever	1769	events to process), or C<-1> if it returned earlier for whatever
1648	reason. Returns immediately when no events are outstanding. The amount of	1770	reason. Returns immediately when no events are outstanding. The amount
1649	events processed depends on the settings of C<IO::AIO::max_poll_req> and	1771	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1650	C<IO::AIO::max_poll_time>.	1772	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1651		1773
1652	If not all requests were processed for whatever reason, the filehandle	1774	If not all requests were processed for whatever reason, the poll file
1653	will still be ready when C<poll_cb> returns, so normally you don't have to	1775	descriptor will still be ready when C<poll_cb> returns, so normally you
1654	do anything special to have it called later.	1776	don't have to do anything special to have it called later.
1655		1777
1656	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes	1778	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1657	ready, it can be beneficial to call this function from loops which submit	1779	ready, it can be beneficial to call this function from loops which submit
1658	a lot of requests, to make sure the results get processed when they become	1780	a lot of requests, to make sure the results get processed when they become
1659	available and not just when the loop is finished and the event loop takes	1781	available and not just when the loop is finished and the event loop takes
…		…
1668	poll => 'r', async => 1,	1790	poll => 'r', async => 1,
1669	cb => \&IO::AIO::poll_cb);	1791	cb => \&IO::AIO::poll_cb);
1670		1792
1671	=item IO::AIO::poll_wait	1793	=item IO::AIO::poll_wait
1672		1794
1673	If there are any outstanding requests and none of them in the result	1795	Wait until either at least one request is in the result phase or no
1674	phase, wait till the result filehandle becomes ready for reading (simply	1796	requests are outstanding anymore.
1675	does a C<select> on the filehandle. This is useful if you want to	1797
1676	synchronously wait for some requests to finish).	1798	This is useful if you want to synchronously wait for some requests to
		1799	become ready, without actually handling them.
1677		1800
1678	See C<nreqs> for an example.	1801	See C<nreqs> for an example.
1679		1802
1680	=item IO::AIO::poll	1803	=item IO::AIO::poll
1681		1804
…		…
1900	ENOSYS, otherwise the return value of C<mprotect>.	2023	ENOSYS, otherwise the return value of C<mprotect>.
1901		2024
1902	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]	2025	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1903		2026
1904	Memory-maps a file (or anonymous memory range) and attaches it to the	2027	Memory-maps a file (or anonymous memory range) and attaches it to the
1905	given C<$scalar>, which will act like a string scalar.	2028	given C<$scalar>, which will act like a string scalar. Returns true on
		2029	success, and false otherwise.
1906		2030
1907	The only operations allowed on the scalar are C<substr>/C<vec> that don't	2031	The only operations allowed on the scalar are C<substr>/C<vec> that don't
1908	change the string length, and most read-only operations such as copying it	2032	change the string length, and most read-only operations such as copying it
1909	or searching it with regexes and so on.	2033	or searching it with regexes and so on.
1910		2034
…		…
1963	Calls the C<munlockall> function.	2087	Calls the C<munlockall> function.
1964		2088
1965	On systems that do not implement C<munlockall>, this function returns	2089	On systems that do not implement C<munlockall>, this function returns
1966	ENOSYS, otherwise the return value of C<munlockall>.	2090	ENOSYS, otherwise the return value of C<munlockall>.
1967		2091
		2092	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		2093
		2094	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		2095	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		2096	should be the file offset.
		2097
		2098	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2099	silently corrupt the data in this case.
		2100
		2101	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		2102	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		2103	C<IO::AIO::SPLICE_F_GIFT>.
		2104
		2105	See the C<splice(2)> manpage for details.
		2106
		2107	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		2108
		2109	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
		2110	description for C<IO::AIO::splice> above for details.
		2111
1968	=back	2112	=back
1969		2113
1970	=cut	2114	=cut
1971		2115
1972	min_parallel 8;	2116	min_parallel 8;

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.224 by root, Sat Apr 7 00:50:33 2012 UTC vs. Revision 1.240 by root, Mon Dec 17 06:18:39 2012 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.224 by root, Sat Apr 7 00:50:33 2012 UTC vs.
Revision 1.240 by root, Mon Dec 17 06:18:39 2012 UTC