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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.24 by root, Sun Jul 31 18:45:48 2005 UTC vs.
Revision 1.33 by root, Wed Aug 17 06:12:10 2005 UTC

…		…
63	use base 'Exporter';	63	use base 'Exporter';
64		64
65	use Fcntl ();	65	use Fcntl ();
66		66
67	BEGIN {	67	BEGIN {
68	$VERSION = 1.1;	68	$VERSION = 1.4;
69		69
70	@EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink	70	@EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink
71	aio_fsync aio_fdatasync aio_readahead);	71	aio_rmdir aio_symlink aio_fsync aio_fdatasync aio_readahead);
72	@EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);	72	@EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);
73		73
74	require XSLoader;	74	require XSLoader;
75	XSLoader::load IO::AIO, $VERSION;	75	XSLoader::load IO::AIO, $VERSION;
76	}	76	}
…		…
88	syscall has been executed asynchronously.	88	syscall has been executed asynchronously.
89		89
90	All functions expecting a filehandle keep a copy of the filehandle	90	All functions expecting a filehandle keep a copy of the filehandle
91	internally until the request has finished.	91	internally until the request has finished.
92		92
93	The filenames you pass to these routines I<must> be absolute. The reason	93	The pathnames you pass to these routines I<must> be absolute and
94	for this is that at the time the request is being executed, the current	94	encoded in byte form. The reason for the former is that at the time the
95	working directory could have changed. Alternatively, you can make sure	95	request is being executed, the current working directory could have
96	that you never change the current working directory.	96	changed. Alternatively, you can make sure that you never change the
		97	current working directory.
		98
		99	To encode pathnames to byte form, either make sure you either: a)
		100	always pass in filenames you got from outside (command line, readdir
		101	etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode
		102	your pathnames to the locale (or other) encoding in effect in the user
		103	environment, d) use Glib::filename_from_unicode on unicode filenames or e)
		104	use something else.
97		105
98	=over 4	106	=over 4
99		107
100	=item aio_open $pathname, $flags, $mode, $callback	108	=item aio_open $pathname, $flags, $mode, $callback
101		109
…		…
142	Reads or writes C<length> bytes from the specified C<fh> and C<offset>	150	Reads or writes C<length> bytes from the specified C<fh> and C<offset>
143	into the scalar given by C<data> and offset C<dataoffset> and calls the	151	into the scalar given by C<data> and offset C<dataoffset> and calls the
144	callback without the actual number of bytes read (or -1 on error, just	152	callback without the actual number of bytes read (or -1 on error, just
145	like the syscall).	153	like the syscall).
146		154
		155	The C<$data> scalar I<MUST NOT> be modified in any way while the request
		156	is outstanding. Modifying it can result in segfaults or WW3 (if the
		157	necessary/optional hardware is installed).
		158
147	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at	159	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
148	offset C<0> within the scalar:	160	offset C<0> within the scalar:
149		161
150	aio_read $fh, 7, 15, $buffer, 0, sub {	162	aio_read $fh, 7, 15, $buffer, 0, sub {
151	$_[0] > 0 or die "read error: $!";	163	$_[0] > 0 or die "read error: $!";
152	print "read $_[0] bytes: <$buffer>\n";	164	print "read $_[0] bytes: <$buffer>\n";
153	};	165	};
154		166
155	=item aio_readahead $fh,$offset,$length, $callback	167	=item aio_readahead $fh,$offset,$length, $callback
156
157	Asynchronously reads the specified byte range into the page cache, using
158	the C<readahead> syscall. If that syscall doesn't exist (likely if your OS
159	isn't Linux) the status will be C<-1> and C<$!> is set to C<ENOSYS>.
160		168
161	C<aio_readahead> populates the page cache with data from a file so that	169	C<aio_readahead> populates the page cache with data from a file so that
162	subsequent reads from that file will not block on disk I/O. The C<$offset>	170	subsequent reads from that file will not block on disk I/O. The C<$offset>
163	argument specifies the starting point from which data is to be read and	171	argument specifies the starting point from which data is to be read and
164	C<$length> specifies the number of bytes to be read. I/O is performed in	172	C<$length> specifies the number of bytes to be read. I/O is performed in
165	whole pages, so that offset is effectively rounded down to a page boundary	173	whole pages, so that offset is effectively rounded down to a page boundary
166	and bytes are read up to the next page boundary greater than or equal to	174	and bytes are read up to the next page boundary greater than or equal to
167	(off-set+length). C<aio_readahead> does not read beyond the end of the	175	(off-set+length). C<aio_readahead> does not read beyond the end of the
168	file. The current file offset of the file is left unchanged.	176	file. The current file offset of the file is left unchanged.
169		177
		178	If that syscall doesn't exist (likely if your OS isn't Linux) it will be
		179	emulated by simply reading the data, which would have a similar effect.
		180
