[ViewVC] Diff of: cvs/IO-AIO/README

Comparing IO-AIO/README (file contents):
Revision 1.51 by root, Sat Apr 7 00:50:33 2012 UTC vs.
Revision 1.55 by root, Sat Jan 25 00:15:52 2014 UTC

…		…
64		64
65	EXAMPLE	65	EXAMPLE
66	This is a simple example that uses the EV module and loads /etc/passwd	66	This is a simple example that uses the EV module and loads /etc/passwd
67	asynchronously:	67	asynchronously:
68		68
69	use Fcntl;
70	use EV;	69	use EV;
71	use IO::AIO;	70	use IO::AIO;
72		71
73	# register the IO::AIO callback with EV	72	# register the IO::AIO callback with EV
74	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;	73	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
…		…
146	the actual aio request is severed and calling its methods will	145	the actual aio request is severed and calling its methods will
147	either do nothing or result in a runtime error).	146	either do nothing or result in a runtime error).
148		147
149	FUNCTIONS	148	FUNCTIONS
150	QUICK OVERVIEW	149	QUICK OVERVIEW
151	This section simply lists the prototypes of the most important functions	150	This section simply lists the prototypes most of the functions for quick
152	for quick reference. See the following sections for function-by-function	151	reference. See the following sections for function-by-function
153	documentation.	152	documentation.
154		153
155	aio_wd $pathname, $callback->($wd)	154	aio_wd $pathname, $callback->($wd)
156	aio_open $pathname, $flags, $mode, $callback->($fh)	155	aio_open $pathname, $flags, $mode, $callback->($fh)
157	aio_close $fh, $callback->($status)	156	aio_close $fh, $callback->($status)
…		…
165	aio_statvfs $fh_or_path, $callback->($statvfs)	164	aio_statvfs $fh_or_path, $callback->($statvfs)
166	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	165	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
167	aio_chown $fh_or_path, $uid, $gid, $callback->($status)	166	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
168	aio_chmod $fh_or_path, $mode, $callback->($status)	167	aio_chmod $fh_or_path, $mode, $callback->($status)
169	aio_truncate $fh_or_path, $offset, $callback->($status)	168	aio_truncate $fh_or_path, $offset, $callback->($status)
		169	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		170	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
170	aio_unlink $pathname, $callback->($status)	171	aio_unlink $pathname, $callback->($status)
171	aio_mknod $pathname, $mode, $dev, $callback->($status)	172	aio_mknod $pathname, $mode, $dev, $callback->($status)
172	aio_link $srcpath, $dstpath, $callback->($status)	173	aio_link $srcpath, $dstpath, $callback->($status)
173	aio_symlink $srcpath, $dstpath, $callback->($status)	174	aio_symlink $srcpath, $dstpath, $callback->($status)
174	aio_readlink $pathname, $callback->($link)	175	aio_readlink $pathname, $callback->($link)
…		…
216	IO::AIO::nready	217	IO::AIO::nready
217	IO::AIO::npending	218	IO::AIO::npending
218		219
219	IO::AIO::sendfile $ofh, $ifh, $offset, $count	220	IO::AIO::sendfile $ofh, $ifh, $offset, $count
220	IO::AIO::fadvise $fh, $offset, $len, $advice	221	IO::AIO::fadvise $fh, $offset, $len, $advice
		222	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
		223	IO::AIO::munmap $scalar
221	IO::AIO::madvise $scalar, $offset, $length, $advice	224	IO::AIO::madvise $scalar, $offset, $length, $advice
222	IO::AIO::mprotect $scalar, $offset, $length, $protect	225	IO::AIO::mprotect $scalar, $offset, $length, $protect
223	IO::AIO::munlock $scalar, $offset = 0, $length = undef	226	IO::AIO::munlock $scalar, $offset = 0, $length = undef
224	IO::AIO::munlockall	227	IO::AIO::munlockall
225		228
…		…
293	Similar to "aioreq_pri", but subtracts the given value from the	296	Similar to "aioreq_pri", but subtracts the given value from the
294	current priority, so the effect is cumulative.	297	current priority, so the effect is cumulative.
295		298
296	aio_open $pathname, $flags, $mode, $callback->($fh)	299	aio_open $pathname, $flags, $mode, $callback->($fh)
297	Asynchronously open or create a file and call the callback with a	300	Asynchronously open or create a file and call the callback with a
298	newly created filehandle for the file.	301	newly created filehandle for the file (or "undef" in case of an
		302	error).
