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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.172 by root, Thu Jan 7 18:08:21 2010 UTC vs.
Revision 1.184 by root, Mon Nov 1 22:03:43 2010 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use IO::AIO;	7	use IO::AIO;
8		8
9	aio_open "/etc/passwd", O_RDONLY, 0, sub {	9	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
10	my $fh = shift	10	my $fh = shift
11	or die "/etc/passwd: $!";	11	or die "/etc/passwd: $!";
12	...	12	...
13	};	13	};
14		14
…		…
25	my $req = aio_unlink "/tmp/file", sub { };	25	my $req = aio_unlink "/tmp/file", sub { };
26	$req->cancel; # cancel request if still in queue	26	$req->cancel; # cancel request if still in queue
27		27
28	my $grp = aio_group sub { print "all stats done\n" };	28	my $grp = aio_group sub { print "all stats done\n" };
29	add $grp aio_stat "..." for ...;	29	add $grp aio_stat "..." for ...;
30
31	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32	use AnyEvent::AIO;
33
34	# EV integration
35	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
36
37	# Event integration
38	Event->io (fd => IO::AIO::poll_fileno,
39	poll => 'r',
40	cb => \&IO::AIO::poll_cb);
41
42	# Glib/Gtk2 integration
43	add_watch Glib::IO IO::AIO::poll_fileno,
44	in => sub { IO::AIO::poll_cb; 1 };
45
46	# Tk integration
47	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
48	readable => \&IO::AIO::poll_cb);
49
50	# Danga::Socket integration
51	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
52	\&IO::AIO::poll_cb);
53		30
54	=head1 DESCRIPTION	31	=head1 DESCRIPTION
55		32
56	This module implements asynchronous I/O using whatever means your	33	This module implements asynchronous I/O using whatever means your
57	operating system supports. It is implemented as an interface to C<libeio>	34	operating system supports. It is implemented as an interface to C<libeio>
…		…
99		76
100	# register the IO::AIO callback with EV	77	# register the IO::AIO callback with EV
101	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;	78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
102		79
103	# queue the request to open /etc/passwd	80	# queue the request to open /etc/passwd
104	aio_open "/etc/passwd", O_RDONLY, 0, sub {	81	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
105	my $fh = shift	82	my $fh = shift
106	or die "error while opening: $!";	83	or die "error while opening: $!";
107		84
108	# stat'ing filehandles is generally non-blocking	85	# stat'ing filehandles is generally non-blocking
109	my $size = -s $fh;	86	my $size = -s $fh;
…		…
191	use common::sense;	168	use common::sense;
192		169
193	use base 'Exporter';	170	use base 'Exporter';
194		171
195	BEGIN {	172	BEGIN {
196	our $VERSION = '3.4';	173	our $VERSION = '3.7';
197		174
198	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close	175	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
199	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
200	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync	177	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
201	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead	178	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
202	aio_rename aio_link aio_move aio_copy aio_group	179	aio_rename aio_link aio_move aio_copy aio_group
203	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown	180	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
204	aio_chmod aio_utime aio_truncate	181	aio_chmod aio_utime aio_truncate
205	aio_msync aio_mtouch aio_statvfs);	182	aio_msync aio_mtouch aio_mlock aio_mlockall
		183	aio_statvfs);
206		184
207	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	185	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
208	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	186	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
209	min_parallel max_parallel max_idle	187	min_parallel max_parallel max_idle
210	nreqs nready npending nthreads	188	nreqs nready npending nthreads
211	max_poll_time max_poll_reqs	189	max_poll_time max_poll_reqs
212	sendfile fadvise);	190	sendfile fadvise madvise
		191	mmap munmap munlock munlockall);
