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

Comparing IO-AIO/README (file contents):
Revision 1.39 by root, Wed Aug 5 11:53:16 2009 UTC vs.
Revision 1.44 by root, Mon Nov 1 22:03:43 2010 UTC

…		…
2	IO::AIO - Asynchronous Input/Output	2	IO::AIO - Asynchronous Input/Output
3		3
4	SYNOPSIS	4	SYNOPSIS
5	use IO::AIO;	5	use IO::AIO;
6		6
7	aio_open "/etc/passwd", O_RDONLY, 0, sub {	7	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
8	my $fh = shift	8	my $fh = shift
9	or die "/etc/passwd: $!";	9	or die "/etc/passwd: $!";
10	...	10	...
11	};	11	};
12		12
…		…
23	my $req = aio_unlink "/tmp/file", sub { };	23	my $req = aio_unlink "/tmp/file", sub { };
24	$req->cancel; # cancel request if still in queue	24	$req->cancel; # cancel request if still in queue
25		25
26	my $grp = aio_group sub { print "all stats done\n" };	26	my $grp = aio_group sub { print "all stats done\n" };
27	add $grp aio_stat "..." for ...;	27	add $grp aio_stat "..." for ...;
28
29	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
30	use AnyEvent::AIO;
31
32	# EV integration
33	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
34
35	# Event integration
36	Event->io (fd => IO::AIO::poll_fileno,
37	poll => 'r',
38	cb => \&IO::AIO::poll_cb);
39
40	# Glib/Gtk2 integration
41	add_watch Glib::IO IO::AIO::poll_fileno,
42	in => sub { IO::AIO::poll_cb; 1 };
43
44	# Tk integration
45	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
46	readable => \&IO::AIO::poll_cb);
47
48	# Danga::Socket integration
49	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
50	\&IO::AIO::poll_cb);
51		28
52	DESCRIPTION	29	DESCRIPTION
53	This module implements asynchronous I/O using whatever means your	30	This module implements asynchronous I/O using whatever means your
54	operating system supports. It is implemented as an interface to "libeio"	31	operating system supports. It is implemented as an interface to "libeio"
55	(<http://software.schmorp.de/pkg/libeio.html>).	32	(<http://software.schmorp.de/pkg/libeio.html>).
…		…
95		72
96	# register the IO::AIO callback with EV	73	# register the IO::AIO callback with EV
97	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;	74	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
98		75
99	# queue the request to open /etc/passwd	76	# queue the request to open /etc/passwd
100	aio_open "/etc/passwd", O_RDONLY, 0, sub {	77	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
101	my $fh = shift	78	my $fh = shift
102	or die "error while opening: $!";	79	or die "error while opening: $!";
103		80
104	# stat'ing filehandles is generally non-blocking	81	# stat'ing filehandles is generally non-blocking
105	my $size = -s $fh;	82	my $size = -s $fh;
…		…
168	anymore (except possibly for the Perl object, but its connection to	145	anymore (except possibly for the Perl object, but its connection to
169	the actual aio request is severed and calling its methods will	146	the actual aio request is severed and calling its methods will
170	either do nothing or result in a runtime error).	147	either do nothing or result in a runtime error).
171		148
172	FUNCTIONS	149	FUNCTIONS
		150	QUICK OVERVIEW
		151	This section simply lists the prototypes of the most important functions
		152	for quick reference. See the following sections for function-by-function
		153	documentation.
		154
		155	aio_open $pathname, $flags, $mode, $callback->($fh)
		156	aio_close $fh, $callback->($status)
		157	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		158	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		159	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
		160	aio_readahead $fh,$offset,$length, $callback->($retval)
		161	aio_stat $fh_or_path, $callback->($status)
		162	aio_lstat $fh, $callback->($status)
		163	aio_statvfs $fh_or_path, $callback->($statvfs)
		164	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		165	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		166	aio_truncate $fh_or_path, $offset, $callback->($status)
		167	aio_chmod $fh_or_path, $mode, $callback->($status)
		168	aio_unlink $pathname, $callback->($status)
		169	aio_mknod $path, $mode, $dev, $callback->($status)
		170	aio_link $srcpath, $dstpath, $callback->($status)
		171	aio_symlink $srcpath, $dstpath, $callback->($status)
		172	aio_readlink $path, $callback->($link)
		173	aio_rename $srcpath, $dstpath, $callback->($status)
		174	aio_mkdir $pathname, $mode, $callback->($status)
		175	aio_rmdir $pathname, $callback->($status)
		176	aio_readdir $pathname, $callback->($entries)
		177	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		178	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
		179	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		180	aio_load $path, $data, $callback->($status)
		181	aio_copy $srcpath, $dstpath, $callback->($status)
		182	aio_move $srcpath, $dstpath, $callback->($status)
		183	aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
		184	aio_rmtree $path, $callback->($status)
		185	aio_sync $callback->($status)
		186	aio_fsync $fh, $callback->($status)
		187	aio_fdatasync $fh, $callback->($status)
		188	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		189	aio_pathsync $path, $callback->($status)
		190	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		191	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		192	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		193	aio_mlockall $flags, $callback->($status)
		194	aio_group $callback->(...)
		195	aio_nop $callback->()
		196
		197	$prev_pri = aioreq_pri [$pri]
		198	aioreq_nice $pri_adjust
		199
		200	IO::AIO::poll_wait
		201	IO::AIO::poll_cb
		202	IO::AIO::poll
		203	IO::AIO::flush
		204	IO::AIO::max_poll_reqs $nreqs
		205	IO::AIO::max_poll_time $seconds
		206	IO::AIO::min_parallel $nthreads
		207	IO::AIO::max_parallel $nthreads
		208	IO::AIO::max_idle $nthreads
		209	IO::AIO::max_outstanding $maxreqs
		210	IO::AIO::nreqs
		211	IO::AIO::nready
		212	IO::AIO::npending
		213
		214	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		215	IO::AIO::fadvise $fh, $offset, $len, $advice
		216	IO::AIO::madvise $scalar, $offset, $length, $advice
		217	IO::AIO::mprotect $scalar, $offset, $length, $protect
		218	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		219	IO::AIO::munlockall
		220
173	AIO REQUEST FUNCTIONS	221	AIO REQUEST FUNCTIONS
174	All the "aio_*" calls are more or less thin wrappers around the syscall	222	All the "aio_*" calls are more or less thin wrappers around the syscall
175	with the same name (sans "aio_"). The arguments are similar or	223	with the same name (sans "aio_"). The arguments are similar or
176	identical, and they all accept an additional (and optional) $callback	224	identical, and they all accept an additional (and optional) $callback
177	argument which must be a code reference. This code reference will get	225	argument which must be a code reference. This code reference will get
…		…
248	will be modified by the umask in effect then the request is being	296	will be modified by the umask in effect then the request is being
249	executed, so better never change the umask.	297	executed, so better never change the umask.
250		298
251	Example:	299	Example:
252		300
253	aio_open "/etc/passwd", O_RDONLY, 0, sub {	301	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
254	if ($_[0]) {	302	if ($_[0]) {
255	print "open successful, fh is $_[0]\n";	303	print "open successful, fh is $_[0]\n";
256	...	304	...
257	} else {	305	} else {
258	die "open failed: $!\n";	306	die "open failed: $!\n";
…		…
313	more than one "aio_sendfile" per $out_fh, as they will interfere	361	more than one "aio_sendfile" per $out_fh, as they will interfere
314	with each other.	362	with each other.
315		363
316	This call tries to make use of a native "sendfile" syscall to	364	This call tries to make use of a native "sendfile" syscall to
317	provide zero-copy operation. For this to work, $out_fh should refer	365	provide zero-copy operation. For this to work, $out_fh should refer
318	to a socket, and $in_fh should refer to mmap'able file.	366	to a socket, and $in_fh should refer to an mmap'able file.
319		367
320	If the native sendfile call fails or is not implemented, it will be	368	If a native sendfile cannot be found or it fails with "ENOSYS",
		369	"ENOTSUP", "EOPNOTSUPP", "EAFNOSUPPORT", "EPROTOTYPE" or "ENOTSOCK",
321	emulated, so you can call "aio_sendfile" on any type of filehandle	370	it will be emulated, so you can call "aio_sendfile" on any type of
322	regardless of the limitations of the operating system.	371	filehandle regardless of the limitations of the operating system.
323		372
324	Please note, however, that "aio_sendfile" can read more bytes from	373	Please note, however, that "aio_sendfile" can read more bytes from
325	$in_fh than are written, and there is no way to find out how many	374	$in_fh than are written, and there is no way to find out how many
326	bytes have been read from "aio_sendfile" alone, as "aio_sendfile"	375	bytes have been read from "aio_sendfile" alone, as "aio_sendfile"
327	only provides the number of bytes written to $out_fh. Only if the	376	only provides the number of bytes written to $out_fh. Only if the
…		…
362	aio_stat "/etc/passwd", sub {	411	aio_stat "/etc/passwd", sub {
363	$_[0] and die "stat failed: $!";	412	$_[0] and die "stat failed: $!";
364	print "size is ", -s _, "\n";	413	print "size is ", -s _, "\n";
365	};	414	};
366		415
		416	aio_statvfs $fh_or_path, $callback->($statvfs)
		417	Works like the POSIX "statvfs" or "fstatvfs" syscalls, depending on
		418	whether a file handle or path was passed.
		419
		420	On success, the callback is passed a hash reference with the
		421	following members: "bsize", "frsize", "blocks", "bfree", "bavail",
		422	"files", "ffree", "favail", "fsid", "flag" and "namemax". On
		423	failure, "undef" is passed.
		424
		425	The following POSIX IO::AIO::ST_* constants are defined: "ST_RDONLY"
		426	and "ST_NOSUID".
		427
		428	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		429	their correct value when available, or to 0 on systems that do not
		430	support them: "ST_NODEV", "ST_NOEXEC", "ST_SYNCHRONOUS",
		431	"ST_MANDLOCK", "ST_WRITE", "ST_APPEND", "ST_IMMUTABLE",
		432	"ST_NOATIME", "ST_NODIRATIME" and "ST_RELATIME".
		433
		434	Example: stat "/wd" and dump out the data if successful.
		435
		436	aio_statvfs "/wd", sub {
		437	my $f = $_[0]
		438	or die "statvfs: $!";
		439
		440	use Data::Dumper;
		441	say Dumper $f;
		442	};
		443
		444	# result:
		445	{
		446	bsize => 1024,
		447	bfree => 4333064312,
		448	blocks => 10253828096,
		449	files => 2050765568,
		450	flag => 4096,
		451	favail => 2042092649,
		452	bavail => 4333064312,
		453	ffree => 2042092649,
		454	namemax => 255,
		455	frsize => 1024,
		456	fsid => 1810
		457	}
		458
367	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	459	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
368	Works like perl's "utime" function (including the special case of	460	Works like perl's "utime" function (including the special case of
369	$atime and $mtime being undef). Fractional times are supported if	461	$atime and $mtime being undef). Fractional times are supported if
370	the underlying syscalls support them.	462	the underlying syscalls support them.
371		463
…		…
512	into memory. Status is the same as with aio_read.	604	into memory. Status is the same as with aio_read.
513		605
514	aio_copy $srcpath, $dstpath, $callback->($status)	606	aio_copy $srcpath, $dstpath, $callback->($status)
515	Try to copy the file (directories not supported as either source	607	Try to copy the file (directories not supported as either source
516	or destination) from $srcpath to $dstpath and call the callback with	608	or destination) from $srcpath to $dstpath and call the callback with
517	the 0 (error) or -1 ok.	609	a status of 0 (ok) or -1 (error, see $!).
518		610
519	This is a composite request that creates the destination file with	611	This is a composite request that creates the destination file with
520	mode 0200 and copies the contents of the source file into it using	612	mode 0200 and copies the contents of the source file into it using
521	"aio_sendfile", followed by restoring atime, mtime, access mode and	613	"aio_sendfile", followed by restoring atime, mtime, access mode and
522	uid/gid, in that order.	614	uid/gid, in that order.
…		…
526	uid/gid, where errors are being ignored.	618	uid/gid, where errors are being ignored.
527		619
528	aio_move $srcpath, $dstpath, $callback->($status)	620	aio_move $srcpath, $dstpath, $callback->($status)
529	Try to move the file (directories not supported as either source	621	Try to move the file (directories not supported as either source
530	or destination) from $srcpath to $dstpath and call the callback with	622	or destination) from $srcpath to $dstpath and call the callback with
531	the 0 (error) or -1 ok.	623	a status of 0 (ok) or -1 (error, see $!).
532		624
533	This is a composite request that tries to rename(2) the file first;	625	This is a composite request that tries to rename(2) the file first;
534	if rename fails with "EXDEV", it copies the file with "aio_copy"	626	if rename fails with "EXDEV", it copies the file with "aio_copy"
535	and, if that is successful, unlinks the $srcpath.	627	and, if that is successful, unlinks the $srcpath.
536		628
…		…
636	Future versions of this function might fall back to other methods	728	Future versions of this function might fall back to other methods
637	when "fsync" on the directory fails (such as calling "sync").	729	when "fsync" on the directory fails (such as calling "sync").
638		730
639	Passes 0 when everything went ok, and -1 on error.	731	Passes 0 when everything went ok, and -1 on error.
640		732
		733	aio_msync $scalar, $offset = 0, $length = undef, flags = 0,
		734	$callback->($status)
		735	This is a rather advanced IO::AIO call, which only works on
		736	mmap(2)ed scalars (see the "IO::AIO::mmap" function, although it
		737	also works on data scalars managed by the Sys::Mmap or Mmap modules,
		738	note that the scalar must only be modified in-place while an aio
		739	operation is pending on it).
		740
		741	It calls the "msync" function of your OS, if available, with the
		742	memory area starting at $offset in the string and ending $length
		743	bytes later. If $length is negative, counts from the end, and if
		744	$length is "undef", then it goes till the end of the string. The
		745	flags can be a combination of "IO::AIO::MS_ASYNC",
		746	"IO::AIO::MS_INVALIDATE" and "IO::AIO::MS_SYNC".
		747
		748	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0,
		749	$callback->($status)
		750	This is a rather advanced IO::AIO call, which works best on
		751	mmap(2)ed scalars.
		752
		753	It touches (reads or writes) all memory pages in the specified range
		754	inside the scalar. All caveats and parameters are the same as for
		755	"aio_msync", above, except for flags, which must be either 0 (which
		756	reads all pages and ensures they are instantiated) or
		757	"IO::AIO::MT_MODIFY", which modifies the memory page s(by reading
		758	and writing an octet from it, which dirties the page).
		759
		760	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		761	This is a rather advanced IO::AIO call, which works best on
		762	mmap(2)ed scalars.
		763
		764	It reads in all the pages of the underlying storage into memory (if
		765	any) and locks them, so they are not getting swapped/paged out or
		766	removed.
		767
		768	If $length is undefined, then the scalar will be locked till the
		769	end.
		770
		771	On systems that do not implement "mlock", this function returns -1
		772	and sets errno to "ENOSYS".
		773
		774	Note that the corresponding "munlock" is synchronous and is
		775	documented under "MISCELLANEOUS FUNCTIONS".
		776
		777	Example: open a file, mmap and mlock it - both will be undone when
		778	$data gets destroyed.
		779
		780	open my $fh, "<", $path or die "$path: $!";
		781	my $data;
		782	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		783	aio_mlock $data; # mlock in background
		784
		785	aio_mlockall $flags, $callback->($status)
		786	Calls the "mlockall" function with the given $flags (a combination
		787	of "IO::AIO::MCL_CURRENT" and "IO::AIO::MCL_FUTURE").
		788
		789	On systems that do not implement "mlockall", this function returns
		790	-1 and sets errno to "ENOSYS".
		791
		792	Note that the corresponding "munlockall" is synchronous and is
		793	documented under "MISCELLANEOUS FUNCTIONS".
		794
		795	Example: asynchronously lock all current and future pages into
		796	memory.
		797
		798	aio_mlockall IO::AIO::MCL_FUTURE;
		799
641	aio_group $callback->(...)	800	aio_group $callback->(...)
642	This is a very special aio request: Instead of doing something, it	801	This is a very special aio request: Instead of doing something, it
643	is a container for other aio requests, which is useful if you want	802	is a container for other aio requests, which is useful if you want
644	to bundle many requests into a single, composite, request with a	803	to bundle many requests into a single, composite, request with a
645	definite callback and the ability to cancel the whole request with	804	definite callback and the ability to cancel the whole request with
…		…
760		919
761	$grp->cancel_subs	920	$grp->cancel_subs
762	Cancel all subrequests and clears any feeder, but not the group	921	Cancel all subrequests and clears any feeder, but not the group
763	request itself. Useful when you queued a lot of events but got a	922	request itself. Useful when you queued a lot of events but got a
764	result early.	923	result early.
		924
		925	The group request will finish normally (you cannot add requests to
		926	the group).
765		927
766	$grp->result (...)	928	$grp->result (...)
767	Set the result value(s) that will be passed to the group callback	929	Set the result value(s) that will be passed to the group callback
768	when all subrequests have finished and set the groups errno to the	930	when all subrequests have finished and set the groups errno to the
769	current value of errno (just like calling "errno" without an error	931	current value of errno (just like calling "errno" without an error
…		…
855		1017
856	Event->io (fd => IO::AIO::poll_fileno,	1018	Event->io (fd => IO::AIO::poll_fileno,
857	poll => 'r', async => 1,	1019	poll => 'r', async => 1,
858	cb => \&IO::AIO::poll_cb);	1020	cb => \&IO::AIO::poll_cb);
859		1021
		1022	IO::AIO::poll_wait
		1023	If there are any outstanding requests and none of them in the result
		1024	phase, wait till the result filehandle becomes ready for reading
		1025	(simply does a "select" on the filehandle. This is useful if you
		1026	want to synchronously wait for some requests to finish).
		1027
		1028	See "nreqs" for an example.
		1029
		1030	IO::AIO::poll
		1031	Waits until some requests have been handled.
		1032
		1033	Returns the number of requests processed, but is otherwise strictly
		1034	equivalent to:
		1035
		1036	IO::AIO::poll_wait, IO::AIO::poll_cb
		1037
		1038	IO::AIO::flush
		1039	Wait till all outstanding AIO requests have been handled.
		1040
		1041	Strictly equivalent to:
		1042
		1043	IO::AIO::poll_wait, IO::AIO::poll_cb
		1044	while IO::AIO::nreqs;
		1045
860	IO::AIO::max_poll_reqs $nreqs	1046	IO::AIO::max_poll_reqs $nreqs
861	IO::AIO::max_poll_time $seconds	1047	IO::AIO::max_poll_time $seconds
862	These set the maximum number of requests (default 0, meaning	1048	These set the maximum number of requests (default 0, meaning
863	infinity) that are being processed by "IO::AIO::poll_cb" in one	1049	infinity) that are being processed by "IO::AIO::poll_cb" in one
864	call, respectively the maximum amount of time (default 0, meaning	1050	call, respectively the maximum amount of time (default 0, meaning
…		…
887	# use a low priority so other tasks have priority	1073	# use a low priority so other tasks have priority
888	Event->io (fd => IO::AIO::poll_fileno,	1074	Event->io (fd => IO::AIO::poll_fileno,
889	poll => 'r', nice => 1,	1075	poll => 'r', nice => 1,
890	cb => &IO::AIO::poll_cb);	1076	cb => &IO::AIO::poll_cb);
891		1077
892	IO::AIO::poll_wait
893	If there are any outstanding requests and none of them in the result
894	phase, wait till the result filehandle becomes ready for reading
895	(simply does a "select" on the filehandle. This is useful if you
896	want to synchronously wait for some requests to finish).
897
898	See "nreqs" for an example.
899
900	IO::AIO::poll
901	Waits until some requests have been handled.
902
903	Returns the number of requests processed, but is otherwise strictly
904	equivalent to:
905
906	IO::AIO::poll_wait, IO::AIO::poll_cb
907
908	IO::AIO::flush
909	Wait till all outstanding AIO requests have been handled.
910
911	Strictly equivalent to:
912
913	IO::AIO::poll_wait, IO::AIO::poll_cb
914	while IO::AIO::nreqs;
915
916	CONTROLLING THE NUMBER OF THREADS	1078	CONTROLLING THE NUMBER OF THREADS
917	IO::AIO::min_parallel $nthreads	1079	IO::AIO::min_parallel $nthreads
918	Set the minimum number of AIO threads to $nthreads. The current	1080	Set the minimum number of AIO threads to $nthreads. The current
919	default is 8, which means eight asynchronous operations can execute	1081	default is 8, which means eight asynchronous operations can execute
920	concurrently at any one time (the number of outstanding requests,	1082	concurrently at any one time (the number of outstanding requests,
…		…
1012	set to non-blocking operations).	1174	set to non-blocking operations).
1013		1175
1014	Returns the number of bytes copied, or -1 on error.	1176	Returns the number of bytes copied, or -1 on error.
1015		1177
1016	IO::AIO::fadvise $fh, $offset, $len, $advice	1178	IO::AIO::fadvise $fh, $offset, $len, $advice
1017	Simply calls the "posix_fadvise" function (see it's manpage for	1179	Simply calls the "posix_fadvise" function (see its manpage for
1018	details). The following advice constants are avaiable:	1180	details). The following advice constants are avaiable:
1019	"IO::AIO::FADV_NORMAL", "IO::AIO::FADV_SEQUENTIAL",	1181	"IO::AIO::FADV_NORMAL", "IO::AIO::FADV_SEQUENTIAL",
1020	"IO::AIO::FADV_RANDOM", "IO::AIO::FADV_NOREUSE",	1182	"IO::AIO::FADV_RANDOM", "IO::AIO::FADV_NOREUSE",
1021	"IO::AIO::FADV_WILLNEED", "IO::AIO::FADV_DONTNEED".	1183	"IO::AIO::FADV_WILLNEED", "IO::AIO::FADV_DONTNEED".
1022		1184
1023	On systems that do not implement "posix_fadvise", this function	1185	On systems that do not implement "posix_fadvise", this function
1024	returns ENOSYS, otherwise the return value of "posix_fadvise".	1186	returns ENOSYS, otherwise the return value of "posix_fadvise".
		1187
		1188	IO::AIO::madvise $scalar, $offset, $len, $advice
		1189	Simply calls the "posix_madvise" function (see its manpage for
		1190	details). The following advice constants are avaiable:
		1191	"IO::AIO::MADV_NORMAL", "IO::AIO::MADV_SEQUENTIAL",
		1192	"IO::AIO::MADV_RANDOM", "IO::AIO::MADV_WILLNEED",
		1193	"IO::AIO::MADV_DONTNEED".
		1194
		1195	On systems that do not implement "posix_madvise", this function
		1196	returns ENOSYS, otherwise the return value of "posix_madvise".
		1197
		1198	IO::AIO::mprotect $scalar, $offset, $len, $protect
		1199	Simply calls the "mprotect" function on the preferably AIO::mmap'ed
		1200	$scalar (see its manpage for details). The following protect
		1201	constants are avaiable: "IO::AIO::PROT_NONE", "IO::AIO::PROT_READ",
		1202	"IO::AIO::PROT_WRITE", "IO::AIO::PROT_EXEC".
		1203
		1204	On systems that do not implement "mprotect", this function returns
		1205	ENOSYS, otherwise the return value of "mprotect".
		1206
		1207	IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		1208	Memory-maps a file (or anonymous memory range) and attaches it to
		1209	the given $scalar, which will act like a string scalar.
		1210
		1211	The only operations allowed on the scalar are "substr"/"vec" that
		1212	don't change the string length, and most read-only operations such
		1213	as copying it or searching it with regexes and so on.
		1214
		1215	Anything else is unsafe and will, at best, result in memory leaks.
		1216
		1217	The memory map associated with the $scalar is automatically removed
		1218	when the $scalar is destroyed, or when the "IO::AIO::mmap" or
		1219	"IO::AIO::munmap" functions are called.
		1220
		1221	This calls the "mmap"(2) function internally. See your system's
		1222	manual page for details on the $length, $prot and $flags parameters.
		1223
		1224	The $length must be larger than zero and smaller than the actual
		1225	filesize.
		1226
		1227	$prot is a combination of "IO::AIO::PROT_NONE",
		1228	"IO::AIO::PROT_EXEC", "IO::AIO::PROT_READ" and/or
		1229	"IO::AIO::PROT_WRITE",
		1230
		1231	$flags can be a combination of "IO::AIO::MAP_SHARED" or
		1232	"IO::AIO::MAP_PRIVATE", or a number of system-specific flags (when
		1233	not available, the are defined as 0): "IO::AIO::MAP_ANONYMOUS"
		1234	(which is set to "MAP_ANON" if your system only provides this
		1235	constant), "IO::AIO::MAP_HUGETLB", "IO::AIO::MAP_LOCKED",
		1236	"IO::AIO::MAP_NORESERVE", "IO::AIO::MAP_POPULATE" or
		1237	"IO::AIO::MAP_NONBLOCK"
		1238
		1239	If $fh is "undef", then a file descriptor of -1 is passed.
		1240
		1241	$offset is the offset from the start of the file - it generally must
		1242	be a multiple of "IO::AIO::PAGESIZE" and defaults to 0.
		1243
		1244	Example:
		1245
		1246	use Digest::MD5;
		1247	use IO::AIO;
		1248
		1249	open my $fh, "<verybigfile"
		1250	or die "$!";
		1251
		1252	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		1253	or die "verybigfile: $!";
		1254
		1255	my $fast_md5 = md5 $data;
		1256
		1257	IO::AIO::munmap $scalar
		1258	Removes a previous mmap and undefines the $scalar.
		1259
		1260	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		1261	Calls the "munlock" function, undoing the effects of a previous
		1262	"aio_mlock" call (see its description for details).
		1263
		1264	IO::AIO::munlockall
		1265	Calls the "munlockall" function.
		1266
		1267	On systems that do not implement "munlockall", this function returns
		1268	ENOSYS, otherwise the return value of "munlockall".
		1269
		1270	EVENT LOOP INTEGRATION
		1271	It is recommended to use AnyEvent::AIO to integrate IO::AIO
		1272	automatically into many event loops:
		1273
		1274	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		1275	use AnyEvent::AIO;
		1276
		1277	You can also integrate IO::AIO manually into many event loops, here are
		1278	some examples of how to do this:
		1279
		1280	# EV integration
		1281	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		1282
		1283	# Event integration
		1284	Event->io (fd => IO::AIO::poll_fileno,
		1285	poll => 'r',
		1286	cb => \&IO::AIO::poll_cb);
		1287
		1288	# Glib/Gtk2 integration
		1289	add_watch Glib::IO IO::AIO::poll_fileno,
		1290	in => sub { IO::AIO::poll_cb; 1 };
		1291
		1292	# Tk integration
		1293	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		1294	readable => \&IO::AIO::poll_cb);
		1295
		1296	# Danga::Socket integration
		1297	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		1298	\&IO::AIO::poll_cb);
1025		1299
1026	FORK BEHAVIOUR	1300	FORK BEHAVIOUR
1027	This module should do "the right thing" when the process using it forks:	1301	This module should do "the right thing" when the process using it forks:
1028		1302
1029	Before the fork, IO::AIO enters a quiescent state where no requests can	1303	Before the fork, IO::AIO enters a quiescent state where no requests can

Diff Legend

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

Comparing IO-AIO/README (file contents): Revision 1.39 by root, Wed Aug 5 11:53:16 2009 UTC vs. Revision 1.44 by root, Mon Nov 1 22:03:43 2010 UTC

Diff Legend

Comparing IO-AIO/README (file contents):
Revision 1.39 by root, Wed Aug 5 11:53:16 2009 UTC vs.
Revision 1.44 by root, Mon Nov 1 22:03:43 2010 UTC