299		303
300	The pathname passed to "aio_open" must be absolute. See API NOTES,	304	The pathname passed to "aio_open" must be absolute. See API NOTES,
301	above, for an explanation.	305	above, for an explanation.
302		306
303	The $flags argument is a bitmask. See the "Fcntl" module for a list.	307	The $flags argument is a bitmask. See the "Fcntl" module for a list.
…		…
355	in case of an error.	359	in case of an error.
356		360
357	In theory, the $whence constants could be different than the	361	In theory, the $whence constants could be different than the
358	corresponding values from Fcntl, but perl guarantees they are the	362	corresponding values from Fcntl, but perl guarantees they are the
359	same, so don't panic.	363	same, so don't panic.
		364
		365	As a GNU/Linux (and maybe Solaris) extension, also the constants
		366	"IO::AIO::SEEK_DATA" and "IO::AIO::SEEK_HOLE" are available, if they
		367	could be found. No guarantees about suitability for use in
		368	"aio_seek" or Perl's "sysseek" can be made though, although I would
		369	naively assume they "just work".
360		370
361	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	371	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
362	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	372	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
363	Reads or writes $length bytes from or to the specified $fh and	373	Reads or writes $length bytes from or to the specified $fh and
364	$offset into the scalar given by $data and offset $dataoffset and	374	$offset into the scalar given by $data and offset $dataoffset and
…		…
519	namemax => 255,	529	namemax => 255,
520	frsize => 1024,	530	frsize => 1024,
521	fsid => 1810	531	fsid => 1810
522	}	532	}
523		533
		534	Here is a (likely partial - send me updates!) list of fsid values
		535	used by Linux - it is safe to hardcode these when $^O is "linux":
		536
		537	0x0000adf5 adfs
		538	0x0000adff affs
		539	0x5346414f afs
		540	0x09041934 anon-inode filesystem
		541	0x00000187 autofs
		542	0x42465331 befs
		543	0x1badface bfs
		544	0x42494e4d binfmt_misc
		545	0x9123683e btrfs
		546	0x0027e0eb cgroupfs
		547	0xff534d42 cifs
		548	0x73757245 coda
		549	0x012ff7b7 coh
		550	0x28cd3d45 cramfs
		551	0x453dcd28 cramfs-wend (wrong endianness)
		552	0x64626720 debugfs
		553	0x00001373 devfs
		554	0x00001cd1 devpts
		555	0x0000f15f ecryptfs
		556	0x00414a53 efs
		557	0x0000137d ext
		558	0x0000ef53 ext2/ext3
		559	0x0000ef51 ext2
		560	0x00004006 fat
		561	0x65735546 fuseblk
		562	0x65735543 fusectl
		563	0x0bad1dea futexfs
		564	0x01161970 gfs2
		565	0x47504653 gpfs
		566	0x00004244 hfs
		567	0xf995e849 hpfs
		568	0x958458f6 hugetlbfs
		569	0x2bad1dea inotifyfs
		570	0x00009660 isofs
		571	0x000072b6 jffs2
		572	0x3153464a jfs
		573	0x6b414653 k-afs
		574	0x0bd00bd0 lustre
		575	0x0000137f minix
		576	0x0000138f minix 30 char names
		577	0x00002468 minix v2
		578	0x00002478 minix v2 30 char names
		579	0x00004d5a minix v3
		580	0x19800202 mqueue
		581	0x00004d44 msdos
		582	0x0000564c novell
		583	0x00006969 nfs
		584	0x6e667364 nfsd
		585	0x00003434 nilfs
		586	0x5346544e ntfs
		587	0x00009fa1 openprom
		588	0x7461636F ocfs2
		589	0x00009fa0 proc
		590	0x6165676c pstorefs
		591	0x0000002f qnx4
		592	0x858458f6 ramfs
		593	0x52654973 reiserfs
		594	0x00007275 romfs
		595	0x67596969 rpc_pipefs
		596	0x73636673 securityfs
		597	0xf97cff8c selinux
		598	0x0000517b smb
		599	0x534f434b sockfs
		600	0x73717368 squashfs
		601	0x62656572 sysfs
		602	0x012ff7b6 sysv2
		603	0x012ff7b5 sysv4
		604	0x01021994 tmpfs
		605	0x15013346 udf
		606	0x00011954 ufs
		607	0x54190100 ufs byteswapped
		608	0x00009fa2 usbdevfs
		609	0x01021997 v9fs
		610	0xa501fcf5 vxfs
		611	0xabba1974 xenfs
		612	0x012ff7b4 xenix
		613	0x58465342 xfs
		614	0x012fd16d xia
		615