213		192
214	push @AIO_REQ, qw(aio_busy); # not exported	193	push @AIO_REQ, qw(aio_busy); # not exported
215		194
216	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	195	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
217		196
218	require XSLoader;	197	require XSLoader;
219	XSLoader::load ("IO::AIO", $VERSION);	198	XSLoader::load ("IO::AIO", $VERSION);
220	}	199	}
221		200
222	=head1 FUNCTIONS	201	=head1 FUNCTIONS
		202
		203	=head2 QUICK OVERVIEW
		204
		205	This section simply lists the prototypes of the most important functions
		206	for quick reference. See the following sections for function-by-function
		207	documentation.
		208
		209	aio_open $pathname, $flags, $mode, $callback->($fh)
		210	aio_close $fh, $callback->($status)
		211	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		212	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		213	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
		214	aio_readahead $fh,$offset,$length, $callback->($retval)
		215	aio_stat $fh_or_path, $callback->($status)
		216	aio_lstat $fh, $callback->($status)
		217	aio_statvfs $fh_or_path, $callback->($statvfs)
		218	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		219	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		220	aio_truncate $fh_or_path, $offset, $callback->($status)
		221	aio_chmod $fh_or_path, $mode, $callback->($status)
		222	aio_unlink $pathname, $callback->($status)
		223	aio_mknod $path, $mode, $dev, $callback->($status)
		224	aio_link $srcpath, $dstpath, $callback->($status)
		225	aio_symlink $srcpath, $dstpath, $callback->($status)
		226	aio_readlink $path, $callback->($link)
		227	aio_rename $srcpath, $dstpath, $callback->($status)
		228	aio_mkdir $pathname, $mode, $callback->($status)
		229	aio_rmdir $pathname, $callback->($status)
		230	aio_readdir $pathname, $callback->($entries)
		231	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		232	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
		233	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		234	aio_load $path, $data, $callback->($status)
		235	aio_copy $srcpath, $dstpath, $callback->($status)
		236	aio_move $srcpath, $dstpath, $callback->($status)
		237	aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
		238	aio_rmtree $path, $callback->($status)
		239	aio_sync $callback->($status)
		240	aio_fsync $fh, $callback->($status)
		241	aio_fdatasync $fh, $callback->($status)
		242	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		243	aio_pathsync $path, $callback->($status)
		244	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		245	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		246	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		247	aio_mlockall $flags, $callback->($status)
		248	aio_group $callback->(...)
		249	aio_nop $callback->()
		250
		251	$prev_pri = aioreq_pri [$pri]
		252	aioreq_nice $pri_adjust
		253
		254	IO::AIO::poll_wait
		255	IO::AIO::poll_cb
		256	IO::AIO::poll
		257	IO::AIO::flush
		258	IO::AIO::max_poll_reqs $nreqs
		259	IO::AIO::max_poll_time $seconds
		260	IO::AIO::min_parallel $nthreads
		261	IO::AIO::max_parallel $nthreads
		262	IO::AIO::max_idle $nthreads
		263	IO::AIO::max_outstanding $maxreqs
		264	IO::AIO::nreqs
		265	IO::AIO::nready
		266	IO::AIO::npending
		267
		268	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		269	IO::AIO::fadvise $fh, $offset, $len, $advice
		270	IO::AIO::madvise $scalar, $offset, $length, $advice
		271	IO::AIO::mprotect $scalar, $offset, $length, $protect
		272	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		273	IO::AIO::munlockall
