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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.225 by root, Tue Apr 10 05:01:33 2012 UTC vs.
Revision 1.242 by root, Sun Jan 6 11:48:13 2013 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.15';	173	our $VERSION = '4.19';
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
…		…
599	namemax => 255,	603	namemax => 255,
600	frsize => 1024,	604	frsize => 1024,
601	fsid => 1810	605	fsid => 1810
602	}	606	}
603		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
604		689
605	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	690	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
606		691
607	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
608	and $mtime being undef). Fractional times are supported if the underlying	693	and $mtime being undef). Fractional times are supported if the underlying
…		…
636	=item aio_truncate $fh_or_path, $offset, $callback->($status)	721	=item aio_truncate $fh_or_path, $offset, $callback->($status)
637		722
638	Works like truncate(2) or ftruncate(2).	723	Works like truncate(2) or ftruncate(2).
639		724
640		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
641	=item aio_chmod $fh_or_path, $mode, $callback->($status)	742	=item aio_chmod $fh_or_path, $mode, $callback->($status)
642		743
643	Works like perl's C<chmod> function.	744	Works like perl's C<chmod> function.
644		745
645		746
…		…
682		783
683		784
684	=item aio_realpath $pathname, $callback->($path)	785	=item aio_realpath $pathname, $callback->($path)
685		786
686	Asynchronously make the path absolute and resolve any symlinks in	787	Asynchronously make the path absolute and resolve any symlinks in
687	C<$path>. The resulting path only consists of directories (Same as	788	C<$path>. The resulting path only consists of directories (same as
688	L<Cwd::realpath>).	789	L<Cwd::realpath>).
689		790
690	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
691	directory by passing it a path of F<.> (a single dot).	792	directory by passing it a path of F<.> (a single dot).
692		793
693		794
694	=item aio_rename $srcpath, $dstpath, $callback->($status)	795	=item aio_rename $srcpath, $dstpath, $callback->($status)
695		796
696	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	797	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
697	rename(2) and call the callback with the result code.	798	rename(2) and call the callback with the result code.
		799
		800	On systems that support the AIO::WD working directory abstraction
		801	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		802	of failing, C<rename> is called on the absolute path of C<$wd>.
698		803
699		804
700	=item aio_mkdir $pathname, $mode, $callback->($status)	805	=item aio_mkdir $pathname, $mode, $callback->($status)
701		806
702	Asynchronously mkdir (create) a directory and call the callback with	807	Asynchronously mkdir (create) a directory and call the callback with
…		…
706		811
707	=item aio_rmdir $pathname, $callback->($status)	812	=item aio_rmdir $pathname, $callback->($status)
708		813
709	Asynchronously rmdir (delete) a directory and call the callback with the	814	Asynchronously rmdir (delete) a directory and call the callback with the
710	result code.	815	result code.
		816
		817	On systems that support the AIO::WD working directory abstraction
		818	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		819	C<rmdir> is called on the absolute path of C<$wd>.