524	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	616	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
525	Works like perl's "utime" function (including the special case of	617	Works like perl's "utime" function (including the special case of
526	$atime and $mtime being undef). Fractional times are supported if	618	$atime and $mtime being undef). Fractional times are supported if
527	the underlying syscalls support them.	619	the underlying syscalls support them.
528		620
…		…
550	aio_chown "path", 0, undef;	642	aio_chown "path", 0, undef;
551		643
552	aio_truncate $fh_or_path, $offset, $callback->($status)	644	aio_truncate $fh_or_path, $offset, $callback->($status)
553	Works like truncate(2) or ftruncate(2).	645	Works like truncate(2) or ftruncate(2).
554		646
		647	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		648	Allocates or freed disk space according to the $mode argument. See
		649	the linux "fallocate" docuemntation for details.
		650
		651	$mode can currently be 0 or "IO::AIO::FALLOC_FL_KEEP_SIZE" to
		652	allocate space, or "IO::AIO::FALLOC_FL_PUNCH_HOLE \|
		653	IO::AIO::FALLOC_FL_KEEP_SIZE", to deallocate a file range.
		654
		655	The file system block size used by "fallocate" is presumably the
		656	"f_bsize" returned by "statvfs".
		657
		658	If "fallocate" isn't available or cannot be emulated (currently no
		659	emulation will be attempted), passes -1 and sets $! to "ENOSYS".
		660
555	aio_chmod $fh_or_path, $mode, $callback->($status)	661	aio_chmod $fh_or_path, $mode, $callback->($status)
556	Works like perl's "chmod" function.	662	Works like perl's "chmod" function.
557		663
558	aio_unlink $pathname, $callback->($status)	664	aio_unlink $pathname, $callback->($status)
559	Asynchronously unlink (delete) a file and call the callback with the	665	Asynchronously unlink (delete) a file and call the callback with the
…		…
585	the callback. If an error occurs, nothing or undef gets passed to	691	the callback. If an error occurs, nothing or undef gets passed to
586	the callback.	692	the callback.
587		693
588	aio_realpath $pathname, $callback->($path)	694	aio_realpath $pathname, $callback->($path)
589	Asynchronously make the path absolute and resolve any symlinks in	695	Asynchronously make the path absolute and resolve any symlinks in
590	$path. The resulting path only consists of directories (Same as	696	$path. The resulting path only consists of directories (same as
591	Cwd::realpath).	697	Cwd::realpath).
592		698
593	This request can be used to get the absolute path of the current	699	This request can be used to get the absolute path of the current
594	working directory by passing it a path of . (a single dot).	700	working directory by passing it a path of . (a single dot).
595		701
596	aio_rename $srcpath, $dstpath, $callback->($status)	702	aio_rename $srcpath, $dstpath, $callback->($status)
597	Asynchronously rename the object at $srcpath to $dstpath, just as	703	Asynchronously rename the object at $srcpath to $dstpath, just as
598	rename(2) and call the callback with the result code.	704	rename(2) and call the callback with the result code.
		705
		706	On systems that support the AIO::WD working directory abstraction
		707	natively, the case "[$wd, "."]" as $srcpath is specialcased -
		708	instead of failing, "rename" is called on the absolute path of $wd.