223		274
224	=head2 AIO REQUEST FUNCTIONS	275	=head2 AIO REQUEST FUNCTIONS
225		276
226	All the C<aio_*> calls are more or less thin wrappers around the syscall	277	All the C<aio_*> calls are more or less thin wrappers around the syscall
227	with the same name (sans C<aio_>). The arguments are similar or identical,	278	with the same name (sans C<aio_>). The arguments are similar or identical,
…		…
307	by the umask in effect then the request is being executed, so better never	358	by the umask in effect then the request is being executed, so better never
308	change the umask.	359	change the umask.
309		360
310	Example:	361	Example:
311		362
312	aio_open "/etc/passwd", O_RDONLY, 0, sub {	363	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
313	if ($_[0]) {	364	if ($_[0]) {
314	print "open successful, fh is $_[0]\n";	365	print "open successful, fh is $_[0]\n";
315	...	366	...
316	} else {	367	} else {
317	die "open failed: $!\n";	368	die "open failed: $!\n";
…		…
379	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each	430	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
380	other.	431	other.
381		432
382	This call tries to make use of a native C<sendfile> syscall to provide	433	This call tries to make use of a native C<sendfile> syscall to provide
383	zero-copy operation. For this to work, C<$out_fh> should refer to a	434	zero-copy operation. For this to work, C<$out_fh> should refer to a
384	socket, and C<$in_fh> should refer to mmap'able file.	435	socket, and C<$in_fh> should refer to an mmap'able file.
385		436
386	If a native sendfile cannot be found or it fails with C<ENOSYS>,	437	If a native sendfile cannot be found or it fails with C<ENOSYS>,
387	C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,	438	C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
388	it will be emulated, so you can call C<aio_sendfile> on any type of	439	it will be emulated, so you can call C<aio_sendfile> on any type of
389	filehandle regardless of the limitations of the operating system.	440	filehandle regardless of the limitations of the operating system.
…		…
432	$_[0] and die "stat failed: $!";	483	$_[0] and die "stat failed: $!";
433	print "size is ", -s _, "\n";	484	print "size is ", -s _, "\n";
434	};	485	};
435		486
436		487
437	=item aio_statvfs $fh_or_path, $callback->($statvfs)	488	=item aio_statvfs $fh_or_path, $callback->($statvfs)
438		489
439	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on	490	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
440	whether a file handle or path was passed.	491	whether a file handle or path was passed.
441		492
442	On success, the callback is passed a hash reference with the following	493	On success, the callback is passed a hash reference with the following
…		…
1039	}	1090	}
1040		1091
1041	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	1092	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1042		1093
1043	This is a rather advanced IO::AIO call, which only works on mmap(2)ed	1094	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1044	scalars (see the L<Sys::Mmap> or L<Mmap> modules for details on this, note	1095	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1096	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1045	that the scalar must only be modified in-place while an aio operation is	1097	scalar must only be modified in-place while an aio operation is pending on
1046	pending on it).	1098	it).
1047		1099
1048	It calls the C<msync> function of your OS, if available, with the memory	1100	It calls the C<msync> function of your OS, if available, with the memory
1049	area starting at C<$offset> in the string and ending C<$length> bytes	1101	area starting at C<$offset> in the string and ending C<$length> bytes
1050	later. If C<$length> is negative, counts from the end, and if C<$length>	1102	later. If C<$length> is negative, counts from the end, and if C<$length>
1051	is C<undef>, then it goes till the end of the string. The flags can be	1103	is C<undef>, then it goes till the end of the string. The flags can be
…		…
1062	as for C<aio_msync>, above, except for flags, which must be either	1114	as for C<aio_msync>, above, except for flags, which must be either
1063	C<0> (which reads all pages and ensures they are instantiated) or	1115	C<0> (which reads all pages and ensures they are instantiated) or
1064	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and	1116	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1065	writing an octet from it, which dirties the page).	1117	writing an octet from it, which dirties the page).
1066		1118
		1119	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1120
		1121	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1122	scalars.
		1123
		1124	It reads in all the pages of the underlying storage into memory (if any)
		1125	and locks them, so they are not getting swapped/paged out or removed.
		1126
		1127	If C<$length> is undefined, then the scalar will be locked till the end.
		1128
		1129	On systems that do not implement C<mlock>, this function returns C<-1>
		1130	and sets errno to C<ENOSYS>.
		1131
		1132	Note that the corresponding C<munlock> is synchronous and is
		1133	documented under L<MISCELLANEOUS FUNCTIONS>.
		1134
		1135	Example: open a file, mmap and mlock it - both will be undone when
		1136	C<$data> gets destroyed.
		1137
		1138	open my $fh, "<", $path or die "$path: $!";
		1139	my $data;
		1140	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1141	aio_mlock $data; # mlock in background
		1142
		1143	=item aio_mlockall $flags, $callback->($status)
		1144
		1145	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1146	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1147
		1148	On systems that do not implement C<mlockall>, this function returns C<-1>
		1149	and sets errno to C<ENOSYS>.
		1150
		1151	Note that the corresponding C<munlockall> is synchronous and is
		1152	documented under L<MISCELLANEOUS FUNCTIONS>.
		1153
		1154	Example: asynchronously lock all current and future pages into memory.
		1155
		1156	aio_mlockall IO::AIO::MCL_FUTURE;
		1157
