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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.187 by root, Fri Feb 11 00:05:17 2011 UTC vs.
Revision 1.193 by root, Thu May 26 04:15:37 2011 UTC

 use common::sense;
 use base 'Exporter';
 BEGIN {
-   our $VERSION = '3.72';
+   our $VERSION = '3.8';
    our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
                      aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
                      aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
                      aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
                      aio_msync aio_mtouch aio_mlock aio_mlockall
                      aio_statvfs);
    our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
    our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
-                       min_parallel max_parallel max_idle
+                       min_parallel max_parallel max_idle idle_timeout
                        nreqs nready npending nthreads
                        max_poll_time max_poll_reqs
                        sendfile fadvise madvise
                        mmap munmap munlock munlockall);
    IO::AIO::max_poll_reqs $nreqs
    IO::AIO::max_poll_time $seconds
    IO::AIO::min_parallel $nthreads
    IO::AIO::max_parallel $nthreads
    IO::AIO::max_idle $nthreads
+   IO::AIO::idle_timeout $seconds
    IO::AIO::max_outstanding $maxreqs
    IO::AIO::nreqs
    IO::AIO::nready
    IO::AIO::npending
 =over 4
 =item IO::AIO::READDIR_DENTS
-When this flag is off, then the callback gets an arrayref with of names
+When this flag is off, then the callback gets an arrayref consisting of
-only (as with C<aio_readdir>), otherwise it gets an arrayref with
+names only (as with C<aio_readdir>), otherwise it gets an arrayref with
 C<[$name, $type, $inode]> arrayrefs, each describing a single directory
 entry in more detail.
 C<$name> is the name of the entry.
 systems that do not deliver the inode information.
 =item IO::AIO::READDIR_DIRS_FIRST
 When this flag is set, then the names will be returned in an order where
-likely directories come first. This is useful when you need to quickly
+likely directories come first, in optimal stat order. This is useful when
-find directories, or you want to find all directories while avoiding to
+you need to quickly find directories, or you want to find all directories
-stat() each entry.
+while avoiding to stat() each entry.
 If the system returns type information in readdir, then this is used
-to find directories directly.  Otherwise, likely directories are files
+to find directories directly. Otherwise, likely directories are names
-beginning with ".", or otherwise files with no dots, of which files with
+beginning with ".", or otherwise names with no dots, of which names with
 short names are tried first.
 =item IO::AIO::READDIR_STAT_ORDER
 When this flag is set, then the names will be returned in an order
 See C<poll_cb> for an example.
 =item IO::AIO::poll_cb
-Process some outstanding events on the result pipe. You have to call this
+Process some outstanding events on the result pipe. You have to call
-regularly. Returns C<0> if all events could be processed, or C<-1> if it
+this regularly. Returns C<0> if all events could be processed (or there
-returned earlier for whatever reason. Returns immediately when no events
+were no events to process), or C<-1> if it returned earlier for whatever
-are outstanding. The amount of events processed depends on the settings of
+reason. Returns immediately when no events are outstanding. The amount of
-C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
+events processed depends on the settings of C<IO::AIO::max_poll_req> and
+C<IO::AIO::max_poll_time>.
 If not all requests were processed for whatever reason, the filehandle
 will still be ready when C<poll_cb> returns, so normally you don't have to
 do anything special to have it called later.
+Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
+ready, it can be beneficial to call this function from loops which submit
+a lot of requests, to make sure the results get processed when they become
+available and not just when the loop is finished and the event loop takes
+over again. This function returns very fast when there are no outstanding
+requests.
 Example: Install an Event watcher that automatically calls
 IO::AIO::poll_cb with high priority (more examples can be found in the
 SYNOPSIS section, at the top of this document):
 Under normal circumstances you don't need to call this function.
 =item IO::AIO::max_idle $nthreads
-Limit the number of threads (default: 4) that are allowed to idle (i.e.,
+Limit the number of threads (default: 4) that are allowed to idle
-threads that did not get a request to process within 10 seconds). That
+(i.e., threads that did not get a request to process within the idle
-means if a thread becomes idle while C<$nthreads> other threads are also
+timeout (default: 10 seconds). That means if a thread becomes idle while
-idle, it will free its resources and exit.
+C<$nthreads> other threads are also idle, it will free its resources and
+exit.
 This is useful when you allow a large number of threads (e.g. 100 or 1000)
 to allow for extremely high load situations, but want to free resources
 under normal circumstances (1000 threads can easily consume 30MB of RAM).
 The default is probably ok in most situations, especially if thread
 creation is fast. If thread creation is very slow on your system you might
 want to use larger values.
+=item IO::AIO::idle_timeout $seconds
+Sets the minimum idle timeout (default 10) after which worker threads are
+allowed to exit. SEe C<IO::AIO::max_idle>.
 =item IO::AIO::max_outstanding $maxreqs
 This is a very bad function to use in interactive programs because it
 blocks, and a bad way to reduce concurrency because it is inexact: Better

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.187 by root, Fri Feb 11 00:05:17 2011 UTC vs. Revision 1.193 by root, Thu May 26 04:15:37 2011 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.187 by root, Fri Feb 11 00:05:17 2011 UTC vs.
Revision 1.193 by root, Thu May 26 04:15:37 2011 UTC