--- IO-AIO/AIO.pm 2005/07/10 22:20:55 1.9 +++ IO-AIO/AIO.pm 2005/07/20 21:55:27 1.22 @@ -24,12 +24,17 @@ # Glib/Gtk2 add_watch Glib::IO IO::AIO::poll_fileno, - \&IO::AIO::poll_cb; + in => sub { IO::AIO::poll_cb; 1 }; # Tk Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", readable => \&IO::AIO::poll_cb); + # Danga::Socket + Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => + \&IO::AIO::poll_cb); + + =head1 DESCRIPTION This module implements asynchronous I/O using whatever means your @@ -45,7 +50,9 @@ remaining functionality would have to be implemented using threads anyway. Although the module will work with in the presence of other threads, it is -currently not reentrant, so use appropriate locking yourself. +currently not reentrant, so use appropriate locking yourself, always call +C from within the same thread, or never call C (or other +C functions) recursively. =cut @@ -56,7 +63,7 @@ use Fcntl (); BEGIN { - $VERSION = 0.2; + $VERSION = 0.9; @EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink aio_fsync aio_fdatasync aio_readahead); @@ -72,18 +79,18 @@ All the C calls are more or less thin wrappers around the syscall with the same name (sans C). The arguments are similar or identical, -and they all accept an additional C<$callback> argument which must be -a code reference. This code reference will get called with the syscall -return code (e.g. most syscalls return C<-1> on error, unlike perl, which -usually delivers "false") as it's sole argument when the given syscall has -been executed asynchronously. +and they all accept an additional (and optional) C<$callback> argument +which must be a code reference. This code reference will get called with +the syscall return code (e.g. most syscalls return C<-1> on error, unlike +perl, which usually delivers "false") as it's sole argument when the given +syscall has been executed asynchronously. All functions that expect a filehandle will also accept a file descriptor. The filenames you pass to these routines I be absolute. The reason -is that at the time the request is being executed, the current working -directory could have changed. Alternatively, you can make sure that you -never change the current working directory. +for this is that at the time the request is being executed, the current +working directory could have changed. Alternatively, you can make sure +that you never change the current working directory. =over 4 @@ -95,8 +102,13 @@ The pathname passed to C must be absolute. See API NOTES, above, for an explanation. -The C<$mode> argument is a bitmask. See the C module for a -list. They are the same as used in C. +The C<$flags> argument is a bitmask. See the C module for a +list. They are the same as used by C. + +Likewise, C<$mode> specifies the mode of the newly created file, if it +didn't exist and C has been given, just like perl's C, +except that it is mandatory (i.e. use C<0> if you don't create new files, +and C<0666> or C<0777> if you do). Example: @@ -113,9 +125,12 @@ Asynchronously close a file and call the callback with the result code. I although accepted, you should not pass in a perl -filehandle here, as perl will likely close the file descriptor itself when -the filehandle is destroyed. Normally, you can safely call perls C -or just let filehandles go out of scope. +filehandle here, as perl will likely close the file descriptor another +time when the filehandle is destroyed. Normally, you can safely call perls +C or just let filehandles go out of scope. + +This is supposed to be a bug in the API, so that might change. It's +therefore best to avoid this function. =item aio_read $fh,$offset,$length, $data,$dataoffset,$callback @@ -126,7 +141,7 @@ callback without the actual number of bytes read (or -1 on error, just like the syscall). -Example: Read 15 bytes at offset 7 into scalar C<$buffer>, strating at +Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at offset C<0> within the scalar: aio_read $fh, 7, 15, $buffer, 0, sub { @@ -137,16 +152,16 @@ =item aio_readahead $fh,$offset,$length, $callback Asynchronously reads the specified byte range into the page cache, using -the C syscall. If that syscall doesn't exist the status will be -C<-1> and C<$!> is set to ENOSYS. +the C syscall. If that syscall doesn't exist (likely if your OS +isn't Linux) the status will be C<-1> and C<$!> is set to C. -readahead() populates the page cache with data from a file so that +C populates the page cache with data from a file so that subsequent reads from that file will not block on disk I/O. The C<$offset> argument specifies the starting point from which data is to be read and C<$length> specifies the number of bytes to be read. I/O is performed in whole pages, so that offset is effectively rounded down to a page boundary and bytes are read up to the next page boundary greater than or equal to -(off-set+length). aio_readahead() does not read beyond the end of the +(off-set+length). C does not read beyond the end of the file. The current file offset of the file is left unchanged. =item aio_stat $fh_or_path, $callback @@ -184,7 +199,8 @@ =item aio_fdatasync $fh, $callback Asynchronously call fdatasync on the given filehandle and call the -callback with the fdatasync result code. +callback with the fdatasync result code. Might set C<$!> to C if +C is not available. =back @@ -194,10 +210,10 @@ =item $fileno = IO::AIO::poll_fileno -Return the I. This filehandle must be -polled for reading by some mechanism outside this module (e.g. Event -or select, see below). If the pipe becomes readable you have to call -C to check the results. +Return the I. This filehandle must be +polled for reading by some mechanism outside this module (e.g. Event or +select, see below or the SYNOPSIS). If the pipe becomes readable you have +to call C to check the results. See C for an example. @@ -207,7 +223,8 @@ regularly. Returns the number of events processed. Returns immediately when no events are outstanding. -You can use Event to multiplex, e.g.: +Example: Install an Event watcher that automatically calls +IO::AIO::poll_cb with high priority: Event->io (fd => IO::AIO::poll_fileno, poll => 'r', async => 1, @@ -216,20 +233,39 @@ =item IO::AIO::poll_wait Wait till the result filehandle becomes ready for reading (simply does a -select on the filehandle. This is useful if you want to synchronously wait +C