711		820
712		821
713	=item aio_readdir $pathname, $callback->($entries)	822	=item aio_readdir $pathname, $callback->($entries)
714		823
715	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	824	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
…		…
1080	}	1189	}
1081		1190
1082	=item aio_rmtree $pathname, $callback->($status)	1191	=item aio_rmtree $pathname, $callback->($status)
1083		1192
1084	Delete a directory tree starting (and including) C<$path>, return the	1193	Delete a directory tree starting (and including) C<$path>, return the
1085	status of the final C<rmdir> only. This is a composite request that	1194	status of the final C<rmdir> only. This is a composite request that
1086	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1195	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1087	everything else.	1196	everything else.
1088		1197
1089	=cut	1198	=cut
1090		1199
…		…
1210		1319
1211	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1320	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1212	scalars.	1321	scalars.
1213		1322
1214	It touches (reads or writes) all memory pages in the specified	1323	It touches (reads or writes) all memory pages in the specified
1215	range inside the scalar. All caveats and parameters are the same	1324	range inside the scalar. All caveats and parameters are the same
1216	as for C<aio_msync>, above, except for flags, which must be either	1325	as for C<aio_msync>, above, except for flags, which must be either
1217	C<0> (which reads all pages and ensures they are instantiated) or	1326	C<0> (which reads all pages and ensures they are instantiated) or
1218	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and	1327	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1219	writing an octet from it, which dirties the page).	1328	writing an octet from it, which dirties the page).
1220		1329
1221	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1330	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1222		1331
1223	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1332	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
…		…
1257		1366
1258	aio_mlockall IO::AIO::MCL_FUTURE;	1367	aio_mlockall IO::AIO::MCL_FUTURE;
1259		1368
1260	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)	1369	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1261		1370
1262	Queries the extents of the given file (by calling the Linux FIEMAP ioctl,	1371	Queries the extents of the given file (by calling the Linux C<FIEMAP>
1263	see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the	1372	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1264	C<ioctl> is not available on your OS, then this rquiest will fail with	1373	the ioctl is not available on your OS, then this request will fail with
1265	C<ENOSYS>.	1374	C<ENOSYS>.
1266		1375
1267	C<$start> is the starting offset to query extents for, C<$length> is the	1376	C<$start> is the starting offset to query extents for, C<$length> is the
1268	size of the range to query - if it is C<undef>, then the whole file will	1377	size of the range to query - if it is C<undef>, then the whole file will
1269	be queried.	1378	be queried.
…		…
1272	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also	1381	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1273	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query	1382	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1274	the data portion.	1383	the data portion.
1275		1384
1276	C<$count> is the maximum number of extent records to return. If it is	1385	C<$count> is the maximum number of extent records to return. If it is
1277	C<undef>, then IO::AIO queries all extents of the file. As a very special	1386	C<undef>, then IO::AIO queries all extents of the range. As a very special
1278	case, if it is C<0>, then the callback receives the number of extents	1387	case, if it is C<0>, then the callback receives the number of extents
1279	instead of the extents themselves.	1388	instead of the extents themselves (which is unreliable, see below).
1280		1389
1281	If an error occurs, the callback receives no arguments. The special	1390	If an error occurs, the callback receives no arguments. The special
1282	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.	1391	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1283		1392
1284	Otherwise, the callback receives an array reference with extent	1393	Otherwise, the callback receives an array reference with extent
…		…
1286	following members:	1395	following members:
1287		1396
1288	[$logical, $physical, $length, $flags]	1397	[$logical, $physical, $length, $flags]
1289		1398
1290	Flags is any combination of the following flag values (typically either C<0>	1399	Flags is any combination of the following flag values (typically either C<0>
1291	or C<IO::AIO::FIEMAP_EXTENT_LAST>):	1400	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1292		1401
1293	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,	1402	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1294	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,	1403	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1295	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,	1404	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1296	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,	1405	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1297	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or	1406	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1298	C<IO::AIO::FIEMAP_EXTENT_SHARED>.	1407	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1408
		1409	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1410	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1411	it to return all extents of a range for files with large number of
		1412	extents. The code works around all these issues if C<$count> is undef.
1299		1413
1300	=item aio_group $callback->(...)	1414	=item aio_group $callback->(...)
1301		1415
1302	This is a very special aio request: Instead of doing something, it is a	1416	This is a very special aio request: Instead of doing something, it is a
1303	container for other aio requests, which is useful if you want to bundle	1417	container for other aio requests, which is useful if you want to bundle
…		…
1419	will still point to the original directory. Most functions accepting a	1533	will still point to the original directory. Most functions accepting a
1420	pathname will use the directory fd on newer systems, and the string on	1534	pathname will use the directory fd on newer systems, and the string on
1421	older systems. Some functions (such as realpath) will always rely on the	1535	older systems. Some functions (such as realpath) will always rely on the
1422	string form of the pathname.	1536	string form of the pathname.
1423		1537
1424	So this fucntionality is mainly useful to get some protection against	1538	So this functionality is mainly useful to get some protection against
1425	C<chdir>, to easily get an absolute path out of a relative path for future	1539	C<chdir>, to easily get an absolute path out of a relative path for future
1426	reference, and to speed up doing many operations in the same directory	1540	reference, and to speed up doing many operations in the same directory
1427	(e.g. when stat'ing all files in a directory).	1541	(e.g. when stat'ing all files in a directory).
1428		1542
1429	The following functions implement this working directory abstraction:	1543	The following functions implement this working directory abstraction:
…		…
1450	=item IO::AIO::CWD	1564	=item IO::AIO::CWD
1451		1565
1452	This is a compiletime constant (object) that represents the process	1566	This is a compiletime constant (object) that represents the process
1453	current working directory.	1567	current working directory.
1454		1568
1455	Specifying this object as working directory object for a pathname is as	1569	Specifying this object as working directory object for a pathname is as if
1456	if the pathname would be specified directly, without a directory object,	1570	the pathname would be specified directly, without a directory object. For
1457	e.g., these calls are functionally identical:	1571	example, these calls are functionally identical:
1458		1572
1459	aio_stat "somefile", sub { ... };	1573	aio_stat "somefile", sub { ... };
1460	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };	1574	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1461		1575
1462	=back	1576	=back
1463		1577
		1578	To recover the path associated with an IO::AIO::WD object, you can use
		1579	C<aio_realpath>:
		1580
		1581	aio_realpath $wd, sub {
		1582	warn "path is $_[0]\n";
		1583	};
		1584
		1585	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1586	sometimes, fall back to using an absolue path.
1464		1587
1465	=head2 IO::AIO::REQ CLASS	1588	=head2 IO::AIO::REQ CLASS
1466		1589
1467	All non-aggregate C<aio_*> functions return an object of this class when	1590	All non-aggregate C<aio_*> functions return an object of this class when
1468	called in non-void context.	1591	called in non-void context.
…		…
1646		1769
1647	See C<poll_cb> for an example.	1770	See C<poll_cb> for an example.
1648		1771
1649	=item IO::AIO::poll_cb	1772	=item IO::AIO::poll_cb
1650		1773
1651	Process some outstanding events on the result pipe. You have to call	1774	Process some requests that have reached the result phase (i.e. they have
		1775	been executed but the results are not yet reported). You have to call
		1776	this "regularly" to finish outstanding requests.
		1777
1652	this regularly. Returns C<0> if all events could be processed (or there	1778	Returns C<0> if all events could be processed (or there were no
1653	were no events to process), or C<-1> if it returned earlier for whatever	1779	events to process), or C<-1> if it returned earlier for whatever
1654	reason. Returns immediately when no events are outstanding. The amount of	1780	reason. Returns immediately when no events are outstanding. The amount
1655	events processed depends on the settings of C<IO::AIO::max_poll_req> and	1781	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1656	C<IO::AIO::max_poll_time>.	1782	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1657		1783
1658	If not all requests were processed for whatever reason, the filehandle	1784	If not all requests were processed for whatever reason, the poll file
1659	will still be ready when C<poll_cb> returns, so normally you don't have to	1785	descriptor will still be ready when C<poll_cb> returns, so normally you
1660	do anything special to have it called later.	1786	don't have to do anything special to have it called later.
1661		1787
1662	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes	1788	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1663	ready, it can be beneficial to call this function from loops which submit	1789	ready, it can be beneficial to call this function from loops which submit
1664	a lot of requests, to make sure the results get processed when they become	1790	a lot of requests, to make sure the results get processed when they become
1665	available and not just when the loop is finished and the event loop takes	1791	available and not just when the loop is finished and the event loop takes
…		…
1674	poll => 'r', async => 1,	1800	poll => 'r', async => 1,
1675	cb => \&IO::AIO::poll_cb);	1801	cb => \&IO::AIO::poll_cb);
1676		1802
1677	=item IO::AIO::poll_wait	1803	=item IO::AIO::poll_wait
1678		1804
1679	If there are any outstanding requests and none of them in the result	1805	Wait until either at least one request is in the result phase or no
1680	phase, wait till the result filehandle becomes ready for reading (simply	1806	requests are outstanding anymore.
1681	does a C<select> on the filehandle. This is useful if you want to	1807
1682	synchronously wait for some requests to finish).	1808	This is useful if you want to synchronously wait for some requests to
		1809	become ready, without actually handling them.