1067	=item aio_group $callback->(...)	1158	=item aio_group $callback->(...)
1068		1159
1069	This is a very special aio request: Instead of doing something, it is a	1160	This is a very special aio request: Instead of doing something, it is a
1070	container for other aio requests, which is useful if you want to bundle	1161	container for other aio requests, which is useful if you want to bundle
1071	many requests into a single, composite, request with a definite callback	1162	many requests into a single, composite, request with a definite callback
…		…
1312		1403
1313	Event->io (fd => IO::AIO::poll_fileno,	1404	Event->io (fd => IO::AIO::poll_fileno,
1314	poll => 'r', async => 1,	1405	poll => 'r', async => 1,
1315	cb => \&IO::AIO::poll_cb);	1406	cb => \&IO::AIO::poll_cb);
1316		1407
		1408	=item IO::AIO::poll_wait
		1409
		1410	If there are any outstanding requests and none of them in the result
		1411	phase, wait till the result filehandle becomes ready for reading (simply
		1412	does a C<select> on the filehandle. This is useful if you want to
		1413	synchronously wait for some requests to finish).
		1414
		1415	See C<nreqs> for an example.
		1416
		1417	=item IO::AIO::poll
		1418
		1419	Waits until some requests have been handled.
		1420
		1421	Returns the number of requests processed, but is otherwise strictly
		1422	equivalent to:
		1423
		1424	IO::AIO::poll_wait, IO::AIO::poll_cb
		1425
		1426	=item IO::AIO::flush
		1427
		1428	Wait till all outstanding AIO requests have been handled.
		1429
		1430	Strictly equivalent to:
		1431
		1432	IO::AIO::poll_wait, IO::AIO::poll_cb
		1433	while IO::AIO::nreqs;
		1434
