ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.26 by root, Sun Aug 7 03:34:07 2005 UTC vs.
Revision 1.32 by root, Wed Aug 17 05:26:20 2005 UTC

… …
63use base 'Exporter'; 63use base 'Exporter';
64 64
65use Fcntl (); 65use Fcntl ();
66 66
67BEGIN { 67BEGIN {
68 $VERSION = 1.1; 68 $VERSION = 1.3;
69
69 70
70 @EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink 71 @EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink
71 aio_fsync aio_fdatasync aio_readahead); 72 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); 73 @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);
73 74
74 require XSLoader; 75 require XSLoader;
75 XSLoader::load IO::AIO, $VERSION; 76 XSLoader::load IO::AIO, $VERSION;
76} 77}
… …
88syscall has been executed asynchronously. 89syscall has been executed asynchronously.
89 90
90All functions expecting a filehandle keep a copy of the filehandle 91All functions expecting a filehandle keep a copy of the filehandle
91internally until the request has finished. 92internally until the request has finished.
92 93
93The filenames you pass to these routines I<must> be absolute. The reason 94The pathnames you pass to these routines I<must> be absolute and
94for this is that at the time the request is being executed, the current 95encoded in byte form. The reason for the former is that at the time the
95working directory could have changed. Alternatively, you can make sure 96request is being executed, the current working directory could have
96that you never change the current working directory. 97changed. Alternatively, you can make sure that you never change the
98current working directory.
99
100To encode pathnames to byte form, either make sure you either: a)
101always pass in filenames you got from outside (command line, readdir
102etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode
103your pathnames to the locale (or other) encoding in effect in the user
104environment, d) use Glib::filename_from_unicode on unicode filenames or e)
105use something else.
97 106
98=over 4 107=over 4
99 108
100=item aio_open $pathname, $flags, $mode, $callback 109=item aio_open $pathname, $flags, $mode, $callback
101 110
… …
142Reads or writes C<length> bytes from the specified C<fh> and C<offset> 151Reads or writes C<length> bytes from the specified C<fh> and C<offset>
143into the scalar given by C<data> and offset C<dataoffset> and calls the 152into the scalar given by C<data> and offset C<dataoffset> and calls the
144callback without the actual number of bytes read (or -1 on error, just 153callback without the actual number of bytes read (or -1 on error, just
145like the syscall). 154like the syscall).
146 155
156The C<$data> scalar I<MUST NOT> be modified in any way while the request
157is outstanding. Modifying it can result in segfaults or WW3 (if the
158necessary/optional hardware is installed).
159
147Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at 160Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
148offset C<0> within the scalar: 161offset C<0> within the scalar:
149 162
150 aio_read $fh, 7, 15, $buffer, 0, sub { 163 aio_read $fh, 7, 15, $buffer, 0, sub {
151 $_[0] > 0 or die "read error: $!"; 164 $_[0] > 0 or die "read error: $!";
… …
191=item aio_unlink $pathname, $callback 204=item aio_unlink $pathname, $callback
192 205
193Asynchronously unlink (delete) a file and call the callback with the 206Asynchronously unlink (delete) a file and call the callback with the
194result code. 207result code.
195 208
209=item aio_rmdir $pathname, $callback
210
211Asynchronously rmdir (delete) a directory and call the callback with the
212result code.
213
196=item aio_fsync $fh, $callback 214=item aio_fsync $fh, $callback
197 215
198Asynchronously call fsync on the given filehandle and call the callback 216Asynchronously call fsync on the given filehandle and call the callback
199with the fsync result code. 217with the fsync result code.
200 218
… …
318 336
319 # try to generate nice filehandles 337 # try to generate nice filehandles
320 my $sym = "IO::AIO::fd#$_[0]"; 338 my $sym = "IO::AIO::fd#$_[0]";
321 local *$sym; 339 local *$sym;
322 340
323 open *$sym, "+<&$_[0]" # usually under any unix 341 open *$sym, "+<&=$_[0]" # usually works under any unix
324 or open *$sym, "<&$_[0]" # cygwin needs this 342 or open *$sym, "<&=$_[0]" # cygwin needs this
325 or open *$sym, ">&$_[0]" # cygwin needs this 343 or open *$sym, ">&=$_[0]" # or this
326 or return undef; 344 or return undef;
327 345
328 *$sym 346 *$sym
329} 347}
330 348
… …
334 max_parallel 0; 352 max_parallel 0;
335} 353}
336 354
3371; 3551;
338 356
357=head2 FORK BEHAVIOUR
358
359Before the fork IO::AIO enters a quiescent state where no requests can be
360added in other threads and no results will be processed. After the fork
361the parent simply leaves the quiescent state and continues request/result
362processing, while the child clears the request/result queue and starts the
363same number of threads as were in use by the parent.
364
339=head1 SEE ALSO 365=head1 SEE ALSO
340 366
341L<Coro>, L<Linux::AIO>. 367L<Coro>, L<Linux::AIO>.
342 368
343=head1 AUTHOR 369=head1 AUTHOR

Diff Legend

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