1683		1810
1684	See C<nreqs> for an example.	1811	See C<nreqs> for an example.
1685		1812
1686	=item IO::AIO::poll	1813	=item IO::AIO::poll
1687		1814
…		…
1906	ENOSYS, otherwise the return value of C<mprotect>.	2033	ENOSYS, otherwise the return value of C<mprotect>.
1907		2034
1908	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]	2035	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1909		2036
1910	Memory-maps a file (or anonymous memory range) and attaches it to the	2037	Memory-maps a file (or anonymous memory range) and attaches it to the
1911	given C<$scalar>, which will act like a string scalar.	2038	given C<$scalar>, which will act like a string scalar. Returns true on
		2039	success, and false otherwise.
1912		2040
1913	The only operations allowed on the scalar are C<substr>/C<vec> that don't	2041	The only operations allowed on the scalar are C<substr>/C<vec> that don't
1914	change the string length, and most read-only operations such as copying it	2042	change the string length, and most read-only operations such as copying it
1915	or searching it with regexes and so on.	2043	or searching it with regexes and so on.
1916		2044
…		…
1975		2103
1976	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or	2104	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
1977	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they	2105	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
1978	should be the file offset.	2106	should be the file offset.
1979		2107
		2108	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2109	silently corrupt the data in this case.
		2110
1980	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,	2111	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
1981	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and	2112	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
1982	C<IO::AIO::SPLICE_F_GIFT>.	2113	C<IO::AIO::SPLICE_F_GIFT>.
1983		2114
1984	See the C<splice(2)> manpage for details.	2115	See the C<splice(2)> manpage for details.

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.225 by root, Tue Apr 10 05:01:33 2012 UTC vs. Revision 1.242 by root, Sun Jan 6 11:48:13 2013 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.225 by root, Tue Apr 10 05:01:33 2012 UTC vs.
Revision 1.242 by root, Sun Jan 6 11:48:13 2013 UTC