599		709
600	aio_mkdir $pathname, $mode, $callback->($status)	710	aio_mkdir $pathname, $mode, $callback->($status)
601	Asynchronously mkdir (create) a directory and call the callback with	711	Asynchronously mkdir (create) a directory and call the callback with
602	the result code. $mode will be modified by the umask at the time the	712	the result code. $mode will be modified by the umask at the time the
603	request is executed, so do not change your umask.	713	request is executed, so do not change your umask.
604		714
605	aio_rmdir $pathname, $callback->($status)	715	aio_rmdir $pathname, $callback->($status)
606	Asynchronously rmdir (delete) a directory and call the callback with	716	Asynchronously rmdir (delete) a directory and call the callback with
607	the result code.	717	the result code.
		718
		719	On systems that support the AIO::WD working directory abstraction
		720	natively, the case "[$wd, "."]" is specialcased - instead of
		721	failing, "rmdir" is called on the absolute path of $wd.
608		722
609	aio_readdir $pathname, $callback->($entries)	723	aio_readdir $pathname, $callback->($entries)
610	Unlike the POSIX call of the same name, "aio_readdir" reads an	724	Unlike the POSIX call of the same name, "aio_readdir" reads an
611	entire directory (i.e. opendir + readdir + closedir). The entries	725	entire directory (i.e. opendir + readdir + closedir). The entries
612	will not be sorted, and will NOT include the "." and ".." entries.	726	will not be sorted, and will NOT include the "." and ".." entries.
…		…
835		949
836	It touches (reads or writes) all memory pages in the specified range	950	It touches (reads or writes) all memory pages in the specified range
837	inside the scalar. All caveats and parameters are the same as for	951	inside the scalar. All caveats and parameters are the same as for
838	"aio_msync", above, except for flags, which must be either 0 (which	952	"aio_msync", above, except for flags, which must be either 0 (which
839	reads all pages and ensures they are instantiated) or	953	reads all pages and ensures they are instantiated) or
840	"IO::AIO::MT_MODIFY", which modifies the memory page s(by reading	954	"IO::AIO::MT_MODIFY", which modifies the memory pages (by reading
841	and writing an octet from it, which dirties the page).	955	and writing an octet from it, which dirties the page).
842		956
843	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	957	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
844	This is a rather advanced IO::AIO call, which works best on	958	This is a rather advanced IO::AIO call, which works best on
845	mmap(2)ed scalars.	959	mmap(2)ed scalars.
…		…
879	memory.	993	memory.
880		994
881	aio_mlockall IO::AIO::MCL_FUTURE;	995	aio_mlockall IO::AIO::MCL_FUTURE;
882		996
883	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)	997	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
884	Queries the extents of the given file (by calling the Linux FIEMAP	998	Queries the extents of the given file (by calling the Linux "FIEMAP"
885	ioctl, see <http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for	999	ioctl, see <http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for
886	details). If the "ioctl" is not available on your OS, then this	1000	details). If the ioctl is not available on your OS, then this
887	rquiest will fail with "ENOSYS".	1001	request will fail with "ENOSYS".
888		1002
889	$start is the starting offset to query extents for, $length is the	1003	$start is the starting offset to query extents for, $length is the
890	size of the range to query - if it is "undef", then the whole file	1004	size of the range to query - if it is "undef", then the whole file
891	will be queried.	1005	will be queried.
892		1006
…		…
894	"IO::AIO::FIEMAP_FLAG_XATTR" - "IO::AIO::FIEMAP_FLAGS_COMPAT" is	1008	"IO::AIO::FIEMAP_FLAG_XATTR" - "IO::AIO::FIEMAP_FLAGS_COMPAT" is
895	also exported), and is normally 0 or "IO::AIO::FIEMAP_FLAG_SYNC" to	1009	also exported), and is normally 0 or "IO::AIO::FIEMAP_FLAG_SYNC" to
896	query the data portion.	1010	query the data portion.
897		1011
898	$count is the maximum number of extent records to return. If it is	1012	$count is the maximum number of extent records to return. If it is
899	"undef", then IO::AIO queries all extents of the file. As a very	1013	"undef", then IO::AIO queries all extents of the range. As a very
900	special case, if it is 0, then the callback receives the number of	1014	special case, if it is 0, then the callback receives the number of
901	extents instead of the extents themselves.	1015	extents instead of the extents themselves (which is unreliable, see
		1016	below).