1317	=item IO::AIO::max_poll_reqs $nreqs	1435	=item IO::AIO::max_poll_reqs $nreqs
1318		1436
1319	=item IO::AIO::max_poll_time $seconds	1437	=item IO::AIO::max_poll_time $seconds
1320		1438
1321	These set the maximum number of requests (default C<0>, meaning infinity)	1439	These set the maximum number of requests (default C<0>, meaning infinity)
…		…
1345	# use a low priority so other tasks have priority	1463	# use a low priority so other tasks have priority
1346	Event->io (fd => IO::AIO::poll_fileno,	1464	Event->io (fd => IO::AIO::poll_fileno,
1347	poll => 'r', nice => 1,	1465	poll => 'r', nice => 1,
1348	cb => &IO::AIO::poll_cb);	1466	cb => &IO::AIO::poll_cb);
1349		1467
1350	=item IO::AIO::poll_wait
1351
1352	If there are any outstanding requests and none of them in the result
1353	phase, wait till the result filehandle becomes ready for reading (simply
1354	does a C<select> on the filehandle. This is useful if you want to
1355	synchronously wait for some requests to finish).
1356
1357	See C<nreqs> for an example.
1358
1359	=item IO::AIO::poll
1360
1361	Waits until some requests have been handled.
1362
1363	Returns the number of requests processed, but is otherwise strictly
1364	equivalent to:
1365
1366	IO::AIO::poll_wait, IO::AIO::poll_cb
1367
1368	=item IO::AIO::flush
1369
1370	Wait till all outstanding AIO requests have been handled.
1371
1372	Strictly equivalent to:
1373
1374	IO::AIO::poll_wait, IO::AIO::poll_cb
1375	while IO::AIO::nreqs;
1376
1377	=back	1468	=back
1378		1469
1379	=head3 CONTROLLING THE NUMBER OF THREADS	1470	=head3 CONTROLLING THE NUMBER OF THREADS
1380		1471
1381	=over	1472	=over
…		…
1491		1582
1492	Returns the number of bytes copied, or C<-1> on error.	1583	Returns the number of bytes copied, or C<-1> on error.
1493		1584
1494	=item IO::AIO::fadvise $fh, $offset, $len, $advice	1585	=item IO::AIO::fadvise $fh, $offset, $len, $advice
1495		1586
1496	Simply calls the C<posix_fadvise> function (see it's	1587	Simply calls the C<posix_fadvise> function (see its
1497	manpage for details). The following advice constants are	1588	manpage for details). The following advice constants are
1498	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,	1589	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1499	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,	1590	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1500	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.	1591	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1501		1592
1502	On systems that do not implement C<posix_fadvise>, this function returns	1593	On systems that do not implement C<posix_fadvise>, this function returns
1503	ENOSYS, otherwise the return value of C<posix_fadvise>.	1594	ENOSYS, otherwise the return value of C<posix_fadvise>.
1504		1595
		1596	=item IO::AIO::madvise $scalar, $offset, $len, $advice
		1597
		1598	Simply calls the C<posix_madvise> function (see its
		1599	manpage for details). The following advice constants are
		1600	avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
		1601	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
		1602
		1603	On systems that do not implement C<posix_madvise>, this function returns
		1604	ENOSYS, otherwise the return value of C<posix_madvise>.
		1605
		1606	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
		1607
		1608	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
		1609	$scalar (see its manpage for details). The following protect
		1610	constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
		1611	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		1612
		1613	On systems that do not implement C<mprotect>, this function returns
		1614	ENOSYS, otherwise the return value of C<mprotect>.
		1615
		1616	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		1617
		1618	Memory-maps a file (or anonymous memory range) and attaches it to the
		1619	given C<$scalar>, which will act like a string scalar.
		1620
		1621	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		1622	change the string length, and most read-only operations such as copying it
		1623	or searching it with regexes and so on.
		1624
		1625	Anything else is unsafe and will, at best, result in memory leaks.
		1626
		1627	The memory map associated with the C<$scalar> is automatically removed
		1628	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		1629	C<IO::AIO::munmap> functions are called.
		1630
		1631	This calls the C<mmap>(2) function internally. See your system's manual
		1632	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		1633
		1634	The C<$length> must be larger than zero and smaller than the actual
		1635	filesize.
		1636
		1637	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		1638	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		1639
		1640	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
		1641	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
		1642	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
		1643	(which is set to C<MAP_ANON> if your system only provides this
		1644	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
		1645	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
		1646	C<IO::AIO::MAP_NONBLOCK>
		1647
		1648	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		1649
		1650	C<$offset> is the offset from the start of the file - it generally must be
		1651	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		1652
		1653	Example:
		1654
		1655	use Digest::MD5;
		1656	use IO::AIO;
		1657
		1658	open my $fh, "<verybigfile"
		1659	or die "$!";
		1660
		1661	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		1662	or die "verybigfile: $!";
		1663
		1664	my $fast_md5 = md5 $data;
		1665
		1666	=item IO::AIO::munmap $scalar
		1667
		1668	Removes a previous mmap and undefines the C<$scalar>.
		1669
		1670	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		1671
		1672	Calls the C<munlock> function, undoing the effects of a previous
		1673	C<aio_mlock> call (see its description for details).
		1674
		1675	=item IO::AIO::munlockall
		1676
		1677	Calls the C<munlockall> function.
		1678
		1679	On systems that do not implement C<munlockall>, this function returns
		1680	ENOSYS, otherwise the return value of C<munlockall>.
		1681
1505	=back	1682	=back
1506		1683
1507	=cut	1684	=cut
1508		1685
1509	min_parallel 8;	1686	min_parallel 8;
1510		1687
1511	END { flush }	1688	END { flush }
1512		1689
1513	1;	1690	1;
		1691
		1692	=head1 EVENT LOOP INTEGRATION
		1693
		1694	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		1695	automatically into many event loops:
		1696
		1697	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		1698	use AnyEvent::AIO;
		1699
		1700	You can also integrate IO::AIO manually into many event loops, here are
		1701	some examples of how to do this:
		1702
		1703	# EV integration
		1704	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		1705
		1706	# Event integration
		1707	Event->io (fd => IO::AIO::poll_fileno,
		1708	poll => 'r',
		1709	cb => \&IO::AIO::poll_cb);
		1710
		1711	# Glib/Gtk2 integration
		1712	add_watch Glib::IO IO::AIO::poll_fileno,
		1713	in => sub { IO::AIO::poll_cb; 1 };
		1714
		1715	# Tk integration
		1716	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		1717	readable => \&IO::AIO::poll_cb);
		1718
		1719	# Danga::Socket integration
		1720	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		1721	\&IO::AIO::poll_cb);
1514		1722
1515	=head2 FORK BEHAVIOUR	1723	=head2 FORK BEHAVIOUR
1516		1724
1517	This module should do "the right thing" when the process using it forks:	1725	This module should do "the right thing" when the process using it forks:
1518		1726

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.172 by root, Thu Jan 7 18:08:21 2010 UTC vs. Revision 1.184 by root, Mon Nov 1 22:03:43 2010 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.172 by root, Thu Jan 7 18:08:21 2010 UTC vs.
Revision 1.184 by root, Mon Nov 1 22:03:43 2010 UTC