170	=item aio_stat $fh_or_path, $callback	181	=item aio_stat $fh_or_path, $callback
171		182
172	=item aio_lstat $fh, $callback	183	=item aio_lstat $fh, $callback
173		184
174	Works like perl's C<stat> or C<lstat> in void context. The callback will	185	Works like perl's C<stat> or C<lstat> in void context. The callback will
…		…
192	=item aio_unlink $pathname, $callback	203	=item aio_unlink $pathname, $callback
193		204
194	Asynchronously unlink (delete) a file and call the callback with the	205	Asynchronously unlink (delete) a file and call the callback with the
195	result code.	206	result code.
196		207
		208	=item aio_rmdir $pathname, $callback
		209
		210	Asynchronously rmdir (delete) a directory and call the callback with the
		211	result code.
		212
197	=item aio_fsync $fh, $callback	213	=item aio_fsync $fh, $callback
198		214
199	Asynchronously call fsync on the given filehandle and call the callback	215	Asynchronously call fsync on the given filehandle and call the callback
200	with the fsync result code.	216	with the fsync result code.
201		217
202	=item aio_fdatasync $fh, $callback	218	=item aio_fdatasync $fh, $callback
203		219
204	Asynchronously call fdatasync on the given filehandle and call the	220	Asynchronously call fdatasync on the given filehandle and call the
205	callback with the fdatasync result code. Might set C<$!> to C<ENOSYS> if	221	callback with the fdatasync result code.
206	C<fdatasync> is not available.	222
		223	If this call isn't available because your OS lacks it or it couldn't be
		224	detected, it will be emulated by calling C<fsync> instead.
207		225
208	=back	226	=back
209		227
210	=head2 SUPPORT FUNCTIONS	228	=head2 SUPPORT FUNCTIONS
211		229
…		…
316	return undef if $_[0] < 0;	334	return undef if $_[0] < 0;
317		335
318	# try to generate nice filehandles	336	# try to generate nice filehandles
319	my $sym = "IO::AIO::fd#$_[0]";	337	my $sym = "IO::AIO::fd#$_[0]";
320	local *$sym;	338	local *$sym;
321	open *$sym, "+<&=$_[0]"	339
		340	open *$sym, "+<&=$_[0]" # usually works under any unix
		341	or open *$sym, "<&=$_[0]" # cygwin needs this
		342	or open *$sym, ">&=$_[0]" # or this
322	or return undef;	343	or return undef;
323		344
324	*$sym	345	*$sym
325	}	346	}
326		347
…		…
330	max_parallel 0;	351	max_parallel 0;
331	}	352	}
332		353
333	1;	354	1;
334		355
		356	=head2 FORK BEHAVIOUR
		357
		358	Before the fork IO::AIO enters a quiescent state where no requests can be
		359	added in other threads and no results will be processed. After the fork
		360	the parent simply leaves the quiescent state and continues request/result
		361	processing, while the child clears the request/result queue and starts the
		362	same number of threads as were in use by the parent.
		363
335	=head1 SEE ALSO	364	=head1 SEE ALSO
336		365
337	L<Coro>, L<Linux::AIO>.	366	L<Coro>, L<Linux::AIO>.
338		367
339	=head1 AUTHOR	368	=head1 AUTHOR

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.24 by root, Sun Jul 31 18:45:48 2005 UTC vs. Revision 1.33 by root, Wed Aug 17 06:12:10 2005 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.24 by root, Sun Jul 31 18:45:48 2005 UTC vs.
Revision 1.33 by root, Wed Aug 17 06:12:10 2005 UTC