902		1017
903	If an error occurs, the callback receives no arguments. The special	1018	If an error occurs, the callback receives no arguments. The special
904	"errno" value "IO::AIO::EBADR" is available to test for flag errors.	1019	"errno" value "IO::AIO::EBADR" is available to test for flag errors.
905		1020
906	Otherwise, the callback receives an array reference with extent	1021	Otherwise, the callback receives an array reference with extent
…		…
908	the following members:	1023	the following members:
909		1024
910	[$logical, $physical, $length, $flags]	1025	[$logical, $physical, $length, $flags]
911		1026
912	Flags is any combination of the following flag values (typically	1027	Flags is any combination of the following flag values (typically
913	either 0 or "IO::AIO::FIEMAP_EXTENT_LAST"):	1028	either 0 or "IO::AIO::FIEMAP_EXTENT_LAST" (1)):
914		1029
915	"IO::AIO::FIEMAP_EXTENT_LAST", "IO::AIO::FIEMAP_EXTENT_UNKNOWN",	1030	"IO::AIO::FIEMAP_EXTENT_LAST", "IO::AIO::FIEMAP_EXTENT_UNKNOWN",
916	"IO::AIO::FIEMAP_EXTENT_DELALLOC", "IO::AIO::FIEMAP_EXTENT_ENCODED",	1031	"IO::AIO::FIEMAP_EXTENT_DELALLOC", "IO::AIO::FIEMAP_EXTENT_ENCODED",
917	"IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED",	1032	"IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED",
918	"IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED",	1033	"IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED",
919	"IO::AIO::FIEMAP_EXTENT_DATA_INLINE",	1034	"IO::AIO::FIEMAP_EXTENT_DATA_INLINE",
920	"IO::AIO::FIEMAP_EXTENT_DATA_TAIL",	1035	"IO::AIO::FIEMAP_EXTENT_DATA_TAIL",
921	"IO::AIO::FIEMAP_EXTENT_UNWRITTEN", "IO::AIO::FIEMAP_EXTENT_MERGED"	1036	"IO::AIO::FIEMAP_EXTENT_UNWRITTEN", "IO::AIO::FIEMAP_EXTENT_MERGED"
922	or "IO::AIO::FIEMAP_EXTENT_SHARED".	1037	or "IO::AIO::FIEMAP_EXTENT_SHARED".
923		1038
		1039	At the time of this writing (Linux 3.2), this requets is unreliable
		1040	unless $count is "undef", as the kernel has all sorts of bugs
		1041	preventing it to return all extents of a range for files with large
		1042	number of extents. The code works around all these issues if $count
		1043	is undef.
		1044
924	aio_group $callback->(...)	1045	aio_group $callback->(...)
925	This is a very special aio request: Instead of doing something, it	1046	This is a very special aio request: Instead of doing something, it
926	is a container for other aio requests, which is useful if you want	1047	is a container for other aio requests, which is useful if you want
927	to bundle many requests into a single, composite, request with a	1048	to bundle many requests into a single, composite, request with a
928	definite callback and the ability to cancel the whole request with	1049	definite callback and the ability to cancel the whole request with
…		…
1039	will still point to the original directory. Most functions accepting a	1160	will still point to the original directory. Most functions accepting a
1040	pathname will use the directory fd on newer systems, and the string on	1161	pathname will use the directory fd on newer systems, and the string on
1041	older systems. Some functions (such as realpath) will always rely on the	1162	older systems. Some functions (such as realpath) will always rely on the
1042	string form of the pathname.	1163	string form of the pathname.
1043		1164
1044	So this fucntionality is mainly useful to get some protection against	1165	So this functionality is mainly useful to get some protection against
1045	"chdir", to easily get an absolute path out of a relative path for	1166	"chdir", to easily get an absolute path out of a relative path for
1046	future reference, and to speed up doing many operations in the same	1167	future reference, and to speed up doing many operations in the same
1047	directory (e.g. when stat'ing all files in a directory).	1168	directory (e.g. when stat'ing all files in a directory).
1048		1169
1049	The following functions implement this working directory abstraction:	1170	The following functions implement this working directory abstraction:
…		…
1059	Since passing "undef" as working directory component of a pathname	1180	Since passing "undef" as working directory component of a pathname
1060	fails the request with "ENOENT", there is often no need for error	1181	fails the request with "ENOENT", there is often no need for error
1061	checking in the "aio_wd" callback, as future requests using the	1182	checking in the "aio_wd" callback, as future requests using the
1062	value will fail in the expected way.	1183	value will fail in the expected way.
1063		1184
1064	If this call isn't available because your OS lacks it or it couldn't
1065	be detected, it will be emulated by calling "fsync" instead.
1066
1067	IO::AIO::CWD	1185	IO::AIO::CWD
1068	This is a compiletime constant (object) that represents the process	1186	This is a compiletime constant (object) that represents the process
1069	current working directory.	1187	current working directory.
1070		1188
1071	Specifying this object as working directory object for a pathname is	1189	Specifying this object as working directory object for a pathname is
1072	as if the pathname would be specified directly, without a directory	1190	as if the pathname would be specified directly, without a directory
1073	object, e.g., these calls are functionally identical:	1191	object. For example, these calls are functionally identical:
1074		1192
1075	aio_stat "somefile", sub { ... };	1193	aio_stat "somefile", sub { ... };
1076	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };	1194	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
		1195
		1196	To recover the path associated with an IO::AIO::WD object, you can use
		1197	"aio_realpath":
		1198
		1199	aio_realpath $wd, sub {
		1200	warn "path is $_[0]\n";
		1201	};
		1202
		1203	Currently, "aio_statvfs" always, and "aio_rename" and "aio_rmdir"
		1204	sometimes, fall back to using an absolue path.
1077		1205
1078	IO::AIO::REQ CLASS	1206	IO::AIO::REQ CLASS
1079	All non-aggregate "aio_*" functions return an object of this class when	1207	All non-aggregate "aio_*" functions return an object of this class when
1080	called in non-void context.	1208	called in non-void context.
1081		1209
…		…
1233	results.	1361	results.
1234		1362
1235	See "poll_cb" for an example.	1363	See "poll_cb" for an example.
1236		1364
1237	IO::AIO::poll_cb	1365	IO::AIO::poll_cb
1238	Process some outstanding events on the result pipe. You have to call	1366	Process some requests that have reached the result phase (i.e. they
		1367	have been executed but the results are not yet reported). You have
		1368	to call this "regularly" to finish outstanding requests.
		1369
1239	this regularly. Returns 0 if all events could be processed (or there	1370	Returns 0 if all events could be processed (or there were no events
1240	were no events to process), or -1 if it returned earlier for	1371	to process), or -1 if it returned earlier for whatever reason.
1241	whatever reason. Returns immediately when no events are outstanding.	1372	Returns immediately when no events are outstanding. The amount of
1242	The amount of events processed depends on the settings of	1373	events processed depends on the settings of "IO::AIO::max_poll_req",
1243	"IO::AIO::max_poll_req" and "IO::AIO::max_poll_time".	1374	"IO::AIO::max_poll_time" and "IO::AIO::max_outstanding".
1244		1375
1245	If not all requests were processed for whatever reason, the	1376	If not all requests were processed for whatever reason, the poll
1246	filehandle will still be ready when "poll_cb" returns, so normally	1377	file descriptor will still be ready when "poll_cb" returns, so
1247	you don't have to do anything special to have it called later.	1378	normally you don't have to do anything special to have it called
		1379	later.
1248		1380
1249	Apart from calling "IO::AIO::poll_cb" when the event filehandle	1381	Apart from calling "IO::AIO::poll_cb" when the event filehandle
1250	becomes ready, it can be beneficial to call this function from loops	1382	becomes ready, it can be beneficial to call this function from loops
1251	which submit a lot of requests, to make sure the results get	1383	which submit a lot of requests, to make sure the results get
1252	processed when they become available and not just when the loop is	1384	processed when they become available and not just when the loop is
…		…
1260	Event->io (fd => IO::AIO::poll_fileno,	1392	Event->io (fd => IO::AIO::poll_fileno,
1261	poll => 'r', async => 1,	1393	poll => 'r', async => 1,
1262	cb => \&IO::AIO::poll_cb);	1394	cb => \&IO::AIO::poll_cb);
1263		1395
1264	IO::AIO::poll_wait	1396	IO::AIO::poll_wait
1265	If there are any outstanding requests and none of them in the result	1397	Wait until either at least one request is in the result phase or no
1266	phase, wait till the result filehandle becomes ready for reading	1398	requests are outstanding anymore.
1267	(simply does a "select" on the filehandle. This is useful if you	1399
1268	want to synchronously wait for some requests to finish).	1400	This is useful if you want to synchronously wait for some requests
		1401	to become ready, without actually handling them.
1269		1402
1270	See "nreqs" for an example.	1403	See "nreqs" for an example.
1271		1404
1272	IO::AIO::poll	1405	IO::AIO::poll
1273	Waits until some requests have been handled.	1406	Waits until some requests have been handled.
…		…
1468	On systems that do not implement "mprotect", this function returns	1601	On systems that do not implement "mprotect", this function returns
1469	ENOSYS, otherwise the return value of "mprotect".	1602	ENOSYS, otherwise the return value of "mprotect".
1470		1603
1471	IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]	1604	IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1472	Memory-maps a file (or anonymous memory range) and attaches it to	1605	Memory-maps a file (or anonymous memory range) and attaches it to
1473	the given $scalar, which will act like a string scalar.	1606	the given $scalar, which will act like a string scalar. Returns true
		1607	on success, and false otherwise.
1474		1608
1475	The only operations allowed on the scalar are "substr"/"vec" that	1609	The only operations allowed on the scalar are "substr"/"vec" that
1476	don't change the string length, and most read-only operations such	1610	don't change the string length, and most read-only operations such
1477	as copying it or searching it with regexes and so on.	1611	as copying it or searching it with regexes and so on.
1478		1612
…		…
1528	IO::AIO::munlockall	1662	IO::AIO::munlockall
1529	Calls the "munlockall" function.	1663	Calls the "munlockall" function.
1530		1664
1531	On systems that do not implement "munlockall", this function returns	1665	On systems that do not implement "munlockall", this function returns
1532	ENOSYS, otherwise the return value of "munlockall".	1666	ENOSYS, otherwise the return value of "munlockall".
		1667
		1668	IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		1669	Calls the GNU/Linux splice(2) syscall, if available. If $r_off or
		1670	$w_off are "undef", then "NULL" is passed for these, otherwise they
		1671	should be the file offset.
		1672
		1673	$r_fh and $w_fh should not refer to the same file, as splice might
		1674	silently corrupt the data in this case.
		1675
		1676	The following symbol flag values are available:
		1677	"IO::AIO::SPLICE_F_MOVE", "IO::AIO::SPLICE_F_NONBLOCK",
		1678	"IO::AIO::SPLICE_F_MORE" and "IO::AIO::SPLICE_F_GIFT".
		1679
		1680	See the splice(2) manpage for details.
		1681
		1682	IO::AIO::tee $r_fh, $w_fh, $length, $flags
		1683	Calls the GNU/Linux tee(2) syscall, see it's manpage and the
		1684	description for "IO::AIO::splice" above for details.
		1685
		1686	$actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		1687	Attempts to query or change the pipe buffer size. Obviously works
		1688	only on pipes, and currently works only on GNU/Linux systems, and
		1689	fails with -1/"ENOSYS" everywhere else. If anybody knows how to
		1690	influence pipe buffer size on other systems, drop me a note.
1533		1691
1534	EVENT LOOP INTEGRATION	1692	EVENT LOOP INTEGRATION
1535	It is recommended to use AnyEvent::AIO to integrate IO::AIO	1693	It is recommended to use AnyEvent::AIO to integrate IO::AIO
1536	automatically into many event loops:	1694	automatically into many event loops:
1537		1695

Diff Legend

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

Comparing IO-AIO/README (file contents): Revision 1.51 by root, Sat Apr 7 00:50:33 2012 UTC vs. Revision 1.55 by root, Sat Jan 25 00:15:52 2014 UTC

Diff Legend

Comparing IO-AIO/README (file contents):
Revision 1.51 by root, Sat Apr 7 00:50:33 2012 UTC vs.
Revision 1.55 by root, Sat Jan 25 00:15:52 